Warning foo

[oota-llvm.git] / include / llvm / Support / CallSite.h

diff --git a/include/llvm/Support/CallSite.h b/include/llvm/Support/CallSite.h
index faf6d0d278a0d9f76f8a09fd370b86c3c882b148..45d28327f98a61575df6b970639b2861a57bad71 100644 (file)
--- a/include/llvm/Support/CallSite.h
+++ b/include/llvm/Support/CallSite.h
@@ -1,14 +1,30 @@
 //===-- llvm/Support/CallSite.h - Abstract Call & Invoke instrs -*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file defines the CallSite class, which is a handy wrapper for code that
 // wants to treat Call and Invoke instructions in a generic way.
 //
+// NOTE: This class is supposed to have "value semantics". So it should be
+// passed by value, not by reference; it should not be "new"ed or "delete"d. It
+// is efficiently copyable, assignable and constructable, with cost equivalent
+// to copying a pointer. (You will notice that it has only a single data
+// member.)
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_SUPPORT_CALLSITE_H
 #define LLVM_SUPPORT_CALLSITE_H
 
 #include "llvm/Instruction.h"
+#include "llvm/BasicBlock.h"
+
+namespace llvm {
 
 class CallInst;
 class InvokeInst;
@@ -22,19 +38,51 @@ public:
   CallSite(const CallSite &CS) : I(CS.I) {}
   CallSite &operator=(const CallSite &CS) { I = CS.I; return *this; }
 
+  /// CallSite::get - This static method is sort of like a constructor.  It will
+  /// create an appropriate call site for a Call or Invoke instruction, but it
+  /// can also create a null initialized CallSite object for something which is
+  /// NOT a call site.
+  ///
+  static CallSite get(Value *V) {
+    if (Instruction *I = dyn_cast<Instruction>(V)) {
+      if (I->getOpcode() == Instruction::Call)
+        return CallSite((CallInst*)I);
+      else if (I->getOpcode() == Instruction::Invoke)
+        return CallSite((InvokeInst*)I);
+    }
+    return CallSite();
+  }
+
+  /// getType - Return the type of the instruction that generated this call site
+  ///
+  const Type *getType () const { return I->getType (); }
+
   /// getInstruction - Return the instruction this call site corresponds to
   ///
   Instruction *getInstruction() const { return I; }
 
+  /// getCaller - Return the caller function for this call site
+  ///
+  Function *getCaller() const { return I->getParent()->getParent(); }
+
   /// getCalledValue - Return the pointer to function that is being called...
   ///
-  Value *getCalledValue() const { return I->getOperand(0); }
+  Value *getCalledValue() const {
+    assert(I && "Not a call or invoke instruction!");
+    return I->getOperand(0);
+  }
 
   /// getCalledFunction - Return the function being called if this is a direct
   /// call, otherwise return null (if it's an indirect call).
   ///
-  Function *getCalledFunction() const {
-    return dyn_cast<Function>(getCalledValue());
+  /// FIXME: This should be inlined once ConstantPointerRefs are gone.  :(
+  Function *getCalledFunction() const;
+
+  /// setCalledFunction - Set the callee to the specified value...
+  ///
+  void setCalledFunction(Value *V) {
+    assert(I && "Not a call or invoke instruction!");
+    I->setOperand(0, V);
   }
 
   /// arg_iterator - The type of iterator to use when looping over actual
@@ -45,12 +93,20 @@ public:
   /// list for a call site.
   ///
   arg_iterator arg_begin() const {
+    assert(I && "Not a call or invoke instruction!");
     if (I->getOpcode() == Instruction::Call)
       return I->op_begin()+1; // Skip Function
     else
       return I->op_begin()+3; // Skip Function, BB, BB
   }
-  arg_iterator arg_end() const { return I->op_begin(); }
+  arg_iterator arg_end() const { return I->op_end(); }
+  unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
+
+  bool operator<(const CallSite &CS) const {
+    return getInstruction() < CS.getInstruction();
+  }
 };
 
+} // End llvm namespace
+
 #endif