@sdeverywhere/parse 0.1.2 → 0.1.4

package/dist/index.d.cts

@@ -1,3 +1,5 @@
+import { XmlElement } from '@rgrove/parse-xml';
+
 /**
  * Format a model variable or subscript/dimension name into a valid C identifier (with
  * special characters converted to underscore).
@@ -30,6 +32,15 @@ declare function canonicalVarId(name: string): string;
  */
 declare function canonicalFunctionId(name: string): string;
 
+/** The simulation parameters, such as start time, end time, and time step. */
+interface SimulationSpec {
+    /** The start time of the simulation. */
+    startTime: number;
+    /** The end time of the simulation. */
+    endTime: number;
+    /** The time step of the simulation. */
+    timeStep: number;
+}
 /** The original name of a dimension, as it appears in the model. */
 type DimName = string;
 /** The canonical identifier of a dimension, as it appears in generated code. */
@@ -353,6 +364,13 @@ interface Equation {
 }
 /** A complete model definition, including all defined dimensions and equations. */
 interface Model {
+    /**
+     * The simulation parameters, such as start time, end time, and time step.
+     *
+     * NOTE: This will be defined for XMILE models, but may be undefined for Vensim models
+     * for which the parameters are not compile-time constants.
+     */
+    simulationSpec?: SimulationSpec;
     /** The array of all dimension definitions in the model. */
     dimensions: DimensionDef[];
     /** The array of all variable/equation definitions in the model. */
@@ -558,4 +576,32 @@ declare function preprocessVensimModel(input: string, options?: {
     removalKeys?: string[];
 }): PreprocessedVensimModel;
 
-export { type BinaryOp, type BinaryOpExpr, type DimId, type DimName, type DimOrSubId, type DimOrSubName, type DimensionDef, type Equation, type EquationLhs, type EquationRhs, type EquationRhsConstList, type EquationRhsData, type EquationRhsExpr, type EquationRhsLookup, type Expr, type FormatVariableRefFunc, type FunctionCall, type FunctionId, type FunctionName, type Keyword, type LookupCall, type LookupDef, type LookupPoint, type LookupRange, type Model, type NumberLiteral, type ParensExpr, type PreprocessedVensimModel, type PrettyOpts, type ReduceExprOptions, type StringLiteral, type SubId, type SubName, type SubscriptMapping, type SubscriptRef, type UnaryOp, type UnaryOpExpr, type VariableDef, type VariableId, type VariableName, type VariableRef, type VensimDef, type VensimParseContext, canonicalFunctionId, canonicalId, canonicalVarId, debugPrintExpr, parseVensimEquation, parseVensimExpr, parseVensimModel, parseVensimSubscriptRange, preprocessVensimModel, prettyPrintExpr, printExprStats, reduceConditionals, reduceExpr, toPrettyString };
+/**
+ * Parse the given XMILE dimension (`<dim>`) definition and return a `DimensionDef` AST node.
+ *
+ * @param input A string containing the XMILE `<dim>` definition.
+ * @returns A `DimensionDef` AST node.
+ */
+declare function parseXmileDimensionDef(dimElem: XmlElement): DimensionDef;
+
+/**
+ * Parse the given XMILE model definition and return a `Model` AST node.
+ *
+ * @param input A string containing the XMILE model.
+ * @param context An object that provides access to file system resources (such as
+ * external data files) that are referenced during the parse phase.
+ * @returns A `Model` AST node.
+ */
+declare function parseXmileModel(input: string): Model;
+
+/**
+ * Parse the given XMILE variable definition and return an array of `Equation` AST nodes
+ * corresponding to the variable definition (or definitions, in the case of a
+ * non-apply-to-all variable that is defined with an `<element>` for each subscript).
+ *
+ * @param input A string containing the XMILE equation definition.
+ * @returns An `Equation` AST node.
+ */
+declare function parseXmileVariableDef(varElem: XmlElement): Equation[];
+
+export { type BinaryOp, type BinaryOpExpr, type DimId, type DimName, type DimOrSubId, type DimOrSubName, type DimensionDef, type Equation, type EquationLhs, type EquationRhs, type EquationRhsConstList, type EquationRhsData, type EquationRhsExpr, type EquationRhsLookup, type Expr, type FormatVariableRefFunc, type FunctionCall, type FunctionId, type FunctionName, type Keyword, type LookupCall, type LookupDef, type LookupPoint, type LookupRange, type Model, type NumberLiteral, type ParensExpr, type PreprocessedVensimModel, type PrettyOpts, type ReduceExprOptions, type SimulationSpec, type StringLiteral, type SubId, type SubName, type SubscriptMapping, type SubscriptRef, type UnaryOp, type UnaryOpExpr, type VariableDef, type VariableId, type VariableName, type VariableRef, type VensimDef, type VensimParseContext, canonicalFunctionId, canonicalId, canonicalVarId, debugPrintExpr, parseVensimEquation, parseVensimExpr, parseVensimModel, parseVensimSubscriptRange, parseXmileDimensionDef, parseXmileModel, parseXmileVariableDef, preprocessVensimModel, prettyPrintExpr, printExprStats, reduceConditionals, reduceExpr, toPrettyString };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { XmlElement } from '@rgrove/parse-xml';
+
 /**
  * Format a model variable or subscript/dimension name into a valid C identifier (with
  * special characters converted to underscore).
@@ -30,6 +32,15 @@ declare function canonicalVarId(name: string): string;
  */
 declare function canonicalFunctionId(name: string): string;
 
+/** The simulation parameters, such as start time, end time, and time step. */
+interface SimulationSpec {
+    /** The start time of the simulation. */
+    startTime: number;
+    /** The end time of the simulation. */
+    endTime: number;
+    /** The time step of the simulation. */
+    timeStep: number;
+}
 /** The original name of a dimension, as it appears in the model. */
 type DimName = string;
 /** The canonical identifier of a dimension, as it appears in generated code. */
@@ -353,6 +364,13 @@ interface Equation {
 }
 /** A complete model definition, including all defined dimensions and equations. */
 interface Model {
+    /**
+     * The simulation parameters, such as start time, end time, and time step.
+     *
+     * NOTE: This will be defined for XMILE models, but may be undefined for Vensim models
+     * for which the parameters are not compile-time constants.
+     */
+    simulationSpec?: SimulationSpec;
     /** The array of all dimension definitions in the model. */
     dimensions: DimensionDef[];
     /** The array of all variable/equation definitions in the model. */
@@ -558,4 +576,32 @@ declare function preprocessVensimModel(input: string, options?: {
     removalKeys?: string[];
 }): PreprocessedVensimModel;
 
-export { type BinaryOp, type BinaryOpExpr, type DimId, type DimName, type DimOrSubId, type DimOrSubName, type DimensionDef, type Equation, type EquationLhs, type EquationRhs, type EquationRhsConstList, type EquationRhsData, type EquationRhsExpr, type EquationRhsLookup, type Expr, type FormatVariableRefFunc, type FunctionCall, type FunctionId, type FunctionName, type Keyword, type LookupCall, type LookupDef, type LookupPoint, type LookupRange, type Model, type NumberLiteral, type ParensExpr, type PreprocessedVensimModel, type PrettyOpts, type ReduceExprOptions, type StringLiteral, type SubId, type SubName, type SubscriptMapping, type SubscriptRef, type UnaryOp, type UnaryOpExpr, type VariableDef, type VariableId, type VariableName, type VariableRef, type VensimDef, type VensimParseContext, canonicalFunctionId, canonicalId, canonicalVarId, debugPrintExpr, parseVensimEquation, parseVensimExpr, parseVensimModel, parseVensimSubscriptRange, preprocessVensimModel, prettyPrintExpr, printExprStats, reduceConditionals, reduceExpr, toPrettyString };
+/**
+ * Parse the given XMILE dimension (`<dim>`) definition and return a `DimensionDef` AST node.
+ *
+ * @param input A string containing the XMILE `<dim>` definition.
+ * @returns A `DimensionDef` AST node.
+ */
+declare function parseXmileDimensionDef(dimElem: XmlElement): DimensionDef;
+
+/**
+ * Parse the given XMILE model definition and return a `Model` AST node.
+ *
+ * @param input A string containing the XMILE model.
+ * @param context An object that provides access to file system resources (such as
+ * external data files) that are referenced during the parse phase.
+ * @returns A `Model` AST node.
+ */
+declare function parseXmileModel(input: string): Model;
+
+/**
+ * Parse the given XMILE variable definition and return an array of `Equation` AST nodes
+ * corresponding to the variable definition (or definitions, in the case of a
+ * non-apply-to-all variable that is defined with an `<element>` for each subscript).
+ *
+ * @param input A string containing the XMILE equation definition.
+ * @returns An `Equation` AST node.
+ */
+declare function parseXmileVariableDef(varElem: XmlElement): Equation[];
+
+export { type BinaryOp, type BinaryOpExpr, type DimId, type DimName, type DimOrSubId, type DimOrSubName, type DimensionDef, type Equation, type EquationLhs, type EquationRhs, type EquationRhsConstList, type EquationRhsData, type EquationRhsExpr, type EquationRhsLookup, type Expr, type FormatVariableRefFunc, type FunctionCall, type FunctionId, type FunctionName, type Keyword, type LookupCall, type LookupDef, type LookupPoint, type LookupRange, type Model, type NumberLiteral, type ParensExpr, type PreprocessedVensimModel, type PrettyOpts, type ReduceExprOptions, type SimulationSpec, type StringLiteral, type SubId, type SubName, type SubscriptMapping, type SubscriptRef, type UnaryOp, type UnaryOpExpr, type VariableDef, type VariableId, type VariableName, type VariableRef, type VensimDef, type VensimParseContext, canonicalFunctionId, canonicalId, canonicalVarId, debugPrintExpr, parseVensimEquation, parseVensimExpr, parseVensimModel, parseVensimSubscriptRange, parseXmileDimensionDef, parseXmileModel, parseXmileVariableDef, preprocessVensimModel, prettyPrintExpr, printExprStats, reduceConditionals, reduceExpr, toPrettyString };