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/Attributes.h"
19 #include "llvm/ADT/ilist_node.h"
23 template<typename ValueSubClass, typename ItemParentClass>
24 class SymbolTableListTraits;
26 /// A class to represent an incoming formal argument to a Function. An argument
27 /// is a very simple Value. It is essentially a named (optional) type. When used
28 /// in the body of a function, it represents the value of the actual argument
29 /// the function was called with.
30 /// @brief LLVM Argument representation
31 class Argument : public Value, public ilist_node<Argument> {
34 friend class SymbolTableListTraits<Argument, Function>;
35 void setParent(Function *parent);
38 /// Argument ctor - If Function argument is specified, this argument is
39 /// inserted at the end of the argument list for the function.
41 explicit Argument(const Type *Ty, const Twine &Name = "", Function *F = 0);
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 /// hasNoCaptureAttr - Return true if this argument has the nocapture
59 /// attribute on it in its containing function.
60 bool hasNoCaptureAttr() const;
62 /// hasSRetAttr - Return true if this argument has the sret attribute on it in
63 /// its containing function.
64 bool hasStructRetAttr() const;
66 /// addAttr - Add a Attribute to an argument
67 void addAttr(Attributes);
69 /// removeAttr - Remove a Attribute from an argument
70 void removeAttr(Attributes);
72 /// classof - Methods for support type inquiry through isa, cast, and
75 static inline bool classof(const Argument *) { return true; }
76 static inline bool classof(const Value *V) {
77 return V->getValueID() == ArgumentVal;
81 } // End llvm namespace