Improve MoveGen diagnostics

Sources/Compiler/Target.swift

@@ -96,7 +96,10 @@ public class MoveTarget: Target {
       }
       exit(0)
     }
-    let generator = MoveGenerator(ast: irPreprocessOutcome.element, environment: environment)
+
+    let generator = MoveGenerator(ast: irPreprocessOutcome.element,
+                                  environment: environment,
+                                  sourceContext: sourceContext)
     return generator.generateCode()
   }
 }

Sources/MoveGen/AST/FunctionDeclaration.swift

@@ -120,7 +120,7 @@ extension AST.FunctionDeclaration {
     }
 
     let args: [FunctionArgument] = signature.parameters.map { parameter in
-      return FunctionArgument(.identifier(parameter.identifier))
+      FunctionArgument(.identifier(parameter.identifier))
     }
 
     let functionCallExpr: Expression = .functionCall(

Sources/MoveGen/Component/MoveSelf.swift

@@ -10,6 +10,7 @@ import Lexer
 import MoveIR
 import Source
 import AST
+import Diagnostic
 
 /// Generates code for a "self" expression.
 struct MoveSelf {
@@ -32,14 +33,21 @@ struct MoveSelf {
       fatalError("Unexpected token \(token.kind)")
     }
     guard !functionContext.isConstructor else {
-      print(#"""
-            \#u{001B}[1;38;5;196mMoveIR generation error:\#u{001B}[0m \#
-            `self' reference before all fields initialized in function `init' in \#(token.sourceLocation)
-            \#tCannot use `self' in a constructor before all attributes have been assigned to, \#
-            as some are still unitialized. This includes any method calls which could access instance fields.
-            \#tInstead try moving method calls to after all values have been initialized.
-            """#)
-      exit(1)
+      Diagnostics.add(Diagnostic(severity: .error,
+                                 sourceLocation: token.sourceLocation,
+                                 message: "`self' reference before all fields initialized in function `init'"))
+      Diagnostics.add(Diagnostic(severity: .note,
+                                 sourceLocation: token.sourceLocation,
+                                 message: #"""
+                                          Cannot use `self' in a constructor before all \#
+                                          attributes have been assigned to, \#
+                                          as some are still unitialised. This includes any \#
+                                          method calls which could access instance fields. \#
+
+                                          Instead try moving method calls to after all values \#
+                                          have been initialized.
+                                          """#))
+      Diagnostics.displayAndExit()
     }
 
     if position == .left {

Sources/MoveGen/Declaration/MoveVariableDeclaration.swift

@@ -8,6 +8,7 @@
 import Foundation
 import AST
 import MoveIR
+import Diagnostic
 
 /// Generates code for a variable declaration.
 struct MoveVariableDeclaration {
@@ -18,15 +19,12 @@ struct MoveVariableDeclaration {
         from: variableDeclaration.type.rawType,
         environment: functionContext.environment
     )?.render(functionContext: functionContext) else {
-      print("""
-            Cannot get variable declaration type from \(variableDeclaration.type.rawType) \
-            at position \(variableDeclaration.sourceLocation) for variable \(variableDeclaration.identifier.name).
-
-            \(functionContext.blockStack)
-
-            flintc internal error located at \(#file):\(#line)
-            """)
-      exit(1)
+      Diagnostics.add(Diagnostic(
+          severity: .error,
+          sourceLocation: variableDeclaration.sourceLocation,
+          message: "Cannot get variable declaration type from \(variableDeclaration.type.rawType)"
+      ))
+      Diagnostics.displayAndExit()
     }
     guard !variableDeclaration.identifier.isSelf else {
       return .variableDeclaration(MoveIR.VariableDeclaration((MoveSelf.name, typeIR)))

Sources/MoveGen/Diagnostics/Diagnostics.swift

@@ -0,0 +1,21 @@
+import Diagnostic
+import Foundation
+
+class Diagnostics {
+  public static var diagnostics: [Diagnostic] = []
+  public static var sourceContext: SourceContext? = nil
+
+  static func add(_ diagnostics: Diagnostic...) {
+    self.diagnostics.append(contentsOf: diagnostics)
+  }
+
+  static func display() {
+    try! print(DiagnosticsFormatter(diagnostics: diagnostics,
+                                    sourceContext: sourceContext!).rendered())
+  }
+
+  static func displayAndExit(code: Int32 = 1) -> Never {
+    display()
+    return exit(code)
+  }
+}

Sources/MoveGen/MoveCanonicalType.swift

@@ -8,6 +8,7 @@
 import Foundation
 import AST
 import MoveIR
+import Diagnostic
 
 /// A MoveIR type.
 indirect enum CanonicalType: CustomStringConvertible {
@@ -29,7 +30,9 @@ indirect enum CanonicalType: CustomStringConvertible {
       case .bool: self = .bool
       case .string: self = .bytearray
       default:
-        print("rawType: \(rawType)")
+        Diagnostics.add(Diagnostic(severity: .warning,
+                                   sourceLocation: nil,
+                                   message: "Could not detect basic type for `\(rawType)'"))
         return nil
       }
 
@@ -60,7 +63,9 @@ indirect enum CanonicalType: CustomStringConvertible {
     case .dictionaryType(let key, _):
       self = CanonicalType(from: key)!
     default:
-      print("rawType': \(rawType)")
+      Diagnostics.add(Diagnostic(severity: .warning,
+                                 sourceLocation: nil,
+                                 message: "Could not detect type for `\(rawType)'"))
       return nil
     }
   }

Sources/MoveGen/MoveContract.swift

@@ -39,7 +39,7 @@ struct MoveContract {
     let renderedImports = MoveIR.Statement.renderStatements(statements: imports)
     // Generate code for each function in the contract.
     let functions = contractBehaviorDeclarations.flatMap { contractBehaviorDeclaration in
-      return contractBehaviorDeclaration.members.compactMap { member -> MoveFunction? in
+      contractBehaviorDeclaration.members.compactMap { member -> MoveFunction? in
         guard case .functionDeclaration(let functionDeclaration) = member else {
           return nil
         }

Sources/MoveGen/MoveGenerator.swift

@@ -4,14 +4,16 @@
 
 import Foundation
 import AST
+import Diagnostic
 
 public struct MoveGenerator {
   var topLevelModule: TopLevelModule
   var environment: Environment
 
-  public init(ast topLevelModule: TopLevelModule, environment: Environment) {
+  public init(ast topLevelModule: TopLevelModule, environment: Environment, sourceContext: SourceContext) {
     self.topLevelModule = topLevelModule
     self.environment = environment
+    Diagnostics.sourceContext = sourceContext
   }
 
   public func generateCode() -> String {

Sources/MoveGen/Preprocessor/MovePreprocessor.swift

@@ -10,6 +10,7 @@ import AST
 import Foundation
 import Source
 import Lexer
+import Diagnostic
 
 /// A preprocessing step to update the program's AST before code generation.
 public struct MovePreprocessor: ASTPass {
@@ -104,8 +105,10 @@ extension ASTPass {
     guard let environment = passContext.environment,
           var scopeContext = passContext.scopeContext,
           let enclosingType = passContext.enclosingTypeIdentifier?.name else {
-      print("Cannot infer type for \(element.sourceLocation)")
-      exit(1)
+      Diagnostics.add(Diagnostic(severity: .error,
+                                 sourceLocation: element.sourceLocation,
+                                 message: "Insufficient information to deduce type"))
+      Diagnostics.displayAndExit()
     }
 
     var type: RawType = environment.type(of: element,

Sources/flint-ca/Analyser.swift

@@ -28,9 +28,9 @@ struct Analyser {
     let diagnosticPool = DiagnosticPool(shouldVerify: false,
                                         quiet: false,
                                         sourceContext: SourceContext(
-                                          sourceFiles: inputFiles,
-                                          sourceCodeString: sourceCode,
-                                          isForServer: true))
+                                            sourceFiles: inputFiles,
+                                            sourceCodeString: sourceCode,
+                                            isForServer: true))
 
     let config = CompilerContractAnalyserConfiguration(sourceFiles: inputFiles,
                                                        sourceCode: sourceCode,

Tests/MoveTests/BehaviourTests/tests/structs.flint

@@ -38,12 +38,13 @@ contract C {
   var b: B = B()
   var c: B = B()
   let d: Int = 5
-  var e: Bool = true
+  var e: Bool
 }
 
 C :: (any) {
   public init() {
     getE()
+    e = true
   }
 
   public func getAx() -> Int {