utils/TableGen/Record.h

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