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 std::string getAsString() const = 0;
66 virtual void print(std::ostream &OS) const = 0;
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;
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);
89 virtual Init *convertValue( FieldInit *FI) {
90 return convertValue((TypedInit*)FI);
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; }
106 inline std::ostream &operator<<(std::ostream &OS, const RecTy &Ty) {
112 /// BitRecTy - 'bit' - Represent a single bit
114 class BitRecTy : public RecTy {
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);}
131 std::string getAsString() const { return "bit"; }
132 void print(std::ostream &OS) const { OS << "bit"; }
134 bool typeIsConvertibleTo(const RecTy *RHS) const {
135 return RHS->baseClassOf(this);
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; }
149 // BitsRecTy - 'bits<n>' - Represent a fixed number of bits
150 /// BitsRecTy - 'bits<n>' - Represent a fixed number of bits
152 class BitsRecTy : public RecTy {
155 BitsRecTy(unsigned Sz) : Size(Sz) {}
157 unsigned getNumBits() const { return Size; }
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);}
174 std::string getAsString() const;
175 void print(std::ostream &OS) const { OS << "bits<" << Size << ">"; }
177 bool typeIsConvertibleTo(const RecTy *RHS) const {
178 return RHS->baseClassOf(this);
180 virtual bool baseClassOf(const BitRecTy *RHS) const { return Size == 1; }
181 virtual bool baseClassOf(const BitsRecTy *RHS) const {
182 return RHS->Size == Size;
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; }
194 /// IntRecTy - 'int' - Represent an integer value of no particular size
196 class IntRecTy : public RecTy {
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);}
213 std::string getAsString() const { return "int"; }
214 void print(std::ostream &OS) const { OS << "int"; }
216 bool typeIsConvertibleTo(const RecTy *RHS) const {
217 return RHS->baseClassOf(this);
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; }
231 /// StringRecTy - 'string' - Represent an string value
233 class StringRecTy : public RecTy {
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);}
250 std::string getAsString() const { return "string"; }
251 void print(std::ostream &OS) const { OS << "string"; }
253 bool typeIsConvertibleTo(const RecTy *RHS) const {
254 return RHS->baseClassOf(this);
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; }
267 // ListRecTy - 'list<Ty>' - Represent a list of values, all of which must be of
268 // the specified type.
269 /// ListRecTy - 'list<Ty>' - Represent a list of values, all of which must
270 /// be of the specified type.
272 class ListRecTy : public RecTy {
275 ListRecTy(RecTy *T) : Ty(T) {}
277 RecTy *getElementType() const { return Ty; }
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);}
294 std::string getAsString() const;
295 void print(std::ostream &OS) const;
297 bool typeIsConvertibleTo(const RecTy *RHS) const {
298 return RHS->baseClassOf(this);
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);
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; }
313 /// CodeRecTy - 'code' - Represent an code fragment, function or method.
315 class CodeRecTy : public RecTy {
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);}
332 std::string getAsString() const { return "code"; }
333 void print(std::ostream &OS) const { OS << "code"; }
335 bool typeIsConvertibleTo(const RecTy *RHS) const {
336 return RHS->baseClassOf(this);
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; }
348 /// DagRecTy - 'dag' - Represent a dag fragment
350 class DagRecTy : public RecTy {
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);}
367 std::string getAsString() const { return "dag"; }
368 void print(std::ostream &OS) const { OS << "dag"; }
370 bool typeIsConvertibleTo(const RecTy *RHS) const {
371 return RHS->baseClassOf(this);
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; }
385 /// RecordRecTy - '[classname]' - Represent an instance of a class, such as:
388 class RecordRecTy : public RecTy {
391 RecordRecTy(Record *R) : Rec(R) {}
393 Record *getRecord() const { return Rec; }
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);}
410 std::string getAsString() const;
411 void print(std::ostream &OS) const;
413 bool typeIsConvertibleTo(const RecTy *RHS) const {
414 return RHS->baseClassOf(this);
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;
428 //===----------------------------------------------------------------------===//
429 // Initializer Classes
430 //===----------------------------------------------------------------------===//
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; }
439 /// print - Print out this value.
440 virtual void print(std::ostream &OS) const = 0;
442 /// dump - Debugging method that may be called through a debugger, just
443 /// invokes print on cerr.
446 /// convertInitializerTo - This virtual function is a simple call-back
447 /// function that should be overridden to call the appropriate
448 /// RecTy::convertValue method.
450 virtual Init *convertInitializerTo(RecTy *Ty) = 0;
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.
457 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits) {
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.
466 virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements) {
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.
474 virtual RecTy *getFieldType(const std::string &FieldName) const { return 0; }
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.
480 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const {
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.
489 virtual Init *resolveReferences(Record &R, const RecordVal *RV) {
494 inline std::ostream &operator<<(std::ostream &OS, const Init &I) {
495 I.print(OS); return OS;
499 /// UnsetInit - ? - Represents an uninitialized value
501 class UnsetInit : public Init {
503 virtual Init *convertInitializerTo(RecTy *Ty) {
504 return Ty->convertValue(this);
507 virtual bool isComplete() const { return false; }
508 virtual void print(std::ostream &OS) const { OS << "?"; }
512 /// BitInit - true/false - Represent a concrete initializer for a bit.
514 class BitInit : public Init {
517 BitInit(bool V) : Value(V) {}
519 bool getValue() const { return Value; }
521 virtual Init *convertInitializerTo(RecTy *Ty) {
522 return Ty->convertValue(this);
525 virtual void print(std::ostream &OS) const { OS << (Value ? "1" : "0"); }
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.
531 class BitsInit : public Init {
532 std::vector<Init*> Bits;
534 BitsInit(unsigned Size) : Bits(Size) {}
536 unsigned getNumBits() const { return Bits.size(); }
538 Init *getBit(unsigned Bit) const {
539 assert(Bit < Bits.size() && "Bit index out of range!");
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!");
548 virtual Init *convertInitializerTo(RecTy *Ty) {
549 return Ty->convertValue(this);
551 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
553 virtual bool isComplete() const {
554 for (unsigned i = 0; i != getNumBits(); ++i)
555 if (!getBit(i)->isComplete()) return false;
558 virtual void print(std::ostream &OS) const;
560 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
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;
570 /// IntInit - 7 - Represent an initalization by a literal integer value.
572 class IntInit : public Init {
575 IntInit(int V) : Value(V) {}
577 int getValue() const { return Value; }
579 virtual Init *convertInitializerTo(RecTy *Ty) {
580 return Ty->convertValue(this);
582 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
584 virtual void print(std::ostream &OS) const { OS << Value; }
588 /// StringInit - "foo" - Represent an initialization by a string value.
590 class StringInit : public Init {
593 StringInit(const std::string &V) : Value(V) {}
595 const std::string &getValue() const { return Value; }
597 virtual Init *convertInitializerTo(RecTy *Ty) {
598 return Ty->convertValue(this);
601 virtual void print(std::ostream &OS) const { OS << "\"" << Value << "\""; }
604 /// CodeInit - "[{...}]" - Represent a code fragment.
606 class CodeInit : public Init {
609 CodeInit(const std::string &V) : Value(V) {}
611 const std::string getValue() const { return Value; }
613 virtual Init *convertInitializerTo(RecTy *Ty) {
614 return Ty->convertValue(this);
617 virtual void print(std::ostream &OS) const { OS << "[{" << Value << "}]"; }
620 /// ListInit - [AL, AH, CL] - Represent a list of defs
622 class ListInit : public Init {
623 std::vector<Init*> Values;
625 ListInit(std::vector<Init*> &Vs) {
629 unsigned getSize() const { return Values.size(); }
630 Init *getElement(unsigned i) const {
631 assert(i < Values.size() && "List element index out of range!");
635 Record *getElementAsRecord(unsigned i) const;
637 Init *convertInitListSlice(const std::vector<unsigned> &Elements);
639 virtual Init *convertInitializerTo(RecTy *Ty) {
640 return Ty->convertValue(this);
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.
648 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
650 virtual void print(std::ostream &OS) const;
653 /// BinOpInit - !op (X, Y) - Combine two inits.
655 class BinOpInit : public Init {
657 enum BinaryOp { SHL, SRA, SRL, STRCONCAT, CONCAT };
662 BinOpInit(BinaryOp opc, Init *lhs, Init *rhs) : Opc(opc), LHS(lhs), RHS(rhs) {
665 BinaryOp getOpcode() const { return Opc; }
666 Init *getLHS() const { return LHS; }
667 Init *getRHS() const { return RHS; }
669 // Fold - If possible, fold this to a simpler init. Return this if not
673 virtual Init *convertInitializerTo(RecTy *Ty) {
674 return Ty->convertValue(this);
677 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
679 virtual void print(std::ostream &OS) const;
684 /// TypedInit - This is the common super-class of types that have a specific,
687 class TypedInit : public Init {
690 TypedInit(RecTy *T) : Ty(T) {}
692 RecTy *getType() const { return Ty; }
694 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
695 virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements);
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.
701 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
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,
711 /// VarInit - 'Opcode' - Represent a reference to an entire variable object.
713 class VarInit : public TypedInit {
716 VarInit(const std::string &VN, RecTy *T) : TypedInit(T), VarName(VN) {}
718 virtual Init *convertInitializerTo(RecTy *Ty) {
719 return Ty->convertValue(this);
722 const std::string &getName() const { return VarName; }
724 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
726 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
729 virtual RecTy *getFieldType(const std::string &FieldName) const;
730 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
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.
737 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
739 virtual void print(std::ostream &OS) const { OS << VarName; }
743 /// VarBitInit - Opcode{0} - Represent access to one bit of a variable or field.
745 class VarBitInit : public Init {
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!");
755 virtual Init *convertInitializerTo(RecTy *Ty) {
756 return Ty->convertValue(this);
759 TypedInit *getVariable() const { return TI; }
760 unsigned getBitNum() const { return Bit; }
762 virtual void print(std::ostream &OS) const {
763 TI->print(OS); OS << "{" << Bit << "}";
765 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
768 /// VarListElementInit - List[4] - Represent access to one element of a var or
770 class VarListElementInit : public TypedInit {
774 VarListElementInit(TypedInit *T, unsigned E)
775 : TypedInit(dynamic_cast<ListRecTy*>(T->getType())->getElementType()),
777 assert(T->getType() && dynamic_cast<ListRecTy*>(T->getType()) &&
778 "Illegal VarBitInit expression!");
781 virtual Init *convertInitializerTo(RecTy *Ty) {
782 return Ty->convertValue(this);
785 TypedInit *getVariable() const { return TI; }
786 unsigned getElementNum() const { return Element; }
788 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
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,
797 virtual void print(std::ostream &OS) const {
798 TI->print(OS); OS << "[" << Element << "]";
800 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
803 /// DefInit - AL - Represent a reference to a 'def' in the description
805 class DefInit : public Init {
808 DefInit(Record *D) : Def(D) {}
810 virtual Init *convertInitializerTo(RecTy *Ty) {
811 return Ty->convertValue(this);
814 Record *getDef() const { return Def; }
816 //virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
818 virtual RecTy *getFieldType(const std::string &FieldName) const;
819 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
821 virtual void print(std::ostream &OS) const;
825 /// FieldInit - X.Y - Represent a reference to a subfield of a variable
827 class FieldInit : public TypedInit {
828 Init *Rec; // Record we are referring to
829 std::string FieldName; // Field we are accessing
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!");
836 virtual Init *convertInitializerTo(RecTy *Ty) {
837 return Ty->convertValue(this);
840 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
842 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
845 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
847 virtual void print(std::ostream &OS) const {
848 Rec->print(OS); OS << "." << FieldName;
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.
856 class DagInit : public Init {
858 std::vector<Init*> Args;
859 std::vector<std::string> ArgNames;
861 DagInit(Init *V, const std::vector<std::pair<Init*, std::string> > &args)
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);
870 DagInit(Init *V, const std::vector<Init*> &args,
871 const std::vector<std::string> &argNames)
872 : Val(V), Args(args), ArgNames(argNames) {
875 virtual Init *convertInitializerTo(RecTy *Ty) {
876 return Ty->convertValue(this);
879 Init *getOperator() const { return Val; }
881 unsigned getNumArgs() const { return Args.size(); }
882 Init *getArg(unsigned Num) const {
883 assert(Num < Args.size() && "Arg number out of range!");
886 const std::string &getArgName(unsigned Num) const {
887 assert(Num < ArgNames.size() && "Arg number out of range!");
888 return ArgNames[Num];
891 void setArg(unsigned Num, Init *I) {
892 assert(Num < Args.size() && "Arg number out of range!");
896 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
898 virtual void print(std::ostream &OS) const;
901 //===----------------------------------------------------------------------===//
902 // High-Level Classes
903 //===----------------------------------------------------------------------===//
911 RecordVal(const std::string &N, RecTy *T, unsigned P);
913 const std::string &getName() const { return Name; }
915 unsigned getPrefix() const { return Prefix; }
916 RecTy *getType() const { return Ty; }
917 Init *getValue() const { return Value; }
919 bool setValue(Init *V) {
921 Value = V->convertInitializerTo(Ty);
929 void print(std::ostream &OS, bool PrintSem = true) const;
932 inline std::ostream &operator<<(std::ostream &OS, const RecordVal &RV) {
939 std::vector<std::string> TemplateArgs;
940 std::vector<RecordVal> Values;
941 std::vector<Record*> SuperClasses;
944 Record(const std::string &N) : Name(N) {}
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 {
952 const std::vector<RecordVal> &getValues() const { return Values; }
953 const std::vector<Record*> &getSuperClasses() const { return SuperClasses; }
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;
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];
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];
972 void addTemplateArg(const std::string &Name) {
973 assert(!isTemplateArg(Name) && "Template arg already defined!");
974 TemplateArgs.push_back(Name);
977 void addValue(const RecordVal &RV) {
978 assert(getValue(RV.getName()) == 0 && "Value already added!");
979 Values.push_back(RV);
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);
989 assert(0 && "Name does not exist in record!");
992 bool isSubClassOf(Record *R) const {
993 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
994 if (SuperClasses[i] == R)
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)
1006 void addSuperClass(Record *R) {
1007 assert(!isSubClassOf(R) && "Already subclassing record!");
1008 SuperClasses.push_back(R);
1011 /// resolveReferences - If there are any field references that refer to fields
1012 /// that have been filled in, we can propagate the values now.
1014 void resolveReferences() { resolveReferencesTo(0); }
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);
1023 //===--------------------------------------------------------------------===//
1024 // High-level methods useful to tablegen back-ends
1027 /// getValueInit - Return the initializer for a value with the specified name,
1028 /// or throw an exception if the field does not exist.
1030 Init *getValueInit(const std::string &FieldName) const;
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.
1036 std::string getValueAsString(const std::string &FieldName) const;
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.
1042 BitsInit *getValueAsBitsInit(const std::string &FieldName) const;
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.
1048 ListInit *getValueAsListInit(const std::string &FieldName) const;
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.
1054 std::vector<Record*> getValueAsListOfDefs(const std::string &FieldName) const;
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.
1060 std::vector<int> getValueAsListOfInts(const std::string &FieldName) const;
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.
1066 Record *getValueAsDef(const std::string &FieldName) const;
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.
1072 bool getValueAsBit(const std::string &FieldName) const;
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.
1078 int getValueAsInt(const std::string &FieldName) const;
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.
1084 DagInit *getValueAsDag(const std::string &FieldName) const;
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.
1090 std::string getValueAsCode(const std::string &FieldName) const;
1093 std::ostream &operator<<(std::ostream &OS, const Record &R);
1095 class RecordKeeper {
1096 std::map<std::string, Record*> Classes, Defs;
1099 for (std::map<std::string, Record*>::iterator I = Classes.begin(),
1100 E = Classes.end(); I != E; ++I)
1102 for (std::map<std::string, Record*>::iterator I = Defs.begin(),
1103 E = Defs.end(); I != E; ++I)
1107 const std::map<std::string, Record*> &getClasses() const { return Classes; }
1108 const std::map<std::string, Record*> &getDefs() const { return Defs; }
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;
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;
1118 void addClass(Record *R) {
1119 assert(getClass(R->getName()) == 0 && "Class already exists!");
1120 Classes.insert(std::make_pair(R->getName(), R));
1122 void addDef(Record *R) {
1123 assert(getDef(R->getName()) == 0 && "Def already exists!");
1124 Defs.insert(std::make_pair(R->getName(), R));
1127 /// removeClass - Remove, but do not delete, the specified record.
1129 void removeClass(const std::string &Name) {
1130 assert(Classes.count(Name) && "Class does not exist!");
1131 Classes.erase(Name);
1133 /// removeDef - Remove, but do not delete, the specified record.
1135 void removeDef(const std::string &Name) {
1136 assert(Defs.count(Name) && "Def does not exist!");
1140 //===--------------------------------------------------------------------===//
1141 // High-level helper methods, useful for tablegen backends...
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;
1153 std::ostream &operator<<(std::ostream &OS, const RecordKeeper &RK);
1155 extern RecordKeeper Records;
1157 } // End llvm namespace