Move the search for the appropriate AND instruction
[oota-llvm.git] / include / llvm / Argument.h
index 7a9acdab1dd32f748ec23af6011ab3f4d46baa74..71c001fbe18d7a04f8e07c546113f0df6dcb41b3 100644 (file)
@@ -1,7 +1,13 @@
-//===-- llvm/Argument.h - Definition of the Argument class -------*- C++ -*--=//
+//===-- llvm/Argument.h - Definition of the Argument class ------*- C++ -*-===//
 //
-// This file defines the Argument class, which represents and incoming formal
-// argument to a function.
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file declares the Argument class. 
 //
 //===----------------------------------------------------------------------===//
 
 #define LLVM_ARGUMENT_H
 
 #include "llvm/Value.h"
+#include "llvm/Attributes.h"
+#include "llvm/ADT/ilist_node.h"
+#include "llvm/ADT/Twine.h"
 
-class Argument : public Value {  // Defined in the InstrType.cpp file
+namespace llvm {
+
+template<typename ValueSubClass, typename ItemParentClass>
+  class SymbolTableListTraits;
+
+/// A class to represent an incoming formal argument to a Function. An argument
+/// is a very simple Value. It is essentially a named (optional) type. When used
+/// in the body of a function, it represents the value of the actual argument
+/// the function was called with.
+/// @brief LLVM Argument representation  
+class Argument : public Value, public ilist_node<Argument> {
   Function *Parent;
 
-  Argument *Prev, *Next; // Next and Prev links for our intrusive linked list
-  void setNext(Argument *N) { Next = N; }
-  void setPrev(Argument *N) { Prev = N; }
-  friend class SymbolTableListTraits<Argument, Function, Function>;
-  inline void setParent(Function *parent) { Parent = parent; }
+  friend class SymbolTableListTraits<Argument, Function>;
+  void setParent(Function *parent);
 
 public:
-  Argument(const Type *Ty, const std::string &Name = "") 
-    : Value(Ty, Value::ArgumentVal, Name) {
-    Parent = 0;
-  }
-
-  /// setName - Specialize setName to handle symbol table majik...
-  virtual void setName(const std::string &name, SymbolTable *ST = 0);
+  /// Argument ctor - If Function argument is specified, this argument is
+  /// inserted at the end of the argument list for the function.
+  ///
+  explicit Argument(const Type *Ty, const Twine &Name = "", Function *F = 0);
 
   inline const Function *getParent() const { return Parent; }
   inline       Function *getParent()       { return Parent; }
-  // getNext/Prev - Return the next or previous argument in the list.
-        Argument *getNext()       { return Next; }
-  const Argument *getNext() const { return Next; }
-        Argument *getPrev()       { return Prev; }
-  const Argument *getPrev() const { return Prev; }
 
-  virtual void print(std::ostream &OS) const;
+  /// getArgNo - Return the index of this formal argument in its containing
+  /// function.  For example in "void foo(int a, float b)" a is 0 and b is 1. 
+  unsigned getArgNo() const;
+  
+  /// hasByValAttr - Return true if this argument has the byval attribute on it
+  /// in its containing function.
+  bool hasByValAttr() const;
+
+  /// hasNestAttr - Return true if this argument has the nest attribute on
+  /// it in its containing function.
+  bool hasNestAttr() const;
+
+  /// hasNoAliasAttr - Return true if this argument has the noalias attribute on
+  /// it in its containing function.
+  bool hasNoAliasAttr() const;
+  
+  /// hasNoCaptureAttr - Return true if this argument has the nocapture
+  /// attribute on it in its containing function.
+  bool hasNoCaptureAttr() const;
+  
+  /// hasSRetAttr - Return true if this argument has the sret attribute on it in
+  /// its containing function.
+  bool hasStructRetAttr() const;
+
+  /// addAttr - Add a Attribute to an argument
+  void addAttr(Attributes);
+  
+  /// removeAttr - Remove a Attribute from an argument
+  void removeAttr(Attributes);
 
   /// classof - Methods for support type inquiry through isa, cast, and
   /// dyn_cast:
   ///
   static inline bool classof(const Argument *) { return true; }
   static inline bool classof(const Value *V) {
-    return V->getValueType() == ArgumentVal;
+    return V->getValueID() == ArgumentVal;
   }
 };
 
+} // End llvm namespace
+
 #endif