I have some trouble getting Goto defintions(F12) containing “.” to work for a custom syntax.
Goto Symbol / Goto symbol in Project however works (for namespaced “.” functions too).
I suspect this is because Goto Definition treats . as a word separator. Does it work if you select the .namespace.function before the [] and then try F12?
It looks to me like the core of your issue is indeed that the default functionality for this assumes that . is a word separator. Confusingly however, I can’t replicate your results from above; as @kingkeith mentioned, selecting the text first allows it to work with no modifications.
In particular, I created a sublime-syntax version of your language spec as outlined above (primarily because XML gives me hives ;)), plus a tmPreferences file to include the symbols in the index and a sample source file. The files that I’m working with are contained in this gist:
With this in place, indeed putting the cursor in one of the parts of the filename and pressing F12 does not find the symbol in question. If you watch the status line, you can see it specifically saying “Unable to find function” and “Unable to find name1”.
However, if I select the entirety of the symbol before pressing F12, the definition is found and the cursor jumps there.
The code that’s doing this is in Packages\Default\symbol.py. In particular, note that the command GotoDefinition contains this:
if not symbol:
pt = v.sel()[0]
symbol, locations = symbol_at_point(v, pt)
else:
locations = lookup_symbol(self.window, symbol)
That is, if you haven’t provided a symbol explicitly it tries to find it based on the cursor position, otherwise it assumes you’ve given it a valid one and just finds places where it exists. Further investigation inside of symbol_at_point shows this:
symbol = view.substr(view.expand_by_class(pt, sublime.CLASS_WORD_START | sublime.CLASS_WORD_END, "[]{}()<>:."))
That is, it is expanding the selection to word boundaries on either end along with a hard coded set of word delimiters, one of which is the dreaded period character. Thus the expansion stops at the period and the symbol can’t be found.
If you modify that line to remove the period, then the F12 key works as expected.
I can’t say why selecting the text first doesn’t work for you though, because it seems like it should.
As seen here, it’s possible to modify the built in handling for this, which is decidedly a terrible idea. Probably a better idea would be to use that code as the basis for your own version of the command that’s custom tailored for your language. You could then create your own key binding with a context that makes it apply for your language to make it seamless.
Arguably it would be better if the default code did something like respect the current setting of word_separators or some other such setting, so that it could be overridden in syntax specific settings. However I’m not familiar enough with how all this stuff hangs together to know how good or bad of an idea that might be.
You can’t ask Sublime for a complete list of all symbols everywhere, but I assume that’s because the list would potentially be massive.
You can however look up all of the locations that a symbol exists for your project assuming you already know what the name of it is via the sublime.Window.lookup_symbol_in_index method.
Thank you for your replies! I will take a closer look tomorrow, but it definitely looks like I can get this functionality working!
(turns out, that if i try F12 on a name-selected function like “function.name1[]” it works, but not “.namespace.function[]” - will have to get to the bottom of that too.)
