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 //===----------------------------------------------------------------------===//
51 class VarListElementInit;
57 //===----------------------------------------------------------------------===//
59 //===----------------------------------------------------------------------===//
64 virtual void print(std::ostream &OS) const = 0;
67 /// typeIsConvertibleTo - Return true if all values of 'this' type can be
68 /// converted to the specified type.
69 virtual bool typeIsConvertibleTo(const RecTy *RHS) const = 0;
71 public: // These methods should only be called from subclasses of Init
72 virtual Init *convertValue( UnsetInit *UI) { return 0; }
73 virtual Init *convertValue( BitInit *BI) { return 0; }
74 virtual Init *convertValue( BitsInit *BI) { return 0; }
75 virtual Init *convertValue( IntInit *II) { return 0; }
76 virtual Init *convertValue(StringInit *SI) { return 0; }
77 virtual Init *convertValue( ListInit *LI) { return 0; }
78 virtual Init *convertValue( CodeInit *CI) { return 0; }
79 virtual Init *convertValue(VarBitInit *VB) { return 0; }
80 virtual Init *convertValue( DefInit *DI) { return 0; }
81 virtual Init *convertValue( DagInit *DI) { return 0; }
82 virtual Init *convertValue( TypedInit *TI) { return 0; }
83 virtual Init *convertValue( VarInit *VI) {
84 return convertValue((TypedInit*)VI);
86 virtual Init *convertValue( FieldInit *FI) {
87 return convertValue((TypedInit*)FI);
90 public: // These methods should only be called by subclasses of RecTy.
91 // baseClassOf - These virtual methods should be overloaded to return true iff
92 // all values of type 'RHS' can be converted to the 'this' type.
93 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
94 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
95 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
96 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
97 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
98 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
99 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
100 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
103 inline std::ostream &operator<<(std::ostream &OS, const RecTy &Ty) {
109 /// BitRecTy - 'bit' - Represent a single bit
111 class BitRecTy : public RecTy {
113 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
114 virtual Init *convertValue( BitInit *BI) { return (Init*)BI; }
115 virtual Init *convertValue( BitsInit *BI);
116 virtual Init *convertValue( IntInit *II);
117 virtual Init *convertValue(StringInit *SI) { return 0; }
118 virtual Init *convertValue( ListInit *LI) { return 0; }
119 virtual Init *convertValue( CodeInit *CI) { return 0; }
120 virtual Init *convertValue(VarBitInit *VB) { return (Init*)VB; }
121 virtual Init *convertValue( DefInit *DI) { return 0; }
122 virtual Init *convertValue( DagInit *DI) { return 0; }
123 virtual Init *convertValue( TypedInit *TI);
124 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
125 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
127 void print(std::ostream &OS) const { OS << "bit"; }
129 bool typeIsConvertibleTo(const RecTy *RHS) const {
130 return RHS->baseClassOf(this);
132 virtual bool baseClassOf(const BitRecTy *RHS) const { return true; }
133 virtual bool baseClassOf(const BitsRecTy *RHS) const;
134 virtual bool baseClassOf(const IntRecTy *RHS) const { return true; }
135 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
136 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
137 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
138 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
139 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
144 // BitsRecTy - 'bits<n>' - Represent a fixed number of bits
145 /// BitsRecTy - 'bits<n>' - Represent a fixed number of bits
147 class BitsRecTy : public RecTy {
150 BitsRecTy(unsigned Sz) : Size(Sz) {}
152 unsigned getNumBits() const { return Size; }
154 virtual Init *convertValue( UnsetInit *UI);
155 virtual Init *convertValue( BitInit *UI);
156 virtual Init *convertValue( BitsInit *BI);
157 virtual Init *convertValue( IntInit *II);
158 virtual Init *convertValue(StringInit *SI) { return 0; }
159 virtual Init *convertValue( ListInit *LI) { return 0; }
160 virtual Init *convertValue( CodeInit *CI) { return 0; }
161 virtual Init *convertValue(VarBitInit *VB) { return 0; }
162 virtual Init *convertValue( DefInit *DI) { return 0; }
163 virtual Init *convertValue( DagInit *DI) { return 0; }
164 virtual Init *convertValue( TypedInit *TI);
165 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
166 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
169 void print(std::ostream &OS) const { OS << "bits<" << Size << ">"; }
171 bool typeIsConvertibleTo(const RecTy *RHS) const {
172 return RHS->baseClassOf(this);
174 virtual bool baseClassOf(const BitRecTy *RHS) const { return Size == 1; }
175 virtual bool baseClassOf(const BitsRecTy *RHS) const {
176 return RHS->Size == Size;
178 virtual bool baseClassOf(const IntRecTy *RHS) const { return true; }
179 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
180 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
181 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
182 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
183 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
188 /// IntRecTy - 'int' - Represent an integer value of no particular size
190 class IntRecTy : public RecTy {
192 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
193 virtual Init *convertValue( BitInit *BI);
194 virtual Init *convertValue( BitsInit *BI);
195 virtual Init *convertValue( IntInit *II) { return (Init*)II; }
196 virtual Init *convertValue(StringInit *SI) { return 0; }
197 virtual Init *convertValue( ListInit *LI) { return 0; }
198 virtual Init *convertValue( CodeInit *CI) { return 0; }
199 virtual Init *convertValue(VarBitInit *VB) { return 0; }
200 virtual Init *convertValue( DefInit *DI) { return 0; }
201 virtual Init *convertValue( DagInit *DI) { return 0; }
202 virtual Init *convertValue( TypedInit *TI);
203 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
204 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
207 void print(std::ostream &OS) const { OS << "int"; }
209 bool typeIsConvertibleTo(const RecTy *RHS) const {
210 return RHS->baseClassOf(this);
213 virtual bool baseClassOf(const BitRecTy *RHS) const { return true; }
214 virtual bool baseClassOf(const BitsRecTy *RHS) const { return true; }
215 virtual bool baseClassOf(const IntRecTy *RHS) const { return true; }
216 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
217 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
218 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
219 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
220 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
224 /// StringRecTy - 'string' - Represent an string value
226 class StringRecTy : public RecTy {
228 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
229 virtual Init *convertValue( BitInit *BI) { return 0; }
230 virtual Init *convertValue( BitsInit *BI) { return 0; }
231 virtual Init *convertValue( IntInit *II) { return 0; }
232 virtual Init *convertValue(StringInit *SI) { return (Init*)SI; }
233 virtual Init *convertValue( ListInit *LI) { return 0; }
234 virtual Init *convertValue( CodeInit *CI) { return 0; }
235 virtual Init *convertValue(VarBitInit *VB) { return 0; }
236 virtual Init *convertValue( DefInit *DI) { return 0; }
237 virtual Init *convertValue( DagInit *DI) { return 0; }
238 virtual Init *convertValue( TypedInit *TI);
239 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
240 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
242 void print(std::ostream &OS) const { OS << "string"; }
244 bool typeIsConvertibleTo(const RecTy *RHS) const {
245 return RHS->baseClassOf(this);
248 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
249 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
250 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
251 virtual bool baseClassOf(const StringRecTy *RHS) const { return true; }
252 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
253 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
254 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
255 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
258 // ListRecTy - 'list<Ty>' - Represent a list of values, all of which must be of
259 // the specified type.
260 /// ListRecTy - 'list<Ty>' - Represent a list of values, all of which must
261 /// be of the specified type.
263 class ListRecTy : public RecTy {
266 ListRecTy(RecTy *T) : Ty(T) {}
268 RecTy *getElementType() const { return Ty; }
270 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
271 virtual Init *convertValue( BitInit *BI) { return 0; }
272 virtual Init *convertValue( BitsInit *BI) { return 0; }
273 virtual Init *convertValue( IntInit *II) { return 0; }
274 virtual Init *convertValue(StringInit *SI) { return 0; }
275 virtual Init *convertValue( ListInit *LI);
276 virtual Init *convertValue( CodeInit *CI) { return 0; }
277 virtual Init *convertValue(VarBitInit *VB) { return 0; }
278 virtual Init *convertValue( DefInit *DI) { return 0; }
279 virtual Init *convertValue( DagInit *DI) { return 0; }
280 virtual Init *convertValue( TypedInit *TI);
281 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
282 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
284 void print(std::ostream &OS) const;
286 bool typeIsConvertibleTo(const RecTy *RHS) const {
287 return RHS->baseClassOf(this);
290 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
291 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
292 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
293 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
294 virtual bool baseClassOf(const ListRecTy *RHS) const {
295 return RHS->getElementType()->typeIsConvertibleTo(Ty);
297 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
298 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
299 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
302 /// CodeRecTy - 'code' - Represent an code fragment, function or method.
304 class CodeRecTy : public RecTy {
306 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
307 virtual Init *convertValue( BitInit *BI) { return 0; }
308 virtual Init *convertValue( BitsInit *BI) { return 0; }
309 virtual Init *convertValue( IntInit *II) { return 0; }
310 virtual Init *convertValue(StringInit *SI) { return 0; }
311 virtual Init *convertValue( ListInit *LI) { return 0; }
312 virtual Init *convertValue( CodeInit *CI) { return (Init*)CI; }
313 virtual Init *convertValue(VarBitInit *VB) { return 0; }
314 virtual Init *convertValue( DefInit *DI) { return 0; }
315 virtual Init *convertValue( DagInit *DI) { return 0; }
316 virtual Init *convertValue( TypedInit *TI);
317 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
318 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
321 void print(std::ostream &OS) const { OS << "code"; }
323 bool typeIsConvertibleTo(const RecTy *RHS) const {
324 return RHS->baseClassOf(this);
326 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
327 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
328 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
329 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
330 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
331 virtual bool baseClassOf(const CodeRecTy *RHS) const { return true; }
332 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
333 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
336 /// DagRecTy - 'dag' - Represent a dag fragment
338 class DagRecTy : public RecTy {
340 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
341 virtual Init *convertValue( BitInit *BI) { return 0; }
342 virtual Init *convertValue( BitsInit *BI) { return 0; }
343 virtual Init *convertValue( IntInit *II) { return 0; }
344 virtual Init *convertValue(StringInit *SI) { return 0; }
345 virtual Init *convertValue( ListInit *LI) { return 0; }
346 virtual Init *convertValue( CodeInit *CI) { return 0; }
347 virtual Init *convertValue(VarBitInit *VB) { return 0; }
348 virtual Init *convertValue( DefInit *DI) { return 0; }
349 virtual Init *convertValue( DagInit *CI) { return (Init*)CI; }
350 virtual Init *convertValue( TypedInit *TI);
351 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
352 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
354 void print(std::ostream &OS) const { OS << "dag"; }
356 bool typeIsConvertibleTo(const RecTy *RHS) const {
357 return RHS->baseClassOf(this);
360 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
361 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
362 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
363 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
364 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
365 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
366 virtual bool baseClassOf(const DagRecTy *RHS) const { return true; }
367 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
371 /// RecordRecTy - '[classname]' - Represent an instance of a class, such as:
374 class RecordRecTy : public RecTy {
377 RecordRecTy(Record *R) : Rec(R) {}
379 Record *getRecord() const { return Rec; }
381 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
382 virtual Init *convertValue( BitInit *BI) { return 0; }
383 virtual Init *convertValue( BitsInit *BI) { return 0; }
384 virtual Init *convertValue( IntInit *II) { return 0; }
385 virtual Init *convertValue(StringInit *SI) { return 0; }
386 virtual Init *convertValue( ListInit *LI) { return 0; }
387 virtual Init *convertValue( CodeInit *CI) { return 0; }
388 virtual Init *convertValue(VarBitInit *VB) { return 0; }
389 virtual Init *convertValue( DefInit *DI);
390 virtual Init *convertValue( DagInit *DI) { return 0; }
391 virtual Init *convertValue( TypedInit *VI);
392 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
393 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
395 void print(std::ostream &OS) const;
397 bool typeIsConvertibleTo(const RecTy *RHS) const {
398 return RHS->baseClassOf(this);
400 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
401 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
402 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
403 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
404 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
405 virtual bool baseClassOf(const CodeRecTy *RHS) const { return false; }
406 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
407 virtual bool baseClassOf(const RecordRecTy *RHS) const;
412 //===----------------------------------------------------------------------===//
413 // Initializer Classes
414 //===----------------------------------------------------------------------===//
419 /// isComplete - This virtual method should be overridden by values that may
420 /// not be completely specified yet.
421 virtual bool isComplete() const { return true; }
423 /// print - Print out this value.
424 virtual void print(std::ostream &OS) const = 0;
426 /// dump - Debugging method that may be called through a debugger, just
427 /// invokes print on cerr.
430 /// convertInitializerTo - This virtual function is a simple call-back
431 /// function that should be overridden to call the appropriate
432 /// RecTy::convertValue method.
434 virtual Init *convertInitializerTo(RecTy *Ty) = 0;
436 /// convertInitializerBitRange - This method is used to implement the bitrange
437 /// selection operator. Given an initializer, it selects the specified bits
438 /// out, returning them as a new init of bits type. If it is not legal to use
439 /// the bit subscript operator on this initializer, return null.
441 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits) {
445 /// convertInitListSlice - This method is used to implement the list slice
446 /// selection operator. Given an initializer, it selects the specified list
447 /// elements, returning them as a new init of list type. If it is not legal
448 /// to take a slice of this, return null.
450 virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements) {
454 /// getFieldType - This method is used to implement the FieldInit class.
455 /// Implementors of this method should return the type of the named field if
456 /// they are of record type.
458 virtual RecTy *getFieldType(const std::string &FieldName) const { return 0; }
460 /// getFieldInit - This method complements getFieldType to return the
461 /// initializer for the specified field. If getFieldType returns non-null
462 /// this method should return non-null, otherwise it returns null.
464 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const {
468 enum BinaryOp { SHL, SRA, SRL };
469 virtual Init *getBinaryOp(BinaryOp Op, Init *RHS) {
473 /// resolveReferences - This method is used by classes that refer to other
474 /// variables which may not be defined at the time they expression is formed.
475 /// If a value is set for the variable later, this method will be called on
476 /// users of the value to allow the value to propagate out.
478 virtual Init *resolveReferences(Record &R, const RecordVal *RV) {
483 inline std::ostream &operator<<(std::ostream &OS, const Init &I) {
484 I.print(OS); return OS;
488 /// UnsetInit - ? - Represents an uninitialized value
490 class UnsetInit : public Init {
492 virtual Init *convertInitializerTo(RecTy *Ty) {
493 return Ty->convertValue(this);
496 virtual bool isComplete() const { return false; }
497 virtual void print(std::ostream &OS) const { OS << "?"; }
501 /// BitInit - true/false - Represent a concrete initializer for a bit.
503 class BitInit : public Init {
506 BitInit(bool V) : Value(V) {}
508 bool getValue() const { return Value; }
510 virtual Init *convertInitializerTo(RecTy *Ty) {
511 return Ty->convertValue(this);
514 virtual void print(std::ostream &OS) const { OS << (Value ? "1" : "0"); }
517 /// BitsInit - { a, b, c } - Represents an initializer for a BitsRecTy value.
518 /// It contains a vector of bits, whose size is determined by the type.
520 class BitsInit : public Init {
521 std::vector<Init*> Bits;
523 BitsInit(unsigned Size) : Bits(Size) {}
525 unsigned getNumBits() const { return Bits.size(); }
527 Init *getBit(unsigned Bit) const {
528 assert(Bit < Bits.size() && "Bit index out of range!");
531 void setBit(unsigned Bit, Init *V) {
532 assert(Bit < Bits.size() && "Bit index out of range!");
533 assert(Bits[Bit] == 0 && "Bit already set!");
537 virtual Init *convertInitializerTo(RecTy *Ty) {
538 return Ty->convertValue(this);
540 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
542 virtual bool isComplete() const {
543 for (unsigned i = 0; i != getNumBits(); ++i)
544 if (!getBit(i)->isComplete()) return false;
547 virtual void print(std::ostream &OS) const;
549 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
551 // printXX - Print this bitstream with the specified format, returning true if
552 // it is not possible.
553 bool printInHex(std::ostream &OS) const;
554 bool printAsVariable(std::ostream &OS) const;
555 bool printAsUnset(std::ostream &OS) const;
559 /// IntInit - 7 - Represent an initalization by a literal integer value.
561 class IntInit : public Init {
564 IntInit(int V) : Value(V) {}
566 int getValue() const { return Value; }
568 virtual Init *convertInitializerTo(RecTy *Ty) {
569 return Ty->convertValue(this);
571 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
573 virtual Init *getBinaryOp(BinaryOp Op, Init *RHS);
575 virtual void print(std::ostream &OS) const { OS << Value; }
579 /// StringInit - "foo" - Represent an initialization by a string value.
581 class StringInit : public Init {
584 StringInit(const std::string &V) : Value(V) {}
586 const std::string &getValue() const { return Value; }
588 virtual Init *convertInitializerTo(RecTy *Ty) {
589 return Ty->convertValue(this);
592 virtual void print(std::ostream &OS) const { OS << "\"" << Value << "\""; }
595 /// CodeInit - "[{...}]" - Represent a code fragment.
597 class CodeInit : public Init {
600 CodeInit(const std::string &V) : Value(V) {}
602 const std::string getValue() const { return Value; }
604 virtual Init *convertInitializerTo(RecTy *Ty) {
605 return Ty->convertValue(this);
608 virtual void print(std::ostream &OS) const { OS << "[{" << Value << "}]"; }
611 /// ListInit - [AL, AH, CL] - Represent a list of defs
613 class ListInit : public Init {
614 std::vector<Init*> Values;
616 ListInit(std::vector<Init*> &Vs) {
620 unsigned getSize() const { return Values.size(); }
621 Init *getElement(unsigned i) const {
622 assert(i < Values.size() && "List element index out of range!");
626 Init *convertInitListSlice(const std::vector<unsigned> &Elements);
628 virtual Init *convertInitializerTo(RecTy *Ty) {
629 return Ty->convertValue(this);
632 /// resolveReferences - This method is used by classes that refer to other
633 /// variables which may not be defined at the time they expression is formed.
634 /// If a value is set for the variable later, this method will be called on
635 /// users of the value to allow the value to propagate out.
637 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
639 virtual void print(std::ostream &OS) const;
643 /// TypedInit - This is the common super-class of types that have a specific,
646 class TypedInit : public Init {
649 TypedInit(RecTy *T) : Ty(T) {}
651 RecTy *getType() const { return Ty; }
653 virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
654 virtual Init *convertInitListSlice(const std::vector<unsigned> &Elements);
656 /// resolveBitReference - This method is used to implement
657 /// VarBitInit::resolveReferences. If the bit is able to be resolved, we
658 /// simply return the resolved value, otherwise we return null.
660 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
663 /// resolveListElementReference - This method is used to implement
664 /// VarListElementInit::resolveReferences. If the list element is resolvable
665 /// now, we return the resolved value, otherwise we return null.
666 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
670 /// VarInit - 'Opcode' - Represent a reference to an entire variable object.
672 class VarInit : public TypedInit {
675 VarInit(const std::string &VN, RecTy *T) : TypedInit(T), VarName(VN) {}
677 virtual Init *convertInitializerTo(RecTy *Ty) {
678 return Ty->convertValue(this);
681 const std::string &getName() const { return VarName; }
683 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
685 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
688 virtual RecTy *getFieldType(const std::string &FieldName) const;
689 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
691 /// resolveReferences - This method is used by classes that refer to other
692 /// variables which may not be defined at the time they expression is formed.
693 /// If a value is set for the variable later, this method will be called on
694 /// users of the value to allow the value to propagate out.
696 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
698 virtual void print(std::ostream &OS) const { OS << VarName; }
702 /// VarBitInit - Opcode{0} - Represent access to one bit of a variable or field.
704 class VarBitInit : public Init {
708 VarBitInit(TypedInit *T, unsigned B) : TI(T), Bit(B) {
709 assert(T->getType() && dynamic_cast<BitsRecTy*>(T->getType()) &&
710 ((BitsRecTy*)T->getType())->getNumBits() > B &&
711 "Illegal VarBitInit expression!");
714 virtual Init *convertInitializerTo(RecTy *Ty) {
715 return Ty->convertValue(this);
718 TypedInit *getVariable() const { return TI; }
719 unsigned getBitNum() const { return Bit; }
721 virtual void print(std::ostream &OS) const {
722 TI->print(OS); OS << "{" << Bit << "}";
724 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
727 /// VarListElementInit - List[4] - Represent access to one element of a var or
729 class VarListElementInit : public TypedInit {
733 VarListElementInit(TypedInit *T, unsigned E)
734 : TypedInit(dynamic_cast<ListRecTy*>(T->getType())->getElementType()),
736 assert(T->getType() && dynamic_cast<ListRecTy*>(T->getType()) &&
737 "Illegal VarBitInit expression!");
740 virtual Init *convertInitializerTo(RecTy *Ty) {
741 return Ty->convertValue(this);
744 TypedInit *getVariable() const { return TI; }
745 unsigned getElementNum() const { return Element; }
747 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
750 /// resolveListElementReference - This method is used to implement
751 /// VarListElementInit::resolveReferences. If the list element is resolvable
752 /// now, we return the resolved value, otherwise we return null.
753 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
756 virtual void print(std::ostream &OS) const {
757 TI->print(OS); OS << "[" << Element << "]";
759 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
762 /// DefInit - AL - Represent a reference to a 'def' in the description
764 class DefInit : public Init {
767 DefInit(Record *D) : Def(D) {}
769 virtual Init *convertInitializerTo(RecTy *Ty) {
770 return Ty->convertValue(this);
773 Record *getDef() const { return Def; }
775 //virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
777 virtual RecTy *getFieldType(const std::string &FieldName) const;
778 virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
780 virtual void print(std::ostream &OS) const;
784 /// FieldInit - X.Y - Represent a reference to a subfield of a variable
786 class FieldInit : public TypedInit {
787 Init *Rec; // Record we are referring to
788 std::string FieldName; // Field we are accessing
790 FieldInit(Init *R, const std::string &FN)
791 : TypedInit(R->getFieldType(FN)), Rec(R), FieldName(FN) {
792 assert(getType() && "FieldInit with non-record type!");
795 virtual Init *convertInitializerTo(RecTy *Ty) {
796 return Ty->convertValue(this);
799 virtual Init *resolveBitReference(Record &R, const RecordVal *RV,
801 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
804 virtual Init *resolveReferences(Record &R, const RecordVal *RV);
806 virtual void print(std::ostream &OS) const {
807 Rec->print(OS); OS << "." << FieldName;
811 /// DagInit - (def a, b) - Represent a DAG tree value. DAG inits are required
812 /// to have Records for their first value, after that, any legal Init is
815 class DagInit : public Init {
817 std::vector<Init*> Args;
818 std::vector<std::string> ArgNames;
820 DagInit(Record *D, const std::vector<std::pair<Init*, std::string> > &args)
822 Args.reserve(args.size());
823 ArgNames.reserve(args.size());
824 for (unsigned i = 0, e = args.size(); i != e; ++i) {
825 Args.push_back(args[i].first);
826 ArgNames.push_back(args[i].second);
830 virtual Init *convertInitializerTo(RecTy *Ty) {
831 return Ty->convertValue(this);
834 Record *getNodeType() const { return NodeTypeDef; }
836 unsigned getNumArgs() const { return Args.size(); }
837 Init *getArg(unsigned Num) const {
838 assert(Num < Args.size() && "Arg number out of range!");
841 const std::string &getArgName(unsigned Num) const {
842 assert(Num < ArgNames.size() && "Arg number out of range!");
843 return ArgNames[Num];
846 void setArg(unsigned Num, Init *I) {
847 assert(Num < Args.size() && "Arg number out of range!");
851 virtual void print(std::ostream &OS) const;
854 //===----------------------------------------------------------------------===//
855 // High-Level Classes
856 //===----------------------------------------------------------------------===//
864 RecordVal(const std::string &N, RecTy *T, unsigned P);
866 const std::string &getName() const { return Name; }
868 unsigned getPrefix() const { return Prefix; }
869 RecTy *getType() const { return Ty; }
870 Init *getValue() const { return Value; }
872 bool setValue(Init *V) {
874 Value = V->convertInitializerTo(Ty);
882 void print(std::ostream &OS, bool PrintSem = true) const;
885 inline std::ostream &operator<<(std::ostream &OS, const RecordVal &RV) {
892 std::vector<std::string> TemplateArgs;
893 std::vector<RecordVal> Values;
894 std::vector<Record*> SuperClasses;
897 Record(const std::string &N) : Name(N) {}
900 const std::string &getName() const { return Name; }
901 void setName(const std::string &Name); // Also updates RecordKeeper.
902 const std::vector<std::string> &getTemplateArgs() const {
905 const std::vector<RecordVal> &getValues() const { return Values; }
906 const std::vector<Record*> &getSuperClasses() const { return SuperClasses; }
908 bool isTemplateArg(const std::string &Name) const {
909 for (unsigned i = 0, e = TemplateArgs.size(); i != e; ++i)
910 if (TemplateArgs[i] == Name) return true;
914 const RecordVal *getValue(const std::string &Name) const {
915 for (unsigned i = 0, e = Values.size(); i != e; ++i)
916 if (Values[i].getName() == Name) return &Values[i];
919 RecordVal *getValue(const std::string &Name) {
920 for (unsigned i = 0, e = Values.size(); i != e; ++i)
921 if (Values[i].getName() == Name) return &Values[i];
925 void addTemplateArg(const std::string &Name) {
926 assert(!isTemplateArg(Name) && "Template arg already defined!");
927 TemplateArgs.push_back(Name);
930 void addValue(const RecordVal &RV) {
931 assert(getValue(RV.getName()) == 0 && "Value already added!");
932 Values.push_back(RV);
935 void removeValue(const std::string &Name) {
936 assert(getValue(Name) && "Cannot remove an entry that does not exist!");
937 for (unsigned i = 0, e = Values.size(); i != e; ++i)
938 if (Values[i].getName() == Name) {
939 Values.erase(Values.begin()+i);
942 assert(0 && "Name does not exist in record!");
945 bool isSubClassOf(Record *R) const {
946 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
947 if (SuperClasses[i] == R)
952 bool isSubClassOf(const std::string &Name) const {
953 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
954 if (SuperClasses[i]->getName() == Name)
959 void addSuperClass(Record *R) {
960 assert(!isSubClassOf(R) && "Already subclassing record!");
961 SuperClasses.push_back(R);
964 /// resolveReferences - If there are any field references that refer to fields
965 /// that have been filled in, we can propagate the values now.
967 void resolveReferences() { resolveReferencesTo(0); }
969 /// resolveReferencesTo - If anything in this record refers to RV, replace the
970 /// reference to RV with the RHS of RV. If RV is null, we resolve all
971 /// possible references.
972 void resolveReferencesTo(const RecordVal *RV);
976 //===--------------------------------------------------------------------===//
977 // High-level methods useful to tablegen back-ends
980 /// getValueInit - Return the initializer for a value with the specified name,
981 /// or throw an exception if the field does not exist.
983 Init *getValueInit(const std::string &FieldName) const;
985 /// getValueAsString - This method looks up the specified field and returns
986 /// its value as a string, throwing an exception if the field does not exist
987 /// or if the value is not a string.
989 std::string getValueAsString(const std::string &FieldName) const;
991 /// getValueAsBitsInit - This method looks up the specified field and returns
992 /// its value as a BitsInit, throwing an exception if the field does not exist
993 /// or if the value is not the right type.
995 BitsInit *getValueAsBitsInit(const std::string &FieldName) const;
997 /// getValueAsListInit - This method looks up the specified field and returns
998 /// its value as a ListInit, throwing an exception if the field does not exist
999 /// or if the value is not the right type.
1001 ListInit *getValueAsListInit(const std::string &FieldName) const;
1003 /// getValueAsListOfDefs - This method looks up the specified field and
1004 /// returnsits value as a vector of records, throwing an exception if the
1005 /// field does not exist or if the value is not the right type.
1007 std::vector<Record*> getValueAsListOfDefs(const std::string &FieldName) const;
1009 /// getValueAsDef - This method looks up the specified field and returns its
1010 /// value as a Record, throwing an exception if the field does not exist or if
1011 /// the value is not the right type.
1013 Record *getValueAsDef(const std::string &FieldName) const;
1015 /// getValueAsBit - This method looks up the specified field and returns its
1016 /// value as a bit, throwing an exception if the field does not exist or if
1017 /// the value is not the right type.
1019 bool getValueAsBit(const std::string &FieldName) const;
1021 /// getValueAsInt - This method looks up the specified field and returns its
1022 /// value as an int, throwing an exception if the field does not exist or if
1023 /// the value is not the right type.
1025 int getValueAsInt(const std::string &FieldName) const;
1027 /// getValueAsDag - This method looks up the specified field and returns its
1028 /// value as an Dag, throwing an exception if the field does not exist or if
1029 /// the value is not the right type.
1031 DagInit *getValueAsDag(const std::string &FieldName) const;
1033 /// getValueAsCode - This method looks up the specified field and returns
1034 /// its value as the string data in a CodeInit, throwing an exception if the
1035 /// field does not exist or if the value is not a code object.
1037 std::string getValueAsCode(const std::string &FieldName) const;
1040 std::ostream &operator<<(std::ostream &OS, const Record &R);
1042 class RecordKeeper {
1043 std::map<std::string, Record*> Classes, Defs;
1046 for (std::map<std::string, Record*>::iterator I = Classes.begin(),
1047 E = Classes.end(); I != E; ++I)
1049 for (std::map<std::string, Record*>::iterator I = Defs.begin(),
1050 E = Defs.end(); I != E; ++I)
1054 const std::map<std::string, Record*> &getClasses() const { return Classes; }
1055 const std::map<std::string, Record*> &getDefs() const { return Defs; }
1057 Record *getClass(const std::string &Name) const {
1058 std::map<std::string, Record*>::const_iterator I = Classes.find(Name);
1059 return I == Classes.end() ? 0 : I->second;
1061 Record *getDef(const std::string &Name) const {
1062 std::map<std::string, Record*>::const_iterator I = Defs.find(Name);
1063 return I == Defs.end() ? 0 : I->second;
1065 void addClass(Record *R) {
1066 assert(getClass(R->getName()) == 0 && "Class already exists!");
1067 Classes.insert(std::make_pair(R->getName(), R));
1069 void addDef(Record *R) {
1070 assert(getDef(R->getName()) == 0 && "Def already exists!");
1071 Defs.insert(std::make_pair(R->getName(), R));
1074 /// removeClass - Remove, but do not delete, the specified record.
1076 void removeClass(const std::string &Name) {
1077 assert(Classes.count(Name) && "Class does not exist!");
1078 Classes.erase(Name);
1080 /// removeDef - Remove, but do not delete, the specified record.
1082 void removeDef(const std::string &Name) {
1083 assert(Defs.count(Name) && "Def does not exist!");
1087 //===--------------------------------------------------------------------===//
1088 // High-level helper methods, useful for tablegen backends...
1090 /// getAllDerivedDefinitions - This method returns all concrete definitions
1091 /// that derive from the specified class name. If a class with the specified
1092 /// name does not exist, an exception is thrown.
1093 std::vector<Record*>
1094 getAllDerivedDefinitions(const std::string &ClassName) const;
1100 std::ostream &operator<<(std::ostream &OS, const RecordKeeper &RK);
1102 extern RecordKeeper Records;
1104 } // End llvm namespace