chore(developer): add store.line metadata and cleanup

Author: mcdurdin

developer/src/kmc-kmn/src/compiler/compiler.ts

@@ -31,6 +31,7 @@ export const STORETYPE__MASK       = 0x1F;
 export interface CompilerResultExtraStore {
   storeType: number; // STORETYPE__MASK
   name: string;      // when debug=false, the .kmx will not have store names
+  line: number;      // source line number where store is defined
 };
 
 export interface CompilerResultExtraGroup {
@@ -203,7 +204,7 @@ export class KmnCompiler implements UnicodeSetParser {
       displayMap: null
     };
     for(let store of wasm_result.extra.stores) {
-      result.extra.stores.push({storeType: store.storeType, name: store.name});
+      result.extra.stores.push({storeType: store.storeType, name: store.name, line: store.line});
     }
     for(let group of wasm_result.extra.groups) {
       result.extra.groups.push({isReadOnly: group.isReadOnly, name: group.name});

developer/src/kmc-kmn/src/kmw-compiler/kmw-compiler.ts

@@ -51,26 +51,16 @@ export function WriteCompiledKeyboard(
 
   setupGlobals(callbacks, opts, FDebug?'  ':'', FDebug?'\r\n':'', kmxResult, keyboard, kmnfile);
 
-  // let fgp: GROUP;
-
-  // let fsp: STORE;
-	// let fkp: KEY;
-
-  // let j: number;
-  // let n: number;
-
   let vMnemonic: number = 0;
-  let /*s: string,*/ sRTL: string = "", sHelp: string = "''", sHelpFile: string = "",
+  let sRTL: string = "", sHelp: string = "''", sHelpFile: string = "",
       sEmbedJSFilename: string = "", sEmbedCSSFilename: string = "";
   let sVisualKeyboardFilename: string = "", sFullName: string = "";
   let sBegin_NewContext: string = "", sBegin_PostKeystroke: string = "";
   let sLayoutFilename: string = "", sVKDictionary: string = "";
   let linecomment: string;  // I3438
-  // let HasRules: boolean;
   let sModifierBitmask: string;
   let FOptionStores: string;
   let FKeyboardVersion = "1.0";
-  // let rec: TSentinelRecord;
 
   let result = "";
 	// Locate the name of the keyboard
@@ -228,33 +218,32 @@ export function WriteCompiledKeyboard(
   const isDebugStore = (index: number) => isStoreType(index, STORETYPE_DEBUG);
   const isReservedStore = (index: number) => isStoreType(index, STORETYPE_RESERVED);
   const isOptionStore = (index: number) => isStoreType(index, STORETYPE_OPTION);
+  const getStoreLine = (index: number) => kmxResult.extra.stores[index].line;
 
 	// Write the stores out
   FOptionStores = '';
 	for(let i = 0; i < keyboard.stores.length; i++) {
     let fsp = keyboard.stores[i];
     // I3438 - Save all system stores to the keyboard, for now   // I3684
 
-    if (!isDebugStore(i)) { // and not (fsp.dwSystemID in [TSS_BITMAP, TSS_NAME, TSS_VERSION, TSS_CUSTOMKEYMANEDITION, TSS_CUSTOMKEYMANEDITIONNAME, TSS_KEYMANCOPYRIGHT]) then
+    if (!isDebugStore(i)) {
       if (fsp.dwSystemID == KMX.KMXFile.TSS_COMPARISON) {
-        result += `${FTabStop}this.s${JavaScript_Name(i, fsp.dpName)}=${JavaScript_Store(keyboard, 0/*fsp.line*/, fsp.dpString)};${nl}`;
+        result += `${FTabStop}this.s${JavaScript_Name(i, fsp.dpName)}=${JavaScript_Store(keyboard, getStoreLine(i), fsp.dpString)};${nl}`;
       }
       else if (fsp.dwSystemID == KMX.KMXFile.TSS_COMPILEDVERSION) {
-        result += `${FTabStop}this.KVER=${JavaScript_Store(keyboard, 0/*fsp.line*/, fsp.dpString)};${nl}`;
+        result += `${FTabStop}this.KVER=${JavaScript_Store(keyboard, getStoreLine(i), fsp.dpString)};${nl}`;
       }
-      //else if fsp.dwSystemID = TSS_VKDICTIONARY then // I3438, required for vkdictionary
-      //  Result := Result + Format('%sthis.s%s=%s;%s', [FTabStop, JavaScript_Name(i, fsp.szName), JavaScript_Store(fsp.line, fsp.dpString), nl])
       else if (isOptionStore(i) && !isReservedStore(i)) {
         result += `${FTabStop}this.s${JavaScript_Name(i,fsp.dpName)}=KeymanWeb.KLOAD(this.KI,"${JavaScript_Name(i,fsp.dpName,true)}",`+
-          `${JavaScript_Store(keyboard, 0/*fsp.line*/, fsp.dpString)});${nl}`;
+          `${JavaScript_Store(keyboard, getStoreLine(i), fsp.dpString)});${nl}`;
 
         if (FOptionStores != '') {
           FOptionStores += ',';
         }
         FOptionStores += `'s${JavaScript_Name(i, fsp.dpName)}'`;
       }
-      else if (fsp.dwSystemID == KMX.KMXFile.TSS_NONE /* aka not fsp.fIsReserved */) {
-        result += `${FTabStop}this.s${JavaScript_Name(i, fsp.dpName)}=${JavaScript_Store(keyboard, 0/*fsp.line*/, fsp.dpString)};${nl}`;   // I3681
+      else if (fsp.dwSystemID == KMX.KMXFile.TSS_NONE /* aka !isReservedStore(i) */) {
+        result += `${FTabStop}this.s${JavaScript_Name(i, fsp.dpName)}=${JavaScript_Store(keyboard, getStoreLine(i), fsp.dpString)};${nl}`;   // I3681
       }
     }
   }

developer/src/kmc-kmn/src/kmw-compiler/messages.ts

@@ -61,6 +61,7 @@ export class KmwCompilerMessages extends KmnCompilerMessages {
     `The touch layout font should be the same for all platforms.`);
   static Warn_TouchLayoutMissingRequiredKeys = (o:{layerId:string, platformName:string, missingKeys:string}) => m(this.WARN_TouchLayoutMissingRequiredKeys,
     `Layer "${o.layerId}" on platform "${o.platformName}" is missing the required key(s) '${o.missingKeys}.`);
+
   // Following messages are kmw-compiler only, so use KmwCompiler error namespace
 
   static Error_NotAnyRequiresVersion14 = () => m(this.ERROR_NotAnyRequiresVersion14,

developer/src/kmcmplib/include/kmcmplibapi.h

@@ -45,6 +45,7 @@ struct KMCMP_COMPILER_OPTIONS {
 struct KMCMP_COMPILER_RESULT_EXTRA_STORE {
   int storeType;    // STORETYPE__MASK
   std::string name; // when debug=false, the .kmx will not have store names
+  int line;         // source line number where store is defined
 };
 
 struct KMCMP_COMPILER_RESULT_EXTRA_GROUP {

developer/src/kmcmplib/src/CompileKeyboardBuffer.cpp

@@ -183,6 +183,7 @@ namespace kmcmp {
         (store->fIsDebug ? STORETYPE_DEBUG : 0) |
         (store->fIsCall ? STORETYPE_CALL : 0);
       extraStore.name = string_from_u16string(store->szName);
+      extraStore.line = store->line;
       fk->extra->stores.push_back(extraStore);
     }
 

developer/src/kmcmplib/src/CompilerInterfacesWasm.cpp

@@ -148,6 +148,7 @@ EMSCRIPTEN_BINDINGS(compiler_interface) {
   emscripten::value_object<KMCMP_COMPILER_RESULT_EXTRA_STORE>("CompilerResultExtraStore")
     .field("storeType", &KMCMP_COMPILER_RESULT_EXTRA_STORE::storeType)
     .field("name", &KMCMP_COMPILER_RESULT_EXTRA_STORE::name)
+    .field("line", &KMCMP_COMPILER_RESULT_EXTRA_STORE::line)
     ;
 
   emscripten::value_object<KMCMP_COMPILER_RESULT_EXTRA_GROUP>("CompilerResultExtraGroup")