nvim-treesitter/queries/firrtl/highlights.scm
Christian Clason 1ae9b0e455 feat!: align standard captures with upstream
Problem: Sharing highlight queries with upstream tree-sitter and
Helix is difficult.

Solution: Where reasonable, use capture names in tree-sitter's standard
list or Helix's Atom-style hierarchy.

Specifically:

* tree-sitter "standard capture names"
  (3f44b89685/highlight/src/lib.rs (L20-L72)):

  - `@parameter` -> `@variable.parameter`
  - `@field` -> `@variable.member`
  - `@namespace` -> `@module`
  - `@float` -> `@number.float`
  - `@symbol` -> `@string.special.symbol`
  - `@string.regex` -> `@string.regexp`
  - `@text.*` -> `@markup.*` (`strong`, `italic`, `link`, `strikethrough`; with exceptions; see below)
  - `@text.title` -> `@markup.heading`
  - `@text.literal` -> `@markup.raw`
  - `@text.reference` -> `@markup.link`
  - `@text.uri` -> `@markup.link.url` (in markup links)
  - `@string.special` -> `@markup.link.label` (non-url links)
  - `@punctuation.special` -> `@markup.list` (markdown lists only; move subitems from `@text.todo`)

* Helix captures
  (https://docs.helix-editor.com/master/themes.html#syntax-highlighting):

  - `@method` -> `@function.method`
  - `@method.call` -> `@function.method.call`
  - `@text.{todo,warning,note,danger}` -> `@comment.{error,warning,hint,info,todo}`
  - `@text.diff.{add,delete,}` -> `@diff.{plus,minus,delta}`
  - `@text.uri` -> `@string.special.url` (outside markup)
  - `@preproc` -> `@keyword.directive`
  - `@define` -> `@keyword.directive`(`.define`?)
  - `@storageclass` -> `@keyword.storage`
  - `@conditional` -> `@keyword.conditional`
  - `@debug` -> `@keyword.debug`
  - `@exception` -> `@keyword.exception`
  - `@include` -> `@keyword.import`
  - `@repeat` -> `@keyword.repeat`

* cleanup

  - remove some redundant `@conceal` (but still allow it for conceal-only patterns)
  - remove obsolete `@error` (syntax linting is out of scope for this repo)
  - sort, cleanup capture list in `CONTRIBUTING.md`
2024-01-19 16:58:37 +01:00

186 lines
2.1 KiB
Scheme

; Namespaces
(circuit (identifier) @module)
(module (identifier) @module)
; Types
((identifier) @type
(#lua-match? @type "^[A-Z][A-Za-z0-9_$]*$"))
; Keywords
[
"circuit"
"module"
"extmodule"
"flip"
"parameter"
"reset"
"wire"
"cmem"
"smem"
"mem"
"reg"
"with"
"mport"
"inst"
"of"
"node"
"is"
"invalid"
"skip"
"infer"
"read"
"write"
"rdwr"
"defname"
] @keyword
; Qualifiers
(qualifier) @type.qualifier
; Storageclasses
[
"input"
"output"
] @keyword.storage
; Conditionals
[
"when"
"else"
] @keyword.conditional
; Annotations
(info) @attribute
; Builtins
[
"stop"
"printf"
"assert"
"assume"
"cover"
"attach"
"mux"
"validif"
] @function.builtin
[
"UInt"
"SInt"
"Analog"
"Fixed"
"Clock"
"AsyncReset"
"Reset"
] @type.builtin
; Fields
[
"data-type"
"depth"
"read-latency"
"write-latency"
"read-under-write"
"reader"
"writer"
"readwriter"
] @variable.member.builtin
((field_id) @variable.member
(#set! "priority" 105))
(port (identifier) @variable.member)
(wire (identifier) @variable.member)
(cmem (identifier) @variable.member)
(smem (identifier) @variable.member)
(memory (identifier) @variable.member)
(register (identifier) @variable.member)
; Parameters
(primitive_operation (identifier) @variable.parameter)
(mux (identifier) @variable.parameter)
(printf (identifier) @variable.parameter)
(reset (identifier) @variable.parameter)
(stop (identifier) @variable.parameter)
; Variables
(identifier) @variable
; Operators
(primop) @keyword.operator
[
"+"
"-"
"="
"=>"
"<="
"<-"
] @operator
; Literals
[
(uint)
(number)
] @number
(number_str) @string.special
(double) @number.float
(string) @string
(escape_sequence) @string.escape
[
"old"
"new"
"undefined"
] @constant.builtin
; Punctuation
[ "{" "}" ] @punctuation.bracket
[ "[" "]" ] @punctuation.bracket
[ "<" ">" ] @punctuation.bracket
[ "(" ")" ] @punctuation.bracket
[
","
"."
":"
] @punctuation.delimiter
; Comments
(comment) @comment @spell
["=>" "<=" "="] @operator