utils/TableGen/Record.h

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