From 921027fb32018546fa459ffaf4afa4960f56d1b6 Mon Sep 17 00:00:00 2001
From: Erasin <erasinoo@gmail.com>
Date: Wed, 10 Aug 2022 20:29:43 +0800
Subject: [PATCH] Update tree-sitter-latex and highlights (#3370)

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
---
 book/src/generated/lang-support.md    |   2 +-
 languages.toml                        |   2 +-
 runtime/queries/latex/highlights.scm  | 615 +++++++++-----------------
 runtime/queries/latex/textobjects.scm |  13 +
 4 files changed, 235 insertions(+), 397 deletions(-)
 create mode 100644 runtime/queries/latex/textobjects.scm

diff --git a/book/src/generated/lang-support.md b/book/src/generated/lang-support.md
index 432efb785..941b7a7af 100644
--- a/book/src/generated/lang-support.md
+++ b/book/src/generated/lang-support.md
@@ -54,7 +54,7 @@
 | jsx | ✓ | ✓ | ✓ | `typescript-language-server` |
 | julia | ✓ |  |  | `julia` |
 | kotlin | ✓ |  |  | `kotlin-language-server` |
-| latex | ✓ |  |  | `texlab` |
+| latex | ✓ | ✓ |  | `texlab` |
 | lean | ✓ |  |  | `lean` |
 | ledger | ✓ |  |  |  |
 | llvm | ✓ | ✓ | ✓ |  |
diff --git a/languages.toml b/languages.toml
index c1f197aad..5f29fea5c 100644
--- a/languages.toml
+++ b/languages.toml
@@ -537,7 +537,7 @@ indent = { tab-width = 4, unit = "\t" }
 
 [[grammar]]
 name = "latex"
-source = { git = "https://github.com/latex-lsp/tree-sitter-latex", rev = "7f720661de5316c0f8fee956526d4002fa1086d8" }
+source = { git = "https://github.com/latex-lsp/tree-sitter-latex", rev = "b3b2cf27f33e71438ebe46934900b1153901c6f2" }
 
 [[language]]
 name = "lean"
diff --git a/runtime/queries/latex/highlights.scm b/runtime/queries/latex/highlights.scm
index 0a030b31f..e39226a27 100644
--- a/runtime/queries/latex/highlights.scm
+++ b/runtime/queries/latex/highlights.scm
@@ -1,410 +1,235 @@
-;; Math
-[
- (displayed_equation)
- (inline_formula)
-] @text.math
+;; General syntax
+(ERROR) @error
 
-;; This highlights the whole environment like vimtex does
-((environment
-  (begin
-   name: (word) @_env)) @text.math
-   (#any-of? @_env
-      "displaymath" "displaymath*"
-      "equation" "equation*"
-      "multline" "multline*"
-      "eqnarray" "eqnarray*"
-      "align" "align*"
-      "array" "array*"
-      "split" "split*"
-      "alignat" "alignat*"
-      "gather" "gather*"
-      "flalign" "flalign*"))
+(command_name) @function
+(caption
+  command: _ @function)
+
+(key_value_pair
+  key: (_) @variable.parameter
+  value: (_))
 
 [
-  (generic_command_name)
-  "\\newcommand"
-  "\\renewcommand"
-  "\\DeclareRobustCommand"
-  "\\DeclareMathOperator"
-  "\\newglossaryentry"
-  "\\caption"
-  "\\label"
-  "\\newlabel"
-  "\\color"
-  "\\colorbox"
-  "\\textcolor"
-  "\\pagecolor"
-  "\\definecolor"
-  "\\definecolorset"
-  "\\newtheorem"
-  "\\declaretheorem"
-  "\\newacronym"
-] @function.macro
+  (comment)
+  (line_comment)
+  (block_comment)
+  (comment_environment)
+] @comment
 
 [
-    "\\ref"
-    "\\vref"
-    "\\Vref"
-    "\\autoref"
-    "\\pageref"
-    "\\cref"
-    "\\Cref"
-    "\\cref*"
-    "\\Cref*"
-    "\\namecref"
-    "\\nameCref"
-    "\\lcnamecref"
-    "\\namecrefs"
-    "\\nameCrefs"
-    "\\lcnamecrefs"
-    "\\labelcref"
-    "\\labelcpageref"
-    "\\crefrange"
-    "\\crefrange"
-    "\\Crefrange"
-    "\\Crefrange"
-    "\\crefrange*"
-    "\\crefrange*"
-    "\\Crefrange*"
-    "\\Crefrange*"
-] @function.macro
+  (brack_group)
+  (brack_group_argc)
+] @variable.parameter
 
-[
-    "\\cite"
-    "\\cite*"
-    "\\Cite"
-    "\\nocite"
-    "\\citet"
-    "\\citep"
-    "\\citet*"
-    "\\citep*"
-    "\\citeauthor"
-    "\\citeauthor*"
-    "\\Citeauthor"
-    "\\Citeauthor*"
-    "\\citetitle"
-    "\\citetitle*"
-    "\\citeyear"
-    "\\citeyear*"
-    "\\citedate"
-    "\\citedate*"
-    "\\citeurl"
-    "\\fullcite"
-    "\\citeyearpar"
-    "\\citealt"
-    "\\citealp"
-    "\\citetext"
-    "\\parencite"
-    "\\parencite*"
-    "\\Parencite"
-    "\\footcite"
-    "\\footfullcite"
-    "\\footcitetext"
-    "\\textcite"
-    "\\Textcite"
-    "\\smartcite"
-    "\\Smartcite"
-    "\\supercite"
-    "\\autocite"
-    "\\Autocite"
-    "\\autocite*"
-    "\\Autocite*"
-    "\\volcite"
-    "\\Volcite"
-    "\\pvolcite"
-    "\\Pvolcite"
-    "\\fvolcite"
-    "\\ftvolcite"
-    "\\svolcite"
-    "\\Svolcite"
-    "\\tvolcite"
-    "\\Tvolcite"
-    "\\avolcite"
-    "\\Avolcite"
-    "\\notecite"
-    "\\notecite"
-    "\\pnotecite"
-    "\\Pnotecite"
-    "\\fnotecite"
-] @function.macro
-
-[
-    "\\ref"
-    "\\vref"
-    "\\Vref"
-    "\\autoref"
-    "\\pageref"
-    "\\cref"
-    "\\Cref"
-    "\\cref*"
-    "\\Cref*"
-    "\\namecref"
-    "\\nameCref"
-    "\\lcnamecref"
-    "\\namecrefs"
-    "\\nameCrefs"
-    "\\lcnamecrefs"
-    "\\labelcref"
-    "\\labelcpageref"
-] @function.macro
-
-
-[
-    "\\crefrange"
-    "\\crefrange"
-    "\\Crefrange"
-    "\\Crefrange"
-    "\\crefrange*"
-    "\\crefrange*"
-    "\\Crefrange*"
-    "\\Crefrange*"
-] @function.macro
-
-
-[
-  "\\gls"
-  "\\Gls"
-  "\\GLS"
-  "\\glspl"
-  "\\Glspl"
-  "\\GLSpl"
-  "\\glsdisp"
-  "\\glslink"
-  "\\glstext"
-  "\\Glstext"
-  "\\GLStext"
-  "\\glsfirst"
-  "\\Glsfirst"
-  "\\GLSfirst"
-  "\\glsplural"
-  "\\Glsplural"
-  "\\GLSplural"
-  "\\glsfirstplural"
-  "\\Glsfirstplural"
-  "\\GLSfirstplural"
-  "\\glsname"
-  "\\Glsname"
-  "\\GLSname"
-  "\\glssymbol"
-  "\\Glssymbol"
-  "\\glsdesc"
-  "\\Glsdesc"
-  "\\GLSdesc"
-  "\\glsuseri"
-  "\\Glsuseri"
-  "\\GLSuseri"
-  "\\glsuserii"
-  "\\Glsuserii"
-  "\\GLSuserii"
-  "\\glsuseriii"
-  "\\Glsuseriii"
-  "\\GLSuseriii"
-  "\\glsuseriv"
-  "\\Glsuseriv"
-  "\\GLSuseriv"
-  "\\glsuserv"
-  "\\Glsuserv"
-  "\\GLSuserv"
-  "\\glsuservi"
-  "\\Glsuservi"
-  "\\GLSuservi"
-] @function.macro
-
-
-[
-  "\\acrshort"
-  "\\Acrshort"
-  "\\ACRshort"
-  "\\acrshortpl"
-  "\\Acrshortpl"
-  "\\ACRshortpl"
-  "\\acrlong"
-  "\\Acrlong"
-  "\\ACRlong"
-  "\\acrlongpl"
-  "\\Acrlongpl"
-  "\\ACRlongpl"
-  "\\acrfull"
-  "\\Acrfull"
-  "\\ACRfull"
-  "\\acrfullpl"
-  "\\Acrfullpl"
-  "\\ACRfullpl"
-  "\\acs"
-  "\\Acs"
-  "\\acsp"
-  "\\Acsp"
-  "\\acl"
-  "\\Acl"
-  "\\aclp"
-  "\\Aclp"
-  "\\acf"
-  "\\Acf"
-  "\\acfp"
-  "\\Acfp"
-  "\\ac"
-  "\\Ac"
-  "\\acp"
-  "\\glsentrylong"
-  "\\Glsentrylong"
-  "\\glsentrylongpl"
-  "\\Glsentrylongpl"
-  "\\glsentryshort"
-  "\\Glsentryshort"
-  "\\glsentryshortpl"
-  "\\Glsentryshortpl"
-  "\\glsentryfullpl"
-  "\\Glsentryfullpl"
-] @function.macro
-
-(comment) @comment
-
-(bracket_group) @variable.parameter
-
-[(math_operator) "="] @operator
-
-[
-  "\\usepackage"
-  "\\documentclass"
-  "\\input"
-  "\\include"
-  "\\subfile"
-  "\\subfileinclude"
-  "\\subfileinclude"
-  "\\includegraphics"
-  "\\addbibresource"
-  "\\bibliography"
-  "\\includesvg"
-  "\\includeinkscape"
-  "\\usepgflibrary"
-  "\\usetikzlibrary"
-] @keyword.control.import
-
-[
-  "\\part"
-  "\\chapter"
-  "\\section"
-  "\\subsection"
-  "\\subsubsection"
-  "\\paragraph"
-  "\\subparagraph"
-] @type
+[(operator) "="] @operator
 
 "\\item" @punctuation.special
 
 ((word) @punctuation.delimiter
-(#eq? @punctuation.delimiter "&"))
+  (#eq? @punctuation.delimiter "&"))
 
-["$" "\\[" "\\]" "\\(" "\\)"] @punctuation.delimiter
-
-(label_definition
- name: (_) @text.reference)
-(label_reference
- label: (_) @text.reference)
-(equation_label_reference
- label: (_) @text.reference)
-(label_reference
- label: (_) @text.reference)
-(label_number
- label: (_) @text.reference)
-
-(citation
- key: (word) @text.reference)
-
-(key_val_pair
-  key: (_) @variable.parameter
-  value: (_))
-
-["[" "]" "{" "}"] @punctuation.bracket ;"(" ")" is has no special meaning in LaTeX
-
-(chapter
-  text: (brace_group) @markup.heading)
-
-(part
-  text: (brace_group) @markup.heading)
-
-(section
-  text: (brace_group) @markup.heading)
-
-(subsection
-  text: (brace_group) @markup.heading)
-
-(subsubsection
-  text: (brace_group) @markup.heading)
-
-(paragraph
-  text: (brace_group) @markup.heading)
-
-(subparagraph
-  text: (brace_group) @markup.heading)
-
-((environment
-  (begin
-   name: (word) @_frame)
-   (brace_group
-        child: (text) @markup.heading))
- (#eq? @_frame "frame"))
-
-((generic_command
-  name:(generic_command_name) @_name
-  arg: (brace_group
-          (text) @markup.heading))
- (#eq? @_name "\\frametitle"))
-
-;; Formatting
-
-((generic_command
-  name:(generic_command_name) @_name
-  arg: (_) @markup.italic)
- (#eq? @_name "\\emph"))
-
-((generic_command
-  name:(generic_command_name) @_name
-  arg: (_) @markup.italic)
- (#match? @_name "^(\\\\textit|\\\\mathit)$"))
-
-((generic_command
-  name:(generic_command_name) @_name
-  arg: (_) @markup.bold)
- (#match? @_name "^(\\\\textbf|\\\\mathbf)$"))
-
-((generic_command
-  name:(generic_command_name) @_name
-  .
-  arg: (_) @markup.link.url)
- (#match? @_name "^(\\\\url|\\\\href)$"))
-
-(ERROR) @error
-
-[
-  "\\begin"
-  "\\end"
-] @text.environment
+["[" "]" "{" "}"] @punctuation.bracket ; "(" ")" has no syntactical meaning in LaTeX
 
+;; General environments
 (begin
- name: (_) @text.environment.name
-  (#not-any-of? @text.environment.name
-      "displaymath" "displaymath*"
-      "equation" "equation*"
-      "multline" "multline*"
-      "eqnarray" "eqnarray*"
-      "align" "align*"
-      "array" "array*"
-      "split" "split*"
-      "alignat" "alignat*"
-      "gather" "gather*"
-      "flalign" "flalign*"))
+  command: _ @function.builtin
+  name: (curly_group_text (text) @function.macro))
 
 (end
- name: (_) @text.environment.name
-  (#not-any-of? @text.environment.name
-      "displaymath" "displaymath*"
-      "equation" "equation*"
-      "multline" "multline*"
-      "eqnarray" "eqnarray*"
-      "align" "align*"
-      "array" "array*"
-      "split" "split*"
-      "alignat" "alignat*"
-      "gather" "gather*"
-      "flalign" "flalign*"))
+  command: _ @function.builtin
+  name: (curly_group_text (text) @function.macro))
+
+;; Definitions and references
+(new_command_definition
+  command: _ @function.macro
+  declaration: (curly_group_command_name (_) @function))
+(old_command_definition
+  command: _ @function.macro
+  declaration: (_) @function)
+(let_command_definition
+  command: _ @function.macro
+  declaration: (_) @function)
+
+(environment_definition
+  command: _ @function.macro
+  name: (curly_group_text (_) @constant))
+
+(theorem_definition
+  command: _ @function.macro
+  name: (curly_group_text (_) @constant))
+
+(paired_delimiter_definition
+  command: _ @function.macro
+  declaration: (curly_group_command_name (_) @function))
+
+(label_definition
+  command: _ @function.macro
+  name: (curly_group_text (_) @label))
+(label_reference_range
+  command: _ @function.macro
+  from: (curly_group_text (_) @label)
+  to: (curly_group_text (_) @label))
+(label_reference
+  command: _ @function.macro
+  names: (curly_group_text_list (_) @label))
+(label_number
+  command: _ @function.macro
+  name: (curly_group_text (_) @label)
+  number: (_) @markup.link.label)
+
+(citation
+  command: _ @function.macro
+  keys: (curly_group_text_list) @string)
+
+(glossary_entry_definition
+  command: _ @function.macro
+  name: (curly_group_text (_) @string))
+(glossary_entry_reference
+  command: _ @function.macro
+  name: (curly_group_text (_) @string))
+
+(acronym_definition
+  command: _ @function.macro
+  name: (curly_group_text (_) @string))
+(acronym_reference
+  command: _ @function.macro
+  name: (curly_group_text (_) @string))
+
+(color_definition
+  command: _ @function.macro
+  name: (curly_group_text (_) @string))
+(color_reference
+  command: _ @function.macro
+  name: (curly_group_text (_) @string))
+
+;; Math
+
+(displayed_equation) @markup.raw.block
+(inline_formula) @markup.raw.inline
+
+(math_environment
+  (begin
+    command: _ @function.builtin
+    name: (curly_group_text (text) @markup.raw)))
+
+(math_environment
+  (text) @markup.raw)
+
+(math_environment
+  (end
+    command: _ @function.builtin
+    name: (curly_group_text (text) @markup.raw)))
+
+;; Sectioning
+(title_declaration
+  command: _ @namespace
+  options: (brack_group (_) @markup.heading)?
+  text: (curly_group (_) @markup.heading))
+
+(author_declaration
+  command: _ @namespace
+  authors: (curly_group_author_list
+             ((author)+ @markup.heading)))
+
+(chapter
+  command: _ @namespace
+  toc: (brack_group (_) @markup.heading)?
+  text: (curly_group (_) @markup.heading))
+
+(part
+  command: _ @namespace
+  toc: (brack_group (_) @markup.heading)?
+  text: (curly_group (_) @markup.heading))
+
+(section
+  command: _ @namespace
+  toc: (brack_group (_) @markup.heading)?
+  text: (curly_group (_) @markup.heading))
+
+(subsection
+  command: _ @namespace
+  toc: (brack_group (_) @markup.heading)?
+  text: (curly_group (_) @markup.heading))
+
+(subsubsection
+  command: _ @namespace
+  toc: (brack_group (_) @markup.heading)?
+  text: (curly_group (_) @markup.heading))
+
+(paragraph
+  command: _ @namespace
+  toc: (brack_group (_) @markup.heading)?
+  text: (curly_group (_) @markup.heading))
+
+(subparagraph
+  command: _ @namespace
+  toc: (brack_group (_) @markup.heading)?
+  text: (curly_group (_) @markup.heading))
+
+;; Beamer frames
+(generic_environment
+  (begin
+    name: (curly_group_text
+            (text) @markup.heading)
+    (#any-of? @markup.heading "frame"))
+  .
+  (curly_group (_) @markup.heading))
+
+((generic_command
+  command: (command_name) @_name
+  arg: (curly_group
+          (text) @markup.heading))
+  (#eq? @_name "\\frametitle"))
+
+;; Formatting
+((generic_command
+  command: (command_name) @_name
+  arg: (curly_group (_) @markup.italic))
+  (#eq? @_name "\\emph"))
+
+((generic_command
+  command: (command_name) @_name
+  arg: (curly_group (_) @markup.italic))
+  (#match? @_name "^(\\\\textit|\\\\mathit)$"))
+
+((generic_command
+  command: (command_name) @_name
+  arg: (curly_group (_) @markup.bold))
+  (#match? @_name "^(\\\\textbf|\\\\mathbf)$"))
+
+((generic_command
+  command: (command_name) @_name
+  .
+  arg: (curly_group (_) @markup.link.uri))
+  (#match? @_name "^(\\\\url|\\\\href)$"))
+
+;; File inclusion commands
+(class_include
+  command: _ @keyword.storage.type
+  path: (curly_group_path) @string)
+
+(package_include
+  command: _ @keyword.storage.type
+  paths: (curly_group_path_list) @string)
+
+(latex_include
+  command: _ @keyword.control.import
+  path: (curly_group_path) @string)
+(import_include
+  command: _ @keyword.control.import
+  directory: (curly_group_path) @string
+  file: (curly_group_path) @string)
+
+(bibtex_include
+  command: _ @keyword.control.import
+  path: (curly_group_path) @string)
+(biblatex_include
+  "\\addbibresource" @include
+  glob: (curly_group_glob_pattern) @string.regex)
+
+(graphics_include
+  command: _ @keyword.control.import
+  path: (curly_group_path) @string)
+(tikz_library_import
+  command: _ @keyword.control.import
+  paths: (curly_group_path_list) @string)
diff --git a/runtime/queries/latex/textobjects.scm b/runtime/queries/latex/textobjects.scm
new file mode 100644
index 000000000..40bb35268
--- /dev/null
+++ b/runtime/queries/latex/textobjects.scm
@@ -0,0 +1,13 @@
+[
+  (generic_command)
+] @function.around
+
+[
+  (chapter)
+  (part)
+  (section)
+  (subsection)
+  (subsubsection)
+  (paragraph)
+  (subparagraph)
+] @class.around