qasm-ts 1.1.2 → 2.0.0

package/.eslintrc.json

@@ -0,0 +1,13 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "no-control-regex": 0
+  }
+}

package/dist/errors.js

@@ -14,8 +14,8 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-exports.__esModule = true;
-exports.MissingSemicolonError = exports.BadParameterError = exports.BadEqualsError = exports.BadGateError = exports.BadMeasurementError = exports.BadBarrierError = exports.BadConditionalError = exports.BadQregError = exports.BadCregError = exports.BadArgumentError = void 0;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadQuantumInstructionError = exports.BadLoopError = exports.BadSubroutineError = exports.BadExpressionError = exports.BadClassicalTypeError = exports.BadStringLiteralError = exports.UnsupportedOpenQASMVersionError = exports.MissingBraceError = exports.MissingSemicolonError = exports.BadParameterError = exports.BadEqualsError = exports.BadGateError = exports.BadMeasurementError = exports.BadBarrierError = exports.BadConditionalError = exports.BadQregError = exports.BadCregError = exports.BadIncludeError = exports.BadArgumentError = void 0;
 /** Class representing a bad argument exception. */
 var BadArgumentError = /** @class */ (function (_super) {
     __extends(BadArgumentError, _super);
@@ -29,6 +29,19 @@ var BadArgumentError = /** @class */ (function (_super) {
     return BadArgumentError;
 }(Error));
 exports.BadArgumentError = BadArgumentError;
+/** Class representing a bad include statement */
+var BadIncludeError = /** @class */ (function (_super) {
+    __extends(BadIncludeError, _super);
+    function BadIncludeError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = BadIncludeError.name;
+        return _this;
+    }
+    return BadIncludeError;
+}(Error));
+exports.BadIncludeError = BadIncludeError;
 /** Class representing a bad quantum register exception. */
 var BadQregError = /** @class */ (function (_super) {
     __extends(BadQregError, _super);
@@ -146,3 +159,107 @@ var MissingSemicolonError = /** @class */ (function (_super) {
     return MissingSemicolonError;
 }(Error));
 exports.MissingSemicolonError = MissingSemicolonError;
+/** Class representing a missing opening or closing parenthesis, bracket, or curly brakcet. */
+var MissingBraceError = /** @class */ (function (_super) {
+    __extends(MissingBraceError, _super);
+    function MissingBraceError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = MissingSemicolonError.name;
+        return _this;
+    }
+    return MissingBraceError;
+}(Error));
+exports.MissingBraceError = MissingBraceError;
+/** Class representing an unsupported OpenQASM version exception. */
+var UnsupportedOpenQASMVersionError = /** @class */ (function (_super) {
+    __extends(UnsupportedOpenQASMVersionError, _super);
+    function UnsupportedOpenQASMVersionError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = UnsupportedOpenQASMVersionError.name;
+        return _this;
+    }
+    return UnsupportedOpenQASMVersionError;
+}(Error));
+exports.UnsupportedOpenQASMVersionError = UnsupportedOpenQASMVersionError;
+/** Class representing an error parsing an expected string literal. */
+var BadStringLiteralError = /** @class */ (function (_super) {
+    __extends(BadStringLiteralError, _super);
+    function BadStringLiteralError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = BadStringLiteralError.name;
+        return _this;
+    }
+    return BadStringLiteralError;
+}(Error));
+exports.BadStringLiteralError = BadStringLiteralError;
+/** Class representing an error parsing scalar types. */
+var BadClassicalTypeError = /** @class */ (function (_super) {
+    __extends(BadClassicalTypeError, _super);
+    function BadClassicalTypeError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = BadClassicalTypeError.name;
+        return _this;
+    }
+    return BadClassicalTypeError;
+}(Error));
+exports.BadClassicalTypeError = BadClassicalTypeError;
+/** Class representing an error parsing an expression. */
+var BadExpressionError = /** @class */ (function (_super) {
+    __extends(BadExpressionError, _super);
+    function BadExpressionError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = BadExpressionError.name;
+        return _this;
+    }
+    return BadExpressionError;
+}(Error));
+exports.BadExpressionError = BadExpressionError;
+/** Class representing an error in defining or calling a custom subroutine. */
+var BadSubroutineError = /** @class */ (function (_super) {
+    __extends(BadSubroutineError, _super);
+    function BadSubroutineError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = BadSubroutineError.name;
+        return _this;
+    }
+    return BadSubroutineError;
+}(Error));
+exports.BadSubroutineError = BadSubroutineError;
+/** Class representing a bad loop statement declaration. */
+var BadLoopError = /** @class */ (function (_super) {
+    __extends(BadLoopError, _super);
+    function BadLoopError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = BadLoopError.name;
+        return _this;
+    }
+    return BadLoopError;
+}(Error));
+exports.BadLoopError = BadLoopError;
+/** Class representing a bad quantum instruction. */
+var BadQuantumInstructionError = /** @class */ (function (_super) {
+    __extends(BadQuantumInstructionError, _super);
+    function BadQuantumInstructionError(message) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.name = BadQuantumInstructionError.name;
+        return _this;
+    }
+    return BadQuantumInstructionError;
+}(Error));
+exports.BadQuantumInstructionError = BadQuantumInstructionError;

package/dist/lexer.js

@@ -1,300 +1,45 @@
 "use strict";
-exports.__esModule = true;
-var token_1 = require("./token");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lex = lex;
+var lexer_1 = require("./qasm2/lexer");
+var lexer_2 = require("./qasm3/lexer");
+var version_1 = require("./version");
 var errors_1 = require("./errors");
-/**
- * Returns whether a given character could be an element of a numeric value.
- * @param c - The character.
- * @return Whether the character is numeric.
- */
-function isNumeric(c) {
-    return (c == '.') || !isNaN(parseInt(c));
-}
-/**
- * Returns whether a given character is a letter.
- * @param c - The character.
- * @return Whether the character is a letter.
- */
-function isLetter(c) {
-    if (c.match(/[a-z]/i)) {
-        return true;
+function lex(qasm, cursor, version) {
+    var lexer;
+    if (version instanceof version_1.OpenQASMVersion) {
+        switch (version.major) {
+            case version_1.OpenQASMMajorVersion.Version2:
+                lexer = new lexer_1.default(qasm, cursor);
+                break;
+            case version_1.OpenQASMMajorVersion.Version3:
+                lexer = new lexer_2.default(qasm, cursor);
+                break;
+            default:
+                throw new errors_1.UnsupportedOpenQASMVersionError("Unsupported OpenQASM version detected: ".concat(version.major));
+        }
     }
-    return false;
-}
-/**
- * Returns whether a given character is alphanumeric.
- * @param c - The character.
- * @return Whether the character is alphanumeric.
- */
-function isAlpha(c) {
-    if (c.match(/^[0-9a-zA-Z]+$/)) {
-        return true;
+    else if (typeof version === "number") {
+        switch (version) {
+            case 2:
+                lexer = new lexer_1.default(qasm, cursor);
+                break;
+            case 3:
+                lexer = new lexer_2.default(qasm, cursor);
+                break;
+            default:
+                throw new errors_1.UnsupportedOpenQASMVersionError("Unsupported OpenQASM version detected: ".concat(version));
+        }
     }
-    return false;
-}
-/**
- * Returns whether a given character is a newline character.
- * @param c - The character.
- * @return Whether the character is a newline.
- */
-function isNewline(c) {
-    if (c.match(/\n|\r(?!\n)|\u2028|\u2029|\r\n/g)) {
-        return true;
+    else if (version === version_1.OpenQASMMajorVersion.Version2) {
+        lexer = new lexer_1.default(qasm, cursor);
     }
-    return false;
-}
-/** Class representing a lexer. */
-var Lexer = /** @class */ (function () {
-    /**
-     * Creates a lexer.
-     * @param input - The string to lex.
-     * @param cursor - The starting cursor position.
-     */
-    function Lexer(input, cursor) {
-        var _this = this;
-        if (cursor === void 0) { cursor = 0; }
-        this.verifyInput = function () {
-            var lines = _this.input.split(/\n|\r(?!\n)|\u2028|\u2029|\r\n/g);
-            for (var i = 0; i < lines.length; i++) {
-                if (!lines[i].startsWith('//')
-                    && !(lines[i].length == 0)
-                    && !(lines[i].includes('gate'))
-                    && !(lines[i].trim() == '{' || lines[i].trim() == '}')
-                    && !lines[i].includes(';')) {
-                    return false;
-                }
-            }
-            return true;
-        };
-        /**
-         * Calling this method lexes the code represented by the provided string.
-         * @return An array of tokens and their corresponding values.
-         */
-        this.lex = function () {
-            var tokens = [];
-            var token;
-            if (!_this.verifyInput()) {
-                throw errors_1.MissingSemicolonError;
-            }
-            while (_this.cursor < _this.input.length) {
-                token = _this.nextToken();
-                if (token) {
-                    tokens.push(token);
-                }
-            }
-            return tokens;
-        };
-        /**
-        * Reads a character and advances the cursor.
-        * @param num - Optional cursor position modifier.
-        */
-        this.readChar = function (num) {
-            if (num === void 0) { num = 1; }
-            _this.cursor += num;
-            return _this.input[_this.cursor - num];
-        };
-        /**
-         * Advances the cusor past the next comment.
-         */
-        this.skipComment = function () {
-            var char = '';
-            while (!isNewline(char)) {
-                char = _this.readChar();
-            }
-        };
-        /**
-         * Determines whether the next character to process equals a given character.
-         * @param c - The given character.
-         * @return Whether the next character equals the given character.
-         */
-        this.peekEq = function (c) { return (_this.peek() == c); };
-        /**
-         * Reads a character without advancing the cursor.
-         * @param index - Optional peek position offset.
-         */
-        this.peek = function () { return _this.input[_this.cursor]; };
-        /**
-         * Reads a numeric value.
-         * @return The numeric value as a string.
-         */
-        this.readNumeric = function () {
-            var num = '';
-            while (isNumeric(_this.peek())) {
-                num += _this.readChar();
-            }
-            return num;
-        };
-        /**
-         * Reads an identifier.
-         * @return The identifier as a string.
-         */
-        this.readIdentifier = function () {
-            var id = '';
-            while (isAlpha(_this.peek())) {
-                id += _this.readChar();
-            }
-            return id;
-        };
-        /**
-         * Reads a string literal.
-         * @param terminator - The literal's termination character.
-         * @return The literal as a string.
-         */
-        this.readStringLiteral = function (terminator) {
-            var lit = '';
-            var char = '';
-            while (!(terminator == char)) {
-                char = _this.readChar();
-                lit += char;
-            }
-            return lit;
-        };
-        /**
-         * Advances the cusor past the next block of whitespace.
-         */
-        this.skipWhitespace = function () {
-            while (' \t\n\r\v'.indexOf(_this.peek()) > -1) {
-                _this.cursor += 1;
-            }
-            return null;
-        };
-        /**
-         * Lexes the next token.
-         * @return The next token and its corresponding value.
-         */
-        this.nextToken = function () {
-            _this.skipWhitespace();
-            if (_this.cursor == _this.input.length) {
-                return [token_1.Token.EndOfFile];
-            }
-            var char = _this.peek();
-            _this.readChar();
-            switch (char) {
-                case '=':
-                    if (_this.peekEq('=')) {
-                        _this.readChar();
-                        return [token_1.Token.Equals];
-                    }
-                    else {
-                        throw errors_1.BadEqualsError;
-                    }
-                case '-':
-                    if (_this.peekEq('>')) {
-                        _this.readChar();
-                        return [token_1.Token.Arrow];
-                    }
-                    else {
-                        return [token_1.Token.Minus];
-                    }
-                case '+':
-                    return [token_1.Token.Plus];
-                case '*':
-                    return [token_1.Token.Times];
-                case '^':
-                    return [token_1.Token.Power];
-                case ';':
-                    return [token_1.Token.Semicolon];
-                case ',':
-                    return [token_1.Token.Comma];
-                case '(':
-                    return [token_1.Token.LParen];
-                case '[':
-                    return [token_1.Token.LSParen];
-                case '{':
-                    return [token_1.Token.LCParen];
-                case ')':
-                    return [token_1.Token.RParen];
-                case ']':
-                    return [token_1.Token.RSParen];
-                case '}':
-                    return [token_1.Token.RCParen];
-                case '/':
-                    if (_this.peekEq('/')) {
-                        _this.skipComment();
-                        return;
-                    }
-                    else {
-                        return [token_1.Token.Divide];
-                    }
-                case 'g':
-                    if ((_this.input[_this.cursor] == 'a')
-                        && (_this.input[_this.cursor + 1] == 't')
-                        && (_this.input[_this.cursor + 2] == 'e')) {
-                        _this.readChar(3);
-                        return [token_1.Token.Gate];
-                    }
-                    var literal = char + _this.readIdentifier();
-                    return [token_1.lookup(literal), new String(literal)];
-                case 'q':
-                    if ((_this.input[_this.cursor] == 'r')
-                        && (_this.input[_this.cursor + 1] == 'e')
-                        && (_this.input[_this.cursor + 2] == 'g')) {
-                        _this.readChar(3);
-                        return [token_1.Token.QReg];
-                    }
-                    var qregLit = char + _this.readIdentifier();
-                    return [token_1.lookup(qregLit), new String(qregLit)];
-                case 'c':
-                    if ((_this.input[_this.cursor] == 'r')
-                        && (_this.input[_this.cursor + 1] == 'e')
-                        && (_this.input[_this.cursor + 2] == 'g')) {
-                        _this.readChar(3);
-                        return [token_1.Token.QReg];
-                    }
-                    var cregLit = char + _this.readIdentifier();
-                    return [token_1.lookup(cregLit), new String(cregLit)];
-                case 'b':
-                    if ((_this.input[_this.cursor] == 'a')
-                        && (_this.input[_this.cursor + 1] == 'r')
-                        && (_this.input[_this.cursor + 2] == 'r')
-                        && (_this.input[_this.cursor + 3] == 'i')
-                        && (_this.input[_this.cursor + 4] == 'e')
-                        && (_this.input[_this.cursor + 5] == 'r')) {
-                        _this.readChar(6);
-                        return [token_1.Token.Barrier];
-                    }
-                    var barLit = char + _this.readIdentifier();
-                    return [token_1.lookup(barLit), new String(barLit)];
-                case 'm':
-                    if ((_this.input[_this.cursor] == 'e')
-                        && (_this.input[_this.cursor + 1] == 'a')
-                        && (_this.input[_this.cursor + 2] == 's')
-                        && (_this.input[_this.cursor + 3] == 'u')
-                        && (_this.input[_this.cursor + 4] == 'r')
-                        && (_this.input[_this.cursor + 5] == 'e')) {
-                        _this.readChar(6);
-                        return [token_1.Token.Measure];
-                    }
-                    var measureLit = char + _this.readIdentifier();
-                    return [token_1.lookup(measureLit), new String(measureLit)];
-                case '\"':
-                    var stringLiteral = char + _this.readStringLiteral('\"');
-                    return [token_1.Token.String, new String(stringLiteral)];
-                case '\’':
-                    var singleStringLiteral = char + _this.readStringLiteral('\’');
-                    return [token_1.Token.String, new String(singleStringLiteral)];
-                default:
-                    if (isLetter(char)) {
-                        var literal_1 = char + _this.readIdentifier();
-                        return [token_1.lookup(literal_1), new String(literal_1)];
-                    }
-                    else if (isNumeric(char)) {
-                        var num = char + _this.readNumeric();
-                        if (num.indexOf('.') != -1) {
-                            return [token_1.Token.Real, parseFloat(num)];
-                        }
-                        else {
-                            return [token_1.Token.NNInteger, parseFloat(num)];
-                        }
-                    }
-                    else {
-                        return [token_1.Token.Illegal];
-                    }
-            }
-        };
-        this.input = input;
-        this.cursor = cursor;
+    else if (version === version_1.OpenQASMMajorVersion.Version3) {
+        lexer = new lexer_2.default(qasm, cursor);
+    }
+    else {
+        lexer = new lexer_2.default(qasm, cursor);
     }
-    return Lexer;
-}());
-exports["default"] = Lexer;
+    var tokens = lexer.lex();
+    return tokens;
+}

package/dist/main.js

@@ -1,18 +1,31 @@
 "use strict";
-exports.__esModule = true;
-var parser_1 = require("./parser");
-var lexer_1 = require("./lexer");
+/* eslint-disable  @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseString = parseString;
+exports.parseFile = parseFile;
 var fs = require("fs");
+var lexer_1 = require("./lexer");
+var parser_1 = require("./parser");
 /**
  * Returns the abstract syntax tree for a given string of QASM code.
  * @param qasm - The code string.
  * @return The corresponding AST.
  */
-function parseString(qasm) {
-    var lexer = new lexer_1["default"](qasm, 0);
-    var tokens = lexer.lex();
-    var parser = new parser_1["default"](tokens);
-    var ast = parser.parse();
+function parseString(qasm, version, verbose, stringify) {
+    var ast;
+    var tokens = (0, lexer_1.lex)(qasm, undefined, version);
+    ast = (0, parser_1.parse)(tokens, version);
+    if (verbose === true) {
+        if (stringify === true) {
+            ast = JSON.stringify(getDetailedOutput(ast), null, 2);
+        }
+        ast = getDetailedOutput(ast);
+    }
+    else {
+        if (stringify === true) {
+            ast = JSON.stringify(ast, null, 2);
+        }
+    }
     return ast;
 }
 /**
@@ -20,7 +33,24 @@ function parseString(qasm) {
  * @param file - The file location.
  * @return The corresponding AST.
  */
-exports.parse = function (file) {
-    return parseString(fs.readFileSync(file, 'utf8'));
-};
-exports.parseString = parseString;
+function parseFile(file, version, verbose, stringify) {
+    return parseString(fs.readFileSync(file, "utf8"), version, verbose, stringify);
+}
+/** Adds class names to the ast. */
+function getDetailedOutput(object) {
+    if (Array.isArray(object)) {
+        return object.map(getDetailedOutput);
+    }
+    else if (object !== null && typeof object === "object") {
+        var result = {};
+        result["__className__"] = object.constructor.name;
+        for (var _i = 0, _a = Object.entries(object); _i < _a.length; _i++) {
+            var _b = _a[_i], key = _b[0], value = _b[1];
+            result[key] = getDetailedOutput(value);
+        }
+        return result;
+    }
+    else {
+        return object;
+    }
+}