Feature/block relative and notes seqn

package.json

@@ -40,7 +40,7 @@
   "dependencies": {
     "@fontsource/jetbrains-mono": "^5.0.19",
     "@nasa-jpl/aerie-ampcs": "^1.0.5",
-    "@nasa-jpl/seq-json-schema": "^1.2.0",
+    "@nasa-jpl/seq-json-schema": "^1.3.0",
     "@nasa-jpl/stellar": "^1.1.18",
     "@streamparser/json": "^0.0.17",
     "@sveltejs/adapter-node": "5.0.1",

src/utilities/codemirror/index.ts

@@ -44,11 +44,13 @@ export const SeqLanguage = LRLanguage.define({
         LocalDeclaration: t.namespace,
         MetaEntry: t.namespace,
         Model: t.namespace,
+        Note: t.namespace,
         ParameterDeclaration: t.namespace,
         Request: t.namespace,
         Stem: t.keyword,
         String: t.string,
         TimeAbsolute: t.className,
+        TimeBlockRelative: t.className,
         TimeComplete: t.className,
         TimeEpoch: t.className,
         TimeGroundEpoch: t.className,

src/utilities/codemirror/sequence.grammar

@@ -45,7 +45,7 @@ commandBlock {
   )+
 }
 
-step { Command | Activate | GroundBlock | GroundEvent | Load }
+step { Command | Activate | GroundBlock | GroundEvent | Load | Note }
 
 commentLine {
   LineComment newLine
@@ -70,7 +70,7 @@ HardwareCommands {
   commandBlock
 }
 
-TimeTag { TimeAbsolute | (TimeGroundEpoch Name { String } whiteSpace)  | TimeEpoch | TimeRelative  | TimeComplete }
+TimeTag { TimeAbsolute | (TimeGroundEpoch Name { String } whiteSpace)  | TimeEpoch | TimeRelative  | TimeComplete | TimeBlockRelative }
 
 Args {
   (whiteSpace (arg))* whiteSpace?
@@ -120,6 +120,15 @@ commonGround {
   Models?
 }
 
+Note {
+  TimeTag
+  noteDirective "(" NoteValue { String } ")"
+  Args
+  LineComment?
+  newLine
+  Metadata?
+}
+
 Request {
   TimeTag
   requestStartDirective "(" RequestName { String } ")"
@@ -178,6 +187,8 @@ Stem { !stemStart identifier }
 
   TimeRelative { 'R'(timeSecond | timeDOY | timeHhmmss) whiteSpace}
 
+  TimeBlockRelative { 'B'$[+\-]?(timeSecond | timeDOY | timeHhmmss) whiteSpace }
+
   TimeEpoch { 'E'$[+\-]?(timeSecond | timeDOY | timeHhmmss) whiteSpace}
 
   TimeGroundEpoch { 'G'$[+\-]?(timeSecond | timeDOY | timeHhmmss) whiteSpace}
@@ -226,11 +237,12 @@ Stem { !stemStart identifier }
   requestEndDirective { "@REQUEST_END" }
   metadataDirective { "@METADATA" }
   modelDirective { "@MODEL" }
+  noteDirective { "@NOTE" }
   genericDirective { "@"identifier }
 
   @precedence { newLine, whiteSpace }
 
-  @precedence{ TimeAbsolute, TimeRelative, TimeEpoch, TimeComplete, TimeGroundEpoch, Boolean, identifier }
+  @precedence{ TimeAbsolute, TimeRelative, TimeEpoch, TimeComplete, TimeGroundEpoch, TimeBlockRelative, Boolean, identifier }
 
   @precedence {
     LoadAndGoDirective,
@@ -249,6 +261,7 @@ Stem { !stemStart identifier }
     loadDirective,
     groundBlockDirective,
     groundEventDirective,
+    noteDirective,
     requestStartDirective,
     requestEndDirective,
     engineDirective,

src/utilities/sequence-editor/grammar.test.ts

@@ -317,6 +317,7 @@ Command(Stem,Args(String),Models(Model(Variable(String),Value(String),Offset(Str
   [
     `Seq.Json comprehension`,
     `A2024-123T12:34:56 @GROUND_BLOCK("ground_block.name") # No Args
+C @NOTE("note_value")
 R123T12:34:56 @GROUND_EVENT("ground_event.name") "foo" 1 2 3
 A2024-123T12:34:56 @ACTIVATE("activate.name") # No Args
 @ENGINE 10
@@ -348,12 +349,14 @@ A2024-123T12:34:56 @REQUEST_BEGIN("request2.name")
   R100 CMD_3 "1 2 3"
   C CMD_4 1 2 3
   R100 CMD_5 "1 2 3"
+  B00:00:00 CMD_6 "1 2 3"
 @REQUEST_END
 @METADATA "foo" "bar"
 `,
     `
 Sequence(Commands(
   GroundBlock(TimeTag(TimeAbsolute),GroundName(String),Args,LineComment),
+  Note(TimeTag(TimeComplete),NoteValue(String)Args),
   GroundEvent(TimeTag(TimeRelative),GroundName(String),Args(String,Number,Number,Number)),
   Activate(TimeTag(TimeAbsolute),SequenceName(String),Args,LineComment,Engine(Number),Epoch(String)),
   Activate(TimeTag(TimeRelative),SequenceName(String),Args(String,Number,Number,Number),LineComment,Engine(Number)),
@@ -379,7 +382,8 @@ Sequence(Commands(
       Command(TimeTag(TimeComplete),Stem,Args(Number,Number,Number)),
       Command(TimeTag(TimeRelative),Stem,Args(String)),
       Command(TimeTag(TimeComplete),Stem,Args(Number,Number,Number)),
-      Command(TimeTag(TimeRelative),Stem,Args(String))
+      Command(TimeTag(TimeRelative),Stem,Args(String)),
+      Command(TimeTag(TimeBlockRelative),Stem,Args(String))
     ),
     Metadata(MetaEntry(Key(String),Value(String)))
   )

src/utilities/sequence-editor/sequence-completion.ts

@@ -187,6 +187,13 @@ export function sequenceCompletion(
               section: 'Time Tags',
               type: 'keyword',
             },
+            {
+              apply: 'B00:00:00 ',
+              info: 'Execute command at an offset from the block',
+              label: 'B (block relative)',
+              section: 'Time Tags',
+              type: 'keyword',
+            },
             {
               apply: 'G1 "epoch.name" ',
               info: 'Add a ground epoch to a request',
@@ -216,6 +223,21 @@ export function sequenceCompletion(
             section: 'Directives',
             type: 'keyword',
           },
+          {
+            apply: (view, _completion, from: number, to: number) => {
+              view.dispatch({
+                changes: {
+                  from: Math.max(0, from + (!cursor.isAfterTimeTag || cursor.isAtSymbolBefore ? -1 : 0)),
+                  insert: `${!cursor.isAfterTimeTag ? 'C ' : ''}@NOTE("note_value")`,
+                  to,
+                },
+              });
+            },
+            info: 'note',
+            label: '@NOTE',
+            section: 'Directives',
+            type: 'function',
+          },
         );
       }
 

src/utilities/sequence-editor/sequence-linter.ts

@@ -757,6 +757,7 @@ function validateTimeTags(command: SyntaxNode, text: string): Diagnostic[] {
     const timeTagAbsoluteNode = timeTagNode?.getChild('TimeAbsolute');
     const timeTagEpochNode = timeTagNode?.getChild('TimeEpoch') ?? timeTagNode.getChild('TimeGroundEpoch');
     const timeTagRelativeNode = timeTagNode?.getChild('TimeRelative');
+    const timeTagBlockRelativeNode = timeTagNode?.getChild('TimeBlockRelative');
 
     if (timeTagAbsoluteNode) {
       const absoluteText = text.slice(timeTagAbsoluteNode.from + 1, timeTagAbsoluteNode.to).trim();
@@ -825,43 +826,58 @@ function validateTimeTags(command: SyntaxNode, text: string): Diagnostic[] {
           }
         }
       }
-    } else if (timeTagRelativeNode) {
-      const relativeText = text.slice(timeTagRelativeNode.from + 1, timeTagRelativeNode.to).trim();
+    } else if (timeTagRelativeNode || timeTagBlockRelativeNode) {
+      let relativeText = '';
+      let from = -1;
+      let to = -1;
+
+      if (timeTagRelativeNode) {
+        from = timeTagRelativeNode.from;
+        to = timeTagRelativeNode.to;
+        relativeText = text.slice(from + 1, to).trim();
+      } else if (timeTagBlockRelativeNode) {
+        from = timeTagBlockRelativeNode.from;
+        to = timeTagBlockRelativeNode.to;
+        relativeText = text.slice(from + 1, to).trim();
+      }
+
       const isValid =
-        validateTime(relativeText, TimeTypes.RELATIVE) || validateTime(relativeText, TimeTypes.RELATIVE_SIMPLE);
+        validateTime(relativeText, TimeTypes.RELATIVE) ||
+        (validateTime(relativeText, TimeTypes.RELATIVE_SIMPLE) && !timeTagBlockRelativeNode);
       if (!isValid) {
         diagnostics.push({
           actions: [],
-          from: timeTagRelativeNode.from,
+          from,
           message: CustomErrorCodes.InvalidRelativeTime().message,
           severity: 'error',
-          to: timeTagRelativeNode.to,
+          to,
         });
       } else {
         if (validateTime(relativeText, TimeTypes.RELATIVE)) {
           if (isTimeMax(relativeText, TimeTypes.RELATIVE)) {
             diagnostics.push({
               actions: [],
-              from: timeTagRelativeNode.from,
+              from,
               message: CustomErrorCodes.MaxRelativeTime().message,
               severity: 'error',
-              to: timeTagRelativeNode.to,
+              to,
             });
           } else {
             if (!isTimeBalanced(relativeText, TimeTypes.EPOCH)) {
               diagnostics.push({
                 actions: [],
-                from: timeTagRelativeNode.from,
+                from,
                 message: CustomErrorCodes.UnbalancedTime(getBalancedDuration(relativeText)).message,
                 severity: 'error',
-                to: timeTagRelativeNode.to,
+                to,
               });
             }
           }
         }
       }
     }
   }
+
   return diagnostics;
 }
 

src/utilities/sequence-editor/to-seq-json.ts

@@ -16,6 +16,7 @@ import type {
   Load,
   Metadata,
   Model,
+  Note,
   NumberArgument,
   RepeatArgument,
   Request,
@@ -144,6 +145,26 @@ function parseRequest(requestNode: SyntaxNode, text: string, commandDictionary:
   };
 }
 
+function parseNote(stepNode: SyntaxNode, text: string): Note {
+  const time = parseTime(stepNode, text);
+
+  const noteValueNode = stepNode.getChild('NoteValue');
+  const noteValue = noteValueNode ? unquoteUnescape(text.slice(noteValueNode.from, noteValueNode.to)) : 'UNKNOWN';
+
+  const description = parseDescription(stepNode, text);
+  const metadata = parseMetadata(stepNode, text);
+  const models = parseModel(stepNode, text);
+
+  return {
+    description,
+    metadata,
+    models,
+    string_arg: noteValue,
+    time,
+    type: 'note',
+  };
+}
+
 function parseGroundBlockEvent(stepNode: SyntaxNode, text: string): GroundBlock | GroundEvent {
   const time = parseTime(stepNode, text);
 
@@ -263,6 +284,8 @@ function parseStep(child: SyntaxNode, text: string, commandDictionary: CommandDi
     case 'GroundBlock':
     case 'GroundEvent':
       return parseGroundBlockEvent(child, text);
+    case 'Note':
+      return parseNote(child, text);
   }
   // Standalone comment nodes (not descriptions of steps), are not supported in the seq.json schema
   // Until a schema change is coordinated, comments will dropped while writing out seq.json.
@@ -428,12 +451,13 @@ function parseTime(commandNode: SyntaxNode, text: string): Time {
   const timeTagCompleteNode = timeTagNode.getChild('TimeComplete');
   const timeTagEpochNode = timeTagNode.getChild('TimeEpoch') || timeTagNode.getChild('TimeGroundEpoch');
   const timeTagRelativeNode = timeTagNode.getChild('TimeRelative');
+  const timeTagBlockRelativeNode = timeTagNode.getChild('TimeBlockRelative');
 
   if (timeTagCompleteNode) {
     return { type: 'COMMAND_COMPLETE' };
   }
 
-  if (!timeTagAbsoluteNode && !timeTagEpochNode && !timeTagRelativeNode) {
+  if (!timeTagAbsoluteNode && !timeTagEpochNode && !timeTagRelativeNode && !timeTagBlockRelativeNode) {
     return { tag, type: 'ABSOLUTE' };
   }
 
@@ -479,7 +503,19 @@ function parseTime(commandNode: SyntaxNode, text: string): Time {
       }
       return { tag, type: 'COMMAND_RELATIVE' };
     }
+  } else if (timeTagBlockRelativeNode) {
+    const timeTagBlockRelativeText = text.slice(timeTagBlockRelativeNode.from + 1, timeTagBlockRelativeNode.to).trim();
+
+    if (validateTime(timeTagBlockRelativeText, TimeTypes.RELATIVE)) {
+      const { isNegative, days, hours, minutes, seconds, milliseconds } = getDurationTimeComponents(
+        parseDurationString(timeTagBlockRelativeText, 'seconds'),
+      );
+      tag = `${isNegative}${days}${days ? 'T' : ''}${hours}:${minutes}:${seconds}${milliseconds ? '.' : ''}${milliseconds}`;
+
+      return { tag, type: 'BLOCK_RELATIVE' };
+    }
   }
+
   return { tag, type: 'ABSOLUTE' };
 }