@sdeverywhere/compile 0.7.0 → 0.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdeverywhere/compile",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "The core Vensim to C compiler for the SDEverywhere tool suite.",
   "type": "module",
   "files": [
@@ -13,7 +13,7 @@
     "antlr4-vensim": "0.6.0",
     "bufx": "^1.0.5",
     "byline": "^5.0.0",
-    "csv-parse": "^4.15.4",
+    "csv-parse": "^5.3.3",
     "js-yaml": "^3.13.1",
     "ramda": "^0.27.0",
     "split-string": "^6.0.0",

package/src/_shared/helpers.js

@@ -1,6 +1,6 @@
 import util from 'util'
 import B from 'bufx'
-import parseCsv from 'csv-parse/lib/sync.js'
+import { parse as parseCsv } from 'csv-parse/sync'
 import R from 'ramda'
 import split from 'split-string'
 import XLSX from 'xlsx'
@@ -14,6 +14,8 @@ let nextTmpVarSeq = 1
 let nextLookupVarSeq = 1
 // next sequence number for generated fixed delay variable names
 let nextFixedDelayVarSeq = 1
+// next sequence number for generated depreciation variable names
+let nextDepreciationVarSeq = 1
 // next sequence number for generated level variable names
 let nextLevelVarSeq = 1
 // next sequence number for generated aux variable names
@@ -73,6 +75,10 @@ export let newFixedDelayVarName = () => {
   // Return a unique fixed delay variable name
   return `_fixed_delay${nextFixedDelayVarSeq++}`
 }
+export let newDepreciationVarName = () => {
+  // Return a unique depreciation variable name
+  return `_depreciation${nextDepreciationVarSeq++}`
+}
 export let newLevelVarName = (basename = null, levelNumber = 0) => {
   // Return a unique level variable name.
   let levelName = basename || nextLevelVarSeq++
@@ -118,9 +124,29 @@ export let listConcat = (a, x, addSpaces = false) => {
     return a + (R.isEmpty(a) ? '' : `,${s}`) + x
   }
 }
+// Convert a number or string into a C double constant string.
+// A blank string is converted to zero, following Excel.
+// A string that cannot be converted throws an exception.
 export let cdbl = x => {
-  // Convert a number into a C double constant.
-  let s = x.toString()
+  function throwError() {
+    throw new Error(`ERROR: cannot convert "${x}" to a number`)
+  }
+  let s = '0.0'
+  if (typeof x === 'number') {
+    s = x.toString()
+  } else if (typeof x === 'string') {
+    if (x.trim() !== '') {
+      let f = parseFloat(x)
+      if (!Number.isNaN(f)) {
+        s = f.toString()
+      } else {
+        throwError()
+      }
+    }
+  } else {
+    throwError()
+  }
+  // Format as a C double literal with a decimal point.
   if (!s.includes('.') && !s.toLowerCase().includes('e')) {
     s += '.0'
   }
@@ -201,8 +227,12 @@ export let readCsv = (pathname, delimiter = ',') => {
       skip_empty_lines: true,
       skip_lines_with_empty_values: true
     }
-    let data = B.read(pathname)
-    csv = parseCsv(data, CSV_PARSE_OPTS)
+    try {
+      let data = B.read(pathname)
+      csv = parseCsv(data, CSV_PARSE_OPTS)
+    } catch (err) {
+      console.error(`ERROR: readCsv ${pathname} ${err.message}`)
+    }
     csvData.set(pathname, csv)
   }
   return csv

package/src/generate/code-gen.js

@@ -217,6 +217,7 @@ ${postStep}
   function declSection() {
     // Emit a declaration for each variable in the model.
     let fixedDelayDecls = ''
+    let depreciationDecls = ''
     let decl = v => {
       // Build a C array declaration for the variable v.
       // This uses the subscript family for each dimension, which may overallocate
@@ -229,6 +230,12 @@ ${postStep}
           family => `[${sub(family).size}]`,
           families
         ).join('')};`
+      } else if (v.isDepreciation()) {
+        // Add the associated Depreciation var decl.
+        depreciationDecls += `\nDepreciation* ${v.depreciationVarName}${R.map(
+          family => `[${sub(family).size}]`,
+          families
+        ).join('')};`
       }
       return varType + v.varName + R.map(family => `[${sub(family).size}]`, families).join('')
     }
@@ -239,7 +246,7 @@ ${postStep}
       asort,
       lines
     )
-    return decls(Model.allVars()) + fixedDelayDecls
+    return decls(Model.allVars()) + fixedDelayDecls + depreciationDecls
   }
   function internalVarsSection() {
     // Declare internal variables to run the model.

package/src/generate/equation-gen.js

@@ -383,7 +383,15 @@ export default class EquationGen extends ModelReader {
         let csvPathname = path.resolve(this.modelDirname, file)
         let data = readCsv(csvPathname, tab)
         if (data) {
-          getCellValue = (c, r) => (data[r] != null && data[r][c] != null ? cdbl(data[r][c]) : null)
+          getCellValue = (c, r) => {
+            let value = '0.0'
+            try {
+              value = data[r] != null && data[r][c] != null ? cdbl(data[r][c]) : null
+            } catch (error) {
+              console.error(`${error.message} in ${csvPathname}`)
+            }
+            return value
+          }
         }
       }
       // If the data was found, convert it to a lookup.
@@ -463,7 +471,15 @@ export default class EquationGen extends ModelReader {
     let csvPathname = path.resolve(this.modelDirname, file)
     let data = readCsv(csvPathname, tab)
     if (data) {
-      let getCellValue = (c, r) => (data[r] != null && data[r][c] != null ? cdbl(data[r][c]) : null)
+      let getCellValue = (c, r) => {
+        let value = '0.0'
+        try {
+          value = data[r] != null && data[r][c] != null ? cdbl(data[r][c]) : null
+        } catch (error) {
+          console.error(`${error.message} in ${csvPathname}`)
+        }
+        return value
+      }
       // Get C subscripts in text form for the LHS in normal order.
       let modelLHSReader = new ModelLHSReader()
       modelLHSReader.read(this.var.modelLHS)
@@ -810,7 +826,13 @@ export default class EquationGen extends ModelReader {
     let exprs = ctx.expr()
     let fn = this.currentFunctionName()
     // Split level functions into init and eval expressions.
-    if (fn === '_INTEG' || fn === '_SAMPLE_IF_TRUE' || fn === '_ACTIVE_INITIAL' || fn === '_DELAY_FIXED') {
+    if (
+      fn === '_INTEG' ||
+      fn === '_SAMPLE_IF_TRUE' ||
+      fn === '_ACTIVE_INITIAL' ||
+      fn === '_DELAY_FIXED' ||
+      fn === '_DEPRECIATE_STRAIGHTLINE'
+    ) {
       if (this.mode.startsWith('init')) {
         // Get the index of the argument holding the initial value.
         let i = 0
@@ -818,10 +840,13 @@ export default class EquationGen extends ModelReader {
           i = 1
         } else if (fn === '_SAMPLE_IF_TRUE' || fn === '_DELAY_FIXED') {
           i = 2
+        } else if (fn === '_DEPRECIATE_STRAIGHTLINE') {
+          i = 3
         }
         this.setArgIndex(i)
         exprs[i].accept(this)
-        // For DELAY FIXED, also initialize the support struct out of band, as it is not a Vensim var.
+        // For DELAY FIXED and DEPRECIATE STRAIGHTLINE, also initialize the support struct
+        // out of band, as they are not Vensim vars.
         if (fn === '_DELAY_FIXED') {
           let fixedDelay = `${this.var.fixedDelayVarName}${this.lhsSubscriptGen(this.var.subscripts)}`
           this.emit(`;\n  ${fixedDelay} = __new_fixed_delay(${fixedDelay}, `)
@@ -831,6 +856,15 @@ export default class EquationGen extends ModelReader {
           this.setArgIndex(2)
           exprs[2].accept(this)
           this.emit(')')
+        } else if (fn === '_DEPRECIATE_STRAIGHTLINE') {
+          let depreciation = `${this.var.depreciationVarName}${this.lhsSubscriptGen(this.var.subscripts)}`
+          this.emit(`;\n  ${depreciation} = __new_depreciation(${depreciation}, `)
+          this.setArgIndex(1)
+          exprs[1].accept(this)
+          this.emit(', ')
+          this.setArgIndex(2)
+          exprs[3].accept(this)
+          this.emit(')')
         }
       } else {
         // We are in eval mode, not init mode.
@@ -844,6 +878,12 @@ export default class EquationGen extends ModelReader {
           exprs[0].accept(this)
           this.emit(', ')
           this.emit(`${this.var.fixedDelayVarName}${this.lhsSubscriptGen(this.var.subscripts)}`)
+        } else if (fn === '_DEPRECIATE_STRAIGHTLINE') {
+          // For DEPRECIATE STRAIGHTLINE, emit the first arg followed by the Depreciation support var.
+          this.setArgIndex(0)
+          exprs[0].accept(this)
+          this.emit(', ')
+          this.emit(`${this.var.depreciationVarName}${this.lhsSubscriptGen(this.var.subscripts)}`)
         } else {
           // Emit the variable LHS as the first arg at eval time, giving the current value for the level.
           this.emit(this.lhs)

package/src/model/equation-reader.js

@@ -16,6 +16,7 @@ import {
   newLevelVarName,
   newLookupVarName,
   newFixedDelayVarName,
+  newDepreciationVarName,
   cartesianProductOf
 } from '../_shared/helpers.js'
 import {
@@ -109,6 +110,10 @@ export default class EquationReader extends ModelReader {
       this.var.varType = 'data'
     } else if (fn === '_GET_DIRECT_CONSTANTS') {
       this.var.varType = 'const'
+    } else if (fn === '_DEPRECIATE_STRAIGHTLINE') {
+      this.var.hasInitValue = true
+      this.var.varSubtype = 'depreciation'
+      this.var.depreciationVarName = canonicalName(newDepreciationVarName())
     }
     super.visitCall(ctx)
     this.callStack.pop()
@@ -249,6 +254,10 @@ export default class EquationReader extends ModelReader {
         this.addReferencesToList(this.var.initReferences)
       } else if (this.argIndexForFunctionName('_DELAY_FIXED') === 2) {
         this.addReferencesToList(this.var.initReferences)
+      } else if (this.argIndexForFunctionName('_DEPRECIATE_STRAIGHTLINE') === 1) {
+        this.addReferencesToList(this.var.initReferences)
+      } else if (this.argIndexForFunctionName('_DEPRECIATE_STRAIGHTLINE') === 2) {
+        this.addReferencesToList(this.var.initReferences)
       } else if (this.argIndexForFunctionName('_ACTIVE_INITIAL') === 1) {
         this.addReferencesToList(this.var.initReferences)
       } else if (this.argIndexForFunctionName('_SAMPLE_IF_TRUE') === 2) {

package/src/model/variable.js

@@ -45,6 +45,8 @@ export default class Variable {
     this.delayTimeVarName = ''
     // DELAY FIXED calls generate a FixedDelay support var.
     this.fixedDelayVarName = ''
+    // DEPRECIATE STRAIGHTLINE calls generate a Depreciation support var.
+    this.depreciationVarName = ''
     // Variables generated by special expansions are not included in output.
     this.includeInOutput = true
   }
@@ -99,6 +101,9 @@ export default class Variable {
   isFixedDelay() {
     return this.varSubtype === 'fixedDelay'
   }
+  isDepreciation() {
+    return this.varSubtype === 'depreciation'
+  }
   isInitial() {
     return this.varType === 'initial'
   }