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