//===-- llvm/iOther.h - "Other" instruction node definitions -----*- C++ -*--=//
//
// This file contains the declarations for instructions that fall into the 
// grandios 'other' catagory...
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_IOTHER_H
#define LLVM_IOTHER_H

#include "llvm/InstrTypes.h"
#include "llvm/Method.h"
#include <vector>

//===----------------------------------------------------------------------===//
//                               PHINode Class
//===----------------------------------------------------------------------===//

// PHINode - The PHINode class is used to represent the magical mystical PHI
// node, that can not exist in nature, but can be synthesized in a computer
// scientist's overactive imagination.
//
class PHINode : public Instruction {
  typedef pair<Use,BasicBlockUse> PairTy;
  vector<PairTy> IncomingValues;

  PHINode(const PHINode &PN);
public:
  PHINode(const Type *Ty, const string &Name = "");
  inline ~PHINode() { dropAllReferences(); }

  virtual Instruction *clone() const { return new PHINode(*this); }

  // Implement all of the functionality required by User...
  //
  virtual void dropAllReferences();
  virtual const Value *getOperand(unsigned i) const {
    if (i >= IncomingValues.size()*2) return 0;
    if (i & 1) return IncomingValues[i/2].second;
    else       return IncomingValues[i/2].first;
  }
  inline Value *getOperand(unsigned i) {
    return (Value*)((const PHINode*)this)->getOperand(i);
  }
  virtual unsigned getNumOperands() const { return IncomingValues.size()*2; }
  virtual bool setOperand(unsigned i, Value *Val);
  virtual string getOpcode() const { return "phi"; }

  // getNumIncomingValues - Return the number of incoming edges the PHI node has
  inline unsigned getNumIncomingValues() const { return IncomingValues.size(); }

  // getIncomingValue - Return incoming value #x
  inline Value *getIncomingValue(unsigned i) const { 
    return IncomingValues[i].first; 
  }

  // getIncomingBlock - Return incoming basic block #x
  inline BasicBlock *getIncomingBlock(unsigned i) const { 
    return IncomingValues[i].second; 
  }

  // addIncoming - Add an incoming value to the end of the PHI list
  void addIncoming(Value *D, BasicBlock *BB);

  // removeIncomingValue - Remove an incoming value.  This is useful if a
  // predecessor basic block is deleted.  The value removed is returned.
  Value *removeIncomingValue(const BasicBlock *BB);
};


//===----------------------------------------------------------------------===//
//                           MethodArgument Class
//===----------------------------------------------------------------------===//

class MethodArgument : public Value {  // Defined in the InstrType.cpp file
  Method *Parent;

  friend class ValueHolder<MethodArgument,Method>;
  inline void setParent(Method *parent) { Parent = parent; }

public:
  MethodArgument(const Type *Ty, const string &Name = "") 
    : Value(Ty, Value::MethodArgumentVal, Name) {
    Parent = 0;
  }

  // Specialize setName to handle symbol table majik...
  virtual void setName(const string &name);

  inline const Method *getParent() const { return Parent; }
  inline       Method *getParent()       { return Parent; }
};


//===----------------------------------------------------------------------===//
//             Classes to function calls and method invocations
//===----------------------------------------------------------------------===//

class CallInst : public Instruction {
  MethodUse M;
  vector<Use> Params;
  CallInst(const CallInst &CI);
public:
  CallInst(Method *M, vector<Value*> &params, const string &Name = "");
  inline ~CallInst() { dropAllReferences(); }

  virtual string getOpcode() const { return "call"; }

  virtual Instruction *clone() const { return new CallInst(*this); }
  bool hasSideEffects() const { return true; }


  const Method *getCalledMethod() const { return M; }
        Method *getCalledMethod()       { return M; }

  // Implement all of the functionality required by Instruction...
  //
  virtual void dropAllReferences();
  virtual const Value *getOperand(unsigned i) const { 
    return i == 0 ? M : ((i <= Params.size()) ? Params[i-1] : 0);
  }
  inline Value *getOperand(unsigned i) {
    return (Value*)((const CallInst*)this)->getOperand(i);
  }
  virtual unsigned getNumOperands() const { return Params.size()+1; }

  virtual bool setOperand(unsigned i, Value *Val);
};

#endif