Add wrappers for DebugInfo.h

Author: CodaFi

Sources/LLVM/DIBuilder.swift

@@ -0,0 +1,389 @@
+#if SWIFT_PACKAGE
+import cllvm
+#endif
+
+/// Source languages known by DWARF.
+public enum DWARFSourceLanguage {
+  case ada83
+
+  case ada95
+
+  case c
+
+  case c89
+
+  case c99
+
+  case c11
+
+  case cPlusPlus
+
+  case cPlusPlus03
+
+  case cPlusPlus11
+
+  case cPlusPlus14
+
+  case cobol74
+
+  case cobol85
+
+  case fortran77
+
+  case fortran90
+
+  case fortran03
+
+  case fortran08
+
+  case pascal83
+
+  case modula2
+
+  case java
+
+  case fortran95
+
+  case PLI
+
+  case objC
+
+  case objCPlusPlus
+
+  case UPC
+
+  case D
+
+  case python
+
+  case openCL
+
+  case go
+
+  case modula3
+
+  case haskell
+
+  case ocaml
+
+  case rust
+
+  case swift
+
+  case julia
+
+  case dylan
+  
+  case renderScript
+  
+  case BLISS
+  
+  // MARK: Vendor Extensions
+
+  case mipsAssembler
+  
+  case googleRenderScript
+  
+  case borlandDelphi
+
+
+  private static let languageMapping: [DWARFSourceLanguage: LLVMDWARFSourceLanguage] = [
+    .c: LLVMDWARFSourceLanguageC, .c89: LLVMDWARFSourceLanguageC89,
+    .c99: LLVMDWARFSourceLanguageC99, .c11: LLVMDWARFSourceLanguageC11,
+    .ada83: LLVMDWARFSourceLanguageAda83,
+    .cPlusPlus: LLVMDWARFSourceLanguageC_plus_plus,
+    .cPlusPlus03: LLVMDWARFSourceLanguageC_plus_plus_03,
+    .cPlusPlus11: LLVMDWARFSourceLanguageC_plus_plus_11,
+    .cPlusPlus14: LLVMDWARFSourceLanguageC_plus_plus_14,
+    .cobol74: LLVMDWARFSourceLanguageCobol74,
+    .cobol85: LLVMDWARFSourceLanguageCobol85,
+    .fortran77: LLVMDWARFSourceLanguageFortran77,
+    .fortran90: LLVMDWARFSourceLanguageFortran90,
+    .pascal83: LLVMDWARFSourceLanguagePascal83,
+    .modula2: LLVMDWARFSourceLanguageModula2,
+    .java: LLVMDWARFSourceLanguageJava,
+    .ada95: LLVMDWARFSourceLanguageAda95,
+    .fortran95: LLVMDWARFSourceLanguageFortran95,
+    .PLI: LLVMDWARFSourceLanguagePLI,
+    .objC: LLVMDWARFSourceLanguageObjC,
+    .objCPlusPlus: LLVMDWARFSourceLanguageObjC_plus_plus,
+    .UPC: LLVMDWARFSourceLanguageUPC,
+    .D: LLVMDWARFSourceLanguageD,
+    .python: LLVMDWARFSourceLanguagePython,
+    .openCL: LLVMDWARFSourceLanguageOpenCL,
+    .go: LLVMDWARFSourceLanguageGo,
+    .modula3: LLVMDWARFSourceLanguageModula3,
+    .haskell: LLVMDWARFSourceLanguageHaskell,
+    .ocaml: LLVMDWARFSourceLanguageOCaml,
+    .rust: LLVMDWARFSourceLanguageRust,
+    .swift: LLVMDWARFSourceLanguageSwift,
+    .julia: LLVMDWARFSourceLanguageJulia,
+    .dylan: LLVMDWARFSourceLanguageDylan,
+    .fortran03: LLVMDWARFSourceLanguageFortran03,
+    .fortran08: LLVMDWARFSourceLanguageFortran08,
+    .renderScript: LLVMDWARFSourceLanguageRenderScript,
+    .BLISS: LLVMDWARFSourceLanguageBLISS,
+    .mipsAssembler: LLVMDWARFSourceLanguageMips_Assembler,
+    .googleRenderScript: LLVMDWARFSourceLanguageGOOGLE_RenderScript,
+    .borlandDelphi: LLVMDWARFSourceLanguageBORLAND_Delphi,
+  ]
+
+  /// Retrieves the corresponding `LLVMDWARFSourceLanguage`.
+  public var llvm: LLVMDWARFSourceLanguage {
+    return DWARFSourceLanguage.languageMapping[self]!
+  }
+}
+
+/// Qualifiers for types, e.g. \c const.
+public enum DWARFTypeQualifier {
+  case null
+
+  case array
+
+  case `class`
+
+  case entryPoint
+
+  case enumeration
+
+  case formalParameter
+
+  case importedDeclaration
+
+  case label
+
+  case lexicalBlock
+
+  case member
+
+  case pointer
+
+  case reference
+
+  case compileUnit
+
+  case string
+
+  case structure
+
+  case subroutine
+
+  case typedef
+
+  case union
+
+  case unspecifiedParameters
+
+  case variant
+
+  case commonBlock
+
+  case commonInclusion
+
+  case inheritance
+
+  case inlinedSubroutine
+
+  case module
+
+  case pointerToMember
+
+  case set
+
+  case subrange
+
+  case withStatement
+
+  case accessDeclaration
+
+  case base
+
+  case `catch`
+
+  case const
+
+  case constant
+
+  case enumerator
+
+  case file
+
+  case friend
+
+  case namelist
+
+  case namelistItem
+
+  case packed
+
+  case subprogram
+
+  case templateTypeParameter
+
+  case templateValueParameter
+
+  case thrown
+
+  case tryBlock
+
+  case variantPart
+
+  case variable
+
+  case volatileType
+
+  // New in DWARF v3:
+  case dwarfProcedure
+
+  case restrict
+
+  case interface
+
+  case namespace
+
+  case importedModule
+
+  case unspecified
+
+  case partialUnit
+
+  case importedUnit
+
+  case condition
+
+  case shared
+
+  case typeUnit
+
+  case rvalueReference
+
+  case templateAlias
+
+  case coarray
+
+  case genericSubrange
+
+  case dynamic
+
+  case atomic
+
+  case callSite
+
+  case callSiteParameter
+
+  case skeletonUnit
+
+  case immutable
+
+  // MARK: Vendor extensions
+
+  case mipsLoop
+
+  case formatLabel
+
+  case functionTemplate
+
+  case classTemplate
+
+  case gnuTemplateTemplateParameter
+
+  case gnuTemplateParameterPack
+
+  case gnuFormalParameterPack
+
+  case appleProperty
+
+  case borlandProperty
+
+  case borlandDelphiString
+
+  case borlandDelphiDynamicArray
+
+  case borlandDelphiSet
+
+  case borlandDelphiVariant
+}
+
+/// The amount of debug information to emit.
+public enum DWARFEmissionKind {
+  case none
+  case full
+  case lineTablesOnly
+
+  private static let emissionMapping: [DWARFEmissionKind: LLVMDWARFEmissionKind] = [
+    .none: LLVMDWARFEmissionNone, .full: LLVMDWARFEmissionFull,
+    .lineTablesOnly: LLVMDWARFEmissionLineTablesOnly,
+  ]
+
+  /// Retrieves the corresponding `LLVMDWARFEmissionKind`.
+  public var llvm: LLVMDWARFEmissionKind {
+    return DWARFEmissionKind.emissionMapping[self]!
+  }
+}
+
+public final class DIBuilder {
+  internal let llvm: LLVMDIBuilderRef
+
+  /// The module this `IRBuilder` is associated with.
+  public let module: Module
+
+  public init(module: Module, allowUnresolved: Bool = false) {
+    self.module = module
+    if allowUnresolved {
+      self.llvm = LLVMCreateDIBuilder(module.llvm)
+    } else {
+      self.llvm = LLVMCreateDIBuilderDisallowUnresolved(module.llvm)
+    }
+  }
+
+  /// A CompileUnit provides an anchor for all debugging
+  /// information generated during this instance of compilation.
+  // FIXME: DWOId
+  public func createCompileUnit(
+    for lang: DWARFSourceLanguage,
+    in file: FileMetadata,
+    identity: String = "",
+    flags: [String],
+    splitName: String = "",
+    kind: DWARFEmissionKind,
+    DWOId: UInt32 = 0,
+    optimized: Bool = false,
+    splitDebugInlining: Bool = false,
+    debugInfoForProfiling: Bool = false
+  ) -> Scope {
+    let allFlags = flags.joined(separator: " ")
+    guard let cu = LLVMDIBuilderCreateCompileUnit(
+      self.llvm, lang.llvm, file.llvm, identity, identity.count,
+      optimized.llvm,
+      allFlags, allFlags.count,
+      /*Runtime Version*/0,
+      splitName, splitName.count,
+      kind.llvm, DWOId,
+      splitDebugInlining.llvm,
+      debugInfoForProfiling.llvm
+    ) else {
+      fatalError()
+    }
+    return Scope(llvm: cu)
+  }
+
+  /// 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("Failed to allocate metadata for a debug location")
+    }
+    return DebugLocation(llvm: loc)
+  }
+
+  /// Construct any deferred debug info descriptors.
+  public func finalize() {
+    LLVMDIBuilderFinalize(self.llvm)
+  }
+
+  deinit {
+    LLVMDisposeDIBuilder(self.llvm)
+  }
+}