feat(glossaries): user glossary commands (#1475)

Allows user-defined glossary reference commands, as a server config.
This is stored under the 'experimental.glossaryReferenceCommands' key in
the server configuration (from the texlab crate, file server/options.rs)

Changed crates/files:
    texlab/src/server/options.rs: new 'glossary_reference_commands' key
        as a vector in the ExperimentalOptions struct ;
    texlab/src/util/from_proto.rs: extend the SyntaxConfig of the server
        configuration using the new 'glossary_reference_commands' key ;
    parser/src/config.rs: new 'glossary_reference_commands' key in the
        SyntaxConfig structure + the glossary reference commands from
	the latex/lexer/commands.rs file in the same crate have been
	moved to a static array here ;
    parser/src/latex/lexer/commands.rs: the classify() command now looks
        in the new 'config.glossary_reference_commands' for glossary
	references ;

Author: Thibaulltt

crates/completion/src/tests.rs

@@ -2341,3 +2341,31 @@ fn test_custom_label_multiple_prefix_ref() {
         "#]],
     );
 }
+
+#[test]
+fn test_custom_glossary_reference_command() {
+    let mut config = SyntaxConfig::default();
+    config.glossary_reference_commands.insert("glsed".to_string());
+
+    check_with_syntax_config(
+        config,
+        r#"
+%! main.tex
+\newglossaryentry{foo}{
+  name={Foo Bar Baz},
+  description={The trio of default variable names.}
+}
+
+\glsed{}
+       |"#,
+        expect![[r#"
+            [
+                GlossaryEntry(
+                    GlossaryEntryData {
+                        name: "foo",
+                    },
+                ),
+            ]
+        "#]],
+    );
+}

crates/parser/src/config.rs

@@ -8,6 +8,7 @@ pub struct SyntaxConfig {
     pub enum_environments: FxHashSet<String>,
     pub verbatim_environments: FxHashSet<String>,
     pub citation_commands: FxHashSet<String>,
+    pub glossary_reference_commands: FxHashSet<String>,
     pub label_definition_commands: FxHashSet<String>,
     pub label_definition_prefixes: Vec<(String, String)>,
     pub label_reference_commands: FxHashSet<String>,
@@ -37,6 +38,11 @@ impl Default for SyntaxConfig {
             .map(ToString::to_string)
             .collect();
 
+        let glossary_reference_commands = DEFAULT_GLOSSARY_REFERENCE_COMMANDS
+            .iter()
+            .map(ToString::to_string)
+            .collect();
+
         let label_definition_commands = DEFAULT_LABEL_DEFINITION_COMMANDS
             .iter()
             .map(ToString::to_string)
@@ -69,6 +75,7 @@ impl Default for SyntaxConfig {
             enum_environments,
             verbatim_environments,
             citation_commands,
+            glossary_reference_commands,
             label_definition_commands,
             label_definition_prefixes,
             label_reference_commands,
@@ -193,6 +200,52 @@ static DEFAULT_CITATION_COMMANDS: &[&str] = &[
     "citeA*",
 ];
 
+static DEFAULT_GLOSSARY_REFERENCE_COMMANDS: &[&str] = &[
+    "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",
+    "glsuseriii",
+    "glsuseriv",
+    "Glsuseriv",
+    "GLSuseriv",
+    "glsuserv",
+    "Glsuserv",
+    "GLSuserv",
+    "glsuservi",
+    "Glsuservi",
+    "GLSuservi"
+];
+
 static DEFAULT_LABEL_DEFINITION_COMMANDS: &[&str] = &["label", "zlabel"];
 
 static DEFAULT_LABEL_DEFINITION_PREFIXES: &[(&str, &str)] = &[];

crates/parser/src/latex/lexer/commands.rs

@@ -50,15 +50,6 @@ pub fn classify(name: &str, config: &SyntaxConfig) -> CommandName {
         | "DeclareCommandCopy" => CommandName::NewCommandDefinition,
         "DeclareMathOperator" | "DeclareMathOperator*" => CommandName::MathOperator,
         "newglossaryentry" => CommandName::GlossaryEntryDefinition,
-        "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"
-        | "glsuseriii" | "glsuseriv" | "Glsuseriv" | "GLSuseriv" | "glsuserv" | "Glsuserv"
-        | "GLSuserv" | "glsuservi" | "Glsuservi" | "GLSuservi" => {
-            CommandName::GlossaryEntryReference
-        }
         "newacronym" | "newacro" | "acrodef" | "acro" | "newacroindefinite"
         | "acrodefindefinite" | "acroindefinite" | "acroplural" | "newacroplural"
         | "acrodefplural" => CommandName::AcronymDefinition,
@@ -100,6 +91,7 @@ pub fn classify(name: &str, config: &SyntaxConfig) -> CommandName {
         "numberline" => CommandName::TocNumberLine,
 
         _ if config.citation_commands.contains(name) => CommandName::Citation,
+        _ if config.glossary_reference_commands.contains(name) => CommandName::GlossaryEntryReference,
         _ if config.label_definition_commands.contains(name) => CommandName::LabelDefinition,
         _ if config.label_reference_commands.contains(name) => CommandName::LabelReference,
         _ if config.label_reference_range_commands.contains(name) => {

crates/texlab/src/server/options.rs

@@ -156,6 +156,7 @@ pub struct ExperimentalOptions {
     pub enum_environments: Vec<String>,
     pub verbatim_environments: Vec<String>,
     pub citation_commands: Vec<String>,
+    pub glossary_reference_commands: Vec<String>,
     pub label_definition_commands: Vec<String>,
     pub label_definition_prefixes: Vec<(String, String)>,
     pub label_reference_commands: Vec<String>,

crates/texlab/src/util/from_proto.rs

@@ -387,6 +387,11 @@ pub fn config(value: Options) -> Config {
         .citation_commands
         .extend(value.experimental.citation_commands);
 
+    config
+        .syntax
+        .glossary_reference_commands
+        .extend(value.experimental.glossary_reference_commands);
+
     config
         .syntax
         .label_definition_commands