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_IR_ARGUMENT_H
15 #define LLVM_IR_ARGUMENT_H
17 #include "llvm/ADT/Twine.h"
18 #include "llvm/ADT/ilist_node.h"
19 #include "llvm/IR/Attributes.h"
20 #include "llvm/IR/Value.h"
24 template<typename ValueSubClass, typename ItemParentClass>
25 class SymbolTableListTraits;
27 /// \brief LLVM Argument representation
29 /// This class represents an incoming formal argument to a Function. A formal
30 /// argument, since it is ``formal'', does not contain an actual value but
31 /// instead represents the type, argument number, and attributes of an argument
32 /// for a specific function. When used in the body of said function, the
33 /// argument of course represents the value of the actual argument that the
34 /// function was called with.
35 class Argument : public Value, public ilist_node<Argument> {
36 virtual void anchor();
39 friend class SymbolTableListTraits<Argument, Function>;
40 void setParent(Function *parent);
43 /// \brief Constructor.
45 /// If \p F is specified, the argument is inserted at the end of the argument
47 explicit Argument(Type *Ty, const Twine &Name = "", Function *F = 0);
49 inline const Function *getParent() const { return Parent; }
50 inline Function *getParent() { return Parent; }
52 /// \brief Return the index of this formal argument in its containing
55 /// For example in "void foo(int a, float b)" a is 0 and b is 1.
56 unsigned getArgNo() const;
58 /// \brief Return true if this argument has the byval attribute on it in its
59 /// containing function.
60 bool hasByValAttr() const;
62 /// \brief If this is a byval argument, return its alignment.
63 unsigned getParamAlignment() const;
65 /// \brief Return true if this argument has the nest attribute on it in its
66 /// containing function.
67 bool hasNestAttr() const;
69 /// \brief Return true if this argument has the noalias attribute on it in its
70 /// containing function.
71 bool hasNoAliasAttr() const;
73 /// \brief Return true if this argument has the nocapture attribute on it in
74 /// its containing function.
75 bool hasNoCaptureAttr() const;
77 /// \brief Return true if this argument has the sret attribute on it in its
78 /// containing function.
79 bool hasStructRetAttr() const;
81 /// \brief Return true if this argument has the returned attribute on it in
82 /// its containing function.
83 bool hasReturnedAttr() const;
85 /// \brief Return true if this argument has the readonly or readnone attribute
86 /// on it in its containing function.
87 bool onlyReadsMemory() const;
90 /// \brief Add a Attribute to an argument.
91 void addAttr(AttributeSet AS);
93 /// \brief Remove a Attribute from an argument.
94 void removeAttr(AttributeSet AS);
96 /// \brief Method for support type inquiry through isa, cast, and
98 static inline bool classof(const Value *V) {
99 return V->getValueID() == ArgumentVal;
103 } // End llvm namespace