V3 Extended: Functions

include/cqasm-annotations.hpp

@@ -15,48 +15,72 @@ namespace cqasm::annotations {
 /**
  * Source location annotation object, containing source file line numbers etc.
  */
-class SourceLocation {
-public:
+struct SourceLocation {
     /**
-     * The name of the source file.
+     * An index within a source location.
+     * An index is defined by a line and a column.
      */
-    std::optional<std::string> file_name;
+    struct Index {
+        std::uint32_t line = 0;
+        std::uint32_t column = 0;
 
-    /**
-     * The first line of the range, or 0 if unknown.
-     */
-    std::uint32_t first_line;
+        bool operator==(const Index &other) const = default;
+        auto operator<=>(const Index &other) const = default;
+    };
 
     /**
-     * The first column of the range, or 0 if unknown.
+     * A range within a source location.
+     * A range is defined by a first and a last index.
      */
-    std::uint32_t first_column;
+    struct Range {
+        Index first;
+        Index last;
+
+        Range() = default;
+        Range(const Index &f, const Index &l);
+        Range(const Range &other) = default;
+        Range(Range &&other) noexcept = default;
+        Range& operator=(const Range &other) = default;
+        Range& operator=(Range &&other) noexcept = default;
+
+        bool operator==(const Range &other) const = default;
+        auto operator<=>(const Range &other) const = default;
+    };
 
     /**
-     * The last line of the range, or 0 if unknown.
+     * The name of the source file.
      */
-    std::uint32_t last_line;
+    std::optional<std::string> file_name;
 
     /**
-     * The last column of the range, or 0 if unknown.
+     * The source location range.
      */
-    std::uint32_t last_column;
+    Range range;
 
     /**
      * Constructs a source location object.
      */
-    explicit SourceLocation(
-        const std::optional<std::string> &file_name,
-        std::uint32_t first_line = 0,
-        std::uint32_t first_column = 0,
-        std::uint32_t last_line = 0,
-        std::uint32_t last_column = 0
-    );
+    SourceLocation() = default;
+    explicit SourceLocation(const std::optional<std::string> &file_name, const Range &range);
+    SourceLocation(const SourceLocation &other) = default;
+    SourceLocation(SourceLocation &&other) noexcept = default;
+    SourceLocation& operator=(const SourceLocation &other) = default;
+    SourceLocation& operator=(SourceLocation &&other) noexcept = default;
+
+    bool operator==(const SourceLocation &other) const = default;
+    // Some versions of clang still do not implement operator<=> for std::optional
+    // So they will complain if we try to define a default operator<=> on a struct that contains a std::optional
+    // This implementation just does not check the optional file_name
+    // Instead, it just assumes that, when comparing source locations, the file_name will be the same
+    // This will always be the case if we are just parsing or analyzing a file or a string
+    auto operator<=>(const SourceLocation &other) const {
+        return range <=> other.range;
+    }
 
     /**
      * Expands the location range to contain the given location in the source file.
      */
-    void expand_to_include(std::uint32_t line, std::uint32_t column = 1);
+    void expand_to_include(const Index &last);
 };
 
 /**

include/cqasm-error.hpp

@@ -65,10 +65,7 @@ class Error : public std::runtime_error {
     Error(
         const std::string &message,
         const std::optional<std::string> &file_name,
-        std::uint32_t first_line,
-        std::uint32_t first_column,
-        std::uint32_t last_line,
-        std::uint32_t last_column);
+        const annotations::SourceLocation::Range &range);
 
     /**
      * Sets the context of this error to the SourceLocation annotation of the given node,

include/cqasm-overload.hpp

@@ -19,6 +19,11 @@ namespace cqasm::overload {
 struct NameResolutionFailure : public std::exception {};
 struct OverloadResolutionFailure : public std::exception {};
 
+
+//----------//
+// Overload //
+//----------//
+
 /**
  * Represents a possible overload for the parameter types of a function, gate, or error model.
  * T is some tag type identifying the overload.
@@ -60,6 +65,11 @@ class Overload {
     }
 };
 
+
+//------------------//
+// OverloadResolver //
+//------------------//
+
 /**
  * Represents a set of possible overloads for the parameter types of a function, gate, or error model.
  * T is some tag type identifying the overload.
@@ -116,6 +126,11 @@ class OverloadResolver {
     }
 };
 
+
+//----------------------//
+// OverloadNameResolver //
+//----------------------//
+
 /**
  * Table of overloaded callables with case-sensitive identifier matching.
  * T is the tag type of the callable/overload pair.
@@ -141,8 +156,7 @@ class OverloadedNameResolver {
      * so more specific overloads should always be added last.
      */
     virtual void add_overload(const std::string &name, const T &tag, const Types &param_types) {
-        auto entry = table.find(name);
-        if (entry == table.end()) {
+        if (auto entry = table.find(name); entry == table.end()) {
             auto resolver = OverloadResolver<T, TypeBase, Node>();
             resolver.add_overload(tag, param_types);
             table.insert(std::pair<std::string, OverloadResolver<T, TypeBase, Node>>(name, std::move(resolver)));
@@ -159,12 +173,10 @@ class OverloadedNameResolver {
      * the appropriately promoted vector of value pointers.
      */
     [[nodiscard]] virtual std::pair<T, Values> resolve(const std::string &name, const Values &args) {
-        auto entry = table.find(name);
-        if (entry == table.end()) {
-            throw NameResolutionFailure{};
-        } else {
+        if (auto entry = table.find(name); entry != table.end()) {
             return entry->second.resolve(args);
         }
+        throw NameResolutionFailure{};
     }
 };
 

include/cqasm-tree.hpp

@@ -7,12 +7,11 @@
 #include "tree-annotatable.hpp"
 #include "tree-base.hpp"
 
-namespace cqasm {
 
 /**
  * Namespace for wrapping tree-gen's support library.
  */
-namespace tree {
+namespace cqasm::tree {
 
 using signed_size_t = ::tree::signed_size_t;
 
@@ -45,5 +44,4 @@ One<T> make(Args... args) {
     return One<T>(std::make_shared<T>(args...));
 }
 
-} // namespace tree
-} // namespace cqasm
+} // namespace cqasm::tree

include/v10/qasm_new_to_old.hpp

@@ -335,7 +335,7 @@ static void handle_parse_result(QasmRepresentation &qasm, cq1x::parser::ParseRes
         if (!subcircuit->name.empty()) {
             int line_number = 0;
             if (auto loc = subcircuit->get_annotation_ptr<cq1x::parser::SourceLocation>()) {
-                line_number = static_cast<int>(loc->first_line);
+                line_number = static_cast<int>(loc->range.first.line);
             }
             auto subcircuit_sp{ std::make_shared<SubCircuit>(
                 subcircuit->name.c_str(),
@@ -368,7 +368,7 @@ static void handle_parse_result(QasmRepresentation &qasm, cq1x::parser::ParseRes
                 if (!opclus) {
                     int line_number = 0;
                     if (auto loc = instruction->get_annotation_ptr<cq1x::parser::SourceLocation>()) {
-                        line_number = static_cast<int>(loc->first_line);
+                        line_number = static_cast<int>(loc->range.first.line);
                     }
                     opclus = std::make_shared<OperationsCluster>(op, line_number);
                 } else {