XXX

Author: CodaFi

Sources/LLVM/DIBuilder.swift

@@ -486,6 +486,14 @@ struct AnyDIType: Metadata, DIType {
   }
 }
 
+public struct VariableMetadata: Metadata {
+  internal let llvm: LLVMMetadataRef
+
+  public func asMetadata() -> LLVMMetadataRef {
+    return llvm
+  }
+}
+
 public struct FileMetadata: Metadata {
   internal let llvm: LLVMMetadataRef
 
@@ -548,27 +556,7 @@ public final class DIBuilder {
 
   /// A CompileUnit provides an anchor for all debugging
   /// information generated during this instance of compilation.
-  /// \param Lang          Source programming language, eg.
-  ///                      \c LLVMDWARFSourceLanguageC99
-  /// \param File          File info.
-  /// \param Producer      Identify the producer of debugging information
-  ///                      and code.  Usually this is a compiler
-  ///                      version string.
-  /// \param isOptimized   A boolean flag which indicates whether optimization
-  ///                      is enabled or not.
-  /// \param Flags         This string lists command line options. This
-  ///                      string is directly embedded in debug info
-  ///                      output which may be used by a tool
-  ///                      analyzing generated debugging information.
-  /// \param RuntimeVer    This indicates runtime version for languages like
-  ///                      Objective-C.
-  /// \param SplitName     The name of the file that we'll split debug info
-  ///                      out into.
-  /// \param Kind          The kind of debug information to generate.
-  /// \param DWOId         The DWOId if this is a split skeleton compile unit.
-  /// \param SplitDebugInlining    Whether to emit inline debug info.
-  /// \param DebugInfoForProfiling Whether to emit extra debug info for
-  ///                              profile collection.
+  // FIXME: DWOId
   public func createCompileUnit(
     for lang: DWARFSourceLanguage,
     in file: FileMetadata,
@@ -603,6 +591,26 @@ public final class DIBuilder {
     return DebugLocation(llvm: loc)
   }
 
+  /// Insert a new llvm.dbg.declare intrinsic call.
+  public func insertDeclareAtEnd(for value: IRValue, with info: VariableMetadata, at loc: DebugLocation, in bb: BasicBlock, addressOps: [Int64] = []) {
+    var ops = addressOps
+    return ops.withUnsafeMutableBufferPointer { buf in
+      return LLVMDIBuilderInsertDeclareAtEnd(self.llvm, value.asLLVM(), info.llvm, buf.baseAddress!, UInt32(addressOps.count), loc.llvm, bb.asLLVM())
+    }
+  }
+
+  /// Insert a new llvm.dbg.value intrinsic call.
+  // FIXME: complex address expression?
+  public func insertDebugValueIntrinsicAtEnd(for value: IRValue, at offset: Int, with info: VariableMetadata, at loc: DebugLocation, in bb: BasicBlock, expr: Metadata? = nil) {
+    LLVMDIBuilderInsertDbgValueIntrinsicAtEnd(self.llvm, value.asLLVM(), UInt64(offset), info.llvm, expr?.asMetadata(), loc.llvm, bb.asLLVM())
+  }
+
+  /// Insert a new llvm.dbg.value intrinsic call.
+  // FIXME: complex address expression?
+  public func insertDebugValueIntrinsicBefore(for value: IRValue, at offset: Int, with info: VariableMetadata, at loc: DebugLocation, in bb: BasicBlock, expr: Metadata? = nil) {
+    LLVMDIBuilderInsertDbgValueIntrinsicBefore(self.llvm, value.asLLVM(), UInt64(offset), info.llvm, expr?.asMetadata(), loc.llvm, bb.asLLVM())
+  }
+
   /// Create a file descriptor to hold debugging information for a file.
   public func createFile(named name: String, in directory: String) -> FileMetadata? {
     guard let file = LLVMDIBuilderCreateFile(self.llvm, name, directory) else { return nil }
@@ -659,11 +667,11 @@ public final class DIBuilder {
 
   /// 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 {
+  public func createAutoVariable(in scope: Scope, named name: String, in file: FileMetadata, at line: Int, type: DIType, alwaysPreserve: Bool, flags: DebugInfoFlags, aligned alignInBits: Int) -> VariableMetadata {
     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)
+    return VariableMetadata(llvm: vari)
   }
 
 
@@ -962,35 +970,6 @@ public func LLVMDIBuilderGetOrCreateSubrange(_ Builder: LLVMDIBuilderRef!, _ Lo:
 /// Get a DINodeArray, create one if required.
 public func LLVMDIBuilderGetOrCreateArray(_ Builder: LLVMDIBuilderRef!, _ Ptr: UnsafeMutablePointer<LLVMMetadataRef?>!, _ Count: UInt32) -> LLVMMetadataRef!
 
-/// Insert a new llvm.dbg.declare intrinsic call.
-/// \param Builder     The DIBuilder.
-/// \param Storage     LLVMValueRef of the variable
-/// \param VarInfo     Variable's debug info descriptor.
-/// \param Expr        A complex location expression.
-/// \param DL          Debug info location.
-/// \param InsertAtEnd Location for the new intrinsic.
-public func LLVMDIBuilderInsertDeclareAtEnd(_ Builder: LLVMDIBuilderRef!, _ V: LLVMValueRef!, _ VarInfo: LLVMMetadataRef!, _ AddrOps: UnsafeMutablePointer<Int64>!, _ AddrOpsCount: UInt32, _ DL: LLVMMetadataRef!, _ InsertAtEnd: LLVMBasicBlockRef!) -> LLVMValueRef!
-
-/// Insert a new llvm.dbg.value intrinsic call.
-/// \param Builder      The DIBuilder.
-/// \param Val          LLVMValueRef of the variable
-/// \param Offset       Offset
-/// \param VarInfo      Variable's debug info descriptor.
-/// \param Expr         A complex location expression.
-/// \param DL           Debug info location.
-/// \param InsertAtEnd Location for the new intrinsic.
-public func LLVMDIBuilderInsertDbgValueIntrinsicAtEnd(_ Builder: LLVMDIBuilderRef!, _ Val: LLVMValueRef!, _ Offset: UInt64, _ VarInfo: LLVMMetadataRef!, _ Expr: LLVMMetadataRef!, _ Loc: LLVMMetadataRef!, _ InsertAtEnd: LLVMBasicBlockRef!) -> LLVMValueRef!
-
-/// Insert a new llvm.dbg.value intrinsic call.
-/// \param Builder      The DIBuilder.
-/// \param Val          LLVMValueRef of the variable
-/// \param Offset       Offset
-/// \param VarInfo      Variable's debug info descriptor.
-/// \param Expr         A complex location expression.
-/// \param DL           Debug info location.
-/// \param InsertBefore Location for the new intrinsic.
-public func LLVMDIBuilderInsertDbgValueIntrinsicBefore(_ Builder: LLVMDIBuilderRef!, _ Val: LLVMValueRef!, _ Offset: UInt64, _ VarInfo: LLVMMetadataRef!, _ Expr: LLVMMetadataRef!, _ Loc: LLVMMetadataRef!, _ InsertBefore: LLVMValueRef!) -> LLVMValueRef!
-
 /// Create a single enumerator value.
 public func LLVMDIBuilderCreateEnumerator(_ Builder: LLVMDIBuilderRef!, _ Name: UnsafePointer<Int8>!, _ Val: Int64) -> LLVMMetadataRef!