Local and Parameter Blocks (#1494)

goetzrrGit · web-flow · commit 67ca5b3969a2 · 2024-10-22T11:21:06.000-10:00
* Updated grammar for Local and Parameters * Added new directive @INPUT_PARAMETER_BEGIN/END and @LOCALS_BEGIN/END * Update Linter to support the new grammar changes * Checking both the new and old Parameters @INPUT_PARAMS and @INPUT_PARAMS_BEGIN * Checking both the new and old Locals @Locals and @LOCALS_BEGIN * Update SeqJSON Exporter. * new LOCAL and INPUT_PARAMS blocks * SeqJson export of Local and Parameters are fully supported now * Update the unit test as well * Update SeqJSON Importer. * new LOCAL and INPUT_PARAMS blocks * Import full SeqJSON spec for Locals and Parameters * Update the unit test as well * Added the new directives to the autocomplete * Update Grammar test * Add support to fold Parameter and Local blocks * Updated the unit test * Fixed PR issues * Address PR issues from Bryan
diff --git a/src/utilities/codemirror/custom-folder.test.ts b/src/utilities/codemirror/custom-folder.test.ts
@@ -1,6 +1,6 @@
 import { EditorState } from '@codemirror/state';
 import { describe, expect, test } from 'vitest';
-import { foldRequest, foldSteps } from './custom-folder';
+import { foldRequest, foldSteps, foldVariables } from './custom-folder';
 import { parser } from './sequence.grammar';
 
 const COMMANDS = [
@@ -23,6 +23,21 @@ const GROUND_ACTIVITIES = [
   'E-00:00:00.001 @GROUND_EVENT("event1")',
 ];
 
+const PARAMETERS = [
+  `@INPUT_PARAMS_BEGIN
+VARIABLE INT "MIN...MAX | ...MAX | MIN..." "VALUE_1, VALUE_2, ..."
+@INPUT_PARAMS_END`,
+  `@INPUT_PARAMS_BEGIN
+@INPUT_PARAMS_END`,
+];
+
+const LOCALS = [
+  `@LOCALS_BEGIN
+VARIABLE INT 
+TEST FLOAT
+@LOCALS_END`,
+];
+
 const REQUEST_ACTIVITIES = [
   `G+00:00:00 "Name" @REQUEST_BEGIN("request.name")
   C SEQ_ECHO ""
@@ -345,3 +360,42 @@ describe('foldRequest', () => {
     });
   });
 });
+
+describe('foldVariables', () => {
+  test('Parameters should return the correct from and to', () => {
+    PARAMETERS.forEach((parameter: string) => {
+      const doc = parameter;
+      const tree = parser.parse(doc);
+      const state = EditorState.create({ doc });
+
+      const node = tree.topNode.getChild('ParameterDeclaration');
+      if (!node) {
+        throw new Error('node not found');
+      } else {
+        expect(node).not.toBeNull();
+        expect(foldVariables(node, state)).toStrictEqual({
+          from: '@INPUT_PARAMS_BEGIN'.length,
+          to: doc.length,
+        });
+      }
+    });
+  });
+  test('Locals should return the correct from and to', () => {
+    LOCALS.forEach((local: string) => {
+      const doc = local;
+      const tree = parser.parse(doc);
+      const state = EditorState.create({ doc });
+
+      const node = tree.topNode.getChild('LocalDeclaration');
+      if (!node) {
+        throw new Error('node not found');
+      } else {
+        expect(node).not.toBeNull();
+        expect(foldVariables(node, state)).toStrictEqual({
+          from: '@LOCALS_BEGIN'.length,
+          to: doc.length,
+        });
+      }
+    });
+  });
+});
diff --git a/src/utilities/codemirror/custom-folder.ts b/src/utilities/codemirror/custom-folder.ts
@@ -20,6 +20,9 @@ export function customFoldInside(node: SyntaxNode, state: EditorState): { from:
       return foldMetadataOrModel(node, state, '@Metadata');
     case 'Models':
       return foldMetadataOrModel(node, state, '@Model');
+    case 'ParameterDeclaration':
+    case 'LocalDeclaration':
+      return foldVariables(node, state);
   }
   return null;
 }
@@ -107,6 +110,39 @@ export function foldRequest(requestNode: SyntaxNode, state: EditorState): { from
   return { from, to: endRequest };
 }
 
+/**
+ * Calculate the fold range for a block of variables.
+ * The fold range starts after the prefix of the block (e.g. "@INPUT_PARAMETERS_BEGIN" or "@LOCALS_BEGIN")
+ * and ends of the block.
+ * If the text ends with a line break, the end of the fold range will be adjusted to the start of the line break.
+ *
+ * @param containerNode - The node containing the variables (e.g. ParameterDeclaration or LocalDeclaration).
+ * @param state - The EditorState object.
+ * @returns A fold range object with "from" and "to" properties.
+ *          Returns null if any of the necessary nodes are not present.
+ */
+export function foldVariables(containerNode: SyntaxNode, state: EditorState): { from: number; to: number } | null {
+  // Get all the Variable nodes in the container node
+  const variablesNodes = containerNode.getChildren('Variable');
+
+  // Calculate the length of the directive (e.g. "@INPUT_PARAMETERS_BEGIN" or "@LOCALS_BEGIN")
+  const directiveLength = state
+    .sliceDoc(containerNode.from, containerNode.to - variablesNodes.length ? getFromAndTo([...variablesNodes]).from : 0)
+    .split('\n')[0].length;
+
+  // Calculate the start of the fold range after the directive
+  const from = containerNode.from + directiveLength;
+
+  // Calculate the end of the fold range after the last Variable node
+  let endBlock = getFromAndTo([containerNode]).to;
+
+  // If the text ends with a line break, adjust the end of the fold range to the start of the line break
+  const text = state.sliceDoc(containerNode.from + directiveLength, endBlock).trimEnd() + '\n';
+  endBlock = from + text.lastIndexOf('\n');
+
+  return { from, to: endBlock };
+}
+
 /**
  * Calculate the fold range for a Metadata or Model node.
  * The fold range starts after the node's prefix (e.g. "@Metadata" or "@Model") and ends after the node.
diff --git a/src/utilities/codemirror/index.ts b/src/utilities/codemirror/index.ts
@@ -19,8 +19,10 @@ export const SeqLanguage = LRLanguage.define({
         GroundBlock: customFoldInside,
         GroundEvent: customFoldInside,
         Load: customFoldInside,
+        LocalDeclaration: customFoldInside,
         Metadata: customFoldInside,
         Models: customFoldInside,
+        ParameterDeclaration: customFoldInside,
         Request: customFoldInside,
       }),
       styleTags({
diff --git a/src/utilities/codemirror/sequence.grammar b/src/utilities/codemirror/sequence.grammar
@@ -27,11 +27,14 @@ IdDeclaration {
 }
 
 ParameterDeclaration {
-  parameterDirective whiteSpace ((Enum whiteSpace?) | (Enum whiteSpace? Object whiteSpace?))+ newLine
+  (parameterDirective whiteSpace Variable{((Enum whiteSpace?) | (Enum whiteSpace? Object whiteSpace?))}+ newLine) |
+  (parameterStartDirective newLine (whiteSpace? Variable{((Enum whiteSpace?) | (Enum whiteSpace? Type { identifier } whiteSpace? ( (EnumName { identifier}) | (Range { String } (whiteSpace Values {String})? ) |  (EnumName { identifier} whiteSpace (Range { String } (whiteSpace Values {String})?) )? whiteSpace?)) )} newLine)* parameterEndDirective newLine ) 
 }
 
 LocalDeclaration {
-  localsDirective (whiteSpace Enum)+ newLine
+  (localsDirective whiteSpace Variable{((Enum whiteSpace?) | (Enum whiteSpace? Object whiteSpace?))}+ newLine) |
+  (localsStartDirective newLine (whiteSpace? Variable{((Enum whiteSpace?) | (Enum whiteSpace? Type { identifier } whiteSpace? ( (EnumName { identifier}) | (Range { String } (whiteSpace Values {String})? ) |  (EnumName { identifier} whiteSpace (Range { String } (whiteSpace Values {String})?) )? whiteSpace?)) )} newLine)* localsEndDirective newLine ) 
+
 }
 
 commandBlock {
@@ -208,7 +211,11 @@ Stem { !stemStart identifier }
   immediateDirective { "@IMMEDIATE" }
   hardwareDirective { "@HARDWARE" }
   localsDirective { "@LOCALS" }
+  localsStartDirective { "@LOCALS_BEGIN" }
+  localsEndDirective { "@LOCALS_END" }
   parameterDirective { "@INPUT_PARAMS" }
+  parameterStartDirective { "@INPUT_PARAMS_BEGIN" }
+  parameterEndDirective { "@INPUT_PARAMS_END" }
   activateDirective { "@ACTIVATE" }
   loadDirective { "@LOAD" }
   engineDirective { "@ENGINE" }
@@ -232,7 +239,11 @@ Stem { !stemStart identifier }
     modelDirective,
     immediateDirective,
     hardwareDirective,
+    localsStartDirective
+    localsEndDirective
     localsDirective,
+    parameterStartDirective,
+    parameterEndDirective,
     parameterDirective,
     activateDirective,
     loadDirective,
diff --git a/src/utilities/sequence-editor/from-seq-json.test.ts b/src/utilities/sequence-editor/from-seq-json.test.ts
@@ -81,7 +81,11 @@ describe('from-seq-json.ts', async () => {
     };
     const sequence = await seqJsonToSequence(JSON.stringify(seqJson));
     const expectedSequence = `@ID "testSymbol"
-@LOCALS L00UINT L00INT L01INT
+@LOCALS_BEGIN
+L00UINT UINT
+L00INT INT
+L01INT INT
+@LOCALS_END
 
 C PYRO_FIRE L00UINT 10 # line argument
 C DDM_BANANA L00INT L01INT
@@ -175,8 +179,20 @@ C FSW_CMD_3
     };
     const sequence = await seqJsonToSequence(JSON.stringify(seqJson));
     const expectedSequence = `@ID "testVariable"
-@INPUT_PARAMS L00INT { "type": "INT" } L01STR { "type": "STRING" } L02FLT { "type": "FLOAT" } L03UINT { "type": "UINT" } L01ENUM { "type": "ENUM" }
-@LOCALS L00INT L01STR L02FLT L03UINT L01ENUM
+@INPUT_PARAMS_BEGIN
+L00INT INT
+L01STR STRING
+L02FLT FLOAT
+L03UINT UINT
+L01ENUM ENUM
+@INPUT_PARAMS_END
+@LOCALS_BEGIN
+L00INT INT
+L01STR STRING
+L02FLT FLOAT
+L03UINT UINT
+L01ENUM ENUM
+@LOCALS_END
 `;
     expect(sequence).toEqual(expectedSequence);
   });
diff --git a/src/utilities/sequence-editor/from-seq-json.ts b/src/utilities/sequence-editor/from-seq-json.ts
@@ -115,30 +115,24 @@ function seqJsonVariableToSequence(
   variables: [VariableDeclaration, ...VariableDeclaration[]],
   type: 'INPUT_PARAMS' | 'LOCALS',
 ): string {
-  let sequence = `@${type}`;
-
-  if (type === 'INPUT_PARAMS') {
-    variables.forEach(variable => {
-      sequence += ` ${variable.name} `;
-
-      if (Object.keys(variable).length > 1) {
-        sequence += '{ ';
-
-        for (const key of Object.keys(variable)) {
-          if (key !== 'name') {
-            sequence += `"${key}": "${variable[key]}", `;
-          }
-        }
-
-        // Remove the trailing space and commma from the last property.
-        sequence = `${sequence.substring(0, sequence.length - 2)} }`;
-      }
-    });
-  } else {
-    sequence += ` ${variables.map(variable => variable.name).join(' ')}`;
-  }
+  let sequence = `@${type}_BEGIN\n`;
+
+  sequence += variables
+    .map(variable => {
+      const name = variable.name;
+      const type = variable.type ? ` ${variable.type}` : '';
+      const enumName = variable.enum_name ? ` ${variable.enum_name}` : '';
+      const allowableRanges = variable.allowable_ranges
+        ? ` "${variable.allowable_ranges.map(range => `${range.min}...${range.max}`).join(',')}"`
+        : '';
+      const allowableValues = variable.allowable_values
+        ? ` ${allowableRanges.length === 0 ? '"" ' : ''}"${variable.allowable_values.map(value => `${value}`).join(',')}"`
+        : '';
+      return `${name}${type}${enumName}${allowableRanges}${allowableValues}`;
+    })
+    .join('\n');
 
-  return sequence.trim() + '\n';
+  return sequence.trim() + `\n@${type}_END\n`;
 }
 
 function seqJsonDescriptionToSequence(description: Description): string {
diff --git a/src/utilities/sequence-editor/grammar.test.ts b/src/utilities/sequence-editor/grammar.test.ts
@@ -111,10 +111,10 @@ FSW_CMD 1 2
 FSW_CMD2`,
     `Sequence(
 LineComment,
-ParameterDeclaration(Enum,Object(Property(PropertyName(String),String))),
+ParameterDeclaration(Variable(Enum,Object(Property(PropertyName(String),String)))),
 LineComment,
 LineComment,
-LocalDeclaration(Enum,Enum),
+LocalDeclaration(Variable(Enum),Variable(Enum)),
 LineComment,
 Metadata(
 MetaEntry(Key(String),Value(String))
@@ -133,8 +133,8 @@ Command(Stem,Args)
 FSW_CMD 1 2
 FSW_CMD2`,
     `Sequence(
-ParameterDeclaration(Enum,Enum),
-LocalDeclaration(Enum,Enum),
+ParameterDeclaration(Variable(Enum),Variable(Enum)),
+LocalDeclaration(Variable(Enum),Variable(Enum)),
 Commands(
 Command(Stem,Args(Number,Number)),
 Command(Stem,Args)
@@ -148,8 +148,8 @@ Command(Stem,Args)
   FSW_CMD 1 2
   FSW_CMD2 "string val"`,
     `Sequence(
-ParameterDeclaration(Enum,Enum),
-LocalDeclaration(Enum,Enum),
+ParameterDeclaration(Variable(Enum),Variable(Enum)),
+LocalDeclaration(Variable(Enum),Variable(Enum)),
 Commands(
 Command(Stem,Args(Number,Number)),
 Command(Stem,Args(String))
@@ -301,9 +301,9 @@ CMD_2 "hello, it's me"
     `Sequence(
 IdDeclaration(String),
 LineComment,
-ParameterDeclaration(Enum),
+ParameterDeclaration(Variable(Enum)),
 LineComment,
-LocalDeclaration(Enum,Enum,Enum),
+LocalDeclaration(Variable(Enum),Variable(Enum),Variable(Enum)),
 Metadata(MetaEntry(Key(String),Value(String))),
 Commands(
 LoadAndGoDirective,
@@ -531,6 +531,38 @@ Command(TimeTag(TimeEpoch),Stem,Args),
 Command(TimeTag(TimeEpoch),Stem,Args)
   ))`,
   ],
+  [
+    'LOCALS BLOCKS',
+    `@LOCALS_BEGIN
+VARIABLE INT
+VARIABLE INT "MIN...MAX | ...MAX | MIN..." "VALUE_1, VALUE_2, ..."
+VARIABLE INT ENUM_NAME
+VARIABLE INT ENUM_NAME "MIN...MAX | ...MAX | MIN..."
+VARIABLE INT ENUM_NAME "" "VALUE_1, VALUE_2, ..."
+VARIABLE INT ENUM_NAME "MIN...MAX | ...MAX | MIN..." "VALUE_1, VALUE_2, ..."
+@LOCALS_END`,
+    `Sequence(LocalDeclaration(Variable(Enum,Type),Variable(Enum,Type,Range(String),Values(String)),Variable(Enum,Type,EnumName),Variable(Enum,Type,EnumName,Range(String)),Variable(Enum,Type,EnumName,Range(String),Values(String)),Variable(Enum,Type,EnumName,Range(String),Values(String))))`,
+  ],
+  [
+    'PARAMETER BLOCKS',
+    `@INPUT_PARAMS_BEGIN
+VARIABLE INT
+VARIABLE INT "MIN...MAX | ...MAX | MIN..." "VALUE_1, VALUE_2, ..."
+VARIABLE INT ENUM_NAME
+VARIABLE INT ENUM_NAME "MIN...MAX | ...MAX | MIN..."
+VARIABLE INT ENUM_NAME "" "VALUE_1, VALUE_2, ..."
+VARIABLE INT ENUM_NAME "MIN...MAX | ...MAX | MIN..." "VALUE_1, VALUE_2, ..."
+@INPUT_PARAMS_END`,
+    `Sequence(ParameterDeclaration(Variable(Enum,Type),Variable(Enum,Type,Range(String),Values(String)),Variable(Enum,Type,EnumName),Variable(Enum,Type,EnumName,Range(String)),Variable(Enum,Type,EnumName,Range(String),Values(String)),Variable(Enum,Type,EnumName,Range(String),Values(String))))`,
+  ],
+  [
+    'EMPTY LOCAL AND PARAM BLOCKS',
+    `@INPUT_PARAMS_BEGIN
+@INPUT_PARAMS_END
+@LOCALS_BEGIN
+@LOCALS_END`,
+    `Sequence(ParameterDeclaration,LocalDeclaration)`,
+  ],
 ];
 
 describe.each([
diff --git a/src/utilities/sequence-editor/sequence-completion.ts b/src/utilities/sequence-editor/sequence-completion.ts
@@ -89,13 +89,41 @@ export function sequenceCompletion(
             section: 'Directives',
             type: 'keyword',
           },
+          {
+            apply: `${cursor.isAtSymbolBefore ? '' : '@'}INPUT_PARAMS_BEGIN\nVARIABLE INT "MIN...MAX | ...MAX | MIN..." "VALUE_1, VALUE_2, ..."\n@INPUT_PARAMS_END`,
+            info: 'Block of Input Parameters',
+            label: '@INPUT_PARAMS_BEGIN',
+            section: 'Directives',
+            type: 'keyword',
+          },
+          {
+            apply: `${cursor.isAtSymbolBefore ? '' : '@'}INPUT_PARAMS_END\n`,
+            info: 'END block of Input Parameters',
+            label: '@INPUT_PARAMS_END',
+            section: 'Directives',
+            type: 'keyword',
+          },
           {
             apply: `${cursor.isAtSymbolBefore ? '' : '@'}LOCALS VALUE`,
             info: 'List of Local Variables',
             label: '@LOCALS',
             section: 'Directives',
             type: 'keyword',
           },
+          {
+            apply: `${cursor.isAtSymbolBefore ? '' : '@'}LOCALS_BEGIN\nVARIABLE INT "MIN...MAX | ...MAX | MIN..." "VALUE_1, VALUE_2, ..."\n@LOCALS_END`,
+            info: 'Block of Local Variables',
+            label: '@LOCALS_BEGIN',
+            section: 'Directives',
+            type: 'keyword',
+          },
+          {
+            apply: `${cursor.isAtSymbolBefore ? '' : '@'}LOCALS_END\n`,
+            info: 'END block of Local Variables',
+            label: '@LOCALS_END',
+            section: 'Directives',
+            type: 'keyword',
+          },
           {
             apply: `${cursor.isAtSymbolBefore ? '' : '@'}HARDWARE`,
             info: 'A HARDWARE Directive',
diff --git a/src/utilities/sequence-editor/sequence-linter.ts b/src/utilities/sequence-editor/sequence-linter.ts
diff --git a/src/utilities/sequence-editor/to-seq-json.test.ts b/src/utilities/sequence-editor/to-seq-json.test.ts
diff --git a/src/utilities/sequence-editor/to-seq-json.ts b/src/utilities/sequence-editor/to-seq-json.ts
diff --git a/src/utilities/sequence-editor/token.test.ts b/src/utilities/sequence-editor/token.test.ts
