@sdeverywhere/compile 0.7.22 → 0.7.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdeverywhere/compile",
-  "version": "0.7.22",
+  "version": "0.7.24",
   "description": "The core Vensim to C compiler for the SDEverywhere tool suite.",
   "type": "module",
   "main": "./src/index.js",

package/src/_shared/helpers.js

@@ -24,6 +24,8 @@ let nextLevelVarSeq = 1
 let nextAuxVarSeq = 1
 // parsed csv data cache
 let csvData = new Map()
+// parsed xlsx data cache
+let xlsxData = new Map()
 
 // Newer versions of the xlsx package require manually setting the `fs` instance
 // before using the `XLSX.readFile` function
@@ -38,6 +40,7 @@ export function resetHelperState() {
   nextLevelVarSeq = 1
   nextAuxVarSeq = 1
   csvData.clear()
+  xlsxData.clear()
 }
 
 export let canonicalName = name => {
@@ -200,7 +203,15 @@ export let isIterable = obj => {
 }
 // Command helpers
 export let readXlsx = pathname => {
-  return XLSX.readFile(pathname, { cellDates: true })
+  // Read the XLSX file at the pathname and parse it.
+  // Return a `XLSX.WorkBook` object that can be used to access the data.
+  // Cache parsed files to support multiple reads from different equations.
+  let xlsx = xlsxData.get(pathname)
+  if (!xlsx) {
+    xlsx = XLSX.readFile(pathname, { cellDates: true })
+    xlsxData.set(pathname, xlsx)
+  }
+  return xlsx
 }
 export let readCsv = (pathname, delimiter = ',') => {
   // Read the CSV file at the pathname and parse it with the given delimiter.
@@ -208,7 +219,7 @@ export let readCsv = (pathname, delimiter = ',') => {
   // If there is a header row, it is returned as the first row.
   // Cache parsed files to support multiple reads from different equations.
   let csv = csvData.get(pathname)
-  if (csv == null) {
+  if (!csv) {
     const CSV_PARSE_OPTS = {
       delimiter,
       columns: false,

package/src/model/model.js

@@ -71,6 +71,10 @@ function read(parsedModel, spec, extData, directData, modelDirname, opts) {
   // Some arrays need to be separated into variables with individual indices to
   // prevent eval cycles. They are manually added to the spec file.
   let specialSeparationDims = spec.specialSeparationDims
+  // All arrays that have one of the specified dimension ID lists are
+  // separated on those dimensions. This allows variables to be separated
+  // without listing each one.
+  let separateAllVarsWithDims = spec.separateAllVarsWithDims
 
   // Dimensions must be defined before reading variables that use them.
   readDimensionDefs(parsedModel, modelDirname)
@@ -79,7 +83,7 @@ function read(parsedModel, spec, extData, directData, modelDirname, opts) {
   if (opts?.stopAfterResolveSubscripts) return
 
   // Read variables from the model parse tree.
-  const vars = readVariables(parsedModel, specialSeparationDims)
+  const vars = readVariables(parsedModel, specialSeparationDims, separateAllVarsWithDims)
 
   // Include a placeholder variable for the exogenous `Time` variable
   const timeVar = new Variable()

package/src/model/read-equations.js

@@ -114,6 +114,9 @@ class Context {
     const parsedModel = { kind: 'vensim', root: parseVensimModel(eqnText) }
 
     // Create one or more `Variable` instances from the equations
+    // TODO: Technically we should pass `spec.separateAllVarsWithDims` here so that any
+    // generated apply-to-all variables will be separated according to the spec like other
+    // normal variables
     const vars = readVariables(parsedModel)
 
     // Add the variables to the `Model`

package/src/model/read-variables.js

@@ -12,17 +12,21 @@ import Variable from './variable.js'
  *
  * @param {*} parsedModel TODO: Use ParsedVensimModel type here
  * @param {Object.<string, string>} [specialSeparationDims] The variable names that need to be
- * separated because of circular references.  A mapping from "C" variable name to "C" dimension
- * name to separate on.
+ * separated because of circular references.  This is an optional mapping from "C" variable name
+ * to "C" dimension name to separate on.
+ * @param {string[][]} [separateAllVarsWithDims] An optional array containing arrays of dimension
+ * identifiers for which variables will be separated.  For example, if the LHS is `x[DimA,DimB,DimC]`
+ * and this array contains a list `['_dima', '_dimb']`, then the LHS will be separated on both
+ * DimA and DimB.
  * @returns {*} An array containing all `Variable` instances that were generated from
  * the model equations.
  */
-export function readVariables(parsedModel, specialSeparationDims) {
+export function readVariables(parsedModel, specialSeparationDims, separateAllVarsWithDims) {
   const variables = []
 
   // Add one or more `Variable` definitions for each parsed equation
   for (const eqn of parsedModel.root.equations) {
-    variables.push(...variablesForEquation(eqn, specialSeparationDims || {}))
+    variables.push(...variablesForEquation(eqn, specialSeparationDims || {}, separateAllVarsWithDims || []))
   }
 
   return variables
@@ -37,10 +41,12 @@ export function readVariables(parsedModel, specialSeparationDims) {
  * @param {*} eqn The parsed equation.
  * @param {Object.<string, string>} specialSeparationDims The variable names that need to be
  * separated because of circular references.
+ * @param {string[][]} separateAllVarsWithDims An array containing arrays of dimension
+ * identifiers for which variables will be separated.
  * @returns {*} An array containing all `Variable` instances that were generated from
  * the given equation.
  */
-function variablesForEquation(eqn, specialSeparationDims) {
+function variablesForEquation(eqn, specialSeparationDims, separateAllVarsWithDims) {
   // Start a new variable defined by this equation
   const variable = new Variable()
 
@@ -115,6 +121,23 @@ function variablesForEquation(eqn, specialSeparationDims) {
       if (!Array.isArray(separationDims)) {
         separationDims = [separationDims]
       }
+      // Alternatively, if the variable was not in `specialSeparationDims`, separate
+      // on dims from `separateAllVarsWithDims` if the var matches one of the dim lists.
+      if (separationDims.length === 0) {
+        for (let dimList of separateAllVarsWithDims) {
+          // Technically we allow each entry in the spec array to be either a single
+          // dim ID string or an array of dim IDs, so convert to array if needed
+          if (!Array.isArray(dimList)) {
+            dimList = [dimList]
+          }
+          // The list entry from the spec is only considered a match if every dimension
+          // in the spec list appears on the LHS
+          if (dimList.every(dim => subIds.includes(dim))) {
+            separationDims = dimList
+            break
+          }
+        }
+      }
       positionsToExpand = subscriptPositionsToExpand(subIds, exceptSubIdSets, separationDims, variable.modelFormula)
     }