LLVM API Documentation

llvm::ConstantArray Class Reference

#include <Constants.h>

Inheritance diagram for llvm::ConstantArray:
[legend]
Collaboration diagram for llvm::ConstantArray:
[legend]

List of all members.

Public Member Functions

 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Constant)
 Transparently provide more efficient getOperand methods.
const ArrayType * getType () const
bool isString () const
bool isCString () const
std::string getAsString () const
virtual bool isNullValue () const
virtual void destroyConstant ()
virtual void replaceUsesOfWithOnConstant (Value *From, Value *To, Use *U)

Static Public Member Functions

static Constant * get (const ArrayType *T, const std::vector< Constant * > &V)
static Constant * get (const ArrayType *T, Constant *const *Vals, unsigned NumVals)
static Constant * get (LLVMContext &Context, const StringRef &Initializer, bool AddNull=true)
static bool classof (const ConstantArray *)
 Methods for support type inquiry through isa, cast, and dyn_cast:.
static bool classof (const Value *V)

Protected Member Functions

 ConstantArray (const ArrayType *T, const std::vector< Constant * > &Val)

Friends

struct ConstantCreator< ConstantArray, ArrayType, std::vector< Constant * > >


Detailed Description

ConstantArray - Constant Array Declarations

Definition at line 337 of file Constants.h.


Constructor & Destructor Documentation

ConstantArray::ConstantArray ( const ArrayType *  T,
const std::vector< Constant * > &  Val 
) [protected]


Member Function Documentation

Constant * ConstantArray::get ( const ArrayType *  T,
const std::vector< Constant * > &  V 
) [static]

Constant * ConstantArray::get ( const ArrayType *  T,
Constant *const *  Vals,
unsigned  NumVals 
) [static]

Definition at line 495 of file Constants.cpp.

Constant * ConstantArray::get ( LLVMContext &  Context,
const StringRef &  Str,
bool  AddNull = true 
) [static]

This method constructs a ConstantArray and initializes it with a text string. The default behavior (AddNull==true) causes a null terminator to be placed at the end of the array. This effectively increases the length of the array by one (you've been warned). However, in some situations this is not desired so if AddNull==false then the string is copied without null termination.

ConstantArray::get(const string&) - Return an array that is initialized to contain the specified string. If length is zero then a null terminator is added to the specified string so that it may be used in a natural way. Otherwise, the length parameter specifies how much of the string to use and it won't be null terminated.

Definition at line 507 of file Constants.cpp.

References llvm::ArrayType::get(), llvm::ConstantInt::get(), llvm::Type::getInt8Ty(), and llvm::StringRef::size().

llvm::ConstantArray::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Constant   ) 

Transparently provide more efficient getOperand methods.

const ArrayType* llvm::ConstantArray::getType (  )  const [inline]

getType - Specialize the getType() method to always return an ArrayType, which reduces the amount of casting needed in parts of the compiler.

Reimplemented from llvm::Value.

Definition at line 364 of file Constants.h.

References llvm::Intrinsic::getType().

Referenced by destroyConstant(), llvm::GetConstantStringInfo(), GetStringLengthH(), isCString(), isString(), and replaceUsesOfWithOnConstant().

bool ConstantArray::isString (  )  const

isString - This method returns true if the array is an array of i8 and the elements of the array are all ConstantInt's.

isString - This method returns true if the array is an array of i8, and if the elements of the array are all ConstantInt's.

Definition at line 884 of file Constants.cpp.

References llvm::Value::getContext(), llvm::Type::getInt8Ty(), llvm::User::getNumOperands(), llvm::Constant::getOperand(), and getType().

Referenced by getAsString(), and printAsCString().

bool ConstantArray::isCString (  )  const

isCString - This method returns true if the array is a string (see

  /// isString) and it ends in a null byte \0 and does not contains any other
  /// 
null bytes except its terminator.

isCString - This method returns true if the array is a string (see isString) and it ends in a null byte \0 and does not contains any other null bytes except its terminator.

Definition at line 899 of file Constants.cpp.

References llvm::Value::getContext(), llvm::Type::getInt8Ty(), llvm::User::getNumOperands(), llvm::Constant::getOperand(), getType(), and isNullValue().

std::string ConstantArray::getAsString (  )  const

getAsString - If this array is isString(), then this method converts the array to an std::string and returns it. Otherwise, it asserts out.

getAsString - If the sub-element type of this array is i8 then this method converts the array to an std::string and returns it. Otherwise, it asserts out.

Definition at line 922 of file Constants.cpp.

References llvm::User::getNumOperands(), llvm::Constant::getOperand(), and isString().

virtual bool llvm::ConstantArray::isNullValue (  )  const [inline, virtual]

isNullValue - Return true if this is the value that would be returned by getNullValue. This always returns false because zero arrays are always created as ConstantAggregateZero objects.

Implements llvm::Constant.

Definition at line 387 of file Constants.h.

Referenced by isCString().

void ConstantArray::destroyConstant (  )  [virtual]

void ConstantArray::replaceUsesOfWithOnConstant ( Value *  ,
Value *  ,
Use *   
) [virtual]

replaceUsesOfWithOnConstant - This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants. Basically this method goes through the trouble of building a new constant that is equivalent to the current one, with all uses of From replaced with uses of To. After this construction is completed, all of the users of 'this' are replaced to use the new constant, and then 'this' is deleted. In general, you should not call this method, instead, use Value::replaceAllUsesWith, which automatically dispatches to this method as needed.

Reimplemented from llvm::Constant.

Definition at line 1829 of file Constants.cpp.

References llvm::LLVMContextImpl::ArrayConstants, llvm::LLVMContextImpl::ConstantsLock, Context, destroyConstant(), E, llvm::ConstantAggregateZero::get(), llvm::Type::getContext(), llvm::User::getNumOperands(), llvm::Constant::getOperand(), getType(), llvm::Constant::isNullValue(), Lookup(), llvm::SystemZCC::O, llvm::User::OperandList, llvm::LLVMContext::pImpl, llvm::Constant::setOperand(), llvm::Value::uncheckedReplaceAllUsesWith(), Val, and Values.

static bool llvm::ConstantArray::classof ( const ConstantArray *   )  [inline, static]

Methods for support type inquiry through isa, cast, and dyn_cast:.

Definition at line 393 of file Constants.h.

static bool llvm::ConstantArray::classof ( const Value *  V  )  [inline, static]

Reimplemented from llvm::Constant.

Definition at line 394 of file Constants.h.

References llvm::Value::ConstantArrayVal, and llvm::Value::getValueID().


Friends And Related Function Documentation

friend struct ConstantCreator< ConstantArray, ArrayType,std::vector< Constant * > > [friend]

Definition at line 339 of file Constants.h.


The documentation for this class was generated from the following files: