Working on better diagnostic handling for qasm3 conversion.

openqasm · Mar 15, 2024 · bd45ac3 · bd45ac3
1 parent f7bd2b1
commit bd45ac3
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/include/API/errors.h b/include/API/errors.h
@@ -21,6 +21,8 @@
 #ifndef QSS_COMPILER_ERROR_H
 #define QSS_COMPILER_ERROR_H
 
+#include "mlir/IR/Diagnostics.h"
+
 #include "llvm/Support/Error.h"
 
 #include <functional>
@@ -71,6 +73,22 @@ struct Diagnostic {
   std::string toString() const;
 };
 
+/// MLIR diagnostic that contains a QSSC diagnostic and will
+/// automatically be deduced by the qss-compiler and its
+/// diagnostic APIs when used in conjunction with MLIR's
+/// in-flight diagnostic APIs.
+class MLIRQSSCDiagnostic : public mlir::Diagnostic {
+  public:
+    MLIRQSSCDiagnostic(mlir::Location loc, mlir::DiagnosticSeverity severity, ErrorCategory qsscErrorCategory)
+       : mlir::Diagnostic(loc, severity), qsscErrorCategory(qsscErrorCategory) {}
+    ErrorCategory getQSSCErrorCategory() { return qsscErrorCategory; }
+
+    private:
+      ErrorCategory qsscErrorCategory;
+
+};
+
+
 using DiagList = std::list<Diagnostic>;
 using DiagRefList = std::list<std::reference_wrapper<const Diagnostic>>;
 using DiagnosticCallback = std::function<void(const Diagnostic &)>;

diff --git a/include/Frontend/OpenQASM3/QUIRGenQASM3Visitor.h b/include/Frontend/OpenQASM3/QUIRGenQASM3Visitor.h
@@ -17,6 +17,8 @@
 #ifndef VISITOR_QUIR_GEN_VISITOR_H
 #define VISITOR_QUIR_GEN_VISITOR_H
 
+#include "API/errors.h"
+
 #include "Dialect/QUIR/IR/QUIRDialect.h"
 #include "Dialect/QUIR/IR/QUIREnums.h"
 #include "Dialect/QUIR/IR/QUIROps.h"
@@ -97,7 +99,8 @@ class QUIRGenQASM3Visitor : public BaseQASM3Visitor {
   ///
   /// \returns an in-flight diagnostic that allows adding messages and notes.
   mlir::InFlightDiagnostic reportError(QASM::ASTBase const *location,
-                                       mlir::DiagnosticSeverity severity);
+                                       mlir::DiagnosticSeverity severity,
+                                       qssc::ErrorCategory category = qssc::ErrorCategory::OpenQASM3UnsupportedInput);
 
   template <class MLIROp>
   ExpressionValueType buildUnaryOp(llvm::StringRef name,

diff --git a/lib/Frontend/OpenQASM3/QUIRGenQASM3Visitor.cpp b/lib/Frontend/OpenQASM3/QUIRGenQASM3Visitor.cpp
@@ -335,13 +335,17 @@ mlir::LogicalResult QUIRGenQASM3Visitor::walkAST() {
 
 mlir::InFlightDiagnostic
 QUIRGenQASM3Visitor::reportError(ASTBase const *location,
-                                 mlir::DiagnosticSeverity severity) {
+                                 mlir::DiagnosticSeverity severity, qssc::ErrorCategory qsscErrorCategory) {
 
   DiagnosticEngine &engine = builder.getContext()->getDiagEngine();
 
   if (severity == mlir::DiagnosticSeverity::Error)
     hasFailed = true;
-  return engine.emit(getLocation(location), severity);
+
+  // Create a MLIRQSSCDiagnostic such that the diagnostic will be properly reported by the
+  // compilers diagnostic handling APIs.
+  auto diagnostic = qssc::MLIRQSSCDiagnostic(getLocation(location), severity, qsscErrorCategory);
+  return engine.emit(std::move(diagnostic));
 }
 
 void QUIRGenQASM3Visitor::visit(const ASTForStatementNode *node) {