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"
21 template<typename ValueSubClass, typename ItemParentClass>
22 class SymbolTableListTraits;
24 /// A class to represent an incoming formal argument to a Function. An argument
25 /// is a very simple Value. It is essentially a named (optional) type. When used
26 /// in the body of a function, it represents the value of the actual argument
27 /// the function was called with.
28 /// @brief LLVM Argument representation
29 class Argument : public Value { // Defined in the Function.cpp file
32 Argument *Prev, *Next; // Next and Prev links for our intrusive linked list
33 void setNext(Argument *N) { Next = N; }
34 void setPrev(Argument *N) { Prev = N; }
35 friend class SymbolTableListTraits<Argument, Function>;
36 void setParent(Function *parent);
39 /// Argument ctor - If Function argument is specified, this argument is
40 /// inserted at the end of the argument list for the function.
42 explicit Argument(const Type *Ty, const std::string &Name = "",
45 inline const Function *getParent() const { return Parent; }
46 inline Function *getParent() { return Parent; }
48 /// getArgNo - Return the index of this formal argument in its containing
49 /// function. For example in "void foo(int a, float b)" a is 0 and b is 1.
50 unsigned getArgNo() const;
52 /// hasByValAttr - Return true if this argument has the byval attribute on it
53 /// in its containing function.
54 bool hasByValAttr() const;
56 /// hasNoAliasAttr - Return true if this argument has the noalias attribute on
57 /// it in its containing function.
58 bool hasNoAliasAttr() const;
60 virtual void print(std::ostream &OS) const;
61 void print(std::ostream *OS) const {
65 /// classof - Methods for support type inquiry through isa, cast, and
68 static inline bool classof(const Argument *) { return true; }
69 static inline bool classof(const Value *V) {
70 return V->getValueID() == ArgumentVal;
74 // getNext/Prev - Return the next or previous argument in the list.
75 Argument *getNext() { return Next; }
76 const Argument *getNext() const { return Next; }
77 Argument *getPrev() { return Prev; }
78 const Argument *getPrev() const { return Prev; }
81 } // End llvm namespace