include/Support/Annotation.h

   1 //===-- Support/Annotation.h - Annotation classes ---------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the declarations for two classes: Annotation & Annotable.
  11 // Using these two simple classes, anything that derives from Annotable can have
  12 // Annotation subclasses attached to them, ready for easy retrieval.
  13 //
  14 // Annotations are designed to be easily attachable to various classes.
  15 //
  16 // The AnnotationManager class is essential for using these classes.  It is
  17 // responsible for turning Annotation name strings into tokens [unique id #'s]
  18 // that may be used to search for and create annotations.
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #ifndef SUPPORT_ANNOTATION_H
  23 #define SUPPORT_ANNOTATION_H
  24
  25 #include <string>
  26 #include <cassert>
  27
  28 namespace llvm {
  29
  30 class AnnotationID;
  31 class Annotation;
  32 class Annotable;
  33 class AnnotationManager;
  34
  35 //===----------------------------------------------------------------------===//
  36 //
  37 // AnnotationID - This class is a thin wrapper around an unsigned integer that
  38 // is used to hopefully prevent errors using AnnotationID's.  They may be copied
  39 // freely around and passed byvalue with little or no overhead.
  40 //
  41 class AnnotationID {
  42   friend class AnnotationManager;
  43   unsigned ID;
  44
  45   AnnotationID();                             // Default ctor is disabled
  46   inline AnnotationID(unsigned i) : ID(i) {}  // Only creatable from AnnMgr
  47 public:
  48   inline AnnotationID(const AnnotationID &A) : ID(A.ID) {}
  49
  50   inline bool operator==(const AnnotationID &A) const {
  51     return A.ID == ID;
  52   }
  53   inline bool operator<(const AnnotationID &A) const {
  54     return ID < A.ID;
  55   }
  56 };
  57
  58
  59 //===----------------------------------------------------------------------===//
  60 //
  61 // Annotation Class - This class serves as a base class for any specific
  62 // annotations that you might need.  Simply subclass this to add extra
  63 // information to the annotations.
  64 //
  65 class Annotation {
  66   friend class Annotable;  // Annotable manipulates Next list
  67   AnnotationID ID;         // ID number, as obtained from AnnotationManager
  68   Annotation *Next;        // The next annotation in the linked list
  69 public:
  70   inline Annotation(AnnotationID id) : ID(id), Next(0) {}
  71   virtual ~Annotation();  // Designed to be subclassed
  72
  73   // getID - Return the unique ID# of this annotation
  74   inline AnnotationID getID() const { return ID; }
  75
  76   // getNext - Return the next annotation in the list...
  77   inline Annotation *getNext() const { return Next; }
  78 };
  79
  80
  81 //===----------------------------------------------------------------------===//
  82 //
  83 // Annotable - This class is used as a base class for all objects that would
  84 // like to have annotation capability.  One notable subclass is Value, which
  85 // means annotations can be attached to almost everything in LLVM.
  86 //
  87 // Annotable objects keep their annotation list sorted as annotations are
  88 // inserted and deleted.  This is used to ensure that annotations with identical
  89 // ID#'s are stored sequentially.
  90 //
  91 class Annotable {
  92   mutable Annotation *AnnotationList;
  93
  94   Annotable(const Annotable &);        // Do not implement
  95   void operator=(const Annotable &);   // Do not implement
  96 public:
  97   Annotable() : AnnotationList(0) {}
  98   ~Annotable();
  99
 100   // getAnnotation - Search the list for annotations of the specified ID.  The
 101   // pointer returned is either null (if no annotations of the specified ID
 102   // exist), or it points to the first element of a potentially list of elements
 103   // with identical ID #'s.
 104   //
 105   Annotation *getAnnotation(AnnotationID ID) const {
 106     for (Annotation *A = AnnotationList; A; A = A->getNext())
 107       if (A->getID() == ID) return A;
 108     return 0;
 109   }
 110
 111   // getOrCreateAnnotation - Search through the annotation list, if there is
 112   // no annotation with the specified ID, then use the AnnotationManager to
 113   // create one.
 114   //
 115   inline Annotation *getOrCreateAnnotation(AnnotationID ID) const;
 116
 117   // addAnnotation - Insert the annotation into the list in a sorted location.
 118   //
 119   void addAnnotation(Annotation *A) const {
 120     assert(A->Next == 0 && "Annotation already in list?!?");
 121
 122     Annotation **AL = &AnnotationList;
 123     while (*AL && (*AL)->ID < A->getID())  // Find where to insert annotation
 124       AL = &((*AL)->Next);
 125     A->Next = *AL;                         // Link the annotation in
 126     *AL = A;
 127   }
 128
 129   // unlinkAnnotation - Remove the first annotation of the specified ID... and
 130   // then return the unlinked annotation.  The annotation object is not deleted.
 131   //
 132   inline Annotation *unlinkAnnotation(AnnotationID ID) const {
 133     for (Annotation **A = &AnnotationList; *A; A = &((*A)->Next))
 134       if ((*A)->getID() == ID) {
 135         Annotation *Ret = *A;
 136         *A = Ret->Next;
 137         Ret->Next = 0;
 138         return Ret;
 139       }
 140     return 0;
 141   }
 142
 143   // deleteAnnotation - Delete the first annotation of the specified ID in the
 144   // list.  Unlink unlinkAnnotation, this actually deletes the annotation object
 145   //
 146   bool deleteAnnotation(AnnotationID ID) const {
 147     Annotation *A = unlinkAnnotation(ID);
 148     delete A;
 149     return A != 0;
 150   }
 151 };
 152
 153
 154 //===----------------------------------------------------------------------===//
 155 //
 156 // AnnotationManager - This class is primarily responsible for maintaining a
 157 // one-to-one mapping between string Annotation names and Annotation ID numbers.
 158 //
 159 // Compared to the rest of the Annotation system, these mapping methods are
 160 // relatively slow, so they should be avoided by locally caching Annotation
 161 // ID #'s.  These methods are safe to call at any time, even by static ctors, so
 162 // they should be used by static ctors most of the time.
 163 //
 164 // This class also provides support for annotations that are created on demand
 165 // by the Annotable::getOrCreateAnnotation method.  To get this to work, simply
 166 // register an annotation handler
 167 //
 168 struct AnnotationManager {
 169   typedef Annotation *(*Factory)(AnnotationID, const Annotable *, void*);
 170
 171   //===--------------------------------------------------------------------===//
 172   // Basic ID <-> Name map functionality
 173
 174   static AnnotationID         getID(const std::string &Name);  // Name -> ID
 175   static const std::string &getName(AnnotationID ID);          // ID -> Name
 176
 177   // getID - Name -> ID + registration of a factory function for demand driven
 178   // annotation support.
 179   static AnnotationID getID(const std::string &Name, Factory Fact,
 180                             void *Data = 0);
 181
 182   //===--------------------------------------------------------------------===//
 183   // Annotation creation on demand support...
 184
 185   // registerAnnotationFactory - This method is used to register a callback
 186   // function used to create an annotation on demand if it is needed by the
 187   // Annotable::getOrCreateAnnotation method.
 188   //
 189   static void registerAnnotationFactory(AnnotationID ID, Factory Func,
 190                                         void *ExtraData = 0);
 191
 192   // createAnnotation - Create an annotation of the specified ID for the
 193   // specified object, using a register annotation creation function.
 194   //
 195   static Annotation *createAnnotation(AnnotationID ID, const Annotable *Obj);
 196 };
 197
 198
 199
 200 // getOrCreateAnnotation - Search through the annotation list, if there is
 201 // no annotation with the specified ID, then use the AnnotationManager to
 202 // create one.
 203 //
 204 inline Annotation *Annotable::getOrCreateAnnotation(AnnotationID ID) const {
 205   Annotation *A = getAnnotation(ID);   // Fast path, check for preexisting ann
 206   if (A) return A;
 207
 208   // No annotation found, ask the annotation manager to create an annotation...
 209   A = AnnotationManager::createAnnotation(ID, this);
 210   assert(A && "AnnotationManager could not create annotation!");
 211   addAnnotation(A);
 212   return A;
 213 }
 214
 215 } // End namespace llvm
 216
 217 #endif