1 //===- Record.h - Classes to represent Table Records ------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file defines the main TableGen data structures, including the TableGen
11 // types, values, and high-level data structures.
13 //===----------------------------------------------------------------------===//
52 class VarListElementInit;
58 //===----------------------------------------------------------------------===//
60 //===----------------------------------------------------------------------===//
65 virtual void print(std::ostream &OS) const = 0;
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 void print(std::ostream &OS) const { OS << "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 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);}
173 void print(std::ostream &OS) const { OS << "bits<" << Size << ">"; }
175 bool typeIsConvertibleTo(const RecTy *RHS) const {
176 return RHS->baseClassOf(this);
178 virtual bool baseClassOf(const BitRecTy *RHS) const { return Size == 1; }
179 virtual bool baseClassOf(const BitsRecTy *RHS) const {
180 return RHS->Size == Size;
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; }
192 /// IntRecTy - 'int' - Represent an integer value of no particular size
194 class IntRecTy : public RecTy {
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);}
212 void print(std::ostream &OS) const { OS << "int"; }
214 bool typeIsConvertibleTo(const RecTy *RHS) const {
215 return RHS->baseClassOf(this);
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; }
229 /// StringRecTy - 'string' - Represent an string value
231 class StringRecTy : public RecTy {
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);}
248 void print(std::ostream &OS) const { OS << "string"; }
250 bool typeIsConvertibleTo(const RecTy *RHS) const {
251 return RHS->baseClassOf(this);
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; }
264 // ListRecTy - 'list<Ty>' - Represent a list of values, all of which must be of
265 // the specified type.
266 /// ListRecTy - 'list<Ty>' - Represent a list of values, all of which must
267 /// be of the specified type.
269 class ListRecTy : public RecTy {
272 ListRecTy(RecTy *T) : Ty(T) {}
274 RecTy *getElementType() const { return Ty; }
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);}
291 void print(std::ostream &OS) const;
293 bool typeIsConvertibleTo(const RecTy *RHS) const {
294 return RHS->baseClassOf(this);
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);
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; }
309 /// CodeRecTy - 'code' - Represent an code fragment, function or method.
311 class CodeRecTy : public RecTy {
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);}
329 void print(std::ostream &OS) const { OS << "code"; }
331 bool typeIsConvertibleTo(const RecTy *RHS) const {
332 return RHS->baseClassOf(this);
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; }
344 /// DagRecTy - 'dag' - Represent a dag fragment
346 class DagRecTy : public RecTy {
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 *BO);
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);}
363 void print(std::ostream &OS) const { OS << "dag"; }
365 bool typeIsConvertibleTo(const RecTy *RHS) const {
366 return RHS->baseClassOf(this);
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; }
380 /// RecordRecTy - '[classname]' - Represent an instance of a class, such as:
383 class RecordRecTy : public RecTy {
386 RecordRecTy(Record *R) : Rec(R) {}
388 Record *getRecord() const { return Rec; }
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);}
405 void print(std::ostream &OS) const;
407 bool typeIsConvertibleTo(const RecTy *RHS) const {
408 return RHS->baseClassOf(this);
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;
422 //===----------------------------------------------------------------------===//
423 // Initializer Classes
424 //===----------------------------------------------------------------------===//
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; }
433 /// print - Print out this value.
434 virtual void print(std::ostream &OS) 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 void print(std::ostream &OS) const { OS << "?"; }
506 /// BitInit - true/false - Represent a concrete initializer for a bit.
508 class BitInit : public Init {
511 BitInit(bool V) : Value(V) {}
513 bool getValue() const { return Value; }
515 virtual Init *convertInitializerTo(RecTy *Ty) {
516 return Ty->convertValue(this);
519 virtual void print(std::ostream &OS) const { OS << (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 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 void print(std::ostream &OS) 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 IntInit(int V) : Value(V) {}
571 int 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 void print(std::ostream &OS) const { OS << Value; }
582 /// StringInit - "foo" - Represent an initialization by a string value.
584 class StringInit : public Init {
587 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 void print(std::ostream &OS) const { OS << "\"" << Value << "\""; }
598 /// CodeInit - "[{...}]" - Represent a code fragment.
600 class CodeInit : public Init {
603 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 void print(std::ostream &OS) const { OS << "[{" << Value << "}]"; }
614 /// ListInit - [AL, AH, CL] - Represent a list of defs
616 class ListInit : public Init {
617 std::vector<Init*> Values;
619 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 void print(std::ostream &OS) const;
647 /// BinOpInit - !op (X, Y) - Combine two inits.
649 class BinOpInit : public Init {
651 enum BinaryOp { SHL, SRA, SRL, STRCONCAT, CONCAT };
656 BinOpInit(BinaryOp opc, Init *lhs, Init *rhs) : Opc(opc), LHS(lhs), RHS(rhs) {
659 BinaryOp getOpcode() const { return Opc; }
660 Init *getLHS() const { return LHS; }
661 Init *getRHS() const { return RHS; }
663 // Fold - If possible, fold this to a simpler init. Return this if not
667 virtual Init *convertInitializerTo(RecTy *Ty) {
668 return Ty->convertValue(this);
671 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
673 virtual void print(std::ostream &OS) const;
678 /// TypedInit - This is the common super-class of types that have a specific,
681 class TypedInit : public Init {
684 TypedInit(RecTy *T) : Ty(T) {}
686 RecTy *getType() const { return Ty; }
688 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
689 virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements);
691 /// resolveBitReference - This method is used to implement
692 /// VarBitInit::resolveReferences. If the bit is able to be resolved, we
693 /// simply return the resolved value, otherwise we return null.
695 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
698 /// resolveListElementReference - This method is used to implement
699 /// VarListElementInit::resolveReferences. If the list element is resolvable
700 /// now, we return the resolved value, otherwise we return null.
701 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
705 /// VarInit - 'Opcode' - Represent a reference to an entire variable object.
707 class VarInit : public TypedInit {
710 VarInit(const std::string &VN, RecTy *T) : TypedInit(T), VarName(VN) {}
712 virtual Init *convertInitializerTo(RecTy *Ty) {
713 return Ty->convertValue(this);
716 const std::string &getName() const { return VarName; }
718 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
720 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
723 virtual RecTy *getFieldType(const std::string &FieldName) const;
724 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
726 /// resolveReferences - This method is used by classes that refer to other
727 /// variables which may not be defined at the time they expression is formed.
728 /// If a value is set for the variable later, this method will be called on
729 /// users of the value to allow the value to propagate out.
731 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
733 virtual void print(std::ostream &OS) const { OS << VarName; }
737 /// VarBitInit - Opcode{0} - Represent access to one bit of a variable or field.
739 class VarBitInit : public Init {
743 VarBitInit(TypedInit *T, unsigned B) : TI(T), Bit(B) {
744 assert(T->getType() && dynamic_cast<BitsRecTy*>(T->getType()) &&
745 ((BitsRecTy*)T->getType())->getNumBits() > B &&
746 "Illegal VarBitInit expression!");
749 virtual Init *convertInitializerTo(RecTy *Ty) {
750 return Ty->convertValue(this);
753 TypedInit *getVariable() const { return TI; }
754 unsigned getBitNum() const { return Bit; }
756 virtual void print(std::ostream &OS) const {
757 TI->print(OS); OS << "{" << Bit << "}";
759 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
762 /// VarListElementInit - List[4] - Represent access to one element of a var or
764 class VarListElementInit : public TypedInit {
768 VarListElementInit(TypedInit *T, unsigned E)
769 : TypedInit(dynamic_cast<ListRecTy*>(T->getType())->getElementType()),
771 assert(T->getType() && dynamic_cast<ListRecTy*>(T->getType()) &&
772 "Illegal VarBitInit expression!");
775 virtual Init *convertInitializerTo(RecTy *Ty) {
776 return Ty->convertValue(this);
779 TypedInit *getVariable() const { return TI; }
780 unsigned getElementNum() const { return Element; }
782 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
785 /// resolveListElementReference - This method is used to implement
786 /// VarListElementInit::resolveReferences. If the list element is resolvable
787 /// now, we return the resolved value, otherwise we return null.
788 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
791 virtual void print(std::ostream &OS) const {
792 TI->print(OS); OS << "[" << Element << "]";
794 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
797 /// DefInit - AL - Represent a reference to a 'def' in the description
799 class DefInit : public Init {
802 DefInit(Record *D) : Def(D) {}
804 virtual Init *convertInitializerTo(RecTy *Ty) {
805 return Ty->convertValue(this);
808 Record *getDef() const { return Def; }
810 //virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
812 virtual RecTy *getFieldType(const std::string &FieldName) const;
813 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
815 virtual void print(std::ostream &OS) const;
819 /// FieldInit - X.Y - Represent a reference to a subfield of a variable
821 class FieldInit : public TypedInit {
822 Init *Rec; // Record we are referring to
823 std::string FieldName; // Field we are accessing
825 FieldInit(Init *R, const std::string &FN)
826 : TypedInit(R->getFieldType(FN)), Rec(R), FieldName(FN) {
827 assert(getType() && "FieldInit with non-record type!");
830 virtual Init *convertInitializerTo(RecTy *Ty) {
831 return Ty->convertValue(this);
834 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
836 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
839 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
841 virtual void print(std::ostream &OS) const {
842 Rec->print(OS); OS << "." << FieldName;
846 /// DagInit - (v a, b) - Represent a DAG tree value. DAG inits are required
847 /// to have at least one value then a (possibly empty) list of arguments. Each
848 /// argument can have a name associated with it.
850 class DagInit : public Init {
852 std::vector<Init*> Args;
853 std::vector<std::string> ArgNames;
855 DagInit(Init *V, const std::vector<std::pair<Init*, std::string> > &args)
857 Args.reserve(args.size());
858 ArgNames.reserve(args.size());
859 for (unsigned i = 0, e = args.size(); i != e; ++i) {
860 Args.push_back(args[i].first);
861 ArgNames.push_back(args[i].second);
864 DagInit(Init *V, const std::vector<Init*> &args,
865 const std::vector<std::string> &argNames)
866 : Val(V), Args(args), ArgNames(argNames) {
869 virtual Init *convertInitializerTo(RecTy *Ty) {
870 return Ty->convertValue(this);
873 Init *getOperator() const { return Val; }
875 unsigned getNumArgs() const { return Args.size(); }
876 Init *getArg(unsigned Num) const {
877 assert(Num < Args.size() && "Arg number out of range!");
880 const std::string &getArgName(unsigned Num) const {
881 assert(Num < ArgNames.size() && "Arg number out of range!");
882 return ArgNames[Num];
885 void setArg(unsigned Num, Init *I) {
886 assert(Num < Args.size() && "Arg number out of range!");
890 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
892 virtual void print(std::ostream &OS) const;
895 //===----------------------------------------------------------------------===//
896 // High-Level Classes
897 //===----------------------------------------------------------------------===//
905 RecordVal(const std::string &N, RecTy *T, unsigned P);
907 const std::string &getName() const { return Name; }
909 unsigned getPrefix() const { return Prefix; }
910 RecTy *getType() const { return Ty; }
911 Init *getValue() const { return Value; }
913 bool setValue(Init *V) {
915 Value = V->convertInitializerTo(Ty);
923 void print(std::ostream &OS, bool PrintSem = true) const;
926 inline std::ostream &operator<<(std::ostream &OS, const RecordVal &RV) {
933 std::vector<std::string> TemplateArgs;
934 std::vector<RecordVal> Values;
935 std::vector<Record*> SuperClasses;
938 Record(const std::string &N) : Name(N) {}
941 const std::string &getName() const { return Name; }
942 void setName(const std::string &Name); // Also updates RecordKeeper.
943 const std::vector<std::string> &getTemplateArgs() const {
946 const std::vector<RecordVal> &getValues() const { return Values; }
947 const std::vector<Record*> &getSuperClasses() const { return SuperClasses; }
949 bool isTemplateArg(const std::string &Name) const {
950 for (unsigned i = 0, e = TemplateArgs.size(); i != e; ++i)
951 if (TemplateArgs[i] == Name) return true;
955 const RecordVal *getValue(const std::string &Name) const {
956 for (unsigned i = 0, e = Values.size(); i != e; ++i)
957 if (Values[i].getName() == Name) return &Values[i];
960 RecordVal *getValue(const std::string &Name) {
961 for (unsigned i = 0, e = Values.size(); i != e; ++i)
962 if (Values[i].getName() == Name) return &Values[i];
966 void addTemplateArg(const std::string &Name) {
967 assert(!isTemplateArg(Name) && "Template arg already defined!");
968 TemplateArgs.push_back(Name);
971 void addValue(const RecordVal &RV) {
972 assert(getValue(RV.getName()) == 0 && "Value already added!");
973 Values.push_back(RV);
976 void removeValue(const std::string &Name) {
977 assert(getValue(Name) && "Cannot remove an entry that does not exist!");
978 for (unsigned i = 0, e = Values.size(); i != e; ++i)
979 if (Values[i].getName() == Name) {
980 Values.erase(Values.begin()+i);
983 assert(0 && "Name does not exist in record!");
986 bool isSubClassOf(Record *R) const {
987 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
988 if (SuperClasses[i] == R)
993 bool isSubClassOf(const std::string &Name) const {
994 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
995 if (SuperClasses[i]->getName() == Name)
1000 void addSuperClass(Record *R) {
1001 assert(!isSubClassOf(R) && "Already subclassing record!");
1002 SuperClasses.push_back(R);
1005 /// resolveReferences - If there are any field references that refer to fields
1006 /// that have been filled in, we can propagate the values now.
1008 void resolveReferences() { resolveReferencesTo(0); }
1010 /// resolveReferencesTo - If anything in this record refers to RV, replace the
1011 /// reference to RV with the RHS of RV. If RV is null, we resolve all
1012 /// possible references.
1013 void resolveReferencesTo(const RecordVal *RV);
1017 //===--------------------------------------------------------------------===//
1018 // High-level methods useful to tablegen back-ends
1021 /// getValueInit - Return the initializer for a value with the specified name,
1022 /// or throw an exception if the field does not exist.
1024 Init *getValueInit(const std::string &FieldName) const;
1026 /// getValueAsString - This method looks up the specified field and returns
1027 /// its value as a string, throwing an exception if the field does not exist
1028 /// or if the value is not a string.
1030 std::string getValueAsString(const std::string &FieldName) const;
1032 /// getValueAsBitsInit - This method looks up the specified field and returns
1033 /// its value as a BitsInit, throwing an exception if the field does not exist
1034 /// or if the value is not the right type.
1036 BitsInit *getValueAsBitsInit(const std::string &FieldName) const;
1038 /// getValueAsListInit - This method looks up the specified field and returns
1039 /// its value as a ListInit, throwing an exception if the field does not exist
1040 /// or if the value is not the right type.
1042 ListInit *getValueAsListInit(const std::string &FieldName) const;
1044 /// getValueAsListOfDefs - This method looks up the specified field and
1045 /// returns its value as a vector of records, throwing an exception if the
1046 /// field does not exist or if the value is not the right type.
1048 std::vector<Record*> getValueAsListOfDefs(const std::string &FieldName) const;
1050 /// getValueAsListOfInts - This method looks up the specified field and returns
1051 /// its value as a vector of integers, throwing an exception if the field does
1052 /// not exist or if the value is not the right type.
1054 std::vector<int> getValueAsListOfInts(const std::string &FieldName) const;
1056 /// getValueAsDef - This method looks up the specified field and returns its
1057 /// value as a Record, throwing an exception if the field does not exist or if
1058 /// the value is not the right type.
1060 Record *getValueAsDef(const std::string &FieldName) const;
1062 /// getValueAsBit - This method looks up the specified field and returns its
1063 /// value as a bit, throwing an exception if the field does not exist or if
1064 /// the value is not the right type.
1066 bool getValueAsBit(const std::string &FieldName) const;
1068 /// getValueAsInt - This method looks up the specified field and returns its
1069 /// value as an int, throwing an exception if the field does not exist or if
1070 /// the value is not the right type.
1072 int getValueAsInt(const std::string &FieldName) const;
1074 /// getValueAsDag - This method looks up the specified field and returns its
1075 /// value as an Dag, throwing an exception if the field does not exist or if
1076 /// the value is not the right type.
1078 DagInit *getValueAsDag(const std::string &FieldName) const;
1080 /// getValueAsCode - This method looks up the specified field and returns
1081 /// its value as the string data in a CodeInit, throwing an exception if the
1082 /// field does not exist or if the value is not a code object.
1084 std::string getValueAsCode(const std::string &FieldName) const;
1087 std::ostream &operator<<(std::ostream &OS, const Record &R);
1089 class RecordKeeper {
1090 std::map<std::string, Record*> Classes, Defs;
1093 for (std::map<std::string, Record*>::iterator I = Classes.begin(),
1094 E = Classes.end(); I != E; ++I)
1096 for (std::map<std::string, Record*>::iterator I = Defs.begin(),
1097 E = Defs.end(); I != E; ++I)
1101 const std::map<std::string, Record*> &getClasses() const { return Classes; }
1102 const std::map<std::string, Record*> &getDefs() const { return Defs; }
1104 Record *getClass(const std::string &Name) const {
1105 std::map<std::string, Record*>::const_iterator I = Classes.find(Name);
1106 return I == Classes.end() ? 0 : I->second;
1108 Record *getDef(const std::string &Name) const {
1109 std::map<std::string, Record*>::const_iterator I = Defs.find(Name);
1110 return I == Defs.end() ? 0 : I->second;
1112 void addClass(Record *R) {
1113 assert(getClass(R->getName()) == 0 && "Class already exists!");
1114 Classes.insert(std::make_pair(R->getName(), R));
1116 void addDef(Record *R) {
1117 assert(getDef(R->getName()) == 0 && "Def already exists!");
1118 Defs.insert(std::make_pair(R->getName(), R));
1121 /// removeClass - Remove, but do not delete, the specified record.
1123 void removeClass(const std::string &Name) {
1124 assert(Classes.count(Name) && "Class does not exist!");
1125 Classes.erase(Name);
1127 /// removeDef - Remove, but do not delete, the specified record.
1129 void removeDef(const std::string &Name) {
1130 assert(Defs.count(Name) && "Def does not exist!");
1134 //===--------------------------------------------------------------------===//
1135 // High-level helper methods, useful for tablegen backends...
1137 /// getAllDerivedDefinitions - This method returns all concrete definitions
1138 /// that derive from the specified class name. If a class with the specified
1139 /// name does not exist, an exception is thrown.
1140 std::vector<Record*>
1141 getAllDerivedDefinitions(const std::string &ClassName) const;
1147 std::ostream &operator<<(std::ostream &OS, const RecordKeeper &RK);
1149 extern RecordKeeper Records;
1151 } // End llvm namespace