General APIs

Collaboration diagram for General APIs:

Macros
#define	LLVM_DECLARE_VALUE_CAST(name)    LLVMValueRef LLVMIsA##name(LLVMValueRef Val);

Functions
LLVMTypeRef	LLVMTypeOf (LLVMValueRef Val)
LLVMValueKind	LLVMGetValueKind (LLVMValueRef Val)
const char *	LLVMGetValueName2 (LLVMValueRef Val, size_t *Length)
void	LLVMSetValueName2 (LLVMValueRef Val, const char *Name, size_t NameLen)
void	LLVMDumpValue (LLVMValueRef Val)
char *	LLVMPrintValueToString (LLVMValueRef Val)
void	LLVMReplaceAllUsesWith (LLVMValueRef OldVal, LLVMValueRef NewVal)
LLVMBool	LLVMIsConstant (LLVMValueRef Val)
LLVMBool	LLVMIsUndef (LLVMValueRef Val)
LLVMBool	LLVMIsPoison (LLVMValueRef Val)
LLVMValueRef	LLVMIsAMDNode (LLVMValueRef Val)
LLVMValueRef	LLVMIsAValueAsMetadata (LLVMValueRef Val)
LLVMValueRef	LLVMIsAMDString (LLVMValueRef Val)
const char *	LLVMGetValueName (LLVMValueRef Val)
void	LLVMSetValueName (LLVMValueRef Val, const char *Name)

Detailed Description

Functions in this section work on all LLVMValueRef instances, regardless of their sub-type. They correspond to functions available on llvm::Value.

Macro Definition Documentation

LLVM_DECLARE_VALUE_CAST

#define LLVM_DECLARE_VALUE_CAST

(

name

)

LLVMValueRef LLVMIsA##name(LLVMValueRef Val);

Convert value instances between types.

Internally, an LLVMValueRef is "pinned" to a specific type. This series of functions allows you to cast an instance to a specific type.

If the cast is not valid for the specified type, NULL is returned.

See also

llvm::dyn_cast_or_null<>

Definition at line 1884 of file Core.h.

Function Documentation

LLVMDumpValue()

void LLVMDumpValue

(

LLVMValueRef

Val

)

Dump a representation of a value to stderr.

See also

llvm::Value::dump()

LLVMGetValueKind()

LLVMValueKind LLVMGetValueKind

(

LLVMValueRef

Val

)

Obtain the enumerated type of a Value instance.

See also

llvm::Value::getValueID()

LLVMGetValueName()

const char * LLVMGetValueName

(

LLVMValueRef

Val

)

Deprecated: Use LLVMGetValueName2 instead.

LLVMGetValueName2()

const char * LLVMGetValueName2	(	LLVMValueRef	Val,
		size_t *	Length
	)

Obtain the string name of a value.

See also

llvm::Value::getName()

LLVMIsAMDNode()

LLVMValueRef LLVMIsAMDNode

(

LLVMValueRef

Val

)

LLVMIsAMDString()

LLVMValueRef LLVMIsAMDString

(

LLVMValueRef

Val

)

LLVMIsAValueAsMetadata()

LLVMValueRef LLVMIsAValueAsMetadata

(

LLVMValueRef

Val

)

LLVMIsConstant()

LLVMBool LLVMIsConstant

(

LLVMValueRef

Val

)

Determine whether the specified value instance is constant.

LLVMIsPoison()

LLVMBool LLVMIsPoison

(

LLVMValueRef

Val

)

Determine whether a value instance is poisonous.

LLVMIsUndef()

LLVMBool LLVMIsUndef

(

LLVMValueRef

Val

)

Determine whether a value instance is undefined.

LLVMPrintValueToString()

char * LLVMPrintValueToString

(

LLVMValueRef

Val

)

Return a string representation of the value. Use LLVMDisposeMessage to free the string.

See also

llvm::Value::print()

LLVMReplaceAllUsesWith()

void LLVMReplaceAllUsesWith	(	LLVMValueRef	OldVal,
		LLVMValueRef	NewVal
	)

Replace all uses of a value with another one.

See also

llvm::Value::replaceAllUsesWith()

LLVMSetValueName()

void LLVMSetValueName	(	LLVMValueRef	Val,
		const char *	Name
	)

Deprecated: Use LLVMSetValueName2 instead.

LLVMSetValueName2()

void LLVMSetValueName2	(	LLVMValueRef	Val,
		const char *	Name,
		size_t	NameLen
	)

Set the string name of a value.

See also

llvm::Value::setName()

LLVMTypeOf()

LLVMTypeRef LLVMTypeOf

(

LLVMValueRef

Val

)

Obtain the type of a value.

See also

llvm::Value::getType()