-//===-- llvm/Annotation.h - Annotation classes -------------------*- C++ -*--=//
+//===-- llvm/Support/Annotation.h - Annotation classes ----------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file contains the declarations for two classes: Annotation & Annotable.
// Using these two simple classes, anything that derives from Annotable can have
// Annotation subclasses attached to them, ready for easy retrieval.
//
-// Annotations are designed to be easily attachable to LLVM code (as all Value's
-// are Annotable), and can even be serialized to bytecode and to assembly.
+// Annotations are designed to be easily attachable to various classes.
//
-// The AnnotationManager class (defined in AnnotationManager.h) is essential for
-// using these classes. It is responsible for turning Annotation name strings
-// into tokens [unique id #'s] that may be used to search for and create
-// annotations.
+// The AnnotationManager class is essential for using these classes. It is
+// responsible for turning Annotation name strings into tokens [unique id #'s]
+// that may be used to search for and create annotations.
//
//===----------------------------------------------------------------------===//
-#ifndef LLVM_ANNOTATION_H
-#define LLVM_ANNOTATION_H
+#ifndef LLVM_SUPPORT_ANNOTATION_H
+#define LLVM_SUPPORT_ANNOTATION_H
#include <string>
+#include <cassert>
+
+namespace llvm {
+
class AnnotationID;
class Annotation;
class Annotable;
-class AnnotationManager;
+struct AnnotationManager;
//===----------------------------------------------------------------------===//
//
// freely around and passed byvalue with little or no overhead.
//
class AnnotationID {
- friend class AnnotationManager;
+ friend struct AnnotationManager;
unsigned ID;
AnnotationID(); // Default ctor is disabled
- inline AnnotationID(unsigned i) : ID(i) {} // Only creatable from AnnMgr
+
+ // AnnotationID is only creatable from AnnMgr.
+ explicit inline AnnotationID(unsigned i) : ID(i) {}
public:
inline AnnotationID(const AnnotationID &A) : ID(A.ID) {}
AnnotationID ID; // ID number, as obtained from AnnotationManager
Annotation *Next; // The next annotation in the linked list
public:
- inline Annotation(AnnotationID id) : ID(id), Next(0) {}
- virtual ~Annotation() {} // Designed to be subclassed
+ explicit inline Annotation(AnnotationID id) : ID(id), Next(0) {}
+ virtual ~Annotation(); // Designed to be subclassed
// getID - Return the unique ID# of this annotation
inline AnnotationID getID() const { return ID; }
//===----------------------------------------------------------------------===//
//
// Annotable - This class is used as a base class for all objects that would
-// like to have annotation capability. One notable subclass is Value, which
-// means annotations can be attached to almost everything in LLVM.
+// like to have annotation capability.
//
// Annotable objects keep their annotation list sorted as annotations are
// inserted and deleted. This is used to ensure that annotations with identical
// ID#'s are stored sequentially.
//
class Annotable {
- Annotation *AnnotationList;
+ mutable Annotation *AnnotationList;
+
+ Annotable(const Annotable &); // Do not implement
+ void operator=(const Annotable &); // Do not implement
public:
Annotable() : AnnotationList(0) {}
- virtual ~Annotable() { // Virtual because it's designed to be subclassed...
- Annotation *A = AnnotationList;
- while (A) {
- Annotation *Next = A->getNext();
- delete A;
- A = Next;
- }
- }
+ ~Annotable();
// getAnnotation - Search the list for annotations of the specified ID. The
// pointer returned is either null (if no annotations of the specified ID
// no annotation with the specified ID, then use the AnnotationManager to
// create one.
//
- inline Annotation *getOrCreateAnnotation(AnnotationID ID);
+ inline Annotation *getOrCreateAnnotation(AnnotationID ID) const;
// addAnnotation - Insert the annotation into the list in a sorted location.
//
- void addAnnotation(Annotation *A) {
+ void addAnnotation(Annotation *A) const {
assert(A->Next == 0 && "Annotation already in list?!?");
Annotation **AL = &AnnotationList;
// unlinkAnnotation - Remove the first annotation of the specified ID... and
// then return the unlinked annotation. The annotation object is not deleted.
//
- inline Annotation *unlinkAnnotation(AnnotationID ID) {
+ inline Annotation *unlinkAnnotation(AnnotationID ID) const {
for (Annotation **A = &AnnotationList; *A; A = &((*A)->Next))
if ((*A)->getID() == ID) {
- Annotation *Ret = *A;
- *A = Ret->Next;
- Ret->Next = 0;
- return Ret;
+ Annotation *Ret = *A;
+ *A = Ret->Next;
+ Ret->Next = 0;
+ return Ret;
}
return 0;
}
// deleteAnnotation - Delete the first annotation of the specified ID in the
// list. Unlink unlinkAnnotation, this actually deletes the annotation object
//
- bool deleteAnnotation(AnnotationID ID) {
+ bool deleteAnnotation(AnnotationID ID) const {
Annotation *A = unlinkAnnotation(ID);
delete A;
return A != 0;
// one-to-one mapping between string Annotation names and Annotation ID numbers.
//
// Compared to the rest of the Annotation system, these mapping methods are
-// relatively slow, so they should be avoided by locally caching Annotation
+// relatively slow, so they should be avoided by locally caching Annotation
// ID #'s. These methods are safe to call at any time, even by static ctors, so
// they should be used by static ctors most of the time.
//
// This class also provides support for annotations that are created on demand
// by the Annotable::getOrCreateAnnotation method. To get this to work, simply
-// register an annotation handler
+// register an annotation handler
//
struct AnnotationManager {
+ typedef Annotation *(*Factory)(AnnotationID, const Annotable *, void*);
+
//===--------------------------------------------------------------------===//
// Basic ID <-> Name map functionality
- static AnnotationID getID (const string &Name); // Name -> ID
- static const string &getName(AnnotationID ID); // ID -> Name
+ static AnnotationID getID(const std::string &Name); // Name -> ID
+ static const std::string &getName(AnnotationID ID); // ID -> Name
+ // getID - Name -> ID + registration of a factory function for demand driven
+ // annotation support.
+ static AnnotationID getID(const std::string &Name, Factory Fact,
+ void *Data = 0);
//===--------------------------------------------------------------------===//
// Annotation creation on demand support...
// registerAnnotationFactory - This method is used to register a callback
- // function used to create an annotation on demand if it is needed by the
+ // function used to create an annotation on demand if it is needed by the
// Annotable::getOrCreateAnnotation method.
//
- static void registerAnnotationFactory(AnnotationID ID,
- Annotation *(*Func)(AnnotationID, Annotable *, void*),
- void *ExtraData = 0);
+ static void registerAnnotationFactory(AnnotationID ID, Factory Func,
+ void *ExtraData = 0);
// createAnnotation - Create an annotation of the specified ID for the
// specified object, using a register annotation creation function.
//
- static Annotation *createAnnotation(AnnotationID ID, Annotable *Obj);
+ static Annotation *createAnnotation(AnnotationID ID, const Annotable *Obj);
};
// no annotation with the specified ID, then use the AnnotationManager to
// create one.
//
-inline Annotation *Annotable::getOrCreateAnnotation(AnnotationID ID) {
+inline Annotation *Annotable::getOrCreateAnnotation(AnnotationID ID) const {
Annotation *A = getAnnotation(ID); // Fast path, check for preexisting ann
if (A) return A;
return A;
}
+} // End namespace llvm
+
#endif
projects / oota-llvm.git / blobdiff