Fix a -Wreturn-type warning in g++.

[oota-llvm.git] / lib / VMCore / ConstantFold.h

diff --git a/lib/VMCore/ConstantFold.h b/lib/VMCore/ConstantFold.h
index dc5d0cfbfaea3bdad5c06ded2eb480acb8678e23..e12f27a7cb1ead40b9e0805e7b638937f52dd2c2 100644 (file)
--- a/lib/VMCore/ConstantFold.h
+++ b/lib/VMCore/ConstantFold.h
@@ -1,82 +1,56 @@
-//===-- 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 they don't know how to perform
+// the specified operation on the specified constant types.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef CONSTANTHANDLING_H
-#define CONSTANTHANDLING_H
+#ifndef CONSTANTFOLDING_H
+#define CONSTANTFOLDING_H
 
-#include <vector>
+#include "llvm/ADT/ArrayRef.h"
 
 namespace llvm {
+  class Value;
   class Constant;
   class Type;
-  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 Constant *lessthan(const Constant *V1, const Constant *V2) const = 0;
-                             
-  virtual Constant *equalto(const Constant *V1, const Constant *V2) const = 0;
-
-  // Casting operators.  ick
-  virtual Constant *castToBool  (const Constant *V) const = 0;
-  virtual Constant *castToSByte (const Constant *V) const = 0;
-  virtual Constant *castToUByte (const Constant *V) const = 0;
-  virtual Constant *castToShort (const Constant *V) const = 0;
-  virtual Constant *castToUShort(const Constant *V) const = 0;
-  virtual Constant *castToInt   (const Constant *V) const = 0;
-  virtual Constant *castToUInt  (const Constant *V) const = 0;
-  virtual Constant *castToLong  (const Constant *V) const = 0;
-  virtual Constant *castToULong (const Constant *V) const = 0;
-  virtual Constant *castToFloat (const Constant *V) const = 0;
-  virtual Constant *castToDouble(const Constant *V) const = 0;
-  virtual Constant *castToPointer(const Constant *V,
-                                  const PointerType *Ty) const = 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);
 
+  // Constant fold various types of instruction...
+  Constant *ConstantFoldCastInstruction(
+    unsigned opcode,     ///< The opcode of the cast
+    Constant *V,         ///< The source constant
+    Type *DestTy   ///< The destination type
+  );
+  Constant *ConstantFoldSelectInstruction(Constant *Cond,
+                                          Constant *V1, Constant *V2);
+  Constant *ConstantFoldExtractElementInstruction(Constant *Val, Constant *Idx);
+  Constant *ConstantFoldInsertElementInstruction(Constant *Val, Constant *Elt,
+                                                 Constant *Idx);
+  Constant *ConstantFoldShuffleVectorInstruction(Constant *V1, Constant *V2,
+                                                 Constant *Mask);
+  Constant *ConstantFoldExtractValueInstruction(Constant *Agg,
+                                                ArrayRef<unsigned> Idxs);
+  Constant *ConstantFoldInsertValueInstruction(Constant *Agg, Constant *Val,
+                                               ArrayRef<unsigned> Idxs);
+  Constant *ConstantFoldBinaryInstruction(unsigned Opcode, Constant *V1,
+                                          Constant *V2);
+  Constant *ConstantFoldCompareInstruction(unsigned short predicate, 
+                                           Constant *C1, Constant *C2);
+  Constant *ConstantFoldGetElementPtr(Constant *C, bool inBounds,
+                                      ArrayRef<Constant *> Idxs);
+  Constant *ConstantFoldGetElementPtr(Constant *C, bool inBounds,
+                                      ArrayRef<Value *> Idxs);
 } // End llvm namespace
 
 #endif