1 //===- Record.h - Classes to represent Table Records ------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the main TableGen data structures, including the TableGen
11 // types, values, and high-level data structures.
13 //===----------------------------------------------------------------------===//
18 #include "TGSourceMgr.h"
19 #include "llvm/Support/DataTypes.h"
51 class VarListElementInit;
57 //===----------------------------------------------------------------------===//
59 //===----------------------------------------------------------------------===//
64 virtual std::string getAsString() const = 0;
65 void print(std::ostream &OS) const { OS << getAsString(); }
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;
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);
88 virtual Init *convertValue( FieldInit *FI) {
89 return convertValue((TypedInit*)FI);
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; }
105 inline std::ostream &operator<<(std::ostream &OS, const RecTy &Ty) {
111 /// BitRecTy - 'bit' - Represent a single bit
113 class BitRecTy : public RecTy {
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);}
130 std::string getAsString() const { return "bit"; }
132 bool typeIsConvertibleTo(const RecTy *RHS) const {
133 return RHS->baseClassOf(this);
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; }
147 // BitsRecTy - 'bits<n>' - Represent a fixed number of bits
148 /// BitsRecTy - 'bits<n>' - Represent a fixed number of bits
150 class BitsRecTy : public RecTy {
153 explicit BitsRecTy(unsigned Sz) : Size(Sz) {}
155 unsigned getNumBits() const { return Size; }
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);}
172 std::string getAsString() const;
174 bool typeIsConvertibleTo(const RecTy *RHS) const {
175 return RHS->baseClassOf(this);
177 virtual bool baseClassOf(const BitRecTy *RHS) const { return Size == 1; }
178 virtual bool baseClassOf(const BitsRecTy *RHS) const {
179 return RHS->Size == Size;
181 virtual bool baseClassOf(const IntRecTy *RHS) const { return true; }
182 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
183 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
184 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
185 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
186 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
191 /// IntRecTy - 'int' - Represent an integer value of no particular size
193 class IntRecTy : public RecTy {
195 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
196 virtual Init *convertValue( BitInit *BI);
197 virtual Init *convertValue( BitsInit *BI);
198 virtual Init *convertValue( IntInit *II) { return (Init*)II; }
199 virtual Init *convertValue(StringInit *SI) { return 0; }
200 virtual Init *convertValue( ListInit *LI) { return 0; }
201 virtual Init *convertValue( CodeInit *CI) { return 0; }
202 virtual Init *convertValue(VarBitInit *VB) { return 0; }
203 virtual Init *convertValue( DefInit *DI) { return 0; }
204 virtual Init *convertValue( DagInit *DI) { return 0; }
205 virtual Init *convertValue( BinOpInit *UI) { return 0; }
206 virtual Init *convertValue( TypedInit *TI);
207 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
208 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
210 std::string getAsString() const { return "int"; }
212 bool typeIsConvertibleTo(const RecTy *RHS) const {
213 return RHS->baseClassOf(this);
216 virtual bool baseClassOf(const BitRecTy *RHS) const { return true; }
217 virtual bool baseClassOf(const BitsRecTy *RHS) const { return true; }
218 virtual bool baseClassOf(const IntRecTy *RHS) const { return true; }
219 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
220 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
221 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
222 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
223 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
227 /// StringRecTy - 'string' - Represent an string value
229 class StringRecTy : public RecTy {
231 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
232 virtual Init *convertValue( BitInit *BI) { return 0; }
233 virtual Init *convertValue( BitsInit *BI) { return 0; }
234 virtual Init *convertValue( IntInit *II) { return 0; }
235 virtual Init *convertValue(StringInit *SI) { return (Init*)SI; }
236 virtual Init *convertValue( ListInit *LI) { return 0; }
237 virtual Init *convertValue( BinOpInit *BO);
238 virtual Init *convertValue( CodeInit *CI) { return 0; }
239 virtual Init *convertValue(VarBitInit *VB) { return 0; }
240 virtual Init *convertValue( DefInit *DI) { return 0; }
241 virtual Init *convertValue( DagInit *DI) { return 0; }
242 virtual Init *convertValue( TypedInit *TI);
243 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
244 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
246 std::string getAsString() const { return "string"; }
248 bool typeIsConvertibleTo(const RecTy *RHS) const {
249 return RHS->baseClassOf(this);
252 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
253 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
254 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
255 virtual bool baseClassOf(const StringRecTy *RHS) const { return true; }
256 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
257 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
258 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
259 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
262 // ListRecTy - 'list<Ty>' - Represent a list of values, all of which must be of
263 // the specified type.
264 /// ListRecTy - 'list<Ty>' - Represent a list of values, all of which must
265 /// be of the specified type.
267 class ListRecTy : public RecTy {
270 explicit ListRecTy(RecTy *T) : Ty(T) {}
272 RecTy *getElementType() const { return Ty; }
274 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
275 virtual Init *convertValue( BitInit *BI) { return 0; }
276 virtual Init *convertValue( BitsInit *BI) { return 0; }
277 virtual Init *convertValue( IntInit *II) { return 0; }
278 virtual Init *convertValue(StringInit *SI) { return 0; }
279 virtual Init *convertValue( ListInit *LI);
280 virtual Init *convertValue( CodeInit *CI) { return 0; }
281 virtual Init *convertValue(VarBitInit *VB) { return 0; }
282 virtual Init *convertValue( DefInit *DI) { return 0; }
283 virtual Init *convertValue( DagInit *DI) { return 0; }
284 virtual Init *convertValue( BinOpInit *UI) { return 0; }
285 virtual Init *convertValue( TypedInit *TI);
286 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
287 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
289 std::string getAsString() const;
291 bool typeIsConvertibleTo(const RecTy *RHS) const {
292 return RHS->baseClassOf(this);
295 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
296 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
297 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
298 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
299 virtual bool baseClassOf(const ListRecTy *RHS) const {
300 return RHS->getElementType()->typeIsConvertibleTo(Ty);
302 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
303 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
304 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
307 /// CodeRecTy - 'code' - Represent an code fragment, function or method.
309 class CodeRecTy : public RecTy {
311 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
312 virtual Init *convertValue( BitInit *BI) { return 0; }
313 virtual Init *convertValue( BitsInit *BI) { return 0; }
314 virtual Init *convertValue( IntInit *II) { return 0; }
315 virtual Init *convertValue(StringInit *SI) { return 0; }
316 virtual Init *convertValue( ListInit *LI) { return 0; }
317 virtual Init *convertValue( CodeInit *CI) { return (Init*)CI; }
318 virtual Init *convertValue(VarBitInit *VB) { return 0; }
319 virtual Init *convertValue( DefInit *DI) { return 0; }
320 virtual Init *convertValue( DagInit *DI) { return 0; }
321 virtual Init *convertValue( BinOpInit *UI) { return 0; }
322 virtual Init *convertValue( TypedInit *TI);
323 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
324 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
326 std::string getAsString() const { return "code"; }
328 bool typeIsConvertibleTo(const RecTy *RHS) const {
329 return RHS->baseClassOf(this);
331 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
332 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
333 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
334 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
335 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
336 virtual bool baseClassOf(const CodeRecTy *RHS) const { return true; }
337 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
338 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
341 /// DagRecTy - 'dag' - Represent a dag fragment
343 class DagRecTy : public RecTy {
345 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
346 virtual Init *convertValue( BitInit *BI) { return 0; }
347 virtual Init *convertValue( BitsInit *BI) { return 0; }
348 virtual Init *convertValue( IntInit *II) { return 0; }
349 virtual Init *convertValue(StringInit *SI) { return 0; }
350 virtual Init *convertValue( ListInit *LI) { return 0; }
351 virtual Init *convertValue( CodeInit *CI) { return 0; }
352 virtual Init *convertValue(VarBitInit *VB) { return 0; }
353 virtual Init *convertValue( DefInit *DI) { return 0; }
354 virtual Init *convertValue( BinOpInit *BO);
355 virtual Init *convertValue( DagInit *CI) { return (Init*)CI; }
356 virtual Init *convertValue( TypedInit *TI);
357 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
358 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
360 std::string getAsString() const { return "dag"; }
362 bool typeIsConvertibleTo(const RecTy *RHS) const {
363 return RHS->baseClassOf(this);
366 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
367 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
368 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
369 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
370 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
371 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
372 virtual bool baseClassOf(const DagRecTy *RHS) const { return true; }
373 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
377 /// RecordRecTy - '[classname]' - Represent an instance of a class, such as:
380 class RecordRecTy : public RecTy {
383 explicit RecordRecTy(Record *R) : Rec(R) {}
385 Record *getRecord() const { return Rec; }
387 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
388 virtual Init *convertValue( BitInit *BI) { return 0; }
389 virtual Init *convertValue( BitsInit *BI) { return 0; }
390 virtual Init *convertValue( IntInit *II) { return 0; }
391 virtual Init *convertValue(StringInit *SI) { return 0; }
392 virtual Init *convertValue( ListInit *LI) { return 0; }
393 virtual Init *convertValue( CodeInit *CI) { return 0; }
394 virtual Init *convertValue(VarBitInit *VB) { return 0; }
395 virtual Init *convertValue( BinOpInit *UI) { return 0; }
396 virtual Init *convertValue( DefInit *DI);
397 virtual Init *convertValue( DagInit *DI) { return 0; }
398 virtual Init *convertValue( TypedInit *VI);
399 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
400 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
402 std::string getAsString() const;
404 bool typeIsConvertibleTo(const RecTy *RHS) const {
405 return RHS->baseClassOf(this);
407 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
408 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
409 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
410 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
411 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
412 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
413 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
414 virtual bool baseClassOf(const RecordRecTy *RHS) const;
419 //===----------------------------------------------------------------------===//
420 // Initializer Classes
421 //===----------------------------------------------------------------------===//
426 /// isComplete - This virtual method should be overridden by values that may
427 /// not be completely specified yet.
428 virtual bool isComplete() const { return true; }
430 /// print - Print out this value.
431 void print(std::ostream &OS) const { OS << getAsString(); }
433 /// getAsString - Convert this value to a string form.
434 virtual std::string getAsString() const = 0;
436 /// dump - Debugging method that may be called through a debugger, just
437 /// invokes print on cerr.
440 /// convertInitializerTo - This virtual function is a simple call-back
441 /// function that should be overridden to call the appropriate
442 /// RecTy::convertValue method.
444 virtual Init *convertInitializerTo(RecTy *Ty) = 0;
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.
451 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits) {
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.
460 virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements) {
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.
468 virtual RecTy *getFieldType(const std::string &FieldName) const { return 0; }
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.
474 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const {
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.
483 virtual Init *resolveReferences(Record &R, const RecordVal *RV) {
488 inline std::ostream &operator<<(std::ostream &OS, const Init &I) {
489 I.print(OS); return OS;
493 /// UnsetInit - ? - Represents an uninitialized value
495 class UnsetInit : public Init {
497 virtual Init *convertInitializerTo(RecTy *Ty) {
498 return Ty->convertValue(this);
501 virtual bool isComplete() const { return false; }
502 virtual std::string getAsString() const { return "?"; }
506 /// BitInit - true/false - Represent a concrete initializer for a bit.
508 class BitInit : public Init {
511 explicit BitInit(bool V) : Value(V) {}
513 bool getValue() const { return Value; }
515 virtual Init *convertInitializerTo(RecTy *Ty) {
516 return Ty->convertValue(this);
519 virtual std::string getAsString() const { return Value ? "1" : "0"; }
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.
525 class BitsInit : public Init {
526 std::vector<Init*> Bits;
528 explicit BitsInit(unsigned Size) : Bits(Size) {}
530 unsigned getNumBits() const { return Bits.size(); }
532 Init *getBit(unsigned Bit) const {
533 assert(Bit < Bits.size() && "Bit index out of range!");
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!");
542 virtual Init *convertInitializerTo(RecTy *Ty) {
543 return Ty->convertValue(this);
545 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
547 virtual bool isComplete() const {
548 for (unsigned i = 0; i != getNumBits(); ++i)
549 if (!getBit(i)->isComplete()) return false;
552 virtual std::string getAsString() const;
554 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
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;
564 /// IntInit - 7 - Represent an initalization by a literal integer value.
566 class IntInit : public Init {
569 explicit IntInit(int64_t V) : Value(V) {}
571 int64_t getValue() const { return Value; }
573 virtual Init *convertInitializerTo(RecTy *Ty) {
574 return Ty->convertValue(this);
576 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
578 virtual std::string getAsString() const;
582 /// StringInit - "foo" - Represent an initialization by a string value.
584 class StringInit : public Init {
587 explicit StringInit(const std::string &V) : Value(V) {}
589 const std::string &getValue() const { return Value; }
591 virtual Init *convertInitializerTo(RecTy *Ty) {
592 return Ty->convertValue(this);
595 virtual std::string getAsString() const { return "\"" + Value + "\""; }
598 /// CodeInit - "[{...}]" - Represent a code fragment.
600 class CodeInit : public Init {
603 explicit CodeInit(const std::string &V) : Value(V) {}
605 const std::string getValue() const { return Value; }
607 virtual Init *convertInitializerTo(RecTy *Ty) {
608 return Ty->convertValue(this);
611 virtual std::string getAsString() const { return "[{" + Value + "}]"; }
614 /// ListInit - [AL, AH, CL] - Represent a list of defs
616 class ListInit : public Init {
617 std::vector<Init*> Values;
619 explicit ListInit(std::vector<Init*> &Vs) {
623 unsigned getSize() const { return Values.size(); }
624 Init *getElement(unsigned i) const {
625 assert(i < Values.size() && "List element index out of range!");
629 Record *getElementAsRecord(unsigned i) const;
631 Init *convertInitListSlice(const std::vector<unsigned> &Elements);
633 virtual Init *convertInitializerTo(RecTy *Ty) {
634 return Ty->convertValue(this);
637 /// resolveReferences - This method is used by classes that refer to other
638 /// variables which may not be defined at the time they expression is formed.
639 /// If a value is set for the variable later, this method will be called on
640 /// users of the value to allow the value to propagate out.
642 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
644 virtual std::string getAsString() const;
646 typedef std::vector<Init*>::iterator iterator;
647 typedef std::vector<Init*>::const_iterator const_iterator;
649 inline iterator begin() { return Values.begin(); }
650 inline const_iterator begin() const { return Values.begin(); }
651 inline iterator end () { return Values.end(); }
652 inline const_iterator end () const { return Values.end(); }
654 inline size_t size () const { return Values.size(); }
655 inline bool empty() const { return Values.empty(); }
658 /// BinOpInit - !op (X, Y) - Combine two inits.
660 class BinOpInit : public Init {
662 enum BinaryOp { SHL, SRA, SRL, STRCONCAT, CONCAT };
667 BinOpInit(BinaryOp opc, Init *lhs, Init *rhs) : Opc(opc), LHS(lhs), RHS(rhs) {
670 BinaryOp getOpcode() const { return Opc; }
671 Init *getLHS() const { return LHS; }
672 Init *getRHS() const { return RHS; }
674 // Fold - If possible, fold this to a simpler init. Return this if not
678 virtual Init *convertInitializerTo(RecTy *Ty) {
679 return Ty->convertValue(this);
682 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
684 virtual std::string getAsString() const;
689 /// TypedInit - This is the common super-class of types that have a specific,
692 class TypedInit : public Init {
695 explicit TypedInit(RecTy *T) : Ty(T) {}
697 RecTy *getType() const { return Ty; }
699 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
700 virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements);
702 /// resolveBitReference - This method is used to implement
703 /// VarBitInit::resolveReferences. If the bit is able to be resolved, we
704 /// simply return the resolved value, otherwise we return null.
706 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
709 /// resolveListElementReference - This method is used to implement
710 /// VarListElementInit::resolveReferences. If the list element is resolvable
711 /// now, we return the resolved value, otherwise we return null.
712 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
716 /// VarInit - 'Opcode' - Represent a reference to an entire variable object.
718 class VarInit : public TypedInit {
721 explicit VarInit(const std::string &VN, RecTy *T)
722 : TypedInit(T), VarName(VN) {}
724 virtual Init *convertInitializerTo(RecTy *Ty) {
725 return Ty->convertValue(this);
728 const std::string &getName() const { return VarName; }
730 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
732 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
735 virtual RecTy *getFieldType(const std::string &FieldName) const;
736 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
738 /// resolveReferences - This method is used by classes that refer to other
739 /// variables which may not be defined at the time they expression is formed.
740 /// If a value is set for the variable later, this method will be called on
741 /// users of the value to allow the value to propagate out.
743 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
745 virtual std::string getAsString() const { return VarName; }
749 /// VarBitInit - Opcode{0} - Represent access to one bit of a variable or field.
751 class VarBitInit : public Init {
755 VarBitInit(TypedInit *T, unsigned B) : TI(T), Bit(B) {
756 assert(T->getType() && dynamic_cast<BitsRecTy*>(T->getType()) &&
757 ((BitsRecTy*)T->getType())->getNumBits() > B &&
758 "Illegal VarBitInit expression!");
761 virtual Init *convertInitializerTo(RecTy *Ty) {
762 return Ty->convertValue(this);
765 TypedInit *getVariable() const { return TI; }
766 unsigned getBitNum() const { return Bit; }
768 virtual std::string getAsString() const;
769 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
772 /// VarListElementInit - List[4] - Represent access to one element of a var or
774 class VarListElementInit : public TypedInit {
778 VarListElementInit(TypedInit *T, unsigned E)
779 : TypedInit(dynamic_cast<ListRecTy*>(T->getType())->getElementType()),
781 assert(T->getType() && dynamic_cast<ListRecTy*>(T->getType()) &&
782 "Illegal VarBitInit expression!");
785 virtual Init *convertInitializerTo(RecTy *Ty) {
786 return Ty->convertValue(this);
789 TypedInit *getVariable() const { return TI; }
790 unsigned getElementNum() const { return Element; }
792 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
795 /// resolveListElementReference - This method is used to implement
796 /// VarListElementInit::resolveReferences. If the list element is resolvable
797 /// now, we return the resolved value, otherwise we return null.
798 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
801 virtual std::string getAsString() const;
802 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
805 /// DefInit - AL - Represent a reference to a 'def' in the description
807 class DefInit : public Init {
810 explicit DefInit(Record *D) : Def(D) {}
812 virtual Init *convertInitializerTo(RecTy *Ty) {
813 return Ty->convertValue(this);
816 Record *getDef() const { return Def; }
818 //virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
820 virtual RecTy *getFieldType(const std::string &FieldName) const;
821 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
823 virtual std::string getAsString() const;
827 /// FieldInit - X.Y - Represent a reference to a subfield of a variable
829 class FieldInit : public TypedInit {
830 Init *Rec; // Record we are referring to
831 std::string FieldName; // Field we are accessing
833 FieldInit(Init *R, const std::string &FN)
834 : TypedInit(R->getFieldType(FN)), Rec(R), FieldName(FN) {
835 assert(getType() && "FieldInit with non-record type!");
838 virtual Init *convertInitializerTo(RecTy *Ty) {
839 return Ty->convertValue(this);
842 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
844 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
847 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
849 virtual std::string getAsString() const {
850 return Rec->getAsString() + "." + FieldName;
854 /// DagInit - (v a, b) - Represent a DAG tree value. DAG inits are required
855 /// to have at least one value then a (possibly empty) list of arguments. Each
856 /// argument can have a name associated with it.
858 class DagInit : public Init {
860 std::vector<Init*> Args;
861 std::vector<std::string> ArgNames;
863 DagInit(Init *V, const std::vector<std::pair<Init*, std::string> > &args)
865 Args.reserve(args.size());
866 ArgNames.reserve(args.size());
867 for (unsigned i = 0, e = args.size(); i != e; ++i) {
868 Args.push_back(args[i].first);
869 ArgNames.push_back(args[i].second);
872 DagInit(Init *V, const std::vector<Init*> &args,
873 const std::vector<std::string> &argNames)
874 : Val(V), Args(args), ArgNames(argNames) {
877 virtual Init *convertInitializerTo(RecTy *Ty) {
878 return Ty->convertValue(this);
881 Init *getOperator() const { return Val; }
883 unsigned getNumArgs() const { return Args.size(); }
884 Init *getArg(unsigned Num) const {
885 assert(Num < Args.size() && "Arg number out of range!");
888 const std::string &getArgName(unsigned Num) const {
889 assert(Num < ArgNames.size() && "Arg number out of range!");
890 return ArgNames[Num];
893 void setArg(unsigned Num, Init *I) {
894 assert(Num < Args.size() && "Arg number out of range!");
898 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
900 virtual std::string getAsString() const;
902 typedef std::vector<Init*>::iterator arg_iterator;
903 typedef std::vector<Init*>::const_iterator const_arg_iterator;
904 typedef std::vector<std::string>::iterator name_iterator;
905 typedef std::vector<std::string>::const_iterator const_name_iterator;
907 inline arg_iterator arg_begin() { return Args.begin(); }
908 inline const_arg_iterator arg_begin() const { return Args.begin(); }
909 inline arg_iterator arg_end () { return Args.end(); }
910 inline const_arg_iterator arg_end () const { return Args.end(); }
912 inline size_t arg_size () const { return Args.size(); }
913 inline bool arg_empty() const { return Args.empty(); }
915 inline name_iterator name_begin() { return ArgNames.begin(); }
916 inline const_name_iterator name_begin() const { return ArgNames.begin(); }
917 inline name_iterator name_end () { return ArgNames.end(); }
918 inline const_name_iterator name_end () const { return ArgNames.end(); }
920 inline size_t name_size () const { return ArgNames.size(); }
921 inline bool name_empty() const { return ArgNames.empty(); }
925 //===----------------------------------------------------------------------===//
926 // High-Level Classes
927 //===----------------------------------------------------------------------===//
935 RecordVal(const std::string &N, RecTy *T, unsigned P);
937 const std::string &getName() const { return Name; }
939 unsigned getPrefix() const { return Prefix; }
940 RecTy *getType() const { return Ty; }
941 Init *getValue() const { return Value; }
943 bool setValue(Init *V) {
945 Value = V->convertInitializerTo(Ty);
953 void print(std::ostream &OS, bool PrintSem = true) const;
956 inline std::ostream &operator<<(std::ostream &OS, const RecordVal &RV) {
964 std::vector<std::string> TemplateArgs;
965 std::vector<RecordVal> Values;
966 std::vector<Record*> SuperClasses;
969 explicit Record(const std::string &N, TGLoc loc) : Name(N), Loc(loc) {}
972 const std::string &getName() const { return Name; }
973 void setName(const std::string &Name); // Also updates RecordKeeper.
975 TGLoc getLoc() const { return Loc; }
977 const std::vector<std::string> &getTemplateArgs() const {
980 const std::vector<RecordVal> &getValues() const { return Values; }
981 const std::vector<Record*> &getSuperClasses() const { return SuperClasses; }
983 bool isTemplateArg(const std::string &Name) const {
984 for (unsigned i = 0, e = TemplateArgs.size(); i != e; ++i)
985 if (TemplateArgs[i] == Name) return true;
989 const RecordVal *getValue(const std::string &Name) const {
990 for (unsigned i = 0, e = Values.size(); i != e; ++i)
991 if (Values[i].getName() == Name) return &Values[i];
994 RecordVal *getValue(const std::string &Name) {
995 for (unsigned i = 0, e = Values.size(); i != e; ++i)
996 if (Values[i].getName() == Name) return &Values[i];
1000 void addTemplateArg(const std::string &Name) {
1001 assert(!isTemplateArg(Name) && "Template arg already defined!");
1002 TemplateArgs.push_back(Name);
1005 void addValue(const RecordVal &RV) {
1006 assert(getValue(RV.getName()) == 0 && "Value already added!");
1007 Values.push_back(RV);
1010 void removeValue(const std::string &Name) {
1011 assert(getValue(Name) && "Cannot remove an entry that does not exist!");
1012 for (unsigned i = 0, e = Values.size(); i != e; ++i)
1013 if (Values[i].getName() == Name) {
1014 Values.erase(Values.begin()+i);
1017 assert(0 && "Name does not exist in record!");
1020 bool isSubClassOf(const Record *R) const {
1021 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1022 if (SuperClasses[i] == R)
1027 bool isSubClassOf(const std::string &Name) const {
1028 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1029 if (SuperClasses[i]->getName() == Name)
1034 void addSuperClass(Record *R) {
1035 assert(!isSubClassOf(R) && "Already subclassing record!");
1036 SuperClasses.push_back(R);
1039 /// resolveReferences - If there are any field references that refer to fields
1040 /// that have been filled in, we can propagate the values now.
1042 void resolveReferences() { resolveReferencesTo(0); }
1044 /// resolveReferencesTo - If anything in this record refers to RV, replace the
1045 /// reference to RV with the RHS of RV. If RV is null, we resolve all
1046 /// possible references.
1047 void resolveReferencesTo(const RecordVal *RV);
1051 //===--------------------------------------------------------------------===//
1052 // High-level methods useful to tablegen back-ends
1055 /// getValueInit - Return the initializer for a value with the specified name,
1056 /// or throw an exception if the field does not exist.
1058 Init *getValueInit(const std::string &FieldName) const;
1060 /// getValueAsString - This method looks up the specified field and returns
1061 /// its value as a string, throwing an exception if the field does not exist
1062 /// or if the value is not a string.
1064 std::string getValueAsString(const std::string &FieldName) const;
1066 /// getValueAsBitsInit - This method looks up the specified field and returns
1067 /// its value as a BitsInit, throwing an exception if the field does not exist
1068 /// or if the value is not the right type.
1070 BitsInit *getValueAsBitsInit(const std::string &FieldName) const;
1072 /// getValueAsListInit - This method looks up the specified field and returns
1073 /// its value as a ListInit, throwing an exception if the field does not exist
1074 /// or if the value is not the right type.
1076 ListInit *getValueAsListInit(const std::string &FieldName) const;
1078 /// getValueAsListOfDefs - This method looks up the specified field and
1079 /// returns its value as a vector of records, throwing an exception if the
1080 /// field does not exist or if the value is not the right type.
1082 std::vector<Record*> getValueAsListOfDefs(const std::string &FieldName) const;
1084 /// getValueAsListOfInts - This method looks up the specified field and returns
1085 /// its value as a vector of integers, throwing an exception if the field does
1086 /// not exist or if the value is not the right type.
1088 std::vector<int64_t> getValueAsListOfInts(const std::string &FieldName) const;
1090 /// getValueAsDef - This method looks up the specified field and returns its
1091 /// value as a Record, throwing an exception if the field does not exist or if
1092 /// the value is not the right type.
1094 Record *getValueAsDef(const std::string &FieldName) const;
1096 /// getValueAsBit - This method looks up the specified field and returns its
1097 /// value as a bit, throwing an exception if the field does not exist or if
1098 /// the value is not the right type.
1100 bool getValueAsBit(const std::string &FieldName) const;
1102 /// getValueAsInt - This method looks up the specified field and returns its
1103 /// value as an int64_t, throwing an exception if the field does not exist or
1104 /// if the value is not the right type.
1106 int64_t getValueAsInt(const std::string &FieldName) const;
1108 /// getValueAsDag - This method looks up the specified field and returns its
1109 /// value as an Dag, throwing an exception if the field does not exist or if
1110 /// the value is not the right type.
1112 DagInit *getValueAsDag(const std::string &FieldName) const;
1114 /// getValueAsCode - This method looks up the specified field and returns
1115 /// its value as the string data in a CodeInit, throwing an exception if the
1116 /// field does not exist or if the value is not a code object.
1118 std::string getValueAsCode(const std::string &FieldName) const;
1121 std::ostream &operator<<(std::ostream &OS, const Record &R);
1123 class RecordKeeper {
1124 std::map<std::string, Record*> Classes, Defs;
1127 for (std::map<std::string, Record*>::iterator I = Classes.begin(),
1128 E = Classes.end(); I != E; ++I)
1130 for (std::map<std::string, Record*>::iterator I = Defs.begin(),
1131 E = Defs.end(); I != E; ++I)
1135 const std::map<std::string, Record*> &getClasses() const { return Classes; }
1136 const std::map<std::string, Record*> &getDefs() const { return Defs; }
1138 Record *getClass(const std::string &Name) const {
1139 std::map<std::string, Record*>::const_iterator I = Classes.find(Name);
1140 return I == Classes.end() ? 0 : I->second;
1142 Record *getDef(const std::string &Name) const {
1143 std::map<std::string, Record*>::const_iterator I = Defs.find(Name);
1144 return I == Defs.end() ? 0 : I->second;
1146 void addClass(Record *R) {
1147 assert(getClass(R->getName()) == 0 && "Class already exists!");
1148 Classes.insert(std::make_pair(R->getName(), R));
1150 void addDef(Record *R) {
1151 assert(getDef(R->getName()) == 0 && "Def already exists!");
1152 Defs.insert(std::make_pair(R->getName(), R));
1155 /// removeClass - Remove, but do not delete, the specified record.
1157 void removeClass(const std::string &Name) {
1158 assert(Classes.count(Name) && "Class does not exist!");
1159 Classes.erase(Name);
1161 /// removeDef - Remove, but do not delete, the specified record.
1163 void removeDef(const std::string &Name) {
1164 assert(Defs.count(Name) && "Def does not exist!");
1168 //===--------------------------------------------------------------------===//
1169 // High-level helper methods, useful for tablegen backends...
1171 /// getAllDerivedDefinitions - This method returns all concrete definitions
1172 /// that derive from the specified class name. If a class with the specified
1173 /// name does not exist, an exception is thrown.
1174 std::vector<Record*>
1175 getAllDerivedDefinitions(const std::string &ClassName) const;
1181 /// LessRecord - Sorting predicate to sort record pointers by name.
1184 bool operator()(const Record *Rec1, const Record *Rec2) const {
1185 return Rec1->getName() < Rec2->getName();
1189 /// LessRecordFieldName - Sorting predicate to sort record pointers by their
1192 struct LessRecordFieldName {
1193 bool operator()(const Record *Rec1, const Record *Rec2) const {
1194 return Rec1->getValueAsString("Name") < Rec2->getValueAsString("Name");
1201 std::string Message;
1203 TGError(TGLoc loc, const std::string &message) : Loc(loc), Message(message) {}
1205 TGLoc getLoc() const { return Loc; }
1206 const std::string &getMessage() const { return Message; }
1210 std::ostream &operator<<(std::ostream &OS, const RecordKeeper &RK);
1212 extern RecordKeeper Records;
1214 void PrintError(TGLoc ErrorLoc, const std::string &Msg);
1217 } // End llvm namespace