1 //===-- llvm/Argument.h - Definition of the Argument class ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the Argument class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ARGUMENT_H
15 #define LLVM_ARGUMENT_H
17 #include "llvm/Value.h"
18 #include "llvm/ParameterAttributes.h"
22 template<typename ValueSubClass, typename ItemParentClass>
23 class SymbolTableListTraits;
25 /// A class to represent an incoming formal argument to a Function. An argument
26 /// is a very simple Value. It is essentially a named (optional) type. When used
27 /// in the body of a function, it represents the value of the actual argument
28 /// the function was called with.
29 /// @brief LLVM Argument representation
30 class Argument : public Value, public ilist_node<Argument> {
33 friend class SymbolTableListTraits<Argument, Function>;
34 void setParent(Function *parent);
37 /// Argument ctor - If Function argument is specified, this argument is
38 /// inserted at the end of the argument list for the function.
40 explicit Argument(const Type *Ty, const std::string &Name = "",
43 inline const Function *getParent() const { return Parent; }
44 inline Function *getParent() { return Parent; }
46 /// getArgNo - Return the index of this formal argument in its containing
47 /// function. For example in "void foo(int a, float b)" a is 0 and b is 1.
48 unsigned getArgNo() const;
50 /// hasByValAttr - Return true if this argument has the byval attribute on it
51 /// in its containing function.
52 bool hasByValAttr() const;
54 /// hasNoAliasAttr - Return true if this argument has the noalias attribute on
55 /// it in its containing function.
56 bool hasNoAliasAttr() const;
58 /// hasSRetAttr - Return true if this argument has the sret attribute on it in
59 /// its containing function.
60 bool hasStructRetAttr() const;
62 /// addAttr - Add a ParamAttr to an argument
63 void addAttr(ParameterAttributes);
65 /// removeAttr - Remove a ParamAttr from an argument
66 void removeAttr(ParameterAttributes);
68 /// classof - Methods for support type inquiry through isa, cast, and
71 static inline bool classof(const Argument *) { return true; }
72 static inline bool classof(const Value *V) {
73 return V->getValueID() == ArgumentVal;
77 } // End llvm namespace