6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2025-07-06 01:24:35 +00:00
Code Issues Projects Releases Wiki Activity

Add some doxygen comments to llvm-c/Core.h.

Browse Source 
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@45450 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Gordon Henriksen
2007-12-30 17:46:33 +00:00
parent e12d6abfdf
commit dc2c07a7cf
2 changed files with 73 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
include/llvm-c/Core.h
View File

@ -45,9 +45,26 @@ extern "C" {
/* Opaque types. */ /* Opaque types. */
/**
* The top-level container for all other LLVM Intermediate Representation (IR)
* objects. See the llvm::Module class.
*/
typedef struct LLVMOpaqueModule *LLVMModuleRef; typedef struct LLVMOpaqueModule *LLVMModuleRef;
/**
* Each value in the LLVM IR has a type, an instance of [lltype]. See the
* llvm::Type class.
*/
typedef struct LLVMOpaqueType *LLVMTypeRef; typedef struct LLVMOpaqueType *LLVMTypeRef;
/**
* When building recursive types using [refine_type], [lltype] values may become
* invalid; use [lltypehandle] to resolve this problem. See the
* llvm::AbstractTypeHolder] class.
*/
typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef; typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
typedef struct LLVMOpaqueValue *LLVMValueRef; typedef struct LLVMOpaqueValue *LLVMValueRef;
typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef; typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef;
typedef struct LLVMOpaqueBuilder *LLVMBuilderRef; typedef struct LLVMOpaqueBuilder *LLVMBuilderRef;
@ -63,38 +80,40 @@ typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef;
typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef; typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef;
typedef enum { typedef enum {
LLVMVoidTypeKind, /* type with no size */ LLVMVoidTypeKind, /**< type with no size */
LLVMFloatTypeKind, /* 32 bit floating point type */ LLVMFloatTypeKind, /**< 32 bit floating point type */
LLVMDoubleTypeKind, /* 64 bit floating point type */ LLVMDoubleTypeKind, /**< 64 bit floating point type */
LLVMX86_FP80TypeKind, /* 80 bit floating point type (X87) */ LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */
LLVMFP128TypeKind, /* 128 bit floating point type (112-bit mantissa) */ LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/
LLVMPPC_FP128TypeKind, /* 128 bit floating point type (two 64-bits) */ LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */
LLVMLabelTypeKind, /* Labels */ LLVMLabelTypeKind, /**< Labels */
LLVMIntegerTypeKind, /* Arbitrary bit width integers */ LLVMIntegerTypeKind, /**< Arbitrary bit width integers */
LLVMFunctionTypeKind, /* Functions */ LLVMFunctionTypeKind, /**< Functions */
LLVMStructTypeKind, /* Structures */ LLVMStructTypeKind, /**< Structures */
LLVMArrayTypeKind, /* Arrays */ LLVMArrayTypeKind, /**< Arrays */
LLVMPointerTypeKind, /* Pointers */ LLVMPointerTypeKind, /**< Pointers */
LLVMOpaqueTypeKind, /* Opaque: type with unknown structure */ LLVMOpaqueTypeKind, /**< Opaque: type with unknown structure */
LLVMVectorTypeKind /* SIMD 'packed' format, or other vector type */ LLVMVectorTypeKind /**< SIMD 'packed' format, or other vector type */
} LLVMTypeKind; } LLVMTypeKind;
typedef enum { typedef enum {
LLVMExternalLinkage, /* Externally visible function */ LLVMExternalLinkage, /**< Externally visible function */
LLVMLinkOnceLinkage, /* Keep one copy of function when linking (inline) */ LLVMLinkOnceLinkage, /**< Keep one copy of function when linking (inline)*/
LLVMWeakLinkage, /* Keep one copy of function when linking (weak) */ LLVMWeakLinkage, /**< Keep one copy of function when linking (weak) */
LLVMAppendingLinkage, /* Special purpose, only applies to global arrays */ LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */
LLVMInternalLinkage, /* Rename collisions when linking (static functions)*/ LLVMInternalLinkage, /**< Rename collisions when linking (static
LLVMDLLImportLinkage, /* Function to be imported from DLL */ functions) */
LLVMDLLExportLinkage, /* Function to be accessible from DLL */ LLVMDLLImportLinkage, /**< Function to be imported from DLL */
LLVMExternalWeakLinkage,/* ExternalWeak linkage description */ LLVMDLLExportLinkage, /**< Function to be accessible from DLL */
LLVMGhostLinkage /* Stand-in functions for streaming fns from bitcode*/ LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */
LLVMGhostLinkage /**< Stand-in functions for streaming fns from
bitcode */
} LLVMLinkage; } LLVMLinkage;
typedef enum { typedef enum {
LLVMDefaultVisibility, /* The GV is visible */ LLVMDefaultVisibility, /**< The GV is visible */
LLVMHiddenVisibility, /* The GV is hidden */ LLVMHiddenVisibility, /**< The GV is hidden */
LLVMProtectedVisibility /* The GV is protected */ LLVMProtectedVisibility /**< The GV is protected */
} LLVMVisibility; } LLVMVisibility;
typedef enum { typedef enum {
@ -106,35 +125,35 @@ typedef enum {
} LLVMCallConv; } LLVMCallConv;
typedef enum { typedef enum {
LLVMIntEQ = 32, /* equal */ LLVMIntEQ = 32, /**< equal */
LLVMIntNE, /* not equal */ LLVMIntNE, /**< not equal */
LLVMIntUGT, /* unsigned greater than */ LLVMIntUGT, /**< unsigned greater than */
LLVMIntUGE, /* unsigned greater or equal */ LLVMIntUGE, /**< unsigned greater or equal */
LLVMIntULT, /* unsigned less than */ LLVMIntULT, /**< unsigned less than */
LLVMIntULE, /* unsigned less or equal */ LLVMIntULE, /**< unsigned less or equal */
LLVMIntSGT, /* signed greater than */ LLVMIntSGT, /**< signed greater than */
LLVMIntSGE, /* signed greater or equal */ LLVMIntSGE, /**< signed greater or equal */
LLVMIntSLT, /* signed less than */ LLVMIntSLT, /**< signed less than */
LLVMIntSLE /* signed less or equal */ LLVMIntSLE /**< signed less or equal */
} LLVMIntPredicate; } LLVMIntPredicate;
typedef enum { typedef enum {
LLVMRealPredicateFalse, /* Always false (always folded) */ LLVMRealPredicateFalse, /**< Always false (always folded) */
LLVMRealOEQ, /* True if ordered and equal */ LLVMRealOEQ, /**< True if ordered and equal */
LLVMRealOGT, /* True if ordered and greater than */ LLVMRealOGT, /**< True if ordered and greater than */
LLVMRealOGE, /* True if ordered and greater than or equal */ LLVMRealOGE, /**< True if ordered and greater than or equal */
LLVMRealOLT, /* True if ordered and less than */ LLVMRealOLT, /**< True if ordered and less than */
LLVMRealOLE, /* True if ordered and less than or equal */ LLVMRealOLE, /**< True if ordered and less than or equal */
LLVMRealONE, /* True if ordered and operands are unequal */ LLVMRealONE, /**< True if ordered and operands are unequal */
LLVMRealORD, /* True if ordered (no nans) */ LLVMRealORD, /**< True if ordered (no nans) */
LLVMRealUNO, /* True if unordered: isnan(X) | isnan(Y) */ LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */
LLVMRealUEQ, /* True if unordered or equal */ LLVMRealUEQ, /**< True if unordered or equal */
LLVMRealUGT, /* True if unordered or greater than */ LLVMRealUGT, /**< True if unordered or greater than */
LLVMRealUGE, /* True if unordered, greater than, or equal */ LLVMRealUGE, /**< True if unordered, greater than, or equal */
LLVMRealULT, /* True if unordered or less than */ LLVMRealULT, /**< True if unordered or less than */
LLVMRealULE, /* True if unordered, less than, or equal */ LLVMRealULE, /**< True if unordered, less than, or equal */
LLVMRealUNE, /* True if unordered or not equal */ LLVMRealUNE, /**< True if unordered or not equal */
LLVMRealPredicateTrue /* Always true (always folded) */ LLVMRealPredicateTrue /**< Always true (always folded) */
} LLVMRealPredicate; } LLVMRealPredicate;

3
lib/VMCore/Core.cpp
View File

@ -562,7 +562,8 @@ void LLVMSetAlignment(LLVMValueRef Global, unsigned Bytes) {
LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name) { LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name) {
return wrap(new GlobalVariable(unwrap(Ty), false, return wrap(new GlobalVariable(unwrap(Ty), false,
GlobalValue::ExternalLinkage, 0, Name, unwrap(M))); GlobalValue::ExternalLinkage, 0, Name,
unwrap(M)));
} }
LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name) { LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name) {