Skip to content

Commit

Permalink
feat(cairo): update tree-sitter grammar and queries
Browse files Browse the repository at this point in the history
  • Loading branch information
0xLucqs committed Jun 10, 2024
1 parent aa1630a commit ee06943
Show file tree
Hide file tree
Showing 6 changed files with 589 additions and 6 deletions.
5 changes: 4 additions & 1 deletion languages.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2074,9 +2074,12 @@ file-types = ["cairo"]
comment-token = "//"
indent = { tab-width = 4, unit = " " }
# auto-format = true
grammar = "rust"
language-servers = [ "cairo-language-server" ]

[[grammar]]
name = "cairo"
source = { git = "https://github.com/starkware-libs/tree-sitter-cairo", rev = "a7bf9d9a71e8f3765ebfbcbdfb6301db0277b3f3" }

[[language]]
name = "cpon"
scope = "scope.cpon"
Expand Down
369 changes: 368 additions & 1 deletion runtime/queries/cairo/highlights.scm
Original file line number Diff line number Diff line change
@@ -1 +1,368 @@
; inherits: rust
; -------
; Tree-Sitter doesn't allow overrides in regards to captures,
; though it is possible to affect the child node of a captured
; node. Thus, the approach here is to flip the order so that
; overrides are unnecessary.
; -------

; -------
; Types
; -------

(type_parameters
(type_identifier) @type.parameter)
(constrained_type_parameter
left: (type_identifier) @type.parameter)

; ---
; Primitives
; ---

(primitive_type) @type.builtin
(boolean_literal) @constant.builtin.boolean
(numeric_literal) @constant.numeric.integer
[
(string_literal)
(shortstring_literal)
] @string
[
(line_comment)
] @comment

; ---
; Extraneous
; ---

(enum_variant (identifier) @type.enum.variant)

(field_initializer
(field_identifier) @variable.other.member)
(shorthand_field_initializer
(identifier) @variable.other.member)
(shorthand_field_identifier) @variable.other.member


; ---
; Punctuation
; ---

[
"::"
"."
";"
","
] @punctuation.delimiter

[
"("
")"
"["
"]"
"{"
"}"
] @punctuation.bracket
(type_arguments
[
"<"
">"
] @punctuation.bracket)
(type_parameters
[
"<"
">"
] @punctuation.bracket)

; ---
; Variables
; ---

(let_declaration
pattern: [
((identifier) @variable)
((tuple_pattern
(identifier) @variable))
])

; It needs to be anonymous to not conflict with `call_expression` further below.
(_
value: (field_expression
value: (identifier)? @variable
field: (field_identifier) @variable.other.member))

(parameter
pattern: (identifier) @variable.parameter)

; -------
; Keywords
; -------

((identifier) @keyword.control
(#match? @keyword.control "^yield$"))


[
"match"
"if"
"else"
] @keyword.control.conditional

[
"while"
"loop"
] @keyword.control.repeat

[
"break"
"continue"
"return"
] @keyword.control.return

"use" @keyword.control.import
(mod_item "mod" @keyword.control.import !body)
(use_as_clause "as" @keyword.control.import)


[
(crate)
(super)
"as"
"pub"
"mod"
(extern)
(nopanic)

"impl"
"trait"
"of"

"default"
] @keyword

[
"struct"
"enum"
"type"
] @keyword.storage.type

"let" @keyword.storage
"fn" @keyword.function

(mutable_specifier) @keyword.storage.modifier.mut
(ref_specifier) @keyword.storage.modifier.ref

(snapshot_type "@" @keyword.storage.modifier.ref)

[
"const"
"ref"
] @keyword.storage.modifier

; TODO: variable.mut to highlight mutable identifiers via locals.scm

; -------
; Constructors
; -------
; TODO: this is largely guesswork, remove it once we get actual info from locals.scm or r-a

(struct_expression
name: (type_identifier) @constructor)

(tuple_enum_pattern
type: [
(identifier) @constructor
(scoped_identifier
name: (identifier) @constructor)
])
(struct_pattern
type: [
((type_identifier) @constructor)
(scoped_type_identifier
name: (type_identifier) @constructor)
])
(match_pattern
((identifier) @constructor) (#match? @constructor "^[A-Z]"))
(or_pattern
((identifier) @constructor)
((identifier) @constructor)
(#match? @constructor "^[A-Z]"))

; -------
; Guess Other Types
; -------

((identifier) @constant
(#match? @constant "^[A-Z][A-Z\\d_]*$"))

; ---
; PascalCase identifiers in call_expressions (e.g. `Ok()`)
; are assumed to be enum constructors.
; ---

(call_expression
function: [
((identifier) @constructor
(#match? @constructor "^[A-Z]"))
(scoped_identifier
name: ((identifier) @constructor
(#match? @constructor "^[A-Z]")))
])

; ---
; PascalCase identifiers under a path which is also PascalCase
; are assumed to be constructors if they have methods or fields.
; ---

(field_expression
value: (scoped_identifier
path: [
(identifier) @type
(scoped_identifier
name: (identifier) @type)
]
name: (identifier) @constructor
(#match? @type "^[A-Z]")
(#match? @constructor "^[A-Z]")))

; ---
; Other PascalCase identifiers are assumed to be structs.
; ---

((identifier) @type
(#match? @type "^[A-Z]"))

; -------
; Functions
; -------

(call_expression
function: [
((identifier) @function)
(scoped_identifier
name: (identifier) @function)
(field_expression
field: (field_identifier) @function)
])
(generic_function
function: [
((identifier) @function)
(scoped_identifier
name: (identifier) @function)
(field_expression
field: (field_identifier) @function.method)
])
(function_item
(function
name: (identifier) @function))

(function_signature_item
(function
name: (identifier) @function))

(external_function_item
(function
name: (identifier) @function))

; ---
; Macros
; ---

(attribute
(identifier) @special
arguments: (token_tree (identifier) @type)
(#eq? @special "derive")
)

(attribute
(identifier) @function.macro)
(attribute
[
(identifier) @function.macro
(scoped_identifier
name: (identifier) @function.macro)
]
(token_tree (identifier) @function.macro)?)

(inner_attribute_item) @attribute

(macro_invocation
macro: [
((identifier) @function.macro)
(scoped_identifier
name: (identifier) @function.macro)
]
"!" @function.macro)


; -------
; Operators
; -------

[
"*"
"->"
"=>"
"<="
"="
"=="
"!"
"!="
"%"
"%="
"@"
"&&"
"|"
"|="
"||"
"^"
"*"
"*="
"-"
"-="
"+"
"+="
"/"
"/="
">"
"<"
">="
">>"
"<<"
] @operator

; -------
; Paths
; -------

(use_declaration
argument: (identifier) @namespace)
(use_wildcard
(identifier) @namespace)
(mod_item
name: (identifier) @namespace)
(scoped_use_list
path: (identifier)? @namespace)
(use_list
(identifier) @namespace)
(use_as_clause
path: (identifier)? @namespace
alias: (identifier) @namespace)

; ---
; Remaining Paths
; ---

(scoped_identifier
path: (identifier)? @namespace
name: (identifier) @namespace)
(scoped_type_identifier
path: (identifier) @namespace)

; -------
; Remaining Identifiers
; -------

"?" @special

(type_identifier) @type
(identifier) @variable
(field_identifier) @variable.other.member
Loading

0 comments on commit ee06943

Please sign in to comment.