Initial work on updatable record format keywords

Signed-off-by: worksofliam <mrliamallan@live.co.uk>

Author: worksofliam

src/ui/dspf.ts

@@ -437,14 +437,14 @@ export class DisplayFile {
   }
 
   // TODO: test cases
-  static getLinesForFormat(recordFormat: RecordInfo): string[] {
+  static getHeaderLinesForFormat(recordFormat: string, keywords: Keyword[]): string[] {
     const lines: string[] = [];
 
-    if (recordFormat.name !== GLOBAL_RECORD_NAME) {
-      lines.push(`     A          R ${recordFormat.name}`);
+    if (recordFormat) {
+      lines.push(`     A          R ${recordFormat}`);
     }
 
-    for (const keyword of recordFormat.keywords) {
+    for (const keyword of keywords) {
       // TODO: support conditions
       lines.push(
         `     A                                      ${keyword.name}${keyword.value ? `(${keyword.value})` : ``}`,
@@ -454,7 +454,7 @@ export class DisplayFile {
     return lines;
   }
 
-  public getRangeForFormat(recordFormat: string): DdsLineRange|undefined {
+  public getHeaderRangeForFormat(recordFormat: string): DdsLineRange|undefined {
     let range: DdsLineRange|undefined = undefined;
     const currentFormatI = this.formats.findIndex(format => format.name === recordFormat);
     if (currentFormatI > 0) {
@@ -474,9 +474,9 @@ export class DisplayFile {
   }
 
   // TODO: test cases
-  public updateFormat(originalFormatName: string, newRecordFormat: RecordInfo): DdsUpdate|undefined {
-    const newLines = DisplayFile.getLinesForFormat(newRecordFormat);
-    let range = this.getRangeForFormat(originalFormatName);
+  public updateFormatHeader(originalFormatName: string, keywords: Keyword[]): DdsUpdate|undefined {
+    const newLines = DisplayFile.getHeaderLinesForFormat(originalFormatName, keywords);
+    let range = this.getHeaderRangeForFormat(originalFormatName);
 
     if (range) {
       range = {

src/ui/index.ts

@@ -1,7 +1,6 @@
-import { readFile, readFileSync } from "fs";
-import { WebviewViewProvider, WebviewView, Uri, CancellationToken, WebviewViewResolveContext, Webview, DiagnosticSeverity, window, WebviewPanel, ViewColumn, ExtensionContext, workspace, TextDocument, TextEdit, Range, WorkspaceEdit, Position } from "vscode";
-import { basename } from "path";
-import { DisplayFile, FieldInfo } from "./dspf";
+import { readFileSync } from "fs";
+import { Uri, Webview, window, WebviewPanel, ViewColumn, ExtensionContext, workspace, TextDocument, Range, WorkspaceEdit, Position } from "vscode";
+import { DisplayFile, FieldInfo, Keyword, RecordInfo } from "./dspf";
 
 
 export class RendererWebview {
@@ -126,7 +125,32 @@ export class RendererWebview {
               );
 
               await workspace.applyEdit(workspaceEdit);
-              this.load(false);
+              this.load(false); //Field is updated on the client
+            }
+          }
+        }
+        break;
+
+      case `updateFormat`:
+        // This does not update any of the fields in the record format, only the format header
+        recordFormat = message.recordFormat;
+        const newKeywords: Keyword[] = message.newKeywords;
+
+        if (typeof recordFormat === `string` && Array.isArray(newKeywords)) {
+          const formatUpdate = this.dds?.updateFormatHeader(recordFormat, newKeywords);
+
+          if (formatUpdate) {
+            if (formatUpdate.range && this.document) {
+              const workspaceEdit = new WorkspaceEdit();
+              workspaceEdit.replace(
+                this.document.uri, 
+                new Range(formatUpdate.range.start, 0, formatUpdate.range.end, 1000), 
+                formatUpdate.newLines.join('\n'), // TOOD: use the correct EOL?
+                {label: `Update DDS Format`, needsConfirmation: false} 
+              );
+
+              await workspace.applyEdit(workspaceEdit);
+              this.load(true);
             }
           }
         }

webui/main.js

@@ -44,6 +44,8 @@ const timeFormats = {
   '*JIS': 'hh:mm:ss',
 };
 
+const GLOBAL_RECORD_FORMAT = `_GLOBAL`;
+
 const vscode = acquireVsCodeApi();
 
 const pxwPerChar = 8.45;
@@ -92,7 +94,7 @@ function loadDDS(newDoc, type, withRerender = true) {
   activeDocumentType = type;
 
   if (withRerender) {
-    const validFormats = activeDocument.formats.filter(format => format.name !== `GLOBAL`);
+    const validFormats = activeDocument.formats.filter(format => format.name !== GLOBAL_RECORD_FORMAT);
 
     setTabs(validFormats.map(format => format.name), lastSelectedFormat);
 
@@ -777,7 +779,9 @@ function updateRecordFormatSidebar(recordInfo, globalInfo) {
 
   sections.push({
     title: `Format Keywords`,
-    html: createKeywordPanel(`keywords-${recordInfo.name}`, recordInfo.keywords),
+    html: createKeywordPanel(`keywords-${recordInfo.name}`, recordInfo.keywords, (keywords) => {
+      sendFormatHeaderUpdate(recordInfo.name, keywords);
+    }),
     open: true
   });
 
@@ -985,6 +989,18 @@ function sendFieldUpdate(recordFormat, originalFieldName, newFieldInfo) {
   }
 }
 
+/**
+ * @param {string} recordFormat 
+ * @param {Keyword[]} newKeywords 
+ */
+function sendFormatHeaderUpdate(recordFormat, newKeywords) {
+  vscode.postMessage({
+    command: `updateFormat`,
+    recordFormat,
+    newKeywords
+  });
+}
+
 /**
  * Used to create panels for editable key/value lists.
  * @param {string} id