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