Improved hover support: Structs, qualified calls and types, more info for modules #356

This moves all of the fetching of docs, specs, types, and callbacks into `Lexical.RemoteControl.Modules`. Those functions now also operate on BEAM object code, which means the object code doesn't need to be repeatedly read from disk. The object code for a module also appears to be available immediately after calling `Code.ensure_compiled(module)`, which allows us to get rid of a timeout/loop that was waiting for it to be written to disk.

The correct guard logic for a call is quite verbose, as you must ensure that the call in a `{call, meta, args}` node isn't a special form, like `:__aliases__`.

This commit currently pulls in a to-be-merged branch of `Sourceror` which contains fixes and changes around `Sourceror.get_range/1`. These are required in order to accurately determine the cursor position in an AST. An additional important change that this commit makes is to add the `unescape: false` option when converting strings to quoted forms. This is needed to determine whether newlines in strings were escaped literals (`\n`) or multi-line. Take this example: iex> Code.string_to_quoted!(~S|"foo\nbar"|) "foo\nbar" iex> Code.string_to_quoted!(~S|"foo ...> bar"|) "foo\nbar" iex> Code.string_to_quoted!(~S|"foo\nbar"|, unescape: false) "foo\\nbar" iex> Code.string_to_quoted!(~S|"foo ...> bar"|, unescape: false) "foo\nbar" Note that, with `unescape: false`, there is a difference between the strings.

There were a few commonalities in all existing usage of `CursorSupport`: 1. In almost all usage, `cursor_position` and `strip_cursor` are used together. 2. In all usage, the returned `{line, column}` tuple could/should be a `Lexical.Document.Position`. 3. In many cases, the stripped text is then used to create a `Lexical.Document`. To address these, a higher level `pop_cursor/2` has been added, returning `{%Position{}, stripped_text}` by default. However, by using the `:as` or `:document` options, `pop_cursor/2` can return `{%Position{}, %Document{}}`, reducing a significant amount of boilerplate. This change also has the effect of reducing the number of tests requiring `PositionSupport`.

When resolving modules, we'll exclude segments trailing the cursor so that you can walk up a module to better understand its context. For instance, for `My.|Nested.Module`, we resolve to `My.Nested`. Using the same behavior for structs makes less sense. If you're hovering a module being used as a struct, often only the full alias is actually a struct; the parents might not be. For instance, with `%My.|Nested.Struct{}`, resolving to `My.Nested` will not yield useful results. Because of this, the full alias is now always resolved in a struct context, so the above would resolve to the struct `My.Nested.Struct`.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved hover support: Structs, qualified calls and types, more info for modules #356

Improved hover support: Structs, qualified calls and types, more info for modules #356

Commits on Sep 21, 2023