Turn StripPointerCast() into a method
[oota-llvm.git] / lib / VMCore / ConstantFold.h
index 8d2933621e6cb393e5f56b7a6427925b32b1d2e6..1c1e6e5d0c29d49ab3faf3aaacff26d1527c21fb 100644 (file)
-//===-- ConstantHandling.h - Stuff for manipulating constants ---*- C++ -*-===//
-// 
+//===-- ConstantFolding.h - Internal Constant Folding Interface -*- 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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
 //===----------------------------------------------------------------------===//
 //
-// WARNING: These operators may return a null object if I don't know how to 
-//          perform the specified operation on the specified constant types.
+// This file defines the (internal) constant folding interfaces for LLVM.  These
+// interfaces are used by the ConstantExpr::get* methods to automatically fold
+// constants when possible.
+//
+// These operators may return a null object if I don't know how to perform the
+// specified operation on the specified constant types.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_CONSTANTHANDLING_H
-#define LLVM_CONSTANTHANDLING_H
-
-#include "llvm/Constants.h"
-#include "llvm/Type.h"
+#ifndef CONSTANTFOLDING_H
+#define CONSTANTFOLDING_H
 
 namespace llvm {
-
-class PointerType;
-
-struct ConstRules {
-  ConstRules() {}
-
-  // Binary Operators...
-  virtual Constant *add(const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *sub(const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *mul(const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *div(const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *rem(const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *op_and(const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *op_or (const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *op_xor(const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *shl(const Constant *V1, const Constant *V2) const = 0;
-  virtual Constant *shr(const Constant *V1, const Constant *V2) const = 0;
-
-  virtual ConstantBool *lessthan(const Constant *V1, 
-                                 const Constant *V2) const = 0;
-  virtual ConstantBool *equalto(const Constant *V1, 
-                                const Constant *V2) const = 0;
-
-  // Casting operators.  ick
-  virtual ConstantBool *castToBool  (const Constant *V) const = 0;
-  virtual ConstantSInt *castToSByte (const Constant *V) const = 0;
-  virtual ConstantUInt *castToUByte (const Constant *V) const = 0;
-  virtual ConstantSInt *castToShort (const Constant *V) const = 0;
-  virtual ConstantUInt *castToUShort(const Constant *V) const = 0;
-  virtual ConstantSInt *castToInt   (const Constant *V) const = 0;
-  virtual ConstantUInt *castToUInt  (const Constant *V) const = 0;
-  virtual ConstantSInt *castToLong  (const Constant *V) const = 0;
-  virtual ConstantUInt *castToULong (const Constant *V) const = 0;
-  virtual ConstantFP   *castToFloat (const Constant *V) const = 0;
-  virtual ConstantFP   *castToDouble(const Constant *V) const = 0;
-  virtual Constant     *castToPointer(const Constant *V,
-                                      const PointerType *Ty) const = 0;
-
-  inline Constant *castTo(const Constant *V, const Type *Ty) const {
-    switch (Ty->getPrimitiveID()) {
-    case Type::BoolTyID:   return castToBool(V);
-    case Type::UByteTyID:  return castToUByte(V);
-    case Type::SByteTyID:  return castToSByte(V);
-    case Type::UShortTyID: return castToUShort(V);
-    case Type::ShortTyID:  return castToShort(V);
-    case Type::UIntTyID:   return castToUInt(V);
-    case Type::IntTyID:    return castToInt(V);
-    case Type::ULongTyID:  return castToULong(V);
-    case Type::LongTyID:   return castToLong(V);
-    case Type::FloatTyID:  return castToFloat(V);
-    case Type::DoubleTyID: return castToDouble(V);
-    case Type::PointerTyID:
-      return castToPointer(V, reinterpret_cast<const PointerType*>(Ty));
-    default: return 0;
-    }
-  }
-
-  // ConstRules::get - Return an instance of ConstRules for the specified
-  // constant operands.
-  //
-  static ConstRules &get(const Constant *V1, const Constant *V2);
-private:
-  ConstRules(const ConstRules &);             // Do not implement
-  ConstRules &operator=(const ConstRules &);  // Do not implement
-};
-
-
-//===----------------------------------------------------------------------===//
-//  Implement higher level instruction folding type instructions
-//===----------------------------------------------------------------------===//
-
-// Constant fold various types of instruction...
-Constant *ConstantFoldCastInstruction(const Constant *V, const Type *DestTy);
-Constant *ConstantFoldBinaryInstruction(unsigned Opcode, const Constant *V1,
-                                        const Constant *V2);
-Constant *ConstantFoldGetElementPtr(const Constant *C,
-                                    const std::vector<Constant*> &IdxList);
-
+  class Value;
+  class Constant;
+  class Type;
+
+  // Constant fold various types of instruction...
+  Constant *ConstantFoldCastInstruction(
+    unsigned opcode,     ///< The opcode of the cast
+    const Constant *V,   ///< The source constant
+    const Type *DestTy   ///< The destination type
+  );
+  Constant *ConstantFoldSelectInstruction(const Constant *Cond,
+                                          const Constant *V1,
+                                          const Constant *V2);
+  Constant *ConstantFoldExtractElementInstruction(const Constant *Val,
+                                                  const Constant *Idx);
+  Constant *ConstantFoldInsertElementInstruction(const Constant *Val,
+                                                 const Constant *Elt,
+                                                 const Constant *Idx);
+  Constant *ConstantFoldShuffleVectorInstruction(const Constant *V1,
+                                                 const Constant *V2,
+                                                 const Constant *Mask);
+  Constant *ConstantFoldBinaryInstruction(unsigned Opcode, const Constant *V1,
+                                          const Constant *V2);
+  Constant *ConstantFoldCompareInstruction(unsigned short predicate, 
+                                           const Constant *C1, 
+                                           const Constant *C2);
+  Constant *ConstantFoldGetElementPtr(const Constant *C,
+                                      Constant* const *Idxs, unsigned NumIdx);
 } // End llvm namespace
 
 #endif