include/llvm/Argument.h

   1 //===-- llvm/Argument.h - Definition of the Argument class ------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares the Argument class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ARGUMENT_H
  15 #define LLVM_ARGUMENT_H
  16
  17 #include "llvm/Value.h"
  18
  19 namespace llvm {
  20
  21 template<typename ValueSubClass, typename ItemParentClass>
  22   class SymbolTableListTraits;
  23
  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
  30   Function *Parent;
  31
  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);
  37
  38 protected:
  39   static void destroyThis(Argument*v) {
  40     Value::destroyThis(v);
  41   }
  42   friend class Value;
  43 public:
  44   /// Argument ctor - If Function argument is specified, this argument is
  45   /// inserted at the end of the argument list for the function.
  46   ///
  47   explicit Argument(const Type *Ty,
  48                     const std::string &Name = "",
  49                     Function *F = 0);
  50
  51   inline const Function *getParent() const { return Parent; }
  52   inline       Function *getParent()       { return Parent; }
  53
  54   virtual void print(std::ostream &OS) const;
  55   void print(std::ostream *OS) const {
  56     if (OS) print(*OS);
  57   }
  58
  59   /// classof - Methods for support type inquiry through isa, cast, and
  60   /// dyn_cast:
  61   ///
  62   static inline bool classof(const Argument *) { return true; }
  63   static inline bool classof(const Value *V) {
  64     return V->getValueID() == ArgumentVal;
  65   }
  66
  67 private:
  68   // getNext/Prev - Return the next or previous argument in the list.
  69   Argument *getNext()       { return Next; }
  70   const Argument *getNext() const { return Next; }
  71   Argument *getPrev()       { return Prev; }
  72   const Argument *getPrev() const { return Prev; }
  73 };
  74
  75 } // End llvm namespace
  76
  77 #endif