@sdeverywhere/compile 0.7.9 → 0.7.11

package/src/parse-and-generate.js

@@ -3,11 +3,14 @@
 import path from 'path'
 import B from 'bufx'
 
+import { parseVensimModel } from '@sdeverywhere/parse'
+
 import { readXlsx } from './_shared/helpers.js'
 import { readDat } from './_shared/read-dat.js'
 import { printSubscripts, yamlSubsList } from './_shared/subscript.js'
-import { parseModel } from './parse/parser.js'
+import { parseModel as legacyParseVensimModel } from './parse/parser.js'
 import Model from './model/model.js'
+import { getDirectSubscripts } from './model/read-subscripts.js'
 import { generateCode } from './generate/code-gen.js'
 
 /**
@@ -15,24 +18,25 @@ import { generateCode } from './generate/code-gen.js'
  *
  * This is the primary entrypoint for the `sde generate` command.
  *
- * - If `operation` is 'generateC', the generated C code will be written to `buildDir`.
- * - If `operation` is 'printVarList', variables and subscripts will be written to
+ * - If `operations` has 'generateC', the generated C code will be written to `buildDir`.
+ * - If `operations` has 'printVarList', variables and subscripts will be written to
  *   txt, yaml, and json files under `buildDir`.
- * - If `operation` is 'printRefIdTest', reference identifiers will be printed to the console.
- * - If `operation` is 'convertNames', no output will be generated, but the results of model
+ * - If `operation` has 'printRefIdTest', reference identifiers will be printed to the console.
+ * - If `operation` has 'convertNames', no output will be generated, but the results of model
  *   analysis will be available.
  *
  * @param input The preprocessed Vensim model text.
  * @param spec The model spec (from the JSON file).
- * @param operation Either 'generateC', 'printVarList', 'printRefIdTest', 'convertNames',
- * or empty string.
+ * @param operations The set of operations to perform; can include 'generateC', 'printVarList',
+ * 'printRefIdTest', 'convertNames'.  If the array is empty, the model will be read but no
+ * operation will be performed.
  * @param modelDirname The absolute path to the directory containing the mdl file.
  * The dat and xlsx files referenced by the spec will be relative to this directory.
  * @param modelName The model name (without the mdl extension).
  * @param buildDir The output directory where the C or list files will be written.
  * @return A string containing the generated C code.
  */
-export async function parseAndGenerate(input, spec, operation, modelDirname, modelName, buildDir) {
+export async function parseAndGenerate(input, spec, operations, modelDirname, modelName, buildDir) {
   // Read time series from external DAT files into a single object.
   // externalDatfiles is an array of either filenames or objects
   // giving a variable name prefix as the key and a filename as the value.
@@ -63,20 +67,20 @@ export async function parseAndGenerate(input, spec, operation, modelDirname, mod
   }
 
   // Parse the model and generate code.
-  let parseTree = parseModel(input)
-  let code = generateCode(parseTree, { spec, operation, extData, directData, modelDirname })
+  let parsedModel = parseModel(input, modelDirname)
+  let code = generateCode(parsedModel, { spec, operations, extData, directData, modelDirname })
 
   function writeOutput(filename, text) {
     let outputPathname = path.join(buildDir, filename)
     B.write(text, outputPathname)
   }
 
-  if (operation === 'generateC') {
+  if (operations.includes('generateC')) {
     // Write the generated C to a file
     writeOutput(`${modelName}.c`, code)
   }
 
-  if (operation === 'printVarList') {
+  if (operations.includes('printVarList')) {
     // Write variables to a text file.
     writeOutput(`${modelName}_vars.txt`, Model.printVarList())
     // Write subscripts to a text file.
@@ -114,3 +118,52 @@ export function printNames(namesPathname, operation) {
   }
   B.printBuf()
 }
+
+/**
+ * Read and parse the given model text and return the parsed model structure.
+ *
+ * TODO: Fix return type
+ *
+ * @param {string} input The string containing the model text.
+ * @param {string} modelDir The absolute path to the directory containing the mdl file.
+ * The dat, xlsx, and csv files referenced by the model will be relative to this directory.
+ * @param {boolean} sort Whether to sort definitions alphabetically in the preprocess step.
+ * @return {*} A parsed tree representation of the model.
+ */
+export function parseModel(input, modelDir, sort = false) {
+  if (process.env.SDE_NONPUBLIC_USE_NEW_PARSE !== '1') {
+    // Use the legacy parser
+    return {
+      kind: 'vensim-legacy',
+      parseTree: legacyParseVensimModel(input)
+    }
+  }
+
+  // Prepare the parse context that provides access to external data files
+  let parseContext /*: VensimParseContext*/
+  if (modelDir) {
+    parseContext = {
+      getDirectSubscripts(fileName, tabOrDelimiter, firstCell, lastCell /*, prefix*/) {
+        // Resolve the CSV file relative the model directory
+        const csvPath = path.resolve(modelDir, fileName)
+
+        // Read the subscripts from the CSV file
+        return getDirectSubscripts(csvPath, tabOrDelimiter, firstCell, lastCell)
+      }
+    }
+  }
+
+  // Parse the model
+  // TODO: The `parseVensimModel` function currently implicitly runs the preprocess
+  // step on the input text.  We should make this configurable (because `parseModel`
+  // is currently called after the legacy preprocessor has already been run).
+  // TODO: We currently sort the preprocessed definitions alphabetically for
+  // compatibility with the legacy preprocessor.  Once we drop the legacy code
+  // we could remove this step and update the tests to use the original order.
+  const root = parseVensimModel(input, parseContext, sort)
+
+  return {
+    kind: 'vensim',
+    root
+  }
+}