ST6RI-521 Added semantic highlighting for prefix metadata.

seidewitz · seidewitz · commit 6231e9bbaa90 · 2022-04-09T00:16:12.000-04:00
diff --git a/org.omg.sysml.jupyter.kernel/src/main/resources/kernel/kernel.js b/org.omg.sysml.jupyter.kernel/src/main/resources/kernel/kernel.js
@@ -54,12 +54,12 @@ var enableMode = function (CodeMirror) {
                 "analysis", "and", "as", "assert", "assign", "assume", "at", "attribute", "bind", "binding", "by",
                 "calc", "case", "comment", "concern", "connect", "connection", "constraint", "decide", "def", "default",
                 "defined", "dependency", "derived", "do", "doc", "else", "end", "entry", "enum", "event", "exhibit",
-                "exit", "expose", "feature", "filter", "first", "flow", "for", "fork", "frame", "from", "hastype", "if",
-                "implies", "import", "in", "include", "individual", "inout", "interface", "istype", "item", "join",
-                "language", "loop", "merge", "message", "metadata", "nonunique", "not", "objective", "occurrence", "of",
-                "or", "ordered", "out", "package", "parallel", "part", "perform", "port", "private", "protected",
-                "public", "readonly", "redefines", "ref", "render", "rendering", "rep", "require", "requirement",
-                "return", "satisfy", "send", "snapshot", "specializes", "stakeholder", "state", "subject", "subsets",
+                "exit", "expose", "filter", "first", "flow", "for", "fork", "frame", "from", "hastype", "if", "implies",
+                "import", "in", "include", "individual", "inout", "interface", "istype", "item", "join", "language",
+                "loop", "merge", "message", "metadata", "nonunique", "not", "objective", "occurrence", "of", "or",
+                "ordered", "out", "package", "parallel", "part", "perform", "port", "private", "protected", "public",
+                "readonly", "redefines", "ref", "render", "rendering", "rep", "require", "requirement", "return",
+                "satisfy", "send", "snapshot", "specializes", "stakeholder", "state", "subject", "subsets",
                 "succession", "then", "timeslice", "to", "transition", "until", "use", "variant", "variation",
                 "verification", "verify", "via", "view", "viewpoint", "when", "while", "xor"
             ]),
@@ -75,21 +75,35 @@ var enableMode = function (CodeMirror) {
             modeProps: {fold: ["brace"]},
             hooks: {
                 "'": function (stream) {
-                    var escaped = false, next;
-                    while ((next = stream.next()) != null) {
-                        if (next == "'" && !escaped) {
-                            break;
-                        }
-                        escaped = !escaped && next == "\\";
+                    let b_escaped = false;
+                    let s_next;
+                    while(s_next = stream.next()) {
+                        if(s_next === "'" && !b_escaped) break;
+                        b_escaped = !b_escaped && s_next === '\\';
                     }
-                    return "variable";
+                    return 'variable';
                 },
                 "/": function (stream) {
                     if (stream.match("/*", false)) {
                         stream.next();
                     }
                     return false;
                 }
+                "#": function(stream) {
+                 	do {
+                 		if (stream.match("'", true)) { 
+                    		let b_escaped = false;
+                    		let s_next;
+                    		while(s_next = stream.next()) {
+                        		if(s_next === "'" && !b_escaped) break;
+                        		b_escaped = !b_escaped && s_next === '\\';
+                    		}
+                		} else {
+                			stream.eatWhile(/\w/);
+                		}
+                	} while (stream.match('::', true))
+                    return 'keyword';
+                },
             }
         });
     });
diff --git a/org.omg.sysml.xtext.ide/xtend-gen/org/omg/sysml/xtext/ide/.gitignore b/org.omg.sysml.xtext.ide/xtend-gen/org/omg/sysml/xtext/ide/.gitignore
@@ -4,3 +4,4 @@
 /.SysMLIdeSetup.xtendbin
 /SysMLIdeModule.java
 /SysMLIdeSetup.java
+/.SysMLUserKeywordHighlightingCalculator.java._trace
diff --git a/org.omg.sysml.xtext.ui/src/org/omg/sysml/xtext/ui/SysMLUiModule.xtend b/org.omg.sysml.xtext.ui/src/org/omg/sysml/xtext/ui/SysMLUiModule.xtend
@@ -7,6 +7,7 @@ import org.eclipse.xtend.lib.annotations.FinalFieldsConstructor
 import org.eclipse.xtext.ui.shared.Access
 import org.eclipse.xtext.ui.editor.quickfix.IssueResolutionProvider
 import org.omg.sysml.xtext.ui.quickfix.SysMLQuickfixProvider
+import org.eclipse.xtext.ide.editor.syntaxcoloring.ISemanticHighlightingCalculator
 
 /**
  * Use this class to register components to be used within the Eclipse IDE.
@@ -15,7 +16,11 @@ import org.omg.sysml.xtext.ui.quickfix.SysMLQuickfixProvider
 class SysMLUiModule extends AbstractSysMLUiModule {
 	
 	override Class<? extends IssueResolutionProvider> bindIssueResolutionProvider() {
-		return SysMLQuickfixProvider;
+		return SysMLQuickfixProvider
+	}
+	
+	def Class<? extends ISemanticHighlightingCalculator> bindISemanticHighlightingCalculator() {
+		return SysMLUserKeywordHighlightingCalculator
 	}
 	
 	override provideIAllContainersState() {
diff --git a/org.omg.sysml.xtext.ui/src/org/omg/sysml/xtext/ui/SysMLUserKeywordHighlightingCalculator.xtend b/org.omg.sysml.xtext.ui/src/org/omg/sysml/xtext/ui/SysMLUserKeywordHighlightingCalculator.xtend
@@ -0,0 +1,57 @@
+/*****************************************************************************
+ * SysML 2 Pilot Implementation
+ * Copyright (c) 2022 Model Driven Solutions, Inc.
+ *    
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ * 
+ * @license LGPL-3.0-or-later <http://spdx.org/licenses/LGPL-3.0-or-later>
+ * 
+ * Contributors:
+ *  Ed Seidewitz, MDS
+ * 
+ *****************************************************************************/
+ package org.omg.sysml.xtext.ui
+
+import org.eclipse.xtext.ide.editor.syntaxcoloring.ISemanticHighlightingCalculator
+import org.eclipse.xtext.resource.XtextResource
+import org.eclipse.xtext.ide.editor.syntaxcoloring.IHighlightedPositionAcceptor
+import org.eclipse.xtext.util.CancelIndicator
+import org.eclipse.xtext.ui.editor.syntaxcoloring.DefaultHighlightingConfiguration
+import org.eclipse.xtext.impl.RuleCallImpl
+import org.eclipse.xtext.service.OperationCanceledManager
+import com.google.inject.Inject
+
+class SysMLUserKeywordHighlightingCalculator implements ISemanticHighlightingCalculator {
+	
+	@Inject
+	OperationCanceledManager cancelManager;
+	
+	override provideHighlightingFor(XtextResource resource, IHighlightedPositionAcceptor acceptor,
+		CancelIndicator cancelIndicator) {
+		if (resource !== null && resource.getParseResult() !== null) {
+			val root = resource.getParseResult().getRootNode();
+			for (node : root.getAsTreeIterable()) {
+				cancelManager.checkCanceled(cancelIndicator);
+				val grammarElement = node.grammarElement
+				if (grammarElement instanceof RuleCallImpl) {
+					val name = grammarElement.rule.name;
+					if ("PrefixMetadataMember".equals(name) || "PrefixMetadataAnnotation".equals(name)) {
+						acceptor.addPosition(node.getOffset(), node.getLength(), DefaultHighlightingConfiguration.KEYWORD_ID);
+					}
+				}
+			}
+		}
+	}
+	
+}
diff --git a/org.omg.sysml.xtext.ui/xtend-gen/org/omg/sysml/xtext/ui/.gitignore b/org.omg.sysml.xtext.ui/xtend-gen/org/omg/sysml/xtext/ui/.gitignore
@@ -1,3 +1,4 @@
 /.SysMLUiModule.java._trace
 /.SysMLUiModule.xtendbin
 /SysMLUiModule.java
+/.SysMLUserKeywordHighlightingCalculator.java._trace
diff --git a/org.omg.sysml.xtext/.launch/Save SysML with Library.launch b/org.omg.sysml.xtext/.launch/Save SysML with Library.launch
@@ -13,6 +13,6 @@
     <booleanAttribute key="org.eclipse.jdt.launching.ATTR_USE_START_ON_FIRST_THREAD" value="true"/>
     <stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.omg.sysml.xtext.util.SysMLRepositorySaveUtil"/>
     <stringAttribute key="org.eclipse.jdt.launching.MODULE_NAME" value="org.omg.sysml.xtext"/>
-    <stringAttribute key="org.eclipse.jdt.launching.PROGRAM_ARGUMENTS" value="-b http://sysml2-sst.intercax.com:9000 -d&#10;-l &quot;${workspace_loc:/SysML-v2-Pilot-Implementation/sysml.library}&quot; &#10;&quot;${selected_resource_loc}&quot;&#10;&quot;Kernel Library&quot;&#10;&quot;Systems Library&quot;&#10;&quot;Domain Library&quot;"/>
+    <stringAttribute key="org.eclipse.jdt.launching.PROGRAM_ARGUMENTS" value="-b http://sysml2-dev.intercax.com:9000 -d&#10;-l &quot;${workspace_loc:/SysML-v2-Pilot-Implementation/sysml.library}&quot; &#10;&quot;${selected_resource_loc}&quot;&#10;&quot;Kernel Library&quot;&#10;&quot;Systems Library&quot;&#10;&quot;Domain Library&quot;"/>
     <stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.omg.sysml.xtext"/>
 </launchConfiguration>
diff --git a/tool-support/syntax-highlighting/jetbrains/KerML.xml b/tool-support/syntax-highlighting/jetbrains/KerML.xml
@@ -11,8 +11,8 @@
       <option name="HAS_PARENS" value="true" />
       <option name="HAS_STRING_ESCAPES" value="true" />
     </options>
-    <keywords keywords="about;abstract;alias;all;and;as;assoc;behavior;binding;bool;by;class;classifier;comment;composite;conjugate;conjugates;conjugation;connector;datatype;default;derived;disjoining;disjoint;doc;element;else;end;expr;false;feature;featured;featuring;filter;first;flow;for;from;function;hastype;if;implies;import;in;inout;interaction;inv;is;istype;language;member;metadata;multiplicity;namespace;nonunique;not;null;of;or;ordered;out;package;portion;predicate;private;protected;public;readonly;redefines;redefinition;relationship;rep;return;specialization;specializes;step;struct;subclassifier;subset;subsets;subtype;succession;then;to;true;type;typed;typing;xor" ignore_case="false" />
-    <keywords2 keywords="!;!=;%;&amp;;&amp;&amp;;*;**;+;-;-&gt;;..;/;:;::;:=;:&gt;;:&gt;&gt;;&lt;;&lt;=;=;==;=&gt;;&gt;;&gt;=;?;??;@;^;^^;|;||;~" />
+    <keywords keywords="about;abstract;alias;all;and;as;assoc;behavior;binding;bool;by;class;classifier;comment;composite;conjugate;conjugates;conjugation;connector;datatype;default;derived;disjoining;disjoint;doc;element;else;end;expr;false;feature;featured;featuring;filter;first;flow;for;from;function;hastype;if;implies;import;in;inout;interaction;inv;is;istype;language;member;metaclass;metadata;multiplicity;namespace;nonunique;not;null;of;or;ordered;out;package;portion;predicate;private;protected;public;readonly;redefines;redefinition;relationship;rep;return;specialization;specializes;step;struct;subclassifier;subset;subsets;subtype;succession;then;to;true;type;typed;typing;xor" ignore_case="false" />
+    <keywords2 keywords="!;!=;%;&amp;;&amp;&amp;;*;**;+;-;-&gt;;..;.?;/;:;::;:=;:&gt;;:&gt;&gt;;&lt;;&lt;=;=;==;=&gt;;&gt;;&gt;=;?;??;@;^;^^;|;||;~" />
   </highlighting>
   <extensionMap>
     <mapping ext="kerml" />
diff --git a/tool-support/syntax-highlighting/jetbrains/SysML.xml b/tool-support/syntax-highlighting/jetbrains/SysML.xml
@@ -11,8 +11,8 @@
       <option name="HAS_PARENS" value="true" />
       <option name="HAS_STRING_ESCAPES" value="true" />
     </options>
-    <keywords keywords="about;abstract;accept;action;actor;after;alias;all;allocate;allocation;analysis;and;as;assert;assign;assume;at;attribute;bind;binding;by;calc;case;comment;concern;connect;connection;constraint;decide;def;default;defined;dependency;derived;do;doc;else;end;entry;enum;event;exhibit;exit;expose;false;feature;filter;first;flow;for;fork;frame;from;hastype;if;implies;import;in;include;individual;inout;interface;istype;item;join;language;loop;merge;message;metadata;nonunique;not;null;objective;occurrence;of;or;ordered;out;package;parallel;part;perform;port;private;protected;public;readonly;redefines;ref;render;rendering;rep;require;requirement;return;satisfy;send;snapshot;specializes;stakeholder;state;subject;subsets;succession;then;timeslice;to;transition;true;until;use;variant;variation;verification;verify;via;view;viewpoint;when;while;xor" ignore_case="false" />
-    <keywords2 keywords="!;!=;%;&amp;;&amp;&amp;;*;**;+;-;-&gt;;..;/;:;::;:=;:&gt;;:&gt;&gt;;&lt;;&lt;=;=;==;=&gt;;&gt;;&gt;=;?;??;@;^;^^;|;||;~" />
+    <keywords keywords="about;abstract;accept;action;actor;after;alias;all;allocate;allocation;analysis;and;as;assert;assign;assume;at;attribute;bind;binding;by;calc;case;comment;concern;connect;connection;constraint;decide;def;default;defined;dependency;derived;do;doc;else;end;entry;enum;event;exhibit;exit;expose;false;filter;first;flow;for;fork;frame;from;hastype;if;implies;import;in;include;individual;inout;interface;istype;item;join;language;loop;merge;message;metadata;nonunique;not;null;objective;occurrence;of;or;ordered;out;package;parallel;part;perform;port;private;protected;public;readonly;redefines;ref;render;rendering;rep;require;requirement;return;satisfy;send;snapshot;specializes;stakeholder;state;subject;subsets;succession;then;timeslice;to;transition;true;until;use;variant;variation;verification;verify;via;view;viewpoint;when;while;xor" ignore_case="false" />
+    <keywords2 keywords="!;!=;%;&amp;;&amp;&amp;;*;**;+;-;-&gt;;.$;..;.?;/;:;::;:=;:&gt;;:&gt;&gt;;&lt;;&lt;=;=;==;=&gt;;&gt;;&gt;=;?;??;@;^;^^;|;||;~" />
   </highlighting>
   <extensionMap>
     <mapping ext="sysml" />
diff --git a/tool-support/syntax-highlighting/jupyter/kernel.js b/tool-support/syntax-highlighting/jupyter/kernel.js
@@ -54,12 +54,12 @@ var enableMode = function (CodeMirror) {
                 "analysis", "and", "as", "assert", "assign", "assume", "at", "attribute", "bind", "binding", "by",
                 "calc", "case", "comment", "concern", "connect", "connection", "constraint", "decide", "def", "default",
                 "defined", "dependency", "derived", "do", "doc", "else", "end", "entry", "enum", "event", "exhibit",
-                "exit", "expose", "feature", "filter", "first", "flow", "for", "fork", "frame", "from", "hastype", "if",
-                "implies", "import", "in", "include", "individual", "inout", "interface", "istype", "item", "join",
-                "language", "loop", "merge", "message", "metadata", "nonunique", "not", "objective", "occurrence", "of",
-                "or", "ordered", "out", "package", "parallel", "part", "perform", "port", "private", "protected",
-                "public", "readonly", "redefines", "ref", "render", "rendering", "rep", "require", "requirement",
-                "return", "satisfy", "send", "snapshot", "specializes", "stakeholder", "state", "subject", "subsets",
+                "exit", "expose", "filter", "first", "flow", "for", "fork", "frame", "from", "hastype", "if", "implies",
+                "import", "in", "include", "individual", "inout", "interface", "istype", "item", "join", "language",
+                "loop", "merge", "message", "metadata", "nonunique", "not", "objective", "occurrence", "of", "or",
+                "ordered", "out", "package", "parallel", "part", "perform", "port", "private", "protected", "public",
+                "readonly", "redefines", "ref", "render", "rendering", "rep", "require", "requirement", "return",
+                "satisfy", "send", "snapshot", "specializes", "stakeholder", "state", "subject", "subsets",
                 "succession", "then", "timeslice", "to", "transition", "until", "use", "variant", "variation",
                 "verification", "verify", "via", "view", "viewpoint", "when", "while", "xor"
             ]),
diff --git a/tool-support/syntax-highlighting/jupyter/mode.ts b/tool-support/syntax-highlighting/jupyter/mode.ts
@@ -42,12 +42,12 @@ export function defineSysMLv2Mode(): void {
                 "analysis", "and", "as", "assert", "assign", "assume", "at", "attribute", "bind", "binding", "by",
                 "calc", "case", "comment", "concern", "connect", "connection", "constraint", "decide", "def", "default",
                 "defined", "dependency", "derived", "do", "doc", "else", "end", "entry", "enum", "event", "exhibit",
-                "exit", "expose", "feature", "filter", "first", "flow", "for", "fork", "frame", "from", "hastype", "if",
-                "implies", "import", "in", "include", "individual", "inout", "interface", "istype", "item", "join",
-                "language", "loop", "merge", "message", "metadata", "nonunique", "not", "objective", "occurrence", "of",
-                "or", "ordered", "out", "package", "parallel", "part", "perform", "port", "private", "protected",
-                "public", "readonly", "redefines", "ref", "render", "rendering", "rep", "require", "requirement",
-                "return", "satisfy", "send", "snapshot", "specializes", "stakeholder", "state", "subject", "subsets",
+                "exit", "expose", "filter", "first", "flow", "for", "fork", "frame", "from", "hastype", "if", "implies",
+                "import", "in", "include", "individual", "inout", "interface", "istype", "item", "join", "language",
+                "loop", "merge", "message", "metadata", "nonunique", "not", "objective", "occurrence", "of", "or",
+                "ordered", "out", "package", "parallel", "part", "perform", "port", "private", "protected", "public",
+                "readonly", "redefines", "ref", "render", "rendering", "rep", "require", "requirement", "return",
+                "satisfy", "send", "snapshot", "specializes", "stakeholder", "state", "subject", "subsets",
                 "succession", "then", "timeslice", "to", "transition", "until", "use", "variant", "variation",
                 "verification", "verify", "via", "view", "viewpoint", "when", "while", "xor"
             ].reduce(f_wordify, {}),
diff --git a/tool-support/syntax-highlighting/vscode/kerml/syntaxes/kerml.tmLanguage.json b/tool-support/syntax-highlighting/vscode/kerml/syntaxes/kerml.tmLanguage.json
@@ -18,11 +18,11 @@
   "repository": {
     "keywords": {
       "patterns": [
-        { "match": "\\b(about|abstract|alias|all|and|as|assoc|behavior|binding|bool|by|class|classifier|comment|composite|conjugate|conjugates|conjugation|connector|datatype|default|derived|disjoining|disjoint|doc|element|else|end|expr|false|feature|featured|featuring|filter|first|flow|for|from|function|hastype|if|implies|import|in|inout|interaction|inv|is|istype|language|member|metadata|multiplicity|namespace|nonunique|not|null|of|or|ordered|out|package|portion|predicate|private|protected|public|readonly|redefines|redefinition|relationship|rep|return|specialization|specializes|step|struct|subclassifier|subset|subsets|subtype|succession|then|to|true|type|typed|typing|xor)\\b", "name": "keyword.other.kerml" },
+        { "match": "\\b(about|abstract|alias|all|and|as|assoc|behavior|binding|bool|by|class|classifier|comment|composite|conjugate|conjugates|conjugation|connector|datatype|default|derived|disjoining|disjoint|doc|element|else|end|expr|false|feature|featured|featuring|filter|first|flow|for|from|function|hastype|if|implies|import|in|inout|interaction|inv|is|istype|language|member|metaclass|metadata|multiplicity|namespace|nonunique|not|null|of|or|ordered|out|package|portion|predicate|private|protected|public|readonly|redefines|redefinition|relationship|rep|return|specialization|specializes|step|struct|subclassifier|subset|subsets|subtype|succession|then|to|true|type|typed|typing|xor)\\b", "name": "keyword.other.kerml" },
         { "match": "(%|&|&&|\\?|\\?\\?|\\^|\\^\\^|\\||\\|\\|)", "name": "keyword.operator.logical.kerml" },
         { "match": "(!|!=|\\<|\\<=|=|==|\\>|\\>=)", "name": "keyword.operator.comparison.kerml" },
         { "match": "(\\*|\\*\\*|\\+|\\-|/)", "name": "keyword.operator.arithmetic.kerml" },
-        { "match": "(\\-\\>|\\.\\.|:|::|:=|:\\>|:\\>\\>|=\\>|@|~)", "name": "keyword.operator.other.kerml" }
+        { "match": "(\\-\\>|\\.\\.|\\.\\?|:|::|:=|:\\>|:\\>\\>|=\\>|@|~)", "name": "keyword.operator.other.kerml" }
       ]
     },
     "strings": {
diff --git a/tool-support/syntax-highlighting/vscode/sysml/syntaxes/sysml.tmLanguage.json b/tool-support/syntax-highlighting/vscode/sysml/syntaxes/sysml.tmLanguage.json
