Toy v1 parser implementation

CMakeLists.txt

@@ -13,7 +13,7 @@ if(POLICY CMP0148)
     cmake_policy(SET CMP0148 NEW)
 endif()
 
-project(cqasm C CXX)
+project(cqasm LANGUAGES C CXX)
 
 # If cqasm was already included elsewhere in the project, don't include it again.
 # There should be only one place for it and one version per project.

include/v3x/BuildTreeGenAstVisitor.hpp

@@ -10,6 +10,13 @@
 namespace cqasm::v3x::parser {
 
 class  BuildTreeGenAstVisitor : public BuildCustomAstVisitor {
+    /**
+     * Name of the file being parsed.
+     */
+    std::string file_name_;
+
+    std::int64_t get_integer_literal_value(antlr4::tree::TerminalNode *node);
+    double get_float_literal_value(antlr4::tree::TerminalNode *node);
 public:
     std::any visitProgram(CqasmParser::ProgramContext *context) override;
     std::any visitVersion(CqasmParser::VersionContext *context) override;
@@ -21,6 +28,9 @@ class  BuildTreeGenAstVisitor : public BuildCustomAstVisitor {
     std::any visitExpressionList(CqasmParser::ExpressionListContext *context) override;
     std::any visitExpression(CqasmParser::ExpressionContext *context) override;
     std::any visitIndex(CqasmParser::IndexContext *context) override;
+
+    explicit BuildTreeGenAstVisitor(const std::string &file_name = "<unknown>")
+    : file_name_{ file_name } {}
 };
 
 }  // namespace cqasm::v3x::parser

include/v3x/ScannerAntlr.hpp

@@ -22,8 +22,8 @@ class ScannerAntlr : public ScannerAdaptor {
     cqasm::v1x::parser::ParseResult parse_(antlr4::ANTLRInputStream &is);
 
 public:
-    explicit ScannerAntlr(std::unique_ptr<BuildCustomAstVisitor> build_visitor_up,
-                          std::unique_ptr<CustomErrorListener> error_listener_up);
+    ScannerAntlr(std::unique_ptr<BuildCustomAstVisitor> build_visitor_up,
+        std::unique_ptr<CustomErrorListener> error_listener_up);
 
     ~ScannerAntlr() override;
 
@@ -34,8 +34,8 @@ class ScannerAntlrFile : public ScannerAntlr {
     std::string file_path_;
 public:
     ScannerAntlrFile(std::unique_ptr<BuildCustomAstVisitor> build_visitor_up,
-                     std::unique_ptr<CustomErrorListener> error_listener_up,
-                     const std::string &file_path);
+        std::unique_ptr<CustomErrorListener> error_listener_up,
+        const std::string &file_path);
 
     ~ScannerAntlrFile() override;
 
@@ -46,8 +46,8 @@ class ScannerAntlrString : public ScannerAntlr {
     std::string data_;
 public:
     ScannerAntlrString(std::unique_ptr<BuildCustomAstVisitor> build_visitor_up,
-                       std::unique_ptr<CustomErrorListener> error_listener_up,
-                       const std::string &data);
+        std::unique_ptr<CustomErrorListener> error_listener_up,
+        const std::string &data);
 
     ~ScannerAntlrString() override;
 

res/v1x/toy-v1x-parsing/expression/out_of_range_float_literal/ast.golden.txt

@@ -0,0 +1,2 @@
+ERROR
+input.cq:2:2: value '1.79769313486231570e+309' is out of the FLOATING_LITERAL range

res/v1x/toy-v1x-parsing/expression/out_of_range_float_literal/input.cq

@@ -0,0 +1,2 @@
+version 3
+x 1.79769313486231570e+309    # biggest double is 1.79769313486231570e+308

res/v1x/toy-v1x-parsing/expression/out_of_range_integer_literal/ast.golden.txt

@@ -0,0 +1,2 @@
+ERROR
+input.cq:2:2: value '18446744073709551616' is out of the INTEGER_LITERAL range

res/v1x/toy-v1x-parsing/expression/out_of_range_integer_literal/input.cq

@@ -0,0 +1,2 @@
+version 3
+x 18446744073709551616  # biggest 64-bit integer is 18446744073709551615

src/CMakeLists.txt

@@ -44,7 +44,7 @@ include(FetchContent)
 # This exposes the generate_tree() function.
 FetchContent_Declare(tree-gen
     GIT_REPOSITORY https://github.com/QuTech-Delft/tree-gen.git
-    GIT_TAG "64819883ff88d4bfa5ec160df86e6c9167c97a7e"
+    GIT_TAG "6a1339ea1ccb74b5ded2a86405a9143c7ef1a067"
 )
 FetchContent_MakeAvailable(tree-gen)
 

src/v3x/BuildTreeGenAstVisitor.cpp

@@ -3,7 +3,7 @@
 #include "v3x/BuildTreeGenAstVisitor.hpp"
 
 #include <algorithm>  // for_each
-#include <cassert>  // assert
+#include <antlr4-runtime.h>
 #include <stdexcept>  // runtime_error
 #include <string>  // stod, stoll
 
@@ -13,12 +13,40 @@ namespace cqasm::v3x::parser {
 using namespace cqasm::v1x::ast;
 using namespace cqasm::error;
 
-std::int64_t get_integer_literal_value(antlr4::tree::TerminalNode *node) {
-    return std::stoll(node->getText());
+std::int64_t BuildTreeGenAstVisitor::get_integer_literal_value(antlr4::tree::TerminalNode *node) {
+    auto text = node->getText();
+    std::int64_t ret{};
+    try {
+        ret = std::stoll(text);
+    } catch (std::out_of_range&) {
+        const auto &token = node->getSymbol();
+        throw std::runtime_error{
+            fmt::format("{}:{}:{}: value '{}' is out of the INTEGER_LITERAL range",
+                file_name_,
+                token->getLine(),
+                token->getCharPositionInLine(),
+                text
+        )};
+    }
+    return ret;
 }
 
-double get_float_literal_value(antlr4::tree::TerminalNode *node) {
-    return std::stod(node->getText());
+double BuildTreeGenAstVisitor::get_float_literal_value(antlr4::tree::TerminalNode *node) {
+    auto text = node->getText();
+    double ret{};
+    try {
+        ret = std::stod(text);
+    } catch (std::out_of_range&) {
+        const auto &token = node->getSymbol();
+        throw std::runtime_error{
+            fmt::format("{}:{}:{}: value '{}' is out of the FLOATING_LITERAL range",
+                file_name_,
+                token->getLine(),
+                token->getCharPositionInLine(),
+                text
+        )};
+    }
+    return ret;
 }
 
 std::any BuildTreeGenAstVisitor::visitProgram(CqasmParser::ProgramContext *context) {
@@ -38,7 +66,7 @@ std::any BuildTreeGenAstVisitor::visitProgram(CqasmParser::ProgramContext *conte
 std::any BuildTreeGenAstVisitor::visitVersion(CqasmParser::VersionContext *context) {
     auto ret = cqasm::tree::make<Version>();
     const auto& integer_literals = context->INTEGER_LITERAL();
-    std::for_each(integer_literals.begin(), integer_literals.end(), [&ret](auto *integer_literal_node) {
+    std::for_each(integer_literals.begin(), integer_literals.end(), [this, &ret](auto *integer_literal_node) {
         auto number = get_integer_literal_value(integer_literal_node);
         ret->items.push_back(number);
     });

src/v3x/ScannerAntlr.cpp

@@ -16,7 +16,7 @@ namespace cqasm::v3x::parser {
 ScannerAdaptor::~ScannerAdaptor() {}
 
 ScannerAntlr::ScannerAntlr(std::unique_ptr<BuildCustomAstVisitor> build_visitor_up,
-                           std::unique_ptr<CustomErrorListener> error_listener_up)
+    std::unique_ptr<CustomErrorListener> error_listener_up)
 : build_visitor_up_{ std::move(build_visitor_up) }
 , error_listener_up_{std::move(error_listener_up)} {}
 
@@ -26,23 +26,26 @@ cqasm::v1x::parser::ParseResult ScannerAntlr::parse_(antlr4::ANTLRInputStream &i
     CqasmLexer lexer{ &is };
     lexer.removeErrorListeners();
     lexer.addErrorListener(error_listener_up_.get());
+
     antlr4::CommonTokenStream tokens{ &lexer };
+
     CqasmParser parser{ &tokens };
     parser.removeErrorListeners();
     parser.addErrorListener(error_listener_up_.get());
+
     auto ast = parser.program();
     auto custom_ast = build_visitor_up_->visitProgram(ast);
     return cqasm::v1x::parser::ParseResult{
-        std::any_cast<cqasm::v1x::ast::One<cqasm::v1x::ast::Program>> (custom_ast),  // root
+        std::any_cast<cqasm::v1x::ast::One<cqasm::v1x::ast::Program>>(custom_ast),  // root
         {}  // error
     };
 }
 
 ScannerAntlrFile::ScannerAntlrFile(std::unique_ptr<BuildCustomAstVisitor> build_visitor_up,
-                                   std::unique_ptr<CustomErrorListener> error_listener_up,
-                                   const std::string &file_path)
+    std::unique_ptr<CustomErrorListener> error_listener_up,
+    const std::string &file_path)
 : ScannerAntlr{ std::move(build_visitor_up) , std::move(error_listener_up) }
-, file_path_{file_path } {
+, file_path_{ file_path } {
     if (!fs::exists(file_path_) || !fs::is_regular_file(file_path_)) {
         throw cqasm::error::AnalysisError{ fmt::format("ScannerAntlrFile couldn't access file '{}'.", file_path_) };
     }
@@ -57,8 +60,8 @@ cqasm::v1x::parser::ParseResult ScannerAntlrFile::parse() {
 }
 
 ScannerAntlrString::ScannerAntlrString(std::unique_ptr<BuildCustomAstVisitor> build_visitor_up,
-                                       std::unique_ptr<CustomErrorListener> error_listener_up,
-                                       const std::string &data)
+    std::unique_ptr<CustomErrorListener> error_listener_up,
+    const std::string &data)
 : ScannerAntlr{ std::move(build_visitor_up), std::move(error_listener_up) }
 , data_{ data } {}
 

src/v3x/cqasm-parse-helper.cpp

@@ -16,7 +16,7 @@ namespace cqasm::v3x::parser {
  * A file_name may be given in addition for use within error messages.
  */
 cqasm::v1x::parser::ParseResult parse_file(const std::string &file_path, const std::string &file_name) {
-    auto builder_visitor_up = std::make_unique<BuildTreeGenAstVisitor>();
+    auto builder_visitor_up = std::make_unique<BuildTreeGenAstVisitor>(file_name);
     auto error_listener_up = std::make_unique<CustomErrorListener>(file_name);
     auto scanner_up = std::make_unique<ScannerAntlrFile>(
             std::move(builder_visitor_up), std::move(error_listener_up), file_path);
@@ -28,7 +28,7 @@ cqasm::v1x::parser::ParseResult parse_file(const std::string &file_path, const s
  * A file_name may be given in addition for use within error messages.
  */
 cqasm::v1x::parser::ParseResult parse_string(const std::string &data, const std::string &file_name) {
-    auto builder_visitor_up = std::make_unique<BuildTreeGenAstVisitor>();
+    auto builder_visitor_up = std::make_unique<BuildTreeGenAstVisitor>(file_name);
     auto error_listener_up = std::make_unique<CustomErrorListener>(file_name);
     auto scanner_up = std::make_unique<ScannerAntlrString>(
             std::move(builder_visitor_up), std::move(error_listener_up), data);