Sort a few more #include lines in tools/... unittests/... and utils/...

[oota-llvm.git] / include / llvm / LLVMContext.h

diff --git a/include/llvm/LLVMContext.h b/include/llvm/LLVMContext.h
index 0aea6b89222a4a51267494e7020ead4d1652bfee..58fb39f056484a967433386b4bedf3787f60f86a 100644 (file)
--- a/include/llvm/LLVMContext.h
+++ b/include/llvm/LLVMContext.h
@@ -15,52 +15,116 @@
 #ifndef LLVM_LLVMCONTEXT_H
 #define LLVM_LLVMCONTEXT_H
 
-#include "llvm/Support/DataTypes.h"
-#include <vector>
-#include <string>
+#include "llvm/Support/Compiler.h"
 
 namespace llvm {
 
-class APFloat;
-class APInt;
-class ArrayType;
-class Constant;
-class ConstantAggregateZero;
-class ConstantArray;
-class ConstantFP;
-class ConstantInt;
-class ConstantPointerNull;
-class ConstantStruct;
-class ConstantVector;
-class FunctionType;
-class IntegerType;
-struct LLVMContextImpl;
-class MDNode;
-class MDString;
-class OpaqueType;
-class PointerType;
+class LLVMContextImpl;
 class StringRef;
-class StructType;
-class Type;
-class UndefValue;
-class Use;
-class Value;
-class VectorType;
+class Twine;
+class Instruction;
+class Module;
+class SMDiagnostic;
+template <typename T> class SmallVectorImpl;
 
 /// This is an important class for using LLVM in a threaded context.  It
 /// (opaquely) owns and manages the core "global" data of LLVM's core 
 /// infrastructure, including the type and constant uniquing tables.
 /// LLVMContext itself provides no locking guarantees, so you should be careful
 /// to have one context per thread.
-struct LLVMContext {
-  LLVMContextImpl* pImpl;
-  
+class LLVMContext {
+public:
+  LLVMContextImpl *const pImpl;
   LLVMContext();
   ~LLVMContext();
+  
+  // Pinned metadata names, which always have the same value.  This is a
+  // compile-time performance optimization, not a correctness optimization.
+  enum {
+    MD_dbg = 0,  // "dbg"
+    MD_tbaa = 1, // "tbaa"
+    MD_prof = 2,  // "prof"
+    MD_fpmath = 3,  // "fpmath"
+    MD_range = 4, // "range"
+    MD_tbaa_struct = 5 // "tbaa.struct"
+  };
+  
+  /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
+  /// This ID is uniqued across modules in the current LLVMContext.
+  unsigned getMDKindID(StringRef Name) const;
+  
+  /// getMDKindNames - Populate client supplied SmallVector with the name for
+  /// custom metadata IDs registered in this LLVMContext.
+  void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
+  
+  
+  typedef void (*DiagHandlerTy)(const SMDiagnostic&, void *Context,
+                                unsigned LocCookie);
+  
+  /// setDiagnosticHandler - This method sets a handler that is invoked
+  /// when problems are detected by the backend.  The first argument is a
+  /// function pointer and the second is a context pointer that gets passed
+  /// into the DiagHandler.
+  ///
+  /// LLVMContext doesn't take ownership or interpret either of these
+  /// pointers.
+  void setDiagnosticHandler(DiagHandlerTy DiagHandler, void *DiagContext = 0);
+
+  /// getDiagnosticHandler - Return the diagnostic handler set by
+  /// setDiagnosticHandler.
+  DiagHandlerTy getDiagnosticHandler() const;
+
+  /// getDiagnosticContext - Return the diagnostic context set by
+  /// setDiagnosticHandler.
+  void *getDiagnosticContext() const;
+  
+  /// FIXME: Temporary copies of the old names; to be removed as soon as
+  /// clang switches to the new ones.
+  typedef DiagHandlerTy InlineAsmDiagHandlerTy;
+  void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
+                                     void *DiagContext = 0) {
+    setDiagnosticHandler(DiagHandler, DiagContext);
+  }
+  InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const {
+    return getDiagnosticHandler();
+  }
+  void *getInlineAsmDiagnosticContext() const {
+    return getDiagnosticContext();
+  }
+  
+  /// emitError - Emit an error message to the currently installed error handler
+  /// with optional location information.  This function returns, so code should
+  /// be prepared to drop the erroneous construct on the floor and "not crash".
+  /// The generated code need not be correct.  The error message will be
+  /// implicitly prefixed with "error: " and should not end with a ".".
+  void emitError(unsigned LocCookie, const Twine &ErrorStr);
+  void emitError(const Instruction *I, const Twine &ErrorStr);
+  void emitError(const Twine &ErrorStr);
+
+  /// emitWarning - This is similar to emitError but it emits a warning instead
+  /// of an error.
+  void emitWarning(unsigned LocCookie, const Twine &ErrorStr);
+  void emitWarning(const Instruction *I, const Twine &ErrorStr);
+  void emitWarning(const Twine &ErrorStr);
+
+private:
+  LLVMContext(LLVMContext&) LLVM_DELETED_FUNCTION;
+  void operator=(LLVMContext&) LLVM_DELETED_FUNCTION;
+
+  /// addModule - Register a module as being instantiated in this context.  If
+  /// the context is deleted, the module will be deleted as well.
+  void addModule(Module*);
+  
+  /// removeModule - Unregister a module from this context.
+  void removeModule(Module*);
+  
+  // Module needs access to the add/removeModule methods.
+  friend class Module;
 };
 
-/// FOR BACKWARDS COMPATIBILITY - Returns a global context.
-extern LLVMContext& getGlobalContext();
+/// getGlobalContext - Returns a global context.  This is for LLVM clients that
+/// only care about operating on a single thread.
+extern LLVMContext &getGlobalContext();
 
 }