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