utils/TableGen/Record.h

   1 //===- Record.h - Classes to represent Table Records ------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the main TableGen data structures, including the TableGen
  11 // types, values, and high-level data structures.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef RECORD_H
  16 #define RECORD_H
  17
  18 #include "TGSourceMgr.h"
  19 #include "llvm/Support/DataTypes.h"
  20 #include <map>
  21 #include <ostream>
  22
  23 namespace llvm {
  24
  25 // RecTy subclasses.
  26 class BitRecTy;
  27 class BitsRecTy;
  28 class IntRecTy;
  29 class StringRecTy;
  30 class ListRecTy;
  31 class CodeRecTy;
  32 class DagRecTy;
  33 class RecordRecTy;
  34
  35 // Init subclasses.
  36 struct Init;
  37 class UnsetInit;
  38 class BitInit;
  39 class BitsInit;
  40 class IntInit;
  41 class StringInit;
  42 class CodeInit;
  43 class ListInit;
  44 class BinOpInit;
  45 class DefInit;
  46 class DagInit;
  47 class TypedInit;
  48 class VarInit;
  49 class FieldInit;
  50 class VarBitInit;
  51 class VarListElementInit;
  52
  53 // Other classes.
  54 class Record;
  55 class RecordVal;
  56
  57 //===----------------------------------------------------------------------===//
  58 //  Type Classes
  59 //===----------------------------------------------------------------------===//
  60
  61 struct RecTy {
  62   virtual ~RecTy() {}
  63
  64   virtual std::string getAsString() const = 0;
  65   void print(std::ostream &OS) const { OS << getAsString(); }
  66   void dump() const;
  67
  68   /// typeIsConvertibleTo - Return true if all values of 'this' type can be
  69   /// converted to the specified type.
  70   virtual bool typeIsConvertibleTo(const RecTy *RHS) const = 0;
  71
  72 public:   // These methods should only be called from subclasses of Init
  73   virtual Init *convertValue( UnsetInit *UI) { return 0; }
  74   virtual Init *convertValue(   BitInit *BI) { return 0; }
  75   virtual Init *convertValue(  BitsInit *BI) { return 0; }
  76   virtual Init *convertValue(   IntInit *II) { return 0; }
  77   virtual Init *convertValue(StringInit *SI) { return 0; }
  78   virtual Init *convertValue(  ListInit *LI) { return 0; }
  79   virtual Init *convertValue( BinOpInit *UI) { return 0; }
  80   virtual Init *convertValue(  CodeInit *CI) { return 0; }
  81   virtual Init *convertValue(VarBitInit *VB) { return 0; }
  82   virtual Init *convertValue(   DefInit *DI) { return 0; }
  83   virtual Init *convertValue(   DagInit *DI) { return 0; }
  84   virtual Init *convertValue( TypedInit *TI) { return 0; }
  85   virtual Init *convertValue(   VarInit *VI) {
  86     return convertValue((TypedInit*)VI);
  87   }
  88   virtual Init *convertValue( FieldInit *FI) {
  89     return convertValue((TypedInit*)FI);
  90   }
  91
  92 public:   // These methods should only be called by subclasses of RecTy.
  93   // baseClassOf - These virtual methods should be overloaded to return true iff
  94   // all values of type 'RHS' can be converted to the 'this' type.
  95   virtual bool baseClassOf(const BitRecTy    *RHS) const { return false; }
  96   virtual bool baseClassOf(const BitsRecTy   *RHS) const { return false; }
  97   virtual bool baseClassOf(const IntRecTy    *RHS) const { return false; }
  98   virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
  99   virtual bool baseClassOf(const ListRecTy   *RHS) const { return false; }
 100   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return false; }
 101   virtual bool baseClassOf(const DagRecTy    *RHS) const { return false; }
 102   virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
 103 };
 104
 105 inline std::ostream &operator<<(std::ostream &OS, const RecTy &Ty) {
 106   Ty.print(OS);
 107   return OS;
 108 }
 109
 110
 111 /// BitRecTy - 'bit' - Represent a single bit
 112 ///
 113 class BitRecTy : public RecTy {
 114 public:
 115   virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
 116   virtual Init *convertValue(   BitInit *BI) { return (Init*)BI; }
 117   virtual Init *convertValue(  BitsInit *BI);
 118   virtual Init *convertValue(   IntInit *II);
 119   virtual Init *convertValue(StringInit *SI) { return 0; }
 120   virtual Init *convertValue(  ListInit *LI) { return 0; }
 121   virtual Init *convertValue(  CodeInit *CI) { return 0; }
 122   virtual Init *convertValue(VarBitInit *VB) { return (Init*)VB; }
 123   virtual Init *convertValue(   DefInit *DI) { return 0; }
 124   virtual Init *convertValue(   DagInit *DI) { return 0; }
 125   virtual Init *convertValue( BinOpInit *UI) { return 0; }
 126   virtual Init *convertValue( TypedInit *TI);
 127   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
 128   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 129
 130   std::string getAsString() const { return "bit"; }
 131
 132   bool typeIsConvertibleTo(const RecTy *RHS) const {
 133     return RHS->baseClassOf(this);
 134   }
 135   virtual bool baseClassOf(const BitRecTy    *RHS) const { return true; }
 136   virtual bool baseClassOf(const BitsRecTy   *RHS) const;
 137   virtual bool baseClassOf(const IntRecTy    *RHS) const { return true; }
 138   virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
 139   virtual bool baseClassOf(const ListRecTy   *RHS) const { return false; }
 140   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return false; }
 141   virtual bool baseClassOf(const DagRecTy    *RHS) const { return false; }
 142   virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
 143
 144 };
 145
 146
 147 // BitsRecTy - 'bits<n>' - Represent a fixed number of bits
 148 /// BitsRecTy - 'bits&lt;n&gt;' - Represent a fixed number of bits
 149 ///
 150 class BitsRecTy : public RecTy {
 151   unsigned Size;
 152 public:
 153   explicit BitsRecTy(unsigned Sz) : Size(Sz) {}
 154
 155   unsigned getNumBits() const { return Size; }
 156
 157   virtual Init *convertValue( UnsetInit *UI);
 158   virtual Init *convertValue(   BitInit *UI);
 159   virtual Init *convertValue(  BitsInit *BI);
 160   virtual Init *convertValue(   IntInit *II);
 161   virtual Init *convertValue(StringInit *SI) { return 0; }
 162   virtual Init *convertValue(  ListInit *LI) { return 0; }
 163   virtual Init *convertValue(  CodeInit *CI) { return 0; }
 164   virtual Init *convertValue(VarBitInit *VB) { return 0; }
 165   virtual Init *convertValue(   DefInit *DI) { return 0; }
 166   virtual Init *convertValue(   DagInit *DI) { return 0; }
 167   virtual Init *convertValue( BinOpInit *UI) { return 0; }
 168   virtual Init *convertValue( TypedInit *TI);
 169   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
 170   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 171
 172   std::string getAsString() const;
 173
 174   bool typeIsConvertibleTo(const RecTy *RHS) const {
 175     return RHS->baseClassOf(this);
 176   }
 177   virtual bool baseClassOf(const BitRecTy    *RHS) const { return Size == 1; }
 178   virtual bool baseClassOf(const BitsRecTy   *RHS) const {
 179     return RHS->Size == Size;
 180   }
 181   virtual bool baseClassOf(const IntRecTy    *RHS) const { return true; }
 182   virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
 183   virtual bool baseClassOf(const ListRecTy   *RHS) const { return false; }
 184   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return false; }
 185   virtual bool baseClassOf(const DagRecTy    *RHS) const { return false; }
 186   virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
 187
 188 };
 189
 190
 191 /// IntRecTy - 'int' - Represent an integer value of no particular size
 192 ///
 193 class IntRecTy : public RecTy {
 194 public:
 195   virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
 196   virtual Init *convertValue(   BitInit *BI);
 197   virtual Init *convertValue(  BitsInit *BI);
 198   virtual Init *convertValue(   IntInit *II) { return (Init*)II; }
 199   virtual Init *convertValue(StringInit *SI) { return 0; }
 200   virtual Init *convertValue(  ListInit *LI) { return 0; }
 201   virtual Init *convertValue(  CodeInit *CI) { return 0; }
 202   virtual Init *convertValue(VarBitInit *VB) { return 0; }
 203   virtual Init *convertValue(   DefInit *DI) { return 0; }
 204   virtual Init *convertValue(   DagInit *DI) { return 0; }
 205   virtual Init *convertValue( BinOpInit *UI) { return 0; }
 206   virtual Init *convertValue( TypedInit *TI);
 207   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
 208   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 209
 210   std::string getAsString() const { return "int"; }
 211
 212   bool typeIsConvertibleTo(const RecTy *RHS) const {
 213     return RHS->baseClassOf(this);
 214   }
 215
 216   virtual bool baseClassOf(const BitRecTy    *RHS) const { return true; }
 217   virtual bool baseClassOf(const BitsRecTy   *RHS) const { return true; }
 218   virtual bool baseClassOf(const IntRecTy    *RHS) const { return true; }
 219   virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
 220   virtual bool baseClassOf(const ListRecTy   *RHS) const { return false; }
 221   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return false; }
 222   virtual bool baseClassOf(const DagRecTy    *RHS) const { return false; }
 223   virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
 224
 225 };
 226
 227 /// StringRecTy - 'string' - Represent an string value
 228 ///
 229 class StringRecTy : public RecTy {
 230 public:
 231   virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
 232   virtual Init *convertValue(   BitInit *BI) { return 0; }
 233   virtual Init *convertValue(  BitsInit *BI) { return 0; }
 234   virtual Init *convertValue(   IntInit *II) { return 0; }
 235   virtual Init *convertValue(StringInit *SI) { return (Init*)SI; }
 236   virtual Init *convertValue(  ListInit *LI) { return 0; }
 237   virtual Init *convertValue( BinOpInit *BO);
 238   virtual Init *convertValue(  CodeInit *CI) { return 0; }
 239   virtual Init *convertValue(VarBitInit *VB) { return 0; }
 240   virtual Init *convertValue(   DefInit *DI) { return 0; }
 241   virtual Init *convertValue(   DagInit *DI) { return 0; }
 242   virtual Init *convertValue( TypedInit *TI);
 243   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
 244   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 245
 246   std::string getAsString() const { return "string"; }
 247
 248   bool typeIsConvertibleTo(const RecTy *RHS) const {
 249     return RHS->baseClassOf(this);
 250   }
 251
 252   virtual bool baseClassOf(const BitRecTy    *RHS) const { return false; }
 253   virtual bool baseClassOf(const BitsRecTy   *RHS) const { return false; }
 254   virtual bool baseClassOf(const IntRecTy    *RHS) const { return false; }
 255   virtual bool baseClassOf(const StringRecTy *RHS) const { return true; }
 256   virtual bool baseClassOf(const ListRecTy   *RHS) const { return false; }
 257   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return false; }
 258   virtual bool baseClassOf(const DagRecTy    *RHS) const { return false; }
 259   virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
 260 };
 261
 262 // ListRecTy - 'list<Ty>' - Represent a list of values, all of which must be of
 263 // the specified type.
 264 /// ListRecTy - 'list&lt;Ty&gt;' - Represent a list of values, all of which must
 265 /// be of the specified type.
 266 ///
 267 class ListRecTy : public RecTy {
 268   RecTy *Ty;
 269 public:
 270   explicit ListRecTy(RecTy *T) : Ty(T) {}
 271
 272   RecTy *getElementType() const { return Ty; }
 273
 274   virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
 275   virtual Init *convertValue(   BitInit *BI) { return 0; }
 276   virtual Init *convertValue(  BitsInit *BI) { return 0; }
 277   virtual Init *convertValue(   IntInit *II) { return 0; }
 278   virtual Init *convertValue(StringInit *SI) { return 0; }
 279   virtual Init *convertValue(  ListInit *LI);
 280   virtual Init *convertValue(  CodeInit *CI) { return 0; }
 281   virtual Init *convertValue(VarBitInit *VB) { return 0; }
 282   virtual Init *convertValue(   DefInit *DI) { return 0; }
 283   virtual Init *convertValue(   DagInit *DI) { return 0; }
 284   virtual Init *convertValue( BinOpInit *UI) { return 0; }
 285   virtual Init *convertValue( TypedInit *TI);
 286   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
 287   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 288
 289   std::string getAsString() const;
 290
 291   bool typeIsConvertibleTo(const RecTy *RHS) const {
 292     return RHS->baseClassOf(this);
 293   }
 294
 295   virtual bool baseClassOf(const BitRecTy    *RHS) const { return false; }
 296   virtual bool baseClassOf(const BitsRecTy   *RHS) const { return false; }
 297   virtual bool baseClassOf(const IntRecTy    *RHS) const { return false; }
 298   virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
 299   virtual bool baseClassOf(const ListRecTy   *RHS) const {
 300     return RHS->getElementType()->typeIsConvertibleTo(Ty);
 301   }
 302   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return false; }
 303   virtual bool baseClassOf(const DagRecTy    *RHS) const { return false; }
 304   virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
 305 };
 306
 307 /// CodeRecTy - 'code' - Represent an code fragment, function or method.
 308 ///
 309 class CodeRecTy : public RecTy {
 310 public:
 311   virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
 312   virtual Init *convertValue(   BitInit *BI) { return 0; }
 313   virtual Init *convertValue(  BitsInit *BI) { return 0; }
 314   virtual Init *convertValue(   IntInit *II) { return 0; }
 315   virtual Init *convertValue(StringInit *SI) { return 0; }
 316   virtual Init *convertValue(  ListInit *LI) { return 0; }
 317   virtual Init *convertValue(  CodeInit *CI) { return (Init*)CI; }
 318   virtual Init *convertValue(VarBitInit *VB) { return 0; }
 319   virtual Init *convertValue(   DefInit *DI) { return 0; }
 320   virtual Init *convertValue(   DagInit *DI) { return 0; }
 321   virtual Init *convertValue( BinOpInit *UI) { return 0; }
 322   virtual Init *convertValue( TypedInit *TI);
 323   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
 324   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 325
 326   std::string getAsString() const { return "code"; }
 327
 328   bool typeIsConvertibleTo(const RecTy *RHS) const {
 329     return RHS->baseClassOf(this);
 330   }
 331   virtual bool baseClassOf(const BitRecTy    *RHS) const { return false; }
 332   virtual bool baseClassOf(const BitsRecTy   *RHS) const { return false; }
 333   virtual bool baseClassOf(const IntRecTy    *RHS) const { return false; }
 334   virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
 335   virtual bool baseClassOf(const ListRecTy   *RHS) const { return false; }
 336   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return true; }
 337   virtual bool baseClassOf(const DagRecTy    *RHS) const { return false; }
 338   virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
 339 };
 340
 341 /// DagRecTy - 'dag' - Represent a dag fragment
 342 ///
 343 class DagRecTy : public RecTy {
 344 public:
 345   virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
 346   virtual Init *convertValue(   BitInit *BI) { return 0; }
 347   virtual Init *convertValue(  BitsInit *BI) { return 0; }
 348   virtual Init *convertValue(   IntInit *II) { return 0; }
 349   virtual Init *convertValue(StringInit *SI) { return 0; }
 350   virtual Init *convertValue(  ListInit *LI) { return 0; }
 351   virtual Init *convertValue(  CodeInit *CI) { return 0; }
 352   virtual Init *convertValue(VarBitInit *VB) { return 0; }
 353   virtual Init *convertValue(   DefInit *DI) { return 0; }
 354   virtual Init *convertValue( BinOpInit *BO);
 355   virtual Init *convertValue(   DagInit *CI) { return (Init*)CI; }
 356   virtual Init *convertValue( TypedInit *TI);
 357   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
 358   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 359
 360   std::string getAsString() const { return "dag"; }
 361
 362   bool typeIsConvertibleTo(const RecTy *RHS) const {
 363     return RHS->baseClassOf(this);
 364   }
 365
 366   virtual bool baseClassOf(const BitRecTy    *RHS) const { return false; }
 367   virtual bool baseClassOf(const BitsRecTy   *RHS) const { return false; }
 368   virtual bool baseClassOf(const IntRecTy    *RHS) const { return false; }
 369   virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
 370   virtual bool baseClassOf(const ListRecTy   *RHS) const { return false; }
 371   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return false; }
 372   virtual bool baseClassOf(const DagRecTy    *RHS) const { return true; }
 373   virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
 374 };
 375
 376
 377 /// RecordRecTy - '[classname]' - Represent an instance of a class, such as:
 378 /// (R32 X = EAX).
 379 ///
 380 class RecordRecTy : public RecTy {
 381   Record *Rec;
 382 public:
 383   explicit RecordRecTy(Record *R) : Rec(R) {}
 384
 385   Record *getRecord() const { return Rec; }
 386
 387   virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
 388   virtual Init *convertValue(   BitInit *BI) { return 0; }
 389   virtual Init *convertValue(  BitsInit *BI) { return 0; }
 390   virtual Init *convertValue(   IntInit *II) { return 0; }
 391   virtual Init *convertValue(StringInit *SI) { return 0; }
 392   virtual Init *convertValue(  ListInit *LI) { return 0; }
 393   virtual Init *convertValue(  CodeInit *CI) { return 0; }
 394   virtual Init *convertValue(VarBitInit *VB) { return 0; }
 395   virtual Init *convertValue( BinOpInit *UI) { return 0; }
 396   virtual Init *convertValue(   DefInit *DI);
 397   virtual Init *convertValue(   DagInit *DI) { return 0; }
 398   virtual Init *convertValue( TypedInit *VI);
 399   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
 400   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 401
 402   std::string getAsString() const;
 403
 404   bool typeIsConvertibleTo(const RecTy *RHS) const {
 405     return RHS->baseClassOf(this);
 406   }
 407   virtual bool baseClassOf(const BitRecTy    *RHS) const { return false; }
 408   virtual bool baseClassOf(const BitsRecTy   *RHS) const { return false; }
 409   virtual bool baseClassOf(const IntRecTy    *RHS) const { return false; }
 410   virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
 411   virtual bool baseClassOf(const ListRecTy   *RHS) const { return false; }
 412   virtual bool baseClassOf(const CodeRecTy   *RHS) const { return false; }
 413   virtual bool baseClassOf(const DagRecTy    *RHS) const { return false; }
 414   virtual bool baseClassOf(const RecordRecTy *RHS) const;
 415 };
 416
 417
 418
 419 //===----------------------------------------------------------------------===//
 420 //  Initializer Classes
 421 //===----------------------------------------------------------------------===//
 422
 423 struct Init {
 424   virtual ~Init() {}
 425
 426   /// isComplete - This virtual method should be overridden by values that may
 427   /// not be completely specified yet.
 428   virtual bool isComplete() const { return true; }
 429
 430   /// print - Print out this value.
 431   void print(std::ostream &OS) const { OS << getAsString(); }
 432
 433   /// getAsString - Convert this value to a string form.
 434   virtual std::string getAsString() const = 0;
 435
 436   /// dump - Debugging method that may be called through a debugger, just
 437   /// invokes print on cerr.
 438   void dump() const;
 439
 440   /// convertInitializerTo - This virtual function is a simple call-back
 441   /// function that should be overridden to call the appropriate
 442   /// RecTy::convertValue method.
 443   ///
 444   virtual Init *convertInitializerTo(RecTy *Ty) = 0;
 445
 446   /// convertInitializerBitRange - This method is used to implement the bitrange
 447   /// selection operator.  Given an initializer, it selects the specified bits
 448   /// out, returning them as a new init of bits type.  If it is not legal to use
 449   /// the bit subscript operator on this initializer, return null.
 450   ///
 451   virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits) {
 452     return 0;
 453   }
 454
 455   /// convertInitListSlice - This method is used to implement the list slice
 456   /// selection operator.  Given an initializer, it selects the specified list
 457   /// elements, returning them as a new init of list type.  If it is not legal
 458   /// to take a slice of this, return null.
 459   ///
 460   virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements) {
 461     return 0;
 462   }
 463
 464   /// getFieldType - This method is used to implement the FieldInit class.
 465   /// Implementors of this method should return the type of the named field if
 466   /// they are of record type.
 467   ///
 468   virtual RecTy *getFieldType(const std::string &FieldName) const { return 0; }
 469
 470   /// getFieldInit - This method complements getFieldType to return the
 471   /// initializer for the specified field.  If getFieldType returns non-null
 472   /// this method should return non-null, otherwise it returns null.
 473   ///
 474   virtual Init *getFieldInit(Record &R, const std::string &FieldName) const {
 475     return 0;
 476   }
 477
 478   /// resolveReferences - This method is used by classes that refer to other
 479   /// variables which may not be defined at the time they expression is formed.
 480   /// If a value is set for the variable later, this method will be called on
 481   /// users of the value to allow the value to propagate out.
 482   ///
 483   virtual Init *resolveReferences(Record &R, const RecordVal *RV) {
 484     return this;
 485   }
 486 };
 487
 488 inline std::ostream &operator<<(std::ostream &OS, const Init &I) {
 489   I.print(OS); return OS;
 490 }
 491
 492
 493 /// UnsetInit - ? - Represents an uninitialized value
 494 ///
 495 class UnsetInit : public Init {
 496 public:
 497   virtual Init *convertInitializerTo(RecTy *Ty) {
 498     return Ty->convertValue(this);
 499   }
 500
 501   virtual bool isComplete() const { return false; }
 502   virtual std::string getAsString() const { return "?"; }
 503 };
 504
 505
 506 /// BitInit - true/false - Represent a concrete initializer for a bit.
 507 ///
 508 class BitInit : public Init {
 509   bool Value;
 510 public:
 511   explicit BitInit(bool V) : Value(V) {}
 512
 513   bool getValue() const { return Value; }
 514
 515   virtual Init *convertInitializerTo(RecTy *Ty) {
 516     return Ty->convertValue(this);
 517   }
 518
 519   virtual std::string getAsString() const { return Value ? "1" : "0"; }
 520 };
 521
 522 /// BitsInit - { a, b, c } - Represents an initializer for a BitsRecTy value.
 523 /// It contains a vector of bits, whose size is determined by the type.
 524 ///
 525 class BitsInit : public Init {
 526   std::vector<Init*> Bits;
 527 public:
 528   explicit BitsInit(unsigned Size) : Bits(Size) {}
 529
 530   unsigned getNumBits() const { return Bits.size(); }
 531
 532   Init *getBit(unsigned Bit) const {
 533     assert(Bit < Bits.size() && "Bit index out of range!");
 534     return Bits[Bit];
 535   }
 536   void setBit(unsigned Bit, Init *V) {
 537     assert(Bit < Bits.size() && "Bit index out of range!");
 538     assert(Bits[Bit] == 0 && "Bit already set!");
 539     Bits[Bit] = V;
 540   }
 541
 542   virtual Init *convertInitializerTo(RecTy *Ty) {
 543     return Ty->convertValue(this);
 544   }
 545   virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
 546
 547   virtual bool isComplete() const {
 548     for (unsigned i = 0; i != getNumBits(); ++i)
 549       if (!getBit(i)->isComplete()) return false;
 550     return true;
 551   }
 552   virtual std::string getAsString() const;
 553
 554   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 555
 556   // printXX - Print this bitstream with the specified format, returning true if
 557   // it is not possible.
 558   bool printInHex(std::ostream &OS) const;
 559   bool printAsVariable(std::ostream &OS) const;
 560   bool printAsUnset(std::ostream &OS) const;
 561 };
 562
 563
 564 /// IntInit - 7 - Represent an initalization by a literal integer value.
 565 ///
 566 class IntInit : public Init {
 567   int64_t Value;
 568 public:
 569   explicit IntInit(int64_t V) : Value(V) {}
 570
 571   int64_t getValue() const { return Value; }
 572
 573   virtual Init *convertInitializerTo(RecTy *Ty) {
 574     return Ty->convertValue(this);
 575   }
 576   virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
 577
 578   virtual std::string getAsString() const;
 579 };
 580
 581
 582 /// StringInit - "foo" - Represent an initialization by a string value.
 583 ///
 584 class StringInit : public Init {
 585   std::string Value;
 586 public:
 587   explicit StringInit(const std::string &V) : Value(V) {}
 588
 589   const std::string &getValue() const { return Value; }
 590
 591   virtual Init *convertInitializerTo(RecTy *Ty) {
 592     return Ty->convertValue(this);
 593   }
 594
 595   virtual std::string getAsString() const { return "\"" + Value + "\""; }
 596 };
 597
 598 /// CodeInit - "[{...}]" - Represent a code fragment.
 599 ///
 600 class CodeInit : public Init {
 601   std::string Value;
 602 public:
 603   explicit CodeInit(const std::string &V) : Value(V) {}
 604
 605   const std::string getValue() const { return Value; }
 606
 607   virtual Init *convertInitializerTo(RecTy *Ty) {
 608     return Ty->convertValue(this);
 609   }
 610
 611   virtual std::string getAsString() const { return "[{" + Value + "}]"; }
 612 };
 613
 614 /// ListInit - [AL, AH, CL] - Represent a list of defs
 615 ///
 616 class ListInit : public Init {
 617   std::vector<Init*> Values;
 618 public:
 619   explicit ListInit(std::vector<Init*> &Vs) {
 620     Values.swap(Vs);
 621   }
 622
 623   unsigned getSize() const { return Values.size(); }
 624   Init *getElement(unsigned i) const {
 625     assert(i < Values.size() && "List element index out of range!");
 626     return Values[i];
 627   }
 628
 629   Record *getElementAsRecord(unsigned i) const;
 630
 631   Init *convertInitListSlice(const std::vector<unsigned> &Elements);
 632
 633   virtual Init *convertInitializerTo(RecTy *Ty) {
 634     return Ty->convertValue(this);
 635   }
 636
 637   /// resolveReferences - This method is used by classes that refer to other
 638   /// variables which may not be defined at the time they expression is formed.
 639   /// If a value is set for the variable later, this method will be called on
 640   /// users of the value to allow the value to propagate out.
 641   ///
 642   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 643
 644   virtual std::string getAsString() const;
 645
 646   typedef std::vector<Init*>::iterator       iterator;
 647   typedef std::vector<Init*>::const_iterator const_iterator;
 648
 649   inline iterator       begin()       { return Values.begin(); }
 650   inline const_iterator begin() const { return Values.begin(); }
 651   inline iterator       end  ()       { return Values.end();   }
 652   inline const_iterator end  () const { return Values.end();   }
 653
 654   inline size_t         size () const { return Values.size();  }
 655   inline bool           empty() const { return Values.empty(); }
 656 };
 657
 658 /// BinOpInit - !op (X, Y) - Combine two inits.
 659 ///
 660 class BinOpInit : public Init {
 661 public:
 662   enum BinaryOp { SHL, SRA, SRL, STRCONCAT, CONCAT };
 663 private:
 664   BinaryOp Opc;
 665   Init *LHS, *RHS;
 666 public:
 667   BinOpInit(BinaryOp opc, Init *lhs, Init *rhs) : Opc(opc), LHS(lhs), RHS(rhs) {
 668   }
 669
 670   BinaryOp getOpcode() const { return Opc; }
 671   Init *getLHS() const { return LHS; }
 672   Init *getRHS() const { return RHS; }
 673
 674   // Fold - If possible, fold this to a simpler init.  Return this if not
 675   // possible to fold.
 676   Init *Fold();
 677
 678   virtual Init *convertInitializerTo(RecTy *Ty) {
 679     return Ty->convertValue(this);
 680   }
 681
 682   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 683
 684   virtual std::string getAsString() const;
 685 };
 686
 687
 688
 689 /// TypedInit - This is the common super-class of types that have a specific,
 690 /// explicit, type.
 691 ///
 692 class TypedInit : public Init {
 693   RecTy *Ty;
 694 public:
 695   explicit TypedInit(RecTy *T) : Ty(T) {}
 696
 697   RecTy *getType() const { return Ty; }
 698
 699   virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
 700   virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements);
 701
 702   /// resolveBitReference - This method is used to implement
 703   /// VarBitInit::resolveReferences.  If the bit is able to be resolved, we
 704   /// simply return the resolved value, otherwise we return null.
 705   ///
 706   virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
 707                                     unsigned Bit) = 0;
 708
 709   /// resolveListElementReference - This method is used to implement
 710   /// VarListElementInit::resolveReferences.  If the list element is resolvable
 711   /// now, we return the resolved value, otherwise we return null.
 712   virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
 713                                             unsigned Elt) = 0;
 714 };
 715
 716 /// VarInit - 'Opcode' - Represent a reference to an entire variable object.
 717 ///
 718 class VarInit : public TypedInit {
 719   std::string VarName;
 720 public:
 721   explicit VarInit(const std::string &VN, RecTy *T)
 722     : TypedInit(T), VarName(VN) {}
 723
 724   virtual Init *convertInitializerTo(RecTy *Ty) {
 725     return Ty->convertValue(this);
 726   }
 727
 728   const std::string &getName() const { return VarName; }
 729
 730   virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
 731                                     unsigned Bit);
 732   virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
 733                                             unsigned Elt);
 734
 735   virtual RecTy *getFieldType(const std::string &FieldName) const;
 736   virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
 737
 738   /// resolveReferences - This method is used by classes that refer to other
 739   /// variables which may not be defined at the time they expression is formed.
 740   /// If a value is set for the variable later, this method will be called on
 741   /// users of the value to allow the value to propagate out.
 742   ///
 743   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 744
 745   virtual std::string getAsString() const { return VarName; }
 746 };
 747
 748
 749 /// VarBitInit - Opcode{0} - Represent access to one bit of a variable or field.
 750 ///
 751 class VarBitInit : public Init {
 752   TypedInit *TI;
 753   unsigned Bit;
 754 public:
 755   VarBitInit(TypedInit *T, unsigned B) : TI(T), Bit(B) {
 756     assert(T->getType() && dynamic_cast<BitsRecTy*>(T->getType()) &&
 757            ((BitsRecTy*)T->getType())->getNumBits() > B &&
 758            "Illegal VarBitInit expression!");
 759   }
 760
 761   virtual Init *convertInitializerTo(RecTy *Ty) {
 762     return Ty->convertValue(this);
 763   }
 764
 765   TypedInit *getVariable() const { return TI; }
 766   unsigned getBitNum() const { return Bit; }
 767
 768   virtual std::string getAsString() const;
 769   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 770 };
 771
 772 /// VarListElementInit - List[4] - Represent access to one element of a var or
 773 /// field.
 774 class VarListElementInit : public TypedInit {
 775   TypedInit *TI;
 776   unsigned Element;
 777 public:
 778   VarListElementInit(TypedInit *T, unsigned E)
 779     : TypedInit(dynamic_cast<ListRecTy*>(T->getType())->getElementType()),
 780                 TI(T), Element(E) {
 781     assert(T->getType() && dynamic_cast<ListRecTy*>(T->getType()) &&
 782            "Illegal VarBitInit expression!");
 783   }
 784
 785   virtual Init *convertInitializerTo(RecTy *Ty) {
 786     return Ty->convertValue(this);
 787   }
 788
 789   TypedInit *getVariable() const { return TI; }
 790   unsigned getElementNum() const { return Element; }
 791
 792   virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
 793                                     unsigned Bit);
 794
 795   /// resolveListElementReference - This method is used to implement
 796   /// VarListElementInit::resolveReferences.  If the list element is resolvable
 797   /// now, we return the resolved value, otherwise we return null.
 798   virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
 799                                             unsigned Elt);
 800
 801   virtual std::string getAsString() const;
 802   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 803 };
 804
 805 /// DefInit - AL - Represent a reference to a 'def' in the description
 806 ///
 807 class DefInit : public Init {
 808   Record *Def;
 809 public:
 810   explicit DefInit(Record *D) : Def(D) {}
 811
 812   virtual Init *convertInitializerTo(RecTy *Ty) {
 813     return Ty->convertValue(this);
 814   }
 815
 816   Record *getDef() const { return Def; }
 817
 818   //virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
 819
 820   virtual RecTy *getFieldType(const std::string &FieldName) const;
 821   virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
 822
 823   virtual std::string getAsString() const;
 824 };
 825
 826
 827 /// FieldInit - X.Y - Represent a reference to a subfield of a variable
 828 ///
 829 class FieldInit : public TypedInit {
 830   Init *Rec;                // Record we are referring to
 831   std::string FieldName;    // Field we are accessing
 832 public:
 833   FieldInit(Init *R, const std::string &FN)
 834     : TypedInit(R->getFieldType(FN)), Rec(R), FieldName(FN) {
 835     assert(getType() && "FieldInit with non-record type!");
 836   }
 837
 838   virtual Init *convertInitializerTo(RecTy *Ty) {
 839     return Ty->convertValue(this);
 840   }
 841
 842   virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
 843                                     unsigned Bit);
 844   virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
 845                                             unsigned Elt);
 846
 847   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 848
 849   virtual std::string getAsString() const {
 850     return Rec->getAsString() + "." + FieldName;
 851   }
 852 };
 853
 854 /// DagInit - (v a, b) - Represent a DAG tree value.  DAG inits are required
 855 /// to have at least one value then a (possibly empty) list of arguments.  Each
 856 /// argument can have a name associated with it.
 857 ///
 858 class DagInit : public Init {
 859   Init *Val;
 860   std::string ValName;
 861   std::vector<Init*> Args;
 862   std::vector<std::string> ArgNames;
 863 public:
 864   DagInit(Init *V, std::string VN,
 865           const std::vector<std::pair<Init*, std::string> > &args)
 866     : Val(V), ValName(VN) {
 867     Args.reserve(args.size());
 868     ArgNames.reserve(args.size());
 869     for (unsigned i = 0, e = args.size(); i != e; ++i) {
 870       Args.push_back(args[i].first);
 871       ArgNames.push_back(args[i].second);
 872     }
 873   }
 874   DagInit(Init *V, std::string VN, const std::vector<Init*> &args,
 875           const std::vector<std::string> &argNames)
 876   : Val(V), ValName(VN), Args(args), ArgNames(argNames) {
 877   }
 878
 879   virtual Init *convertInitializerTo(RecTy *Ty) {
 880     return Ty->convertValue(this);
 881   }
 882
 883   Init *getOperator() const { return Val; }
 884
 885   const std::string &getName() const { return ValName; }
 886
 887   unsigned getNumArgs() const { return Args.size(); }
 888   Init *getArg(unsigned Num) const {
 889     assert(Num < Args.size() && "Arg number out of range!");
 890     return Args[Num];
 891   }
 892   const std::string &getArgName(unsigned Num) const {
 893     assert(Num < ArgNames.size() && "Arg number out of range!");
 894     return ArgNames[Num];
 895   }
 896
 897   void setArg(unsigned Num, Init *I) {
 898     assert(Num < Args.size() && "Arg number out of range!");
 899     Args[Num] = I;
 900   }
 901
 902   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 903
 904   virtual std::string getAsString() const;
 905
 906   typedef std::vector<Init*>::iterator             arg_iterator;
 907   typedef std::vector<Init*>::const_iterator       const_arg_iterator;
 908   typedef std::vector<std::string>::iterator       name_iterator;
 909   typedef std::vector<std::string>::const_iterator const_name_iterator;
 910
 911   inline arg_iterator        arg_begin()       { return Args.begin(); }
 912   inline const_arg_iterator  arg_begin() const { return Args.begin(); }
 913   inline arg_iterator        arg_end  ()       { return Args.end();   }
 914   inline const_arg_iterator  arg_end  () const { return Args.end();   }
 915
 916   inline size_t              arg_size () const { return Args.size();  }
 917   inline bool                arg_empty() const { return Args.empty(); }
 918
 919   inline name_iterator       name_begin()       { return ArgNames.begin(); }
 920   inline const_name_iterator name_begin() const { return ArgNames.begin(); }
 921   inline name_iterator       name_end  ()       { return ArgNames.end();   }
 922   inline const_name_iterator name_end  () const { return ArgNames.end();   }
 923
 924   inline size_t              name_size () const { return ArgNames.size();  }
 925   inline bool                name_empty() const { return ArgNames.empty(); }
 926
 927 };
 928
 929 //===----------------------------------------------------------------------===//
 930 //  High-Level Classes
 931 //===----------------------------------------------------------------------===//
 932
 933 class RecordVal {
 934   std::string Name;
 935   RecTy *Ty;
 936   unsigned Prefix;
 937   Init *Value;
 938 public:
 939   RecordVal(const std::string &N, RecTy *T, unsigned P);
 940
 941   const std::string &getName() const { return Name; }
 942
 943   unsigned getPrefix() const { return Prefix; }
 944   RecTy *getType() const { return Ty; }
 945   Init *getValue() const { return Value; }
 946
 947   bool setValue(Init *V) {
 948     if (V) {
 949       Value = V->convertInitializerTo(Ty);
 950       return Value == 0;
 951     }
 952     Value = 0;
 953     return false;
 954   }
 955
 956   void dump() const;
 957   void print(std::ostream &OS, bool PrintSem = true) const;
 958 };
 959
 960 inline std::ostream &operator<<(std::ostream &OS, const RecordVal &RV) {
 961   RV.print(OS << "  ");
 962   return OS;
 963 }
 964
 965 class Record {
 966   std::string Name;
 967   TGLoc Loc;
 968   std::vector<std::string> TemplateArgs;
 969   std::vector<RecordVal> Values;
 970   std::vector<Record*> SuperClasses;
 971 public:
 972
 973   explicit Record(const std::string &N, TGLoc loc) : Name(N), Loc(loc) {}
 974   ~Record() {}
 975
 976   const std::string &getName() const { return Name; }
 977   void setName(const std::string &Name);  // Also updates RecordKeeper.
 978
 979   TGLoc getLoc() const { return Loc; }
 980
 981   const std::vector<std::string> &getTemplateArgs() const {
 982     return TemplateArgs;
 983   }
 984   const std::vector<RecordVal> &getValues() const { return Values; }
 985   const std::vector<Record*>   &getSuperClasses() const { return SuperClasses; }
 986
 987   bool isTemplateArg(const std::string &Name) const {
 988     for (unsigned i = 0, e = TemplateArgs.size(); i != e; ++i)
 989       if (TemplateArgs[i] == Name) return true;
 990     return false;
 991   }
 992
 993   const RecordVal *getValue(const std::string &Name) const {
 994     for (unsigned i = 0, e = Values.size(); i != e; ++i)
 995       if (Values[i].getName() == Name) return &Values[i];
 996     return 0;
 997   }
 998   RecordVal *getValue(const std::string &Name) {
 999     for (unsigned i = 0, e = Values.size(); i != e; ++i)
1000       if (Values[i].getName() == Name) return &Values[i];
1001     return 0;
1002   }
1003
1004   void addTemplateArg(const std::string &Name) {
1005     assert(!isTemplateArg(Name) && "Template arg already defined!");
1006     TemplateArgs.push_back(Name);
1007   }
1008
1009   void addValue(const RecordVal &RV) {
1010     assert(getValue(RV.getName()) == 0 && "Value already added!");
1011     Values.push_back(RV);
1012   }
1013
1014   void removeValue(const std::string &Name) {
1015     assert(getValue(Name) && "Cannot remove an entry that does not exist!");
1016     for (unsigned i = 0, e = Values.size(); i != e; ++i)
1017       if (Values[i].getName() == Name) {
1018         Values.erase(Values.begin()+i);
1019         return;
1020       }
1021     assert(0 && "Name does not exist in record!");
1022   }
1023
1024   bool isSubClassOf(const Record *R) const {
1025     for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1026       if (SuperClasses[i] == R)
1027         return true;
1028     return false;
1029   }
1030
1031   bool isSubClassOf(const std::string &Name) const {
1032     for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1033       if (SuperClasses[i]->getName() == Name)
1034         return true;
1035     return false;
1036   }
1037
1038   void addSuperClass(Record *R) {
1039     assert(!isSubClassOf(R) && "Already subclassing record!");
1040     SuperClasses.push_back(R);
1041   }
1042
1043   /// resolveReferences - If there are any field references that refer to fields
1044   /// that have been filled in, we can propagate the values now.
1045   ///
1046   void resolveReferences() { resolveReferencesTo(0); }
1047
1048   /// resolveReferencesTo - If anything in this record refers to RV, replace the
1049   /// reference to RV with the RHS of RV.  If RV is null, we resolve all
1050   /// possible references.
1051   void resolveReferencesTo(const RecordVal *RV);
1052
1053   void dump() const;
1054
1055   //===--------------------------------------------------------------------===//
1056   // High-level methods useful to tablegen back-ends
1057   //
1058
1059   /// getValueInit - Return the initializer for a value with the specified name,
1060   /// or throw an exception if the field does not exist.
1061   ///
1062   Init *getValueInit(const std::string &FieldName) const;
1063
1064   /// getValueAsString - This method looks up the specified field and returns
1065   /// its value as a string, throwing an exception if the field does not exist
1066   /// or if the value is not a string.
1067   ///
1068   std::string getValueAsString(const std::string &FieldName) const;
1069
1070   /// getValueAsBitsInit - This method looks up the specified field and returns
1071   /// its value as a BitsInit, throwing an exception if the field does not exist
1072   /// or if the value is not the right type.
1073   ///
1074   BitsInit *getValueAsBitsInit(const std::string &FieldName) const;
1075
1076   /// getValueAsListInit - This method looks up the specified field and returns
1077   /// its value as a ListInit, throwing an exception if the field does not exist
1078   /// or if the value is not the right type.
1079   ///
1080   ListInit *getValueAsListInit(const std::string &FieldName) const;
1081
1082   /// getValueAsListOfDefs - This method looks up the specified field and
1083   /// returns its value as a vector of records, throwing an exception if the
1084   /// field does not exist or if the value is not the right type.
1085   ///
1086   std::vector<Record*> getValueAsListOfDefs(const std::string &FieldName) const;
1087
1088   /// getValueAsListOfInts - This method looks up the specified field and returns
1089   /// its value as a vector of integers, throwing an exception if the field does
1090   /// not exist or if the value is not the right type.
1091   ///
1092   std::vector<int64_t> getValueAsListOfInts(const std::string &FieldName) const;
1093
1094   /// getValueAsDef - This method looks up the specified field and returns its
1095   /// value as a Record, throwing an exception if the field does not exist or if
1096   /// the value is not the right type.
1097   ///
1098   Record *getValueAsDef(const std::string &FieldName) const;
1099
1100   /// getValueAsBit - This method looks up the specified field and returns its
1101   /// value as a bit, throwing an exception if the field does not exist or if
1102   /// the value is not the right type.
1103   ///
1104   bool getValueAsBit(const std::string &FieldName) const;
1105
1106   /// getValueAsInt - This method looks up the specified field and returns its
1107   /// value as an int64_t, throwing an exception if the field does not exist or
1108   /// if the value is not the right type.
1109   ///
1110   int64_t getValueAsInt(const std::string &FieldName) const;
1111
1112   /// getValueAsDag - This method looks up the specified field and returns its
1113   /// value as an Dag, throwing an exception if the field does not exist or if
1114   /// the value is not the right type.
1115   ///
1116   DagInit *getValueAsDag(const std::string &FieldName) const;
1117
1118   /// getValueAsCode - This method looks up the specified field and returns
1119   /// its value as the string data in a CodeInit, throwing an exception if the
1120   /// field does not exist or if the value is not a code object.
1121   ///
1122   std::string getValueAsCode(const std::string &FieldName) const;
1123 };
1124
1125 std::ostream &operator<<(std::ostream &OS, const Record &R);
1126
1127 class RecordKeeper {
1128   std::map<std::string, Record*> Classes, Defs;
1129 public:
1130   ~RecordKeeper() {
1131     for (std::map<std::string, Record*>::iterator I = Classes.begin(),
1132            E = Classes.end(); I != E; ++I)
1133       delete I->second;
1134     for (std::map<std::string, Record*>::iterator I = Defs.begin(),
1135            E = Defs.end(); I != E; ++I)
1136       delete I->second;
1137   }
1138
1139   const std::map<std::string, Record*> &getClasses() const { return Classes; }
1140   const std::map<std::string, Record*> &getDefs() const { return Defs; }
1141
1142   Record *getClass(const std::string &Name) const {
1143     std::map<std::string, Record*>::const_iterator I = Classes.find(Name);
1144     return I == Classes.end() ? 0 : I->second;
1145   }
1146   Record *getDef(const std::string &Name) const {
1147     std::map<std::string, Record*>::const_iterator I = Defs.find(Name);
1148     return I == Defs.end() ? 0 : I->second;
1149   }
1150   void addClass(Record *R) {
1151     assert(getClass(R->getName()) == 0 && "Class already exists!");
1152     Classes.insert(std::make_pair(R->getName(), R));
1153   }
1154   void addDef(Record *R) {
1155     assert(getDef(R->getName()) == 0 && "Def already exists!");
1156     Defs.insert(std::make_pair(R->getName(), R));
1157   }
1158
1159   /// removeClass - Remove, but do not delete, the specified record.
1160   ///
1161   void removeClass(const std::string &Name) {
1162     assert(Classes.count(Name) && "Class does not exist!");
1163     Classes.erase(Name);
1164   }
1165   /// removeDef - Remove, but do not delete, the specified record.
1166   ///
1167   void removeDef(const std::string &Name) {
1168     assert(Defs.count(Name) && "Def does not exist!");
1169     Defs.erase(Name);
1170   }
1171
1172   //===--------------------------------------------------------------------===//
1173   // High-level helper methods, useful for tablegen backends...
1174
1175   /// getAllDerivedDefinitions - This method returns all concrete definitions
1176   /// that derive from the specified class name.  If a class with the specified
1177   /// name does not exist, an exception is thrown.
1178   std::vector<Record*>
1179   getAllDerivedDefinitions(const std::string &ClassName) const;
1180
1181
1182   void dump() const;
1183 };
1184
1185 /// LessRecord - Sorting predicate to sort record pointers by name.
1186 ///
1187 struct LessRecord {
1188   bool operator()(const Record *Rec1, const Record *Rec2) const {
1189     return Rec1->getName() < Rec2->getName();
1190   }
1191 };
1192
1193 /// LessRecordFieldName - Sorting predicate to sort record pointers by their
1194 /// name field.
1195 ///
1196 struct LessRecordFieldName {
1197   bool operator()(const Record *Rec1, const Record *Rec2) const {
1198     return Rec1->getValueAsString("Name") < Rec2->getValueAsString("Name");
1199   }
1200 };
1201
1202
1203 class TGError {
1204   TGLoc Loc;
1205   std::string Message;
1206 public:
1207   TGError(TGLoc loc, const std::string &message) : Loc(loc), Message(message) {}
1208
1209   TGLoc getLoc() const { return Loc; }
1210   const std::string &getMessage() const { return Message; }
1211 };
1212
1213
1214 std::ostream &operator<<(std::ostream &OS, const RecordKeeper &RK);
1215
1216 extern RecordKeeper Records;
1217
1218 void PrintError(TGLoc ErrorLoc, const std::string &Msg);
1219
1220
1221 } // End llvm namespace
1222
1223 #endif