//===- DIBuilderBindings.h - Bindings for DIBuilder -------------*- C++ -*-===//

//

//                     The LLVM Compiler Infrastructure

//

// This file is distributed under the University of Illinois Open Source

// License. See LICENSE.TXT for details.

//

//===----------------------------------------------------------------------===//

//

// This file defines C bindings for the DIBuilder class.

//

//===----------------------------------------------------------------------===//

/*

 * Shamelessly based on DIBuilderBindings.h from LLVM's GO bindings. The original

 * file could be found at bindings/go/llvm/DIBuilderBindings.h in LLVM source tree.

 */

#ifndef LLVM_BINDINGS_GO_LLVM_DIBUILDERBINDINGS_H

#define LLVM_BINDINGS_GO_LLVM_DIBUILDERBINDINGS_H

#include <llvm-c/Core.h>

#include <llvm-c-ext/CoreExt.h>

#ifdef __cplusplus

extern "C" {

#endif

// FIXME: These bindings shouldn't be Go-specific and should eventually move to

// a (somewhat) less stable collection of C APIs for use in creating bindings of

// LLVM in other languages.

typedef struct LLVMOpaqueDIBuilder *LLVMDIBuilderRef;

LLVMDIBuilderRef LLVMNewDIBuilder(LLVMModuleRef m);

void LLVMDIBuilderDestroy(LLVMDIBuilderRef d);

void LLVMDIBuilderFinalize(LLVMDIBuilderRef d);

/**

 * A CompileUnit provides an anchor for all debugging

 * information generated during this instance of compilation.

 * \param Lang          Source programming language, eg. LLVM_DW_LANG_C99.

 *                      User-defined languages should start at 0x8000.

 * \param File          File name

 * \param Dir           Directory

 * \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 RuntimeVersion This indicates runtime version for languages like

 *                      Objective-C.

 *

 * \see LLVMDWARFLamguage

 * \see llvm::DIBuilder::createCompileUnit()

 */

LLVMMetadataRef

LLVMDIBuilderCreateCompileUnit(LLVMDIBuilderRef D, unsigned Language,

                               const char *File, const char *Dir,

                               const char *Producer, int Optimized,

                               const char *Flags, unsigned RuntimeVersion);

LLVMMetadataRef LLVMDIBuilderCreateFile(LLVMDIBuilderRef D, const char *File,

                                        const char *Dir);

LLVMMetadataRef LLVMDIBuilderCreateLexicalBlock(LLVMDIBuilderRef D,

                                                LLVMMetadataRef Scope,

                                                LLVMMetadataRef File,

                                                unsigned Line, unsigned Column);

LLVMMetadataRef LLVMDIBuilderCreateLexicalBlockFile(LLVMDIBuilderRef D,

                                                    LLVMMetadataRef Scope,

                                                    LLVMMetadataRef File,

                                                    unsigned Discriminator);

#if (LLVM_VERSION_MAJOR <= 3) && (LLVM_VERSION_MINOR <= 8)

LLVMMetadataRef LLVMDIBuilderCreateFunction(

    LLVMDIBuilderRef D, LLVMMetadataRef Scope, const char *Name,

    const char *LinkageName, LLVMMetadataRef File, unsigned Line,

    LLVMMetadataRef CompositeType, int IsLocalToUnit, int IsDefinition,

    unsigned ScopeLine, unsigned Flags, int IsOptimized, LLVMValueRef Function);

#else

LLVMMetadataRef LLVMDIBuilderCreateFunction(

    LLVMDIBuilderRef D, LLVMMetadataRef Scope, const char *Name,

    const char *LinkageName, LLVMMetadataRef File, unsigned Line,

    LLVMMetadataRef CompositeType, int IsLocalToUnit, int IsDefinition,

    unsigned ScopeLine, unsigned Flags, int IsOptimized);

#endif

LLVMMetadataRef LLVMDIBuilderCreateAutoVariable(

    LLVMDIBuilderRef Dref, LLVMMetadataRef Scope,

    const char *Name, LLVMMetadataRef File, unsigned Line, LLVMMetadataRef Ty,

    int AlwaysPreserve, unsigned Flags);

LLVMMetadataRef LLVMDIBuilderCreateParameterVariable(

    LLVMDIBuilderRef Dref, LLVMMetadataRef Scope,

    const char *Name, LLVMMetadataRef File, unsigned Line, LLVMMetadataRef Ty,

    int AlwaysPreserve, unsigned Flags, unsigned ArgNo);

/**

 * Create debugging information entry for a basic type.

 *

 * \param Name        Type name.

 * \param SizeInBits  Size of the type.

 * \param AlignInBits Type alignment.

 * \param Encoding    DWARF encoding code, e.g. LLVM_DW_ATE_float.

 */

LLVMMetadataRef LLVMDIBuilderCreateBasicType(LLVMDIBuilderRef D,

                                             const char *Name,

                                             uint64_t SizeInBits,

                                             uint64_t AlignInBits,

                                             unsigned Encoding);

LLVMMetadataRef LLVMDIBuilderCreatePointerType(LLVMDIBuilderRef D,

                                               LLVMMetadataRef PointeeType,

                                               uint64_t SizeInBits,

                                               uint64_t AlignInBits,

                                               const char *Name);

#if (LLVM_VERSION_MAJOR <= 3) && (LLVM_VERSION_MINOR <= 8)

LLVMMetadataRef

LLVMDIBuilderCreateSubroutineType(LLVMDIBuilderRef D, LLVMMetadataRef File,

                                  LLVMMetadataRef ParameterTypes);

#else

LLVMMetadataRef

LLVMDIBuilderCreateSubroutineType(LLVMDIBuilderRef D, LLVMMetadataRef ParameterTypes);

#endif

LLVMMetadataRef LLVMDIBuilderCreateStructType(

    LLVMDIBuilderRef D, LLVMMetadataRef Scope, const char *Name,

    LLVMMetadataRef File, unsigned Line, uint64_t SizeInBits,

    uint64_t AlignInBits, unsigned Flags, LLVMMetadataRef DerivedFrom,

    LLVMMetadataRef ElementTypes);

LLVMMetadataRef LLVMDIBuilderCreateReplaceableCompositeType(

    LLVMDIBuilderRef D, unsigned Tag, const char *Name, LLVMMetadataRef Scope,

    LLVMMetadataRef File, unsigned Line, unsigned RuntimeLang,

    uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags);

LLVMMetadataRef

LLVMDIBuilderCreateMemberType(LLVMDIBuilderRef D, LLVMMetadataRef Scope,

                              const char *Name, LLVMMetadataRef File,

                              unsigned Line, uint64_t SizeInBits,

                              uint64_t AlignInBits, uint64_t OffsetInBits,

                              unsigned Flags, LLVMMetadataRef Ty);

LLVMMetadataRef LLVMDIBuilderCreateArrayType(LLVMDIBuilderRef D,

                                             uint64_t SizeInBits,

                                             uint64_t AlignInBits,

                                             LLVMMetadataRef ElementType,

                                             LLVMMetadataRef Subscripts);

LLVMMetadataRef LLVMDIBuilderCreateTypedef(LLVMDIBuilderRef D,

                                           LLVMMetadataRef Ty, const char *Name,

                                           LLVMMetadataRef File, unsigned Line,

                                           LLVMMetadataRef Context);

LLVMMetadataRef LLVMDIBuilderGetOrCreateSubrange(LLVMDIBuilderRef D, int64_t Lo,

                                                 int64_t Count);

LLVMMetadataRef LLVMDIBuilderGetOrCreateArray(LLVMDIBuilderRef D,

                                              LLVMMetadataRef *Data,

                                              size_t Length);

LLVMMetadataRef LLVMDIBuilderGetOrCreateTypeArray(LLVMDIBuilderRef D,

                                                  LLVMMetadataRef *Data,

                                                  size_t Length);

LLVMMetadataRef LLVMDIBuilderCreateExpression(LLVMDIBuilderRef Dref,

                                              int64_t *Addr, size_t Length);

LLVMValueRef LLVMDIBuilderInsertDeclareAtEnd(LLVMDIBuilderRef D,

                                             LLVMValueRef Storage,

                                             LLVMMetadataRef VarInfo,

                                             LLVMMetadataRef Expr,

											 LLVMMetadataRef Location,

                                             LLVMBasicBlockRef Block);

LLVMValueRef LLVMDIBuilderInsertValueAtEnd(LLVMDIBuilderRef D, LLVMValueRef Val,

                                           uint64_t Offset,

                                           LLVMMetadataRef VarInfo,

                                           LLVMMetadataRef Expr,

										   LLVMMetadataRef Location,

                                           LLVMBasicBlockRef Block);

#ifdef __cplusplus

} // extern "C"

#endif

#endif