Find References

[z80dev]

For any given symbol definition/declaration, we want to be able to find all references to this symbol in the project.

With Vyper's (current) lack of modules, this is simplified given that we only have to search the current file being edited.

LSP API Methods

• textDocument/references

Variations of Reference Lookups

Variable Names

x: uint256

@external
def foo() -> uint256:
    return self.x

Looking up references of x should give us a list of every usage of self.x in the contract.

Constants and immutables will be referenced without the self prefix.

User-Defined "Types"

"Types" isn't quite the right word, but is useful here to cover both struct and event declarations.

event Foo:
    x: uint256
    y: uint256
    
struct Bar:
    z: uint256

@external
def baz() -> Bar:
    log Foo(1, 2)
    return Bar({z: 3})

Looking up references of Foo should bring up the line where we log Foo.

Looking up references of Bar should bring up both the line where we declare the return type of baz() to be Bar, as well as the line where we create a new instance of Bar to be returned