@sdeverywhere/compile 0.7.17 → 0.7.19

package/src/model/read-equation-fn-game.js

@@ -0,0 +1,50 @@
+import { canonicalName } from '../_shared/helpers.js'
+
+/**
+ * Generate a lookup variable that can be used to provide inputs to a the `GAME`
+ * function at runtime.
+ *
+ * @param {*} v
+ * @param {*} callExpr
+ * @param {*} context
+ */
+export function generateGameVariables(v, callExpr, context) {
+  // If the LHS includes subscripts, use those same subscripts when generating
+  // the new lookup variable
+  let subs
+  if (context.eqnLhs.varDef.subscriptRefs) {
+    const subNames = context.eqnLhs.varDef.subscriptRefs.map(subRef => subRef.subName)
+    subs = `[${subNames.join(',')}]`
+  } else {
+    subs = ''
+  }
+
+  // Synthesize a lookup variable name that is the same as the LHS variable
+  // name with ' game inputs' appended to it
+  const gameLookupVarName = context.eqnLhs.varDef.varName + ' game inputs'
+
+  // Add a reference to the synthesized game inputs lookup
+  const gameLookupVarId = canonicalName(gameLookupVarName)
+  v.gameLookupVarName = gameLookupVarId
+  if (v.referencedLookupVarNames) {
+    v.referencedLookupVarNames.push(gameLookupVarId)
+  } else {
+    v.referencedLookupVarNames = [gameLookupVarId]
+  }
+
+  // Define a variable for the synthesized game inputs lookup
+  const gameLookupVars = context.defineVariable(`${gameLookupVarName}${subs} ~~|`)
+
+  // Normally `defineVariable` sets `includeInOutput` to false for generated
+  // variables, but we want the generated lookup variable to appear in the
+  // model listing so that the user can reference it, so set `includeInOutput`
+  // to true.  Also change the `varType` to 'lookup' instead of 'data'.  We
+  // will declare a `Lookup` variable in the generated code, but unlike a
+  // normal lookup, we won't initialize it with data by default (it can only
+  // be updated at runtime).
+  gameLookupVars.forEach(v => {
+    v.includeInOutput = true
+    v.varType = 'lookup'
+    v.varSubtype = 'gameInputs'
+  })
+}

package/src/model/read-equations.js

@@ -16,6 +16,7 @@ import {
 
 import Model from './model.js'
 import { generateDelayVariables } from './read-equation-fn-delay.js'
+import { generateGameVariables } from './read-equation-fn-game.js'
 import { generateNpvVariables } from './read-equation-fn-npv.js'
 import { generateSmoothVariables } from './read-equation-fn-smooth.js'
 import { generateTrendVariables } from './read-equation-fn-trend.js'
@@ -128,6 +129,8 @@ class Context {
       // Inhibit output for generated variables
       v.includeInOutput = false
     })
+
+    return vars
   }
 
   /**
@@ -383,16 +386,6 @@ function visitFunctionCall(v, callExpr, context) {
       validateCallArgs(callExpr, 1)
       break
 
-    // TODO: We do not currently have full support for the GAME function, so report a warning for now
-    case '_GAME':
-      if (process.env.SDE_REPORT_UNSUPPORTED_FUNCTIONS !== '0') {
-        console.warn(
-          `WARNING: The GAME function (used in the definition of '${v.modelLHS}') is currently implemented as a no-op (it returns the input value).`
-        )
-      }
-      validateCallArgs(callExpr, 1)
-      break
-
     //
     //
     // 2-argument functions...
@@ -491,6 +484,12 @@ function visitFunctionCall(v, callExpr, context) {
       argModes[2] = 'init'
       break
 
+    case '_GAME':
+      validateCallDepth(callExpr, context)
+      validateCallArgs(callExpr, 1)
+      generateGameVariables(v, callExpr, context)
+      break
+
     case '_GET_DIRECT_CONSTANTS': {
       validateCallDepth(callExpr, context)
       validateCallArgs(callExpr, 3)

package/src/model/read-variables.js

@@ -49,7 +49,7 @@ export function readVariables(parsedModel, specialSeparationDims) {
  */
 function variablesForEquation(eqn, specialSeparationDims) {
   // Start a new variable defined by this equation
-  const variable = new Variable(null)
+  const variable = new Variable()
 
   // Fill in the LHS details
   const lhs = eqn.lhs.varDef
@@ -137,7 +137,7 @@ function variablesForEquation(eqn, specialSeparationDims) {
     // Generate variables expanded over subscripts to the model
     const variables = []
     for (const expansion of expansions) {
-      const v = new Variable(null)
+      const v = new Variable()
       v.varName = baseVarId
       v.modelLHS = lhsText
       v.modelFormula = rhsText

package/src/model/variable.js

@@ -1,15 +1,8 @@
 export default class Variable {
-  constructor(eqnCtx) {
-    // The equation rule context allows us to generate code by visiting the parse tree.
-    this.eqnCtx = eqnCtx
+  constructor() {
     // Save both sides of the equation text in the model for documentation purposes.
-    if (eqnCtx) {
-      this.modelLHS = eqnCtx.lhs().getText()
-      this.modelFormula = this.formula(eqnCtx)
-    } else {
-      this.modelLHS = ''
-      this.modelFormula = ''
-    }
+    this.modelLHS = ''
+    this.modelFormula = ''
     // An equation defines a variable with a var name, saved in canonical form here.
     this.varName = ''
     // Subscripts are canonical dimension or index names on the LHS in normal order.
@@ -48,6 +41,8 @@ export default class Variable {
     // DELAY3* calls are expanded into new level vars and substituted during code generation.
     this.delayVarRefId = ''
     this.delayTimeVarName = ''
+    // GAME calls generate a Lookup support var.
+    this.gameLookupVarName = ''
     // DELAY FIXED calls generate a FixedDelay support var.
     this.fixedDelayVarName = ''
     // DEPRECIATE STRAIGHTLINE calls generate a Depreciation support var.
@@ -57,7 +52,6 @@ export default class Variable {
   }
   copy() {
     let c = new Variable()
-    c.eqnCtx = this.eqnCtx
     c.modelLHS = this.modelLHS
     c.modelFormula = this.modelFormula
     c.varName = this.varName
@@ -75,19 +69,10 @@ export default class Variable {
     c.trendVarName = this.trendVarName
     c.delayVarRefId = this.delayVarRefId
     c.delayTimeVarName = this.delayTimeVarName
+    c.gameLookupVarName = this.gameLookupVarName
     c.includeInOutput = this.includeInOutput
     return c
   }
-  formula(eqnCtx) {
-    if (eqnCtx) {
-      if (eqnCtx.expr()) {
-        return eqnCtx.expr().getText()
-      } else if (eqnCtx.constList()) {
-        return eqnCtx.constList().getText()
-      }
-    }
-    return ''
-  }
   hasSubscripts() {
     return this.subscripts.length > 0
   }

package/src/parse-and-generate.js

@@ -8,10 +8,9 @@ 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 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'
+import { generateCode } from './generate/gen-code.js'
 
 /**
  * Parse a Vensim model and generate C code.
@@ -19,17 +18,18 @@ import { generateCode } from './generate/code-gen.js'
  * This is the primary entrypoint for the `sde generate` command.
  *
  * - If `operations` has 'generateC', the generated C code will be written to `buildDir`.
+ * - If `operations` has 'generateJS', the generated JS 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` has 'printRefIdTest', reference identifiers will be printed to the console.
- * - If `operation` has 'convertNames', no output will be generated, but the results of model
+ * - If `operations` has 'printRefIdTest', reference identifiers will be printed to the console.
+ * - If `operations` 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 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 operations The set of operations to perform; can include 'generateC', 'generateJS',
+ * '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).
@@ -66,7 +66,7 @@ export async function parseAndGenerate(input, spec, operations, modelDirname, mo
     }
   }
 
-  // Parse the model and generate code.
+  // Parse the model and generate code
   let parsedModel = parseModel(input, modelDirname)
   let code = generateCode(parsedModel, { spec, operations, extData, directData, modelDirname })
 
@@ -80,6 +80,11 @@ export async function parseAndGenerate(input, spec, operations, modelDirname, mo
     writeOutput(`${modelName}.c`, code)
   }
 
+  if (operations.includes('generateJS')) {
+    // Write the generated JS to a file
+    writeOutput(`${modelName}.js`, code)
+  }
+
   if (operations.includes('printVarList')) {
     // Write variables to a text file.
     writeOutput(`${modelName}_vars.txt`, Model.printVarList())
@@ -90,7 +95,11 @@ export async function parseAndGenerate(input, spec, operations, modelDirname, mo
     // Write subscripts to a YAML file.
     writeOutput(`${modelName}_subs.yaml`, yamlSubsList())
     // Write variables and subscripts to a JSON file.
-    writeOutput(`${modelName}.json`, Model.jsonList())
+    const jsonList = Model.jsonList()
+    writeOutput(`${modelName}.json`, JSON.stringify(jsonList.full, null, 2))
+    // Write minimal variable index and dimension specs to a JSON file used
+    // by the runtime package to initialize a `ModelListing` instance).
+    writeOutput(`${modelName}_min.json`, JSON.stringify(jsonList.minimal, null, 2))
   }
 
   return code
@@ -127,18 +136,11 @@ export function printNames(namesPathname, operation) {
  * @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.
+ * @param {Object} options The options that control parsing.
+ * @param {boolean} options.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 === '0') {
-    // Use the legacy parser
-    return {
-      kind: 'vensim-legacy',
-      parseTree: legacyParseVensimModel(input)
-    }
-  }
-
+export function parseModel(input, modelDir, options) {
   // Prepare the parse context that provides access to external data files
   let parseContext /*: VensimParseContext*/
   if (modelDir) {
@@ -160,6 +162,7 @@ export function parseModel(input, modelDir, sort = false) {
   // 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 sort = options?.sort === true
   const root = parseVensimModel(input, parseContext, sort)
 
   return {

package/src/preprocess/preprocessor.js

@@ -3,14 +3,14 @@ import B from 'bufx'
 import * as R from 'ramda'
 import { splitEquations, replaceDelimitedStrings } from '../_shared/helpers.js'
 
-export let preprocessModel = (mdlFilename, spec, profile = 'genc', writeFiles = false, outDecls = []) => {
+export let preprocessModel = (mdlFilename, spec, profile = 'runnable', writeFiles = false, outDecls = []) => {
   const MACROS_FILENAME = 'macros.txt'
   const REMOVALS_FILENAME = 'removals.txt'
   const INSERTIONS_FILENAME = 'mdl-edits.txt'
   const ENCODING = '{UTF-8}'
   let profiles = {
     // simplified but still runnable model
-    genc: {
+    runnable: {
       emitEncoding: true,
       emitCommentMarkers: true,
       joinFormulaLines: false