Added a default adaptation and hooks for auto indent and auto complete

src/components/sequencing/SequenceEditor.svelte

@@ -17,6 +17,7 @@
   import { EditorView, basicSetup } from 'codemirror';
   import { debounce } from 'lodash-es';
   import { createEventDispatcher, onDestroy, onMount } from 'svelte';
+  import { get } from 'svelte/store';
   import {
     inputFormat,
     outputFormat,
@@ -40,7 +41,6 @@
   import effects from '../../utilities/effects';
   import { downloadBlob, downloadJSON } from '../../utilities/generic';
   import { inputLinter, outputLinter } from '../../utilities/sequence-editor/extension-points';
-  import { sequenceAutoIndent } from '../../utilities/sequence-editor/sequence-autoindent';
   import { sequenceCompletion } from '../../utilities/sequence-editor/sequence-completion';
   import { sequenceTooltip } from '../../utilities/sequence-editor/sequence-tooltip';
   import { showFailureToast, showSuccessToast } from '../../utilities/toast';
@@ -191,12 +191,12 @@
         EditorView.lineWrapping,
         EditorView.theme({ '.cm-gutter': { 'min-height': `${clientHeightGridRightTop}px` } }),
         lintGutter(),
-        compartmentSeqLanguage.of(setupLanguageSupport(sequenceCompletion(null, null, []))),
+        compartmentSeqLanguage.of(setupLanguageSupport(get(sequenceAdaptation).autoComplete(null, null, []))),
         compartmentSeqLinter.of(inputLinter()),
         compartmentSeqTooltip.of(sequenceTooltip()),
         EditorView.updateListener.of(debounce(sequenceUpdateListener, 250)),
         EditorView.updateListener.of(selectedCommandUpdateListener),
-        indentService.of(sequenceAutoIndent()),
+        indentService.of(get(sequenceAdaptation).autoIndent()),
         EditorState.readOnly.of(readOnly),
       ],
       parent: editorSequenceDiv,

src/stores/sequence-adaptation.ts

@@ -3,12 +3,47 @@ import type { GlobalType } from '../types/global-type';
 import type { ISequenceAdaptation, SequenceAdaptation } from '../types/sequencing';
 import gql from '../utilities/gql';
 import { seqJsonToSequence } from '../utilities/sequence-editor/from-seq-json';
+import { sequenceAutoIndent } from '../utilities/sequence-editor/sequence-autoindent';
+import { sequenceCompletion } from '../utilities/sequence-editor/sequence-completion';
 import { sequenceToSeqJson } from '../utilities/sequence-editor/to-seq-json';
 import { gqlSubscribable } from './subscribable';
 
+const defaultAdaptation: ISequenceAdaptation = {
+  argDelegator: undefined,
+  autoComplete: sequenceCompletion,
+  autoIndent: sequenceAutoIndent,
+  conditionalKeywords: {
+    else: 'CMD_ELSE',
+    elseIf: ['CMD_ELSE_IF'],
+    endIf: 'CMD_END_IF',
+    if: ['CMD_IF'],
+  },
+  globals: [],
+  inputFormat: {
+    linter: undefined,
+    name: 'SeqN',
+    toInputFormat: seqJsonToSequence,
+  },
+  loopKeywords: {
+    break: 'CMD_BREAK',
+    continue: 'CMD_CONTINUE',
+    endWhileLoop: 'CMD_END_WHILE_LOOP',
+    whileLoop: ['CMD_WHILE_LOOP', 'CMD_WHILE_LOOP_OR'],
+  },
+  modifyOutput: undefined,
+  modifyOutputParse: undefined,
+  outputFormat: [
+    {
+      fileExtension: 'json',
+      name: 'Seq JSON',
+      toOutputFormat: sequenceToSeqJson,
+    },
+  ],
+};
+
 /* Writeable */
 
-export const sequenceAdaptation: Writable<ISequenceAdaptation | undefined> = writable(undefined);
+export const sequenceAdaptation: Writable<ISequenceAdaptation> = writable(defaultAdaptation);
 
 /* Subscriptions. */
 
@@ -26,38 +61,34 @@ export const outputFormat = derived(
 /* Helpers */
 
 export function getGlobals(): GlobalType[] {
-  return get(sequenceAdaptation)?.globals ?? [];
+  return get(sequenceAdaptation).globals ?? [];
 }
 
 export function setSequenceAdaptation(newSequenceAdaptation: ISequenceAdaptation | undefined): void {
   sequenceAdaptation.set({
-    argDelegator: newSequenceAdaptation?.argDelegator ?? undefined,
+    argDelegator: newSequenceAdaptation?.argDelegator ?? defaultAdaptation.argDelegator,
+    autoComplete: newSequenceAdaptation?.autoComplete ?? defaultAdaptation.autoComplete,
+    autoIndent: newSequenceAdaptation?.autoIndent ?? defaultAdaptation.autoIndent,
     conditionalKeywords: {
-      else: newSequenceAdaptation?.conditionalKeywords?.else ?? 'CMD_ELSE',
-      elseIf: newSequenceAdaptation?.conditionalKeywords?.elseIf ?? ['CMD_ELSE_IF'],
-      endIf: newSequenceAdaptation?.conditionalKeywords?.endIf ?? 'CMD_END_IF',
-      if: newSequenceAdaptation?.conditionalKeywords?.if ?? ['CMD_IF'],
+      else: newSequenceAdaptation?.conditionalKeywords?.else ?? defaultAdaptation.conditionalKeywords.else,
+      elseIf: newSequenceAdaptation?.conditionalKeywords?.elseIf ?? defaultAdaptation.conditionalKeywords.elseIf,
+      endIf: newSequenceAdaptation?.conditionalKeywords?.endIf ?? defaultAdaptation.conditionalKeywords.endIf,
+      if: newSequenceAdaptation?.conditionalKeywords?.if ?? defaultAdaptation.conditionalKeywords.if,
     },
-    globals: newSequenceAdaptation?.globals ?? [],
+    globals: newSequenceAdaptation?.globals ?? defaultAdaptation.globals,
     inputFormat: {
-      linter: newSequenceAdaptation?.inputFormat?.linter ?? undefined,
-      name: newSequenceAdaptation?.inputFormat?.name ?? 'SeqN',
-      toInputFormat: newSequenceAdaptation?.inputFormat?.toInputFormat ?? seqJsonToSequence,
+      linter: newSequenceAdaptation?.inputFormat?.linter ?? defaultAdaptation.inputFormat.linter,
+      name: newSequenceAdaptation?.inputFormat?.name ?? defaultAdaptation.inputFormat.name,
+      toInputFormat: newSequenceAdaptation?.inputFormat?.toInputFormat ?? defaultAdaptation.inputFormat.toInputFormat,
     },
     loopKeywords: {
-      break: newSequenceAdaptation?.loopKeywords?.break ?? 'CMD_BREAK',
-      continue: newSequenceAdaptation?.loopKeywords?.continue ?? 'CMD_CONTINUE',
-      endWhileLoop: newSequenceAdaptation?.loopKeywords?.endWhileLoop ?? 'CMD_END_WHILE_LOOP',
-      whileLoop: newSequenceAdaptation?.loopKeywords?.whileLoop ?? ['CMD_WHILE_LOOP', 'CMD_WHILE_LOOP_OR'],
+      break: newSequenceAdaptation?.loopKeywords?.break ?? defaultAdaptation.loopKeywords.break,
+      continue: newSequenceAdaptation?.loopKeywords?.continue ?? defaultAdaptation.loopKeywords.continue,
+      endWhileLoop: newSequenceAdaptation?.loopKeywords?.endWhileLoop ?? defaultAdaptation.loopKeywords.endWhileLoop,
+      whileLoop: newSequenceAdaptation?.loopKeywords?.whileLoop ?? defaultAdaptation.loopKeywords.whileLoop,
     },
-    modifyOutput: newSequenceAdaptation?.modifyOutput ?? undefined,
-    modifyOutputParse: newSequenceAdaptation?.modifyOutputParse ?? undefined,
-    outputFormat: newSequenceAdaptation?.outputFormat ?? [
-      {
-        fileExtension: 'json',
-        name: 'Seq JSON',
-        toOutputFormat: sequenceToSeqJson,
-      },
-    ],
+    modifyOutput: newSequenceAdaptation?.modifyOutput ?? defaultAdaptation.modifyOutput,
+    modifyOutputParse: newSequenceAdaptation?.modifyOutputParse ?? defaultAdaptation.modifyOutputParse,
+    outputFormat: newSequenceAdaptation?.outputFormat ?? defaultAdaptation.outputFormat,
   });
 }

src/types/sequencing.ts

@@ -1,3 +1,5 @@
+import type { CompletionContext, CompletionResult } from '@codemirror/autocomplete';
+import type { IndentContext } from '@codemirror/language';
 import type { Diagnostic } from '@codemirror/lint';
 import type { SyntaxNode } from '@lezer/common';
 import type {
@@ -57,6 +59,12 @@ export interface IOutputFormat {
 
 export interface ISequenceAdaptation {
   argDelegator?: ArgDelegator;
+  autoComplete: (
+    channelDictionary: AmpcsChannelDictionary | null,
+    commandDictionary: AmpcsCommandDictionary | null,
+    parameterDictionaries: AmpcsParameterDictionary[],
+  ) => (context: CompletionContext) => CompletionResult | null;
+  autoIndent: () => (context: IndentContext, pos: number) => number | null | undefined;
   conditionalKeywords: { else: string; elseIf: string[]; endIf: string; if: string[] };
   globals?: GlobalType[];
   inputFormat: {

src/utilities/sequence-editor/extension-points.ts

@@ -41,8 +41,8 @@ export function getCustomArgDef(
 ) {
   let delegate = undefined;
 
-  if (get(sequenceAdaptation)?.argDelegator !== undefined) {
-    delegate = get(sequenceAdaptation)?.argDelegator?.[stem]?.[dictArg.name];
+  if (get(sequenceAdaptation).argDelegator !== undefined) {
+    delegate = get(sequenceAdaptation).argDelegator?.[stem]?.[dictArg.name];
   }
 
   return delegate?.(dictArg, parameterDictionaries, channelDictionary, precedingArgs) ?? dictArg;
@@ -53,7 +53,7 @@ export async function toInputFormat(
   parameterDictionaries: ParameterDictionary[],
   channelDictionary: ChannelDictionary | null,
 ) {
-  const modifyOutputParse = get(sequenceAdaptation)?.modifyOutputParse;
+  const modifyOutputParse = get(sequenceAdaptation).modifyOutputParse;
   let modifiedOutput = null;
 
   if (modifyOutputParse !== undefined) {
@@ -71,7 +71,7 @@ export function inputLinter(
   parameterDictionaries: ParameterDictionary[] = [],
 ): Extension {
   return linter(view => {
-    const inputLinter = get(sequenceAdaptation)?.inputFormat.linter;
+    const inputLinter = get(sequenceAdaptation).inputFormat.linter;
     const tree = syntaxTree(view.state);
     const treeNode = tree.topNode;
     let diagnostics: Diagnostic[];

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

@@ -203,8 +203,8 @@ function conditionalAndLoopKeywordsLinter(commandNodes: SyntaxNode[], text: stri
   const loopStack: WhileOpener[] = [];
   const conditionalKeywords = [];
   const loopKeywords = [];
-  const sequenceAdaptationConditionalKeywords = get(sequenceAdaptation)?.conditionalKeywords;
-  const sequenceAdaptationLoopKeywords = get(sequenceAdaptation)?.loopKeywords;
+  const sequenceAdaptationConditionalKeywords = get(sequenceAdaptation).conditionalKeywords;
+  const sequenceAdaptationLoopKeywords = get(sequenceAdaptation).loopKeywords;
 
   conditionalKeywords.push(
     sequenceAdaptationConditionalKeywords?.else,