XXX

Author: CodaFi

Sources/LLVM/DIBuilder.swift

@@ -2,6 +2,16 @@
 import cllvm
 #endif
 
+// FIXME: This should be in the bindings.
+public enum MachineInfoRecordType: UInt32 {
+  // Macinfo Type Encodings
+  case define = 0x01
+  case undef = 0x02
+  case startFile = 0x03
+  case endFile = 0x04
+  case vendorExt = 0xff
+}
+
 public struct DebugInfoFlags: OptionSet {
   public let rawValue: LLVMDIFlags.RawValue
 
@@ -363,7 +373,7 @@ public enum DWARFTypeEncoding {
 
   case ascii
 
-  static let typeEncodingMapping: [DWARFTypeEncoding: LLVMDWARFTypeEncoding] = [
+  private static let typeEncodingMapping: [DWARFTypeEncoding: LLVMDWARFTypeEncoding] = [
     .address: LLVMDWARFTypeEncoding_address,
     .boolean: LLVMDWARFTypeEncoding_boolean,
     .complexFloat: LLVMDWARFTypeEncoding_complex_float,
@@ -395,13 +405,67 @@ public enum DWARFEmissionKind {
   case lineTablesOnly
 }
 
-public struct MetaData {
+public protocol Metadata {
+  func asMetadata() -> LLVMMetadataRef
+}
+
+struct AnyMetadata: Metadata {
+  let llvm: LLVMMetadataRef
+
+  func asMetadata() -> LLVMMetadataRef {
+    return llvm
+  }
+}
+
+struct AnyDIType: Metadata, DIType {
+  let llvm: LLVMMetadataRef
+
+  func asMetadata() -> LLVMMetadataRef {
+    return llvm
+  }
+
+  func asMetadata(with builder: DIBuilder) -> LLVMMetadataRef {
+    return llvm
+  }
+}
+
+public struct FileMetadata: Metadata {
+  internal let llvm: LLVMMetadataRef
+
+  public func asMetadata() -> LLVMMetadataRef {
+    return llvm
+  }
+}
+
+public struct Scope: Metadata {
+  internal let llvm: LLVMMetadataRef
+
+  public func asMetadata() -> LLVMMetadataRef {
+    return llvm
+  }
+}
+
+public struct Macro: Metadata {
+  internal let llvm: LLVMMetadataRef
+
+  public func asMetadata() -> LLVMMetadataRef {
+    return llvm
+  }
+}
+
+public struct DIModule: Metadata {
   internal let llvm: LLVMMetadataRef
 
-  /// Find subprogram that is enclosing this scope.
-  var subprogram: MetaData? {
-    guard let prgm = LLVMGetSubprogram(self.llvm) else { return nil }
-    return MetaData(llvm: prgm)
+  public func asMetadata() -> LLVMMetadataRef {
+    return llvm
+  }
+}
+
+public struct DebugLocation: Metadata {
+  internal let llvm: LLVMMetadataRef
+
+  public func asMetadata() -> LLVMMetadataRef {
+    return llvm
   }
 }
 
@@ -416,27 +480,78 @@ public final class DIBuilder {
     self.llvm = LLVMDIBuilderCreate(module.llvm, allowUnresolved ? 1 : 0)
   }
 
+  /// Creates a new DebugLocation that describes a source location.
+  public func createDebugLocation(at loc : (line: Int, column: Int), in scope: Scope, inlinedAt: Scope? = nil) -> DebugLocation {
+    guard let loc = LLVMDIBuilderCreateDebugLocation(self.module.context.llvm, UInt32(loc.line), UInt32(loc.column), scope.llvm, inlinedAt?.llvm) else {
+      fatalError()
+    }
+    return DebugLocation(llvm: loc)
+  }
+
   /// Create a file descriptor to hold debugging information for a file.
-  public func createFile(named name: String, in directory: String) -> MetaData? {
+  public func createFile(named name: String, in directory: String) -> FileMetadata? {
     guard let file = LLVMDIBuilderCreateFile(self.llvm, name, directory) else { return nil }
-    return MetaData(llvm: file)
+    return FileMetadata(llvm: file)
   }
 
   /// Create debugging information temporary entry for a macro file.
-  public func createTemporaryMacroFile(at line: UInt32, in file: MetaData, withParent parent: MetaData? = nil) -> MetaData? {
+  public func createTemporaryMacroFile(at line: UInt32, in file: FileMetadata, withParent parent: FileMetadata? = nil) -> FileMetadata? {
     guard let file = LLVMDIBuilderCreateTempMacroFile(self.llvm, parent?.llvm, line, file.llvm) else { return nil }
-    return MetaData(llvm: file)
+    return FileMetadata(llvm: file)
+  }
+
+  /// This creates a descriptor for a lexical block with the
+  /// specified parent context.
+  public func createLexicalBlock(in scope: Scope, in file: FileMetadata, at loc : (line: Int, column: Int)) -> Scope {
+    guard let scope = LLVMDIBuilderCreateLexicalBlock(self.llvm, scope.llvm, file.llvm, UInt32(loc.line), UInt32(loc.column)) else {
+      fatalError()
+    }
+    return Scope(llvm: scope)
+  }
+
+  /// This creates new descriptor for a module with the specified
+  /// parent scope.
+  public func createModule(in scope: Scope, named name: String, macros: [String], include ipath: String, _ isysRoot: String) -> DIModule {
+    guard let module = LLVMDIBuilderCreateModule(self.llvm, scope.llvm, name, macros.joined(separator: " "), ipath, isysRoot) else {
+      fatalError()
+    }
+    return DIModule(llvm: module)
+  }
+
+  /// Create debugging information entry for a macro.
+  public func createMacro(in parent: FileMetadata, at line: Int, type macroTy: MachineInfoRecordType, name: String) -> Macro! {
+    guard let macro = LLVMDIBuilderCreateMacro(self.llvm, parent.asMetadata(), UInt32(line), macroTy.rawValue, name) else {
+      fatalError()
+    }
+    return Macro(llvm: macro)
   }
 
-  /// Create subroutine type.
-  public func createSubroutineType(in file: MetaData, types: [MetaData]) -> MetaData? {
-    var vals = types.map { $0.llvm as Optional }
-    return vals.withUnsafeMutableBufferPointer { buf in
-      guard let file = LLVMDIBuilderCreateSubroutineType(self.llvm, file.llvm, buf.baseAddress, UInt32(types.count)) else { return nil }
-      return MetaData(llvm: file)
+  /// Create debugging information entry for a typedef.
+  public func createTypedef(of type: DIType, named name: String, in file: FileMetadata, at line: Int, in scope: Scope) -> DIType {
+    guard let typedef = LLVMDIBuilderCreateTypedef(self.llvm, type.asMetadata(with: self), name, file.llvm, UInt32(line), scope.llvm) else {
+      fatalError()
     }
+    return AnyDIType(llvm: typedef)
   }
 
+  /// Create a new DIType with "artificial" flag set.
+  public func createArtificialType(of type: DIType) -> DIType {
+    guard let ty = LLVMDIBuilderCreateArtificialType(self.llvm, type.asMetadata(with: self)) else {
+      fatalError()
+    }
+    return AnyDIType(llvm: ty)
+  }
+
+  /// Create a new descriptor for an auto variable.  This is a local variable
+  /// that is not a subprogram parameter.
+  public func createAutoVariable(in scope: Scope, named name: String, in file: FileMetadata, at line: Int, type: DIType, alwaysPreserve: Bool, flags: DebugInfoFlags, aligned alignInBits: Int) -> Metadata {
+    guard let vari = LLVMDIBuilderCreateAutoVariable(self.llvm, scope.llvm, name, file.llvm, UInt32(line), type.asMetadata(with: self), alwaysPreserve ? 1 : 0, flags.llvm, UInt32(alignInBits)) else {
+      fatalError()
+    }
+    return AnyMetadata(llvm: vari)
+  }
+
+
   /// Construct any deferred debug info descriptors.
   public func finalize() {
     LLVMDIBuilderFinalize(self.llvm)
@@ -495,20 +610,6 @@ public func LLVMDIBuilderCreateFunction(_ Builder: LLVMDIBuilderRef!, _ Scope: L
 /// except that the resulting DbgNode is meant to be RAUWed.
 public func LLVMDIBuilderCreateTempFunctionFwdDecl(_ Builder: LLVMDIBuilderRef!, _ Scope: LLVMMetadataRef!, _ Name: UnsafePointer<Int8>!, _ LinkageName: UnsafePointer<Int8>!, _ File: LLVMMetadataRef!, _ LineNo: UInt32, _ Ty: LLVMMetadataRef!, _ IsLocalToUnit: UInt8, _ IsDefinition: UInt8, _ ScopeLine: UInt32, _ Flags: LLVMDIFlags, _ IsOptimized: UInt8, _ Fn: LLVMValueRef!, _ TemplateParams: UnsafeMutablePointer<LLVMMetadataRef?>!, _ NumTemplateParams: UInt32, _ Decl: LLVMMetadataRef!) -> LLVMMetadataRef!
 
-/// Create C++11 nullptr type.
-
-/// This creates new descriptor for a module with the specified
-/// parent scope.
-/// \param Builder     The DIBuilder.
-/// \param Scope       Parent scope
-/// \param Name        Name of this module
-/// \param ConfigurationMacros
-///                    A space-separated shell-quoted list of -D macro
-///                    definitions as they would appear on a command line.
-/// \param IncludePath The path to the module map file.
-/// \param ISysRoot    The clang system root (value of -isysroot).
-public func LLVMDIBuilderCreateModule(_ Builder: LLVMDIBuilderRef!, _ Scope: LLVMMetadataRef!, _ Name: UnsafePointer<Int8>!, _ ConfigurationMacros: UnsafePointer<Int8>!, _ IncludePath: UnsafePointer<Int8>!, _ ISysRoot: UnsafePointer<Int8>!) -> LLVMMetadataRef!
-
 /// Create debugging information entry for a class.
 /// \param Scope        Scope in which this class is defined.
 /// \param Name         class name.
@@ -523,19 +624,6 @@ public func LLVMDIBuilderCreateModule(_ Builder: LLVMDIBuilderRef!, _ Scope: LLV
 /// \param TemplateParms Template type parameters.
 public func LLVMDIBuilderCreateClassType(_ Builder: LLVMDIBuilderRef!, _ Scope: LLVMMetadataRef!, _ Name: UnsafePointer<Int8>!, _ File: LLVMMetadataRef!, _ LineNumber: UInt32, _ SizeInBits: UInt64, _ AlignInBits: UInt32, _ OffsetInBits: UInt64, _ Flags: LLVMDIFlags, _ Elements: UnsafeMutablePointer<LLVMMetadataRef?>!, _ NumElements: UInt32, _ DerivedFrom: LLVMMetadataRef!, _ TemplateParamsNode: LLVMMetadataRef!) -> LLVMMetadataRef!
 
-/// Create a new DIType* with "artificial" flag set.
-public func LLVMDIBuilderCreateArtificialType(_ Builder: LLVMDIBuilderRef!, _ Type: LLVMMetadataRef!) -> LLVMMetadataRef!
-
-/// Create a new descriptor for an auto variable.  This is a local variable
-/// that is not a subprogram parameter.
-///
-/// \c Scope must be a \a DILocalScope, and thus its scope chain eventually
-/// leads to a \a DISubprogram.
-///
-/// If \c AlwaysPreserve, this variable will be referenced from its
-/// containing subprogram, and will survive some optimizations.
-public func LLVMDIBuilderCreateAutoVariable(_ Builder: LLVMDIBuilderRef!, _ Scope: LLVMMetadataRef!, _ Name: UnsafePointer<Int8>!, _ File: LLVMMetadataRef!, _ LineNo: UInt32, _ Type: LLVMMetadataRef!, _ AlwaysPreserve: UInt8, _ Flags: LLVMDIFlags, _ AlignInBits: UInt32) -> LLVMMetadataRef!
-
 /// Create a new descriptor for the specified variable.
 /// \param Context     Variable scope.
 /// \param Name        Name of the variable.
@@ -584,15 +672,6 @@ public func LLVMDIBuilderCreateForwardDecl(_ Builder: LLVMDIBuilderRef!, _ Tag:
 /// \param TParams        Function template parameters.
 public func LLVMDIBuilderCreateMethod(_ Builder: LLVMDIBuilderRef!, _ Scope: LLVMMetadataRef!, _ Name: UnsafePointer<Int8>!, _ LinkageName: UnsafePointer<Int8>!, _ File: LLVMMetadataRef!, _ LineNumber: UInt32, _ FuncTy: LLVMMetadataRef!, _ Flags: LLVMDIFlags, _ IsLocalToUnit: UInt8, _ IsDefinition: UInt8, _ IsOptimized: UInt8, _ TemplateParameters: UnsafeMutablePointer<LLVMMetadataRef?>!, _ NumTemplateParameters: UInt32) -> LLVMMetadataRef!
 
-/// Create debugging information entry for a typedef.
-/// \param Builder     The DIBuilder.
-/// \param Ty          Original type.
-/// \param Name        Typedef name.
-/// \param File        File where this type is defined.
-/// \param LineNo      Line number.
-/// \param Scope       The surrounding context for the typedef.
-public func LLVMDIBuilderCreateTypedef(_ Builder: LLVMDIBuilderRef!, _ Type: LLVMMetadataRef!, _ Name: UnsafePointer<Int8>!, _ File: LLVMMetadataRef!, _ Line: UInt32, _ Scope: LLVMMetadataRef!) -> LLVMMetadataRef!
-
 /// Create debugging information entry to establish
 /// inheritance relationship between two types.
 /// \param Builder      The DIBuilder.
@@ -603,15 +682,6 @@ public func LLVMDIBuilderCreateTypedef(_ Builder: LLVMDIBuilderRef!, _ Type: LLV
 ///                     e.g. private
 public func LLVMDIBuilderCreateInheritance(_ Builder: LLVMDIBuilderRef!, _ Type: LLVMMetadataRef!, _ BaseType: LLVMMetadataRef!, _ BaseOffset: UInt64, _ Flags: LLVMDIFlags) -> LLVMMetadataRef!
 
-/// Create debugging information entry for a macro.
-/// \param Builder    The DIBuilder.
-/// \param Parent     Macro parent (could be nullptr).
-/// \param Line       Source line number where the macro is defined.
-/// \param MacroType  DW_MACINFO_define or DW_MACINFO_undef.
-/// \param Name       Macro name.
-/// \param Value      Macro value.
-public func LLVMDIBuilderCreateMacro(_ Builder: LLVMDIBuilderRef!, _ ParentMacroFile: LLVMMetadataRef!, _ Line: UInt32, _ MacroType: UInt32, _ Name: UnsafePointer<Int8>!) -> LLVMMetadataRef!
-
 /// Create debugging information entry for a 'friend'.
 public func LLVMDIBuilderCreateFriend(_ Builder: LLVMDIBuilderRef!, _ Type: LLVMMetadataRef!, _ FriendType: LLVMMetadataRef!) -> LLVMMetadataRef!
 
@@ -736,14 +806,6 @@ public func LLVMDIBuilderCreateUnspecifiedParameter(_ Builder: LLVMDIBuilderRef!
 /// Create a DWARF unspecified type.
 public func LLVMDIBuilderCreateUnspecifiedType(_ Builder: LLVMDIBuilderRef!, _ Name: UnsafePointer<Int8>!) -> LLVMMetadataRef!
 
-/// This creates a descriptor for a lexical block with the
-/// specified parent context.
-/// \param Builder      The DIBuilder.
-/// \param Scope         Parent lexical scope.
-/// \param File          Source file.
-/// \param Line          Line number.
-/// \param Col           Column number.
-public func LLVMDIBuilderCreateLexicalBlock(_ Builder: LLVMDIBuilderRef!, _ Scope: LLVMMetadataRef!, _ File: LLVMMetadataRef!, _ Line: UInt32, _ Col: UInt32) -> LLVMMetadataRef!
 
 /// Create a new descriptor for a parameter variable.
 ///
@@ -911,12 +973,4 @@ public func LLVMDIBuilderCreateNameSpace(_ Builder: LLVMDIBuilderRef!, _ Scope:
 /// has a self-reference -- \a DIBuilder needs to track the array to
 /// resolve cycles.
 public func LLVMDICompositeTypeSetTypeArray(_ Builder: LLVMDIBuilderRef!, _ CompositeTy: LLVMMetadataRef!, _ Types: UnsafeMutablePointer<LLVMMetadataRef?>!, _ NumTypes: UInt32)
-
-/// Creates a new DebugLocation that describes a source location.
-/// \param Line The line in the source file.
-/// \param Column The column in the source file.
-/// \param Scope The scope in which the location resides.
-/// \param InlinedAt The scope where this location was inlined, if at all.
-///                  (optional).
-public func LLVMDIBuilderCreateDebugLocation(_ Ctx: LLVMContextRef!, _ Line: UInt32, _ Column: UInt32, _ Scope: LLVMMetadataRef!, _ InlinedAt: LLVMMetadataRef!) -> LLVMMetadataRef!
 */