@sdeverywhere/cli 0.7.27 → 0.7.28

package/README.md

@@ -97,7 +97,10 @@ sde bundle [--config sde.config.js] [--verbose]
 sde generate --list {model}
 ```
 
-#### Preprocess a model to remove macros and tabbed arrays to removals.txt
+#### Preprocess a model to remove macros and tabbed arrays
+
+_NOTE:_ For most users it is not necessary to run the preprocessor manually
+because the transpiler runs the preprocessor automatically prior to parsing.
 
 ```
 sde generate --preprocess {model}
@@ -204,21 +207,6 @@ There is an example in the `directdata` sample model.
 }
 ```
 
-#### Specify equations to remove from the model
-
-When SDEverywhere cannot handle a certain Vensim construct yet, you will need to remove equations that use the construct from the model, convert it by hand into something that SDEverywhere can handle, and then insert it back into the model.
-To have the preprocessor remove equations from the model into a `removals.txt` file, specify substrings to match in the equation in the `removalKeys` section.
-Macros and `TABBED ARRAY` equations are already automatically removed by the preprocessor.
-
-For instance, you could key on the variable name in the equation definition.
-
-```json
-"removalKeys": [
-  "varname1 =",
-  "varname2 ="
-]
-```
-
 #### Generating, compiling, running, and testing the C code
 
 To generate C code using the `--spec` argument, enter the following command:
@@ -260,15 +248,6 @@ That is, the values are separated by spaces, and each pair has an index number,
 The zero-based index maps into a static array of input variable pointers held in the function.
 These are used to set the value directly into the static `double` variable in the generated code.
 
-#### Inserting a file into the model
-
-Some constructs like macros are not supported by SDEverywhere.
-They are removed from the model by the preprocessor into the `removals.txt` file.
-You can edit these constructs into a form that SDEverywhere supports and insert them back into the model.
-Create a file called `mdl-edits.txt` in the model directory with the constructs to insert.
-For instance, manually expand macros and place them into the `mdl-edits.txt` file.
-The preprocessor will read this file and insert its contents unchanged into the beginning of the model.
-
 ## License
 
 SDEverywhere is distributed under the MIT license. See `LICENSE` for more details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdeverywhere/cli",
-  "version": "0.7.27",
+  "version": "0.7.28",
   "description": "Contains the `sde` command line interface for the SDEverywhere tool suite.",
   "type": "module",
   "files": [
@@ -11,8 +11,8 @@
     "sde": "src/main.js"
   },
   "dependencies": {
-    "@sdeverywhere/build": "^0.3.6",
-    "@sdeverywhere/compile": "^0.7.20",
+    "@sdeverywhere/build": "^0.3.7",
+    "@sdeverywhere/compile": "^0.7.21",
     "bufx": "^1.0.5",
     "byline": "^5.0.0",
     "ramda": "^0.27.0",

package/src/sde-build.js

@@ -43,7 +43,8 @@ export let build = async (model, opts) => {
     }
   } catch (e) {
     // Exit with a non-zero error code if any step failed
-    console.error(`ERROR: ${e.message}\n`)
+    console.error(e)
+    console.error()
     process.exit(1)
   }
 }

package/src/sde-causes.js

@@ -1,4 +1,6 @@
-import { generateCode, parseModel, preprocessModel } from '@sdeverywhere/compile'
+import { readFileSync } from 'fs'
+
+import { parseAndGenerate } from '@sdeverywhere/compile'
 
 import { modelPathProps, parseSpec } from './utils.js'
 
@@ -14,22 +16,13 @@ let builder = {
 let handler = argv => {
   causes(argv.model, argv.c_varname, argv)
 }
-let causes = (model, varname, opts) => {
+let causes = async (model, varname, opts) => {
   // Get the model name and directory from the model argument.
-  let { modelDirname, modelPathname } = modelPathProps(model)
-  let extData = new Map()
-  let directData = new Map()
+  let { modelDirname, modelPathname, modelName } = modelPathProps(model)
   let spec = parseSpec(opts.spec)
-  // Preprocess model text into parser input.
-  // TODO: The legacy `parseModel` function previously required the `preprocessModel`
-  // step to be performed first, but the new `parseModel` runs the preprocessor
-  // implicitly, so we can remove this step (and can simplify this code to use
-  // `parseAndGenerate` instead)
-  let input = preprocessModel(modelPathname, spec)
   // Parse the model to get variable and subscript information.
-  let parsedModel = parseModel(input, modelDirname)
-  let operations = ['printRefGraph']
-  generateCode(parsedModel, { spec, operations, extData, directData, modelDirname, varname })
+  let input = readFileSync(modelPathname, 'utf8')
+  await parseAndGenerate(input, spec, ['printRefGraph'], modelDirname, modelName, '', varname)
 }
 export default {
   command,

package/src/sde-flatten.js

@@ -1,8 +1,9 @@
+import { readFileSync } from 'fs'
 import path from 'path'
 
 import B from 'bufx'
 
-import { preprocessModel } from '@sdeverywhere/compile'
+import { preprocessVensimModel } from '@sdeverywhere/compile'
 
 import { buildDir, modelPathProps } from './utils.js'
 
@@ -44,16 +45,23 @@ const flatten = async (outFile, inFiles, opts) => {
     // Get the path and short name of the input mdl file
     const inModelProps = modelPathProps(inFile)
 
-    // Preprocess the mdl file and extract the equations
-    const decls = []
-    preprocessModel(inModelProps.modelPathname, undefined, 'runnable', false, decls)
+    // Read the mdl file content
+    const mdlContent = readFileSync(inModelProps.modelPathname, 'utf8')
 
-    // Associate each declaration with the name of the model from which it came
-    for (const decl of decls) {
-      decl.sourceModelName = inModelProps.modelName
+    // Preprocess the mdl file and extract the equations and subscript range definitions
+    const { defs } = preprocessVensimModel(mdlContent)
+
+    for (const def of defs) {
+      // Associate each definition with the name of the model from which it came
+      def.sourceModelName = inModelProps.modelName
+
+      // The object contains the preprocessed definition in a `def` property; copy this
+      // to a `processedDecl` property for clarity (since the existing code used that
+      // property name).
+      def.processedDecl = def.def
     }
 
-    fileDecls[inModelProps.modelName] = decls
+    fileDecls[inModelProps.modelName] = defs
   }
 
   // Collapse so that we have only one equation or declaration per key.
@@ -176,9 +184,8 @@ const flatten = async (outFile, inFiles, opts) => {
   B.open('pp')
   const ENCODING = '{UTF-8}'
   B.emitLine(ENCODING, 'pp')
-  B.emitLine('', 'pp')
   for (const decl of sorted) {
-    B.emitLine(`${decl.processedDecl}\n`, 'pp')
+    B.emitLine(`\n${decl.processedDecl}`, 'pp')
   }
 
   // Write the flattened mdl file to the build directory

package/src/sde-generate.js

@@ -1,7 +1,8 @@
 import path from 'path'
+import { readFileSync } from 'fs'
 import B from 'bufx'
 
-import { parseAndGenerate, preprocessModel } from '@sdeverywhere/compile'
+import { parseAndGenerate, preprocessVensimModel } from '@sdeverywhere/compile'
 
 import { buildDir, modelPathProps, parseSpec } from './utils.js'
 
@@ -28,11 +29,6 @@ export let builder = {
     type: 'boolean',
     alias: 'p'
   },
-  analysis: {
-    describe: 'write a nonexecutable preprocessed model for analysis',
-    type: 'boolean',
-    alias: 'a'
-  },
   spec: {
     describe: 'pathname of the I/O specification JSON file',
     type: 'string',
@@ -64,16 +60,13 @@ export let generate = async (model, opts) => {
   let { modelDirname, modelName, modelPathname } = modelPathProps(model)
   // Ensure the build directory exists.
   let buildDirname = buildDir(opts.builddir, modelDirname)
-  // Preprocess model text into parser input. Stop now if that's all we're doing.
   let spec = parseSpec(opts.spec)
-  // Produce a runnable model with the "runnable" and "preprocess" options.
-  let profile = opts.analysis ? 'analysis' : 'runnable'
-  // Write the preprocessed model and removals if the option is "analysis" or "preprocess".
-  let writeFiles = opts.analysis || opts.preprocess
-  let input = preprocessModel(modelPathname, spec, profile, writeFiles)
-  if (writeFiles) {
+  let mdlContent = readFileSync(modelPathname, 'utf8')
+  if (opts.preprocess) {
+    // Only run the preprocessor.
+    let preprocessed = preprocessModel(mdlContent)
     let outputPathname = path.join(buildDirname, `${modelName}.mdl`)
-    B.write(input, outputPathname)
+    B.write(preprocessed, outputPathname)
     process.exit(0)
   }
   // Parse the model and generate code. If no operation is specified, the code generator will
@@ -94,7 +87,7 @@ export let generate = async (model, opts) => {
   if (opts.refidtest) {
     operations.push('printRefIdTest')
   }
-  await parseAndGenerate(input, spec, operations, modelDirname, modelName, buildDirname)
+  await parseAndGenerate(mdlContent, spec, operations, modelDirname, modelName, buildDirname)
 }
 
 export default {
@@ -104,3 +97,29 @@ export default {
   handler,
   generate
 }
+
+/**
+ * Read and preprocess the given Vensim model content.
+ *
+ * @param {string} mdlContent The mdl content.
+ * @return {string} The preprocessed mdl text.
+ */
+function preprocessModel(mdlContent) {
+  // Run the preprocessor
+  const { defs } = preprocessVensimModel(mdlContent)
+
+  // Sort the definitions alphabetically by key.  This mainly exists for compatibility
+  // with the legacy `sde generate --preprocess` command, which was changed in #55 to
+  // sort definitions alphabetically.
+  defs.sort((a, b) => {
+    return a.key < b.key ? -1 : a.key > b.key ? 1 : 0
+  })
+
+  // Join the preprocessed definitions into a single string
+  let text = '{UTF-8}\n'
+  for (const def of defs) {
+    text += `\n${def.def}\n`
+  }
+
+  return text
+}

package/src/sde-names.js

@@ -1,4 +1,6 @@
-import { parseAndGenerate, preprocessModel, printNames } from '@sdeverywhere/compile'
+import { readFileSync } from 'fs'
+
+import { parseAndGenerate, printNames } from '@sdeverywhere/compile'
 
 import { modelPathProps, parseSpec } from './utils.js'
 
@@ -26,9 +28,8 @@ let names = async (model, namesPathname, opts) => {
   // Get the model name and directory from the model argument.
   let { modelDirname, modelPathname, modelName } = modelPathProps(model)
   let spec = parseSpec(opts.spec)
-  // Preprocess model text into parser input.
-  let input = preprocessModel(modelPathname, spec)
   // Parse the model to get variable and subscript information.
+  let input = readFileSync(modelPathname, 'utf8')
   await parseAndGenerate(input, spec, ['convertNames'], modelDirname, modelName, '')
   // Read each variable name from the names file and convert it.
   printNames(namesPathname, opts.toc ? 'to-c' : 'to-vensim')

package/src/sde-test.js

@@ -66,7 +66,8 @@ export let test = async (model, opts) => {
     }
   } catch (e) {
     // Exit with a non-zero error code if any step failed
-    console.error(`ERROR: ${e.message}\n`)
+    console.error(e)
+    console.error()
     process.exit(1)
   }
 }