ifc-expressions 0.1.0

package/dist/ExprVisitor.d.ts

@@ -0,0 +1,22 @@
+import IfcExpressionVisitor from "../generated/parser/IfcExpressionVisitor";
+import { AttributeRefContext, ExprContext, NestedObjectChainEndContext, NestedObjectChainInnerContext, NumAddSubContext, NumAttributeRefContext, NumLitContext, NumLiteralContext, NumMulDivContext, NumParensContext, ObjectRefContext, StringAttributeRefContext, StringConcatContext, StringLiteralContext } from "../generated/parser/IfcExpressionParser";
+import { Expr } from "./expression/Expr";
+export declare class ExprVisitor extends IfcExpressionVisitor<Expr<any>> {
+    constructor();
+    visitAttributeRef: (ctx: AttributeRefContext) => Expr<any>;
+    visitObjectRef: (ctx: ObjectRefContext) => Expr<any>;
+    visitNestedObjectChainInner: (ctx: NestedObjectChainInnerContext) => Expr<any>;
+    visitNestedObjectChainEnd: (ctx: NestedObjectChainEndContext) => Expr<any>;
+    private stripBrackets;
+    visitStringLiteral: (ctx: StringLiteralContext) => Expr<any>;
+    visitStringAttributeRef: (ctx: StringAttributeRefContext) => Expr<any>;
+    visitStringConcat: (ctx: StringConcatContext) => Expr<any>;
+    visitNumAttributeRef: (ctx: NumAttributeRefContext) => Expr<any>;
+    visitNumLiteral: (ctx: NumLiteralContext) => Expr<any>;
+    visitNumAddSub: (ctx: NumAddSubContext) => Expr<any>;
+    visitNumMulDiv: (ctx: NumMulDivContext) => Expr<any>;
+    visitNumParens: (ctx: NumParensContext) => Expr<any>;
+    visitExpr: (ctx: ExprContext) => Expr<any>;
+    visitNumLit: (ctx: NumLitContext) => Expr<any>;
+    private failNode;
+}

package/dist/IfcErrorListener.d.ts

@@ -0,0 +1,8 @@
+import { ErrorListener, RecognitionException, Recognizer, Token } from "antlr4";
+import { SyntaxErrorException } from "./SyntaxErrorException";
+export declare class IfcErrorListener extends ErrorListener<Token> {
+    private exception;
+    syntaxError(recognizer: Recognizer<Token>, offendingSymbol: Token, line: number, column: number, msg: string, e: RecognitionException | undefined): void;
+    isErrorOccurred(): boolean;
+    getException(): SyntaxErrorException;
+}

package/dist/IfcExpression.d.ts

@@ -0,0 +1,9 @@
+import { ErrorListener, Token } from "antlr4";
+import { IfcExpressionContext } from "./context/IfcExpressionContext";
+import { LiteralValueAnyArity } from "./context/value/LiteralValueAnyArity";
+import { ExprContext } from "../generated/parser/IfcExpressionParser";
+export declare class IfcExpression {
+    static parse(input: string, errorListener?: ErrorListener<Token>): ExprContext;
+    static evaluate(expression: string, context: IfcExpressionContext): LiteralValueAnyArity;
+    private static extractExprTree;
+}

package/dist/SyntaxErrorException.d.ts

@@ -0,0 +1,10 @@
+import { Token } from "antlr4";
+export declare class SyntaxErrorException extends Error {
+    private readonly _offendingSymbol;
+    private readonly _line;
+    private readonly _column;
+    constructor(offendingSymbol: Token, line: number, column: number, msg: string);
+    get offendingSymbol(): Token;
+    get line(): number;
+    get column(): number;
+}

package/dist/cjs/IfcExpression.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IfcExpression = void 0;
+const antlr4_1 = require("antlr4");
+const ExprVisitor_1 = require("./ExprVisitor");
+const IfcErrorListener_1 = require("./IfcErrorListener");
+const utils_1 = require("./utils");
+const IfcExpressionParser_1 = __importDefault(require("../generated/parser/IfcExpressionParser"));
+const IfcExpressionLexer_1 = __importDefault(require("../generated/parser/IfcExpressionLexer"));
+class IfcExpression {
+    static parse(input, errorListener) {
+        const chars = new antlr4_1.CharStream(input); // replace this with a FileStream as required
+        const lexer = new IfcExpressionLexer_1.default(chars);
+        const tokens = new antlr4_1.CommonTokenStream(lexer);
+        const parser = new IfcExpressionParser_1.default(tokens);
+        if ((0, utils_1.notNullish)(errorListener)) {
+            parser.removeErrorListeners();
+            parser.addErrorListener(errorListener);
+        }
+        return parser.expr();
+    }
+    static evaluate(expression, context) {
+        const errorListener = new IfcErrorListener_1.IfcErrorListener();
+        const tree = IfcExpression.parse(expression, errorListener);
+        if (errorListener.isErrorOccurred()) {
+            throw errorListener.getException();
+        }
+        const parsedExpression = this.extractExprTree(tree);
+        return parsedExpression.evaluate(context);
+    }
+    static extractExprTree(tree) {
+        const visitor = new ExprVisitor_1.ExprVisitor();
+        return visitor.visit(tree);
+    }
+}
+exports.IfcExpression = IfcExpression;
+//# sourceMappingURL=IfcExpression.js.map

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function nullish(val: any): boolean;
+export declare function notNullish(val: any): boolean;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "ifc-expressions",
+  "version": "0.1.0",
+  "description": "Parsing and evaluation of IFC expressions",
+  "main": "dist/cjs/ifcExpression.js",
+  "module": "dist/mjs/ifcExpression.js",
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/ifcExpression.js",
+      "require": "./dist/cjs/ifcExpression.js"
+    }
+  },
+  "types": "./dist/ifcExpression.d.ts",
+  "files": [
+    "./dist/*"
+  ],
+  "engines": {
+    "node": ">=14.16"
+  },
+  "scripts": {
+    "build-complete": "npm run format-apply && npm run build && npm run test",
+    "build": "npm run clean && npm run make-parser && npm run transpile",
+    "clean": "gulp clean",
+    "make-parser": "cd src/grammar && java -jar ../../antlr4/antlr-4.13.0-complete.jar -Werror -Dlanguage=TypeScript -visitor IfcExpression.g4 -o ../../generated/parser",
+    "transpile": "gulp build",
+    "test": "jest --coverage",
+    "format-apply": "prettier --write .",
+    "lint": "eslint .",
+    "format-check": "prettier --check .",
+    "check": "npm run format-check && npm run lint"
+  },
+  "keywords": [
+    "MMS",
+    "Expressions",
+    "BIM",
+    "Merkmalservice",
+    "Formula"
+  ],
+  "dependencies": {
+    "antlr4": "^4.13.0",
+    "decimal.js": "^10.4.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.2",
+    "@typescript-eslint/eslint-plugin": "^5.60.0",
+    "@typescript-eslint/parser": "^5.60.0",
+    "del": "^7.0.0",
+    "eslint": "^8.43.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "gulp": "^4.0.2",
+    "gulp-typescript": "^6.0.0-alpha.1",
+    "gulp-uglify": "^3.0.2",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.8",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.1.3"
+  }
+}