Matching of identifiers between tmLanguage and tmTheme files

Question

I'm trying to understand how Visual Studio Code matches identifiers between theme and language files. For instance in one tmLanguage file I have a definition like this:

...
            <dict>
                <key>begin</key>
                <string>'</string>
                <key>beginCaptures</key>
                <dict>
                    <key>0</key>
                    <dict>
                        <key>name</key>
                        <string>punctuation.definition.string.begin.java-or-c</string>
                    </dict>
                </dict>
...

The dict contains the identifier punctuation.definition.string.begin.java-or-c to identify the start of the single quote string. Now looking in one of the tmThemes files I have, this identifier is never mentioned and in fact I can imagine that language file writers are free to use any identifier they want. But how can a theme be matched against them so that VS Code knows which color to apply? Is there somewhere a documentation describing the process?

score 2 · Answer 1 · edited May 23 '17 at 12:00

2

There are some conventions (scroll around the used identifiers so that themes can be used for multiple languages.
So basically you are right, the one writing the language file is in theory completely free using any identifier he likes but then there is probably also needed an accompanying theme file.

You may also want to check the following answer:
Are there any standards for tmlanguage keyword types?

edited May 23 '17 at 12:00

Community

1
1

answered Aug 14 '16 at 12:48

DAXaholic

33,312
6
76
74

⇬ as this got me started, even though it doesn't really answer the question. – Mike Lischke Aug 14 '16 at 14:42

score 0 · Accepted Answer · answered Aug 14 '16 at 14:51

Visual Studio Code obviously uses the styling approach from TextMate, hence much of what applies in TextMate (e.g. theme and language customization) is valid in VS Code as well. Matching is done similar like for CSS selectors, as this described in the Scope Selectors documentation. In short: theme files contain color values for certain scopes (e.g. those mentioned by DAXaholic). These are matched partially or fully against the scopes specified in the language file, e.g. a scope "string" matches all "string.quoted" scopes etc.

Further reading, especially which scopes one should support in language + theme files, can be done on the page: Writing a TextMate Grammar: Some Lessons Learned, which also mentions a list of standard scopes.

Matching of identifiers between tmLanguage and tmTheme files

2 Answers2