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 { // Defined in the Function.cpp file
33 Argument *Prev, *Next; // Next and Prev links for our intrusive linked list
34 void setNext(Argument *N) { Next = N; }
35 void setPrev(Argument *N) { Prev = N; }
36 friend class SymbolTableListTraits<Argument, Function>;
37 void setParent(Function *parent);
40 /// Argument ctor - If Function argument is specified, this argument is
41 /// inserted at the end of the argument list for the function.
43 explicit Argument(const Type *Ty, const std::string &Name = "",
46 inline const Function *getParent() const { return Parent; }
47 inline Function *getParent() { return Parent; }
49 /// getArgNo - Return the index of this formal argument in its containing
50 /// function. For example in "void foo(int a, float b)" a is 0 and b is 1.
51 unsigned getArgNo() const;
53 /// hasByValAttr - Return true if this argument has the byval attribute on it
54 /// in its containing function.
55 bool hasByValAttr() const;
57 /// hasNoAliasAttr - Return true if this argument has the noalias attribute on
58 /// it in its containing function.
59 bool hasNoAliasAttr() const;
61 /// hasSRetAttr - Return true if this argument has the sret attribute on it in
62 /// its containing function.
63 bool hasStructRetAttr() const;
65 /// addAttr - Add a ParamAttr to an argument
66 void addAttr(ParameterAttributes);
68 /// removeAttr - Remove a ParamAttr from an argument
69 void removeAttr(ParameterAttributes);
71 virtual void print(std::ostream &OS) const;
72 void print(std::ostream *OS) const {
76 /// classof - Methods for support type inquiry through isa, cast, and
79 static inline bool classof(const Argument *) { return true; }
80 static inline bool classof(const Value *V) {
81 return V->getValueID() == ArgumentVal;
85 // getNext/Prev - Return the next or previous argument in the list.
86 Argument *getNext() { return Next; }
87 const Argument *getNext() const { return Next; }
88 Argument *getPrev() { return Prev; }
89 const Argument *getPrev() const { return Prev; }
92 } // End llvm namespace