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