1 //===-- llvm/Argument.h - Definition of the Argument class ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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 SC> struct ilist_traits;
22 template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
23 typename SubClass> 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, Function,
37 ilist_traits<Argument> >;
38 void setParent(Function *parent);
41 /// Argument ctor - If Function argument is specified, this argument is
42 /// inserted at the end of the argument list for the function.
44 Argument(const Type *Ty, const std::string &Name = "", Function *F = 0);
46 inline const Function *getParent() const { return Parent; }
47 inline Function *getParent() { return Parent; }
49 // getNext/Prev - Return the next or previous argument in the list.
50 Argument *getNext() { return Next; }
51 const Argument *getNext() const { return Next; }
52 Argument *getPrev() { return Prev; }
53 const Argument *getPrev() const { return Prev; }
55 virtual void print(std::ostream &OS) const;
56 void print(std::ostream *OS) const {
60 /// classof - Methods for support type inquiry through isa, cast, and
63 static inline bool classof(const Argument *) { return true; }
64 static inline bool classof(const Value *V) {
65 return V->getValueType() == ArgumentVal;
69 } // End llvm namespace