[C Family] Full rewrite of C family syntaxes #4147
Conversation
|
My motivations are simple |
C++/C.sublime-syntax
Outdated
| - include: expressions | ||
| prototype: | ||
| - include: preprocessor.comment | ||
| - match: \\$ |
There was a problem hiding this comment.
heads up, you can test this in a test file for Sublime via:
// SYNTAX TEST "Packages/C/C.sublime-syntax" \
... \
// ^ punctuation.separator.continuation \
...
C++/syntax_test_c.c
Outdated
| @@ -1,1555 +1,185 @@ | |||
| /* SYNTAX TEST "Packages/C++/C.sublime-syntax" */ | |||
| // SYNTAX TEST "Packages/C++/C.sublime-syntax" | |||
There was a problem hiding this comment.
for line-continuation, change header to:
// SYNTAX TEST "Packages/C++/C.sublime-syntax" \
when testing:
... \
// ^ punctuation.separator.continuation \
...
duplicate the line-separator for continuation to the line with the expected scopes as well.
- Add digit separator `'` (C23) - Add scopes for __VA_ARGS__ and __VA_OPT__ - Give defined macro a `suport.macro.c` scope - Add #embed, #elifdef, and #elifndef directives - Add multi-line double-slashed comments via `\` - Fix some bugs
…ht for fn pointer types in a typedef.
|
Some general advices:
I'd recommend to organize contexts in a logical tree-like top-down structure, grouping related things like preprocessors, declarations, statements, expressions, keywords, identifiers, constants, operators, variables etc. together. Various syntaxes even use All of that will certainly help to keep track of structure as syntax definition grows. Keeping same context order and structure especially is important when extending a syntax, which will be the casse for C++. The more syntaxes in this repo follow a common schema the easier it is to maintain them. Premature ordering can be kill of creativity, so order is not that important for prototyping. Maybe however don't wait too long to add some structure. Please don't just add some code snippets to syntax test files, but also design assertions on the way going. It sometimes takes more time to write tests than syntax, they are however the only way to ensure not to break wanted/designed behavior by automated syntax tests. When writing rules for certain constructs you have in mind what you find important. Tests are just an expression of those thoughts or tools to verify your ideas/expectations against reality and vice versa. Tests can (or even should) also contain incomplete statements/expressions, to ensure code doesn't break too badly. At least it helps to ensure to limit breaking highlighting to small regions or makes you think about how to achieve it. Assertions should also contain some negative tests to ensure meta scope boundaries are maintained correctly or to avoid unwanted overlapping meta scopes. These are the less obvious issues, which may however impact various functionalities such as syntax based folding. |
|
FWIW, context order and structure of existing C syntaxes may not be ideal nor a good template to rely on. Better look at something more recent, such as Java, PHP or Python. |
|
I don't think those are the actual tests. 😉 I note the path to the syntax def in May I recommend similar to your PackageDev clone, you look at the suggestions in the ReadMe of this repo? Then you can modify the C syntax directly. If you want to keep the old one for comparison, you can rename it or move that one to
|
|
I can't tell if these have been fixed yet, but some issues I noticed for C++ files on the latest stable that don't seem to be mentioned above:
The names of namespaces being used don't have any specific scopes relating them to namespaces.
I would expect the |
| - match: \}|\] # Fallback | ||
| scope: invalid.illegal.stray-bracket-end.c | ||
| pop: 1 |
There was a problem hiding this comment.
This may easily cause owning contest to also break or not being terminated correctly due to brackets already being consumed here.
I'd recommend to use lookaheads and consume stray brackets only in top-level context.
|
To auto-close related issues upon merge of this PR, GitHub expects certain keywords: or in other words, you need to change the following in your opening comment (which will be the commit message of the merge commit): ## Issues fixed
- fixes #1070
- fixes #1093
... |
|
Edited OP to add GitHub's format. |
|
There's this old PR #1831, that hasn't been merged into |
|
Not sure how useful #1831 still is. It came with some interesting parts, but scoping variable definitions Disclaimer: It's a while (some years) I had a look at it, the last time. |
|
I just mentioned it cause it wasn't in Michael's "possibly related" list of issues/PRs. |
| captures: | ||
| 1: entity.name.type.typedef.c | ||
| pop: 1 | ||
| - match: ; # Fallback |
There was a problem hiding this comment.
Missing scope? Alternatively use a lookahead and let a parent context consume/scope it, if it is required to handle multiple context pops.
| property: | ||
| - match: \( | ||
| scope: punctuation.section.group.begin.objc | ||
| push: property.attrs |
There was a problem hiding this comment.
If @property ()()() is not a valid statement, I'd suggest to set property.attr.
| push: property.attrs | |
| set: property.attrs |
| push: property.attrs | ||
| - include: else-pop | ||
| property.attrs: | ||
| - match: \) |
There was a problem hiding this comment.
All groups should receive a corresponding meta scope.
| - match: \) | |
| - meta_scope: meta.group.objc | |
| - match: \) |
| - include: expression-identifiers | ||
| - include: punctuation.comma | ||
| - include: operator.pointer |
There was a problem hiding this comment.
Please, always start contexts with meta_scope followed by real patterns.
| - match: (?=\b(self)\s*(\.)) | ||
| push: self-access |
There was a problem hiding this comment.
Maybe just...
| - match: (?=\b(self)\s*(\.)) | |
| push: self-access | |
| - match: \bself\b | |
| scope: variable.language.objc | |
| push: self-access | |
| ... | |
| self-access: | |
| - match: \s*(\.)\s*({{identifier}}) | |
| captures: | |
| 1: keyword.operator.accessor.objc | |
| 2: variable.other.member.objc | |
| - include: pop-immediately | |
| block-fn: | ||
| - match: \( | ||
| scope: punctuation.section.group.begin.objc | ||
| push: function.params |
There was a problem hiding this comment.
Note this would also match void func()()() {}
| - match: . | ||
| scope: support.function.objc |
There was a problem hiding this comment.
A . pattern causes each character to become a single token, which is not ideal for various reasons and should be avoided if possible.
| scope: variable.language.objc | ||
| - match: \@(property|synthesize|dynamic)\b | ||
| scope: keyword.other.objc | ||
| - match: '(@available)\b(\()' |
There was a problem hiding this comment.
A \b in between is not required as \( is already a word boundary. Optionally supporting whitespace via \s* may be useful however.
| - match: '(@available)\b(\()' | |
| - match: '(@available)\s*(\()' |
| 1: keyword.operator.word.objc | ||
| 2: punctuation.section.group.begin.objc | ||
| push: selector-obj | ||
| - match: '@(selector|encode|available)' |
There was a problem hiding this comment.
Tiny optimization, but avoiding unused capture groups helps with performance a little bit.
| - match: '@(selector|encode|available)' | |
| - match: '@(?:selector|encode|available)' |
| scope: storage.type.objc | ||
| - match: \@(?:interface|class|implementation|protocol|end)\b | ||
| scope: keyword.declaration.objc | ||
| - match: '(?=\bNS\w+\b)' |
There was a problem hiding this comment.
Not quite sure, but the following might be enough
| - match: '(?=\bNS\w+\b)' | |
| - match: '(?=\bNS)' |
I am currently working on a full rewrite of the C family using modern Sublime Text syntax highlighting features. I plan to rewrite C, Objective-C, C++, and Objective-C++ in that order. Note that as of right now, only the C syntax has been edited and the syntax test file does not yet have any annotations.
This is currently a draft. Please feel free to let me know if I'm missing anything and I will add it to the roadmap.
C Roadmap
Changes made to C Highlighting
#if 0and#if 1 #elsecreating a commented out blockiandjto numerical suffixes (GNU extension)_Alignof,alignof, andoffsetof,_Static_assert,static_assert,_Pragmaas word operators__cplusplusis asupport.constantnullptr_t(C23) andmax_align_t(C11) to list of default types_Thread_local,thread_local,_Atomic,_Alignasand_Noreturnas storage modifiers__declspecproperties__attribute__properties'(C23)__VA_ARGS__and__VA_OPT__(C23)suport.macro.cscope#embed,#elifdef, and#elifndefdirectives (C23)\typedefsupport for function ptrstypedefnow share the same scoping as regular function defsIssues
constas an indexed entity.name.type #3504