1 //===- llvm/TableGen/Record.h - Classes for Table Records -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the main TableGen data structures, including the TableGen
11 // types, values, and high-level data structures.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_TABLEGEN_RECORD_H
16 #define LLVM_TABLEGEN_RECORD_H
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/ADT/FoldingSet.h"
20 #include "llvm/Support/Allocator.h"
21 #include "llvm/Support/SourceMgr.h"
22 #include "llvm/Support/DataTypes.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/raw_ostream.h"
56 class VarListElementInit;
64 //===----------------------------------------------------------------------===//
66 //===----------------------------------------------------------------------===//
70 virtual void anchor();
72 RecTy() : ListTy(0) {}
75 virtual std::string getAsString() const = 0;
76 void print(raw_ostream &OS) const { OS << getAsString(); }
79 /// typeIsConvertibleTo - Return true if all values of 'this' type can be
80 /// converted to the specified type.
81 virtual bool typeIsConvertibleTo(const RecTy *RHS) const = 0;
83 /// getListTy - Returns the type representing list<this>.
84 ListRecTy *getListTy();
86 public: // These methods should only be called from subclasses of Init
87 virtual Init *convertValue( UnsetInit *UI) { return 0; }
88 virtual Init *convertValue( BitInit *BI) { return 0; }
89 virtual Init *convertValue( BitsInit *BI) { return 0; }
90 virtual Init *convertValue( IntInit *II) { return 0; }
91 virtual Init *convertValue(StringInit *SI) { return 0; }
92 virtual Init *convertValue( ListInit *LI) { return 0; }
93 virtual Init *convertValue( UnOpInit *UI) {
94 return convertValue((TypedInit*)UI);
96 virtual Init *convertValue( BinOpInit *UI) {
97 return convertValue((TypedInit*)UI);
99 virtual Init *convertValue( TernOpInit *UI) {
100 return convertValue((TypedInit*)UI);
102 virtual Init *convertValue(VarBitInit *VB) { return 0; }
103 virtual Init *convertValue( DefInit *DI) { return 0; }
104 virtual Init *convertValue( DagInit *DI) { return 0; }
105 virtual Init *convertValue( TypedInit *TI) { return 0; }
106 virtual Init *convertValue( VarInit *VI) {
107 return convertValue((TypedInit*)VI);
109 virtual Init *convertValue( FieldInit *FI) {
110 return convertValue((TypedInit*)FI);
113 public: // These methods should only be called by subclasses of RecTy.
114 // baseClassOf - These virtual methods should be overloaded to return true iff
115 // all values of type 'RHS' can be converted to the 'this' type.
116 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
117 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
118 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
119 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
120 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
121 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
122 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
125 inline raw_ostream &operator<<(raw_ostream &OS, const RecTy &Ty) {
131 /// BitRecTy - 'bit' - Represent a single bit
133 class BitRecTy : public RecTy {
134 static BitRecTy Shared;
137 static BitRecTy *get() { return &Shared; }
139 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
140 virtual Init *convertValue( BitInit *BI) { return (Init*)BI; }
141 virtual Init *convertValue( BitsInit *BI);
142 virtual Init *convertValue( IntInit *II);
143 virtual Init *convertValue(StringInit *SI) { return 0; }
144 virtual Init *convertValue( ListInit *LI) { return 0; }
145 virtual Init *convertValue(VarBitInit *VB) { return (Init*)VB; }
146 virtual Init *convertValue( DefInit *DI) { return 0; }
147 virtual Init *convertValue( DagInit *DI) { return 0; }
148 virtual Init *convertValue( UnOpInit *UI) { return RecTy::convertValue(UI);}
149 virtual Init *convertValue( BinOpInit *UI) { return RecTy::convertValue(UI);}
150 virtual Init *convertValue( TernOpInit *UI) { return RecTy::convertValue(UI);}
151 virtual Init *convertValue( TypedInit *TI);
152 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
153 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
155 std::string getAsString() const { return "bit"; }
157 bool typeIsConvertibleTo(const RecTy *RHS) const {
158 return RHS->baseClassOf(this);
160 virtual bool baseClassOf(const BitRecTy *RHS) const { return true; }
161 virtual bool baseClassOf(const BitsRecTy *RHS) const;
162 virtual bool baseClassOf(const IntRecTy *RHS) const { return true; }
163 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
164 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
165 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
166 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
171 // BitsRecTy - 'bits<n>' - Represent a fixed number of bits
172 /// BitsRecTy - 'bits<n>' - Represent a fixed number of bits
174 class BitsRecTy : public RecTy {
176 explicit BitsRecTy(unsigned Sz) : Size(Sz) {}
178 static BitsRecTy *get(unsigned Sz);
180 unsigned getNumBits() const { return Size; }
182 virtual Init *convertValue( UnsetInit *UI);
183 virtual Init *convertValue( BitInit *UI);
184 virtual Init *convertValue( BitsInit *BI);
185 virtual Init *convertValue( IntInit *II);
186 virtual Init *convertValue(StringInit *SI) { return 0; }
187 virtual Init *convertValue( ListInit *LI) { return 0; }
188 virtual Init *convertValue(VarBitInit *VB) { return 0; }
189 virtual Init *convertValue( DefInit *DI) { return 0; }
190 virtual Init *convertValue( DagInit *DI) { return 0; }
191 virtual Init *convertValue( UnOpInit *UI) { return RecTy::convertValue(UI);}
192 virtual Init *convertValue( BinOpInit *UI) { return RecTy::convertValue(UI);}
193 virtual Init *convertValue( TernOpInit *UI) { return RecTy::convertValue(UI);}
194 virtual Init *convertValue( TypedInit *TI);
195 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
196 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
198 std::string getAsString() const;
200 bool typeIsConvertibleTo(const RecTy *RHS) const {
201 return RHS->baseClassOf(this);
203 virtual bool baseClassOf(const BitRecTy *RHS) const { return Size == 1; }
204 virtual bool baseClassOf(const BitsRecTy *RHS) const {
205 return RHS->Size == Size;
207 virtual bool baseClassOf(const IntRecTy *RHS) const { return true; }
208 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
209 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
210 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
211 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
216 /// IntRecTy - 'int' - Represent an integer value of no particular size
218 class IntRecTy : public RecTy {
219 static IntRecTy Shared;
222 static IntRecTy *get() { return &Shared; }
224 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
225 virtual Init *convertValue( BitInit *BI);
226 virtual Init *convertValue( BitsInit *BI);
227 virtual Init *convertValue( IntInit *II) { return (Init*)II; }
228 virtual Init *convertValue(StringInit *SI) { return 0; }
229 virtual Init *convertValue( ListInit *LI) { return 0; }
230 virtual Init *convertValue(VarBitInit *VB) { return 0; }
231 virtual Init *convertValue( DefInit *DI) { return 0; }
232 virtual Init *convertValue( DagInit *DI) { return 0; }
233 virtual Init *convertValue( UnOpInit *UI) { return RecTy::convertValue(UI);}
234 virtual Init *convertValue( BinOpInit *UI) { return RecTy::convertValue(UI);}
235 virtual Init *convertValue( TernOpInit *UI) { return RecTy::convertValue(UI);}
236 virtual Init *convertValue( TypedInit *TI);
237 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
238 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
240 std::string getAsString() const { return "int"; }
242 bool typeIsConvertibleTo(const RecTy *RHS) const {
243 return RHS->baseClassOf(this);
246 virtual bool baseClassOf(const BitRecTy *RHS) const { return true; }
247 virtual bool baseClassOf(const BitsRecTy *RHS) const { return true; }
248 virtual bool baseClassOf(const IntRecTy *RHS) const { return true; }
249 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
250 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
251 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
252 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
256 /// StringRecTy - 'string' - Represent an string value
258 class StringRecTy : public RecTy {
259 static StringRecTy Shared;
262 static StringRecTy *get() { return &Shared; }
264 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
265 virtual Init *convertValue( BitInit *BI) { return 0; }
266 virtual Init *convertValue( BitsInit *BI) { return 0; }
267 virtual Init *convertValue( IntInit *II) { return 0; }
268 virtual Init *convertValue(StringInit *SI) { return (Init*)SI; }
269 virtual Init *convertValue( ListInit *LI) { return 0; }
270 virtual Init *convertValue( UnOpInit *BO);
271 virtual Init *convertValue( BinOpInit *BO);
272 virtual Init *convertValue( TernOpInit *BO) { return RecTy::convertValue(BO);}
274 virtual Init *convertValue(VarBitInit *VB) { return 0; }
275 virtual Init *convertValue( DefInit *DI) { return 0; }
276 virtual Init *convertValue( DagInit *DI) { return 0; }
277 virtual Init *convertValue( TypedInit *TI);
278 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
279 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
281 std::string getAsString() const { return "string"; }
283 bool typeIsConvertibleTo(const RecTy *RHS) const {
284 return RHS->baseClassOf(this);
287 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
288 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
289 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
290 virtual bool baseClassOf(const StringRecTy *RHS) const { return true; }
291 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
292 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
293 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
296 // ListRecTy - 'list<Ty>' - Represent a list of values, all of which must be of
297 // the specified type.
298 /// ListRecTy - 'list<Ty>' - Represent a list of values, all of which must
299 /// be of the specified type.
301 class ListRecTy : public RecTy {
303 explicit ListRecTy(RecTy *T) : Ty(T) {}
304 friend ListRecTy *RecTy::getListTy();
306 static ListRecTy *get(RecTy *T) { return T->getListTy(); }
307 RecTy *getElementType() const { return Ty; }
309 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
310 virtual Init *convertValue( BitInit *BI) { return 0; }
311 virtual Init *convertValue( BitsInit *BI) { return 0; }
312 virtual Init *convertValue( IntInit *II) { return 0; }
313 virtual Init *convertValue(StringInit *SI) { return 0; }
314 virtual Init *convertValue( ListInit *LI);
315 virtual Init *convertValue(VarBitInit *VB) { return 0; }
316 virtual Init *convertValue( DefInit *DI) { return 0; }
317 virtual Init *convertValue( DagInit *DI) { return 0; }
318 virtual Init *convertValue( UnOpInit *UI) { return RecTy::convertValue(UI);}
319 virtual Init *convertValue( BinOpInit *UI) { return RecTy::convertValue(UI);}
320 virtual Init *convertValue( TernOpInit *UI) { return RecTy::convertValue(UI);}
321 virtual Init *convertValue( TypedInit *TI);
322 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
323 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
325 std::string getAsString() const;
327 bool typeIsConvertibleTo(const RecTy *RHS) const {
328 return RHS->baseClassOf(this);
331 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
332 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
333 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
334 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
335 virtual bool baseClassOf(const ListRecTy *RHS) const {
336 return RHS->getElementType()->typeIsConvertibleTo(Ty);
338 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
339 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
342 /// DagRecTy - 'dag' - Represent a dag fragment
344 class DagRecTy : public RecTy {
345 static DagRecTy Shared;
348 static DagRecTy *get() { return &Shared; }
350 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
351 virtual Init *convertValue( BitInit *BI) { return 0; }
352 virtual Init *convertValue( BitsInit *BI) { return 0; }
353 virtual Init *convertValue( IntInit *II) { return 0; }
354 virtual Init *convertValue(StringInit *SI) { return 0; }
355 virtual Init *convertValue( ListInit *LI) { return 0; }
356 virtual Init *convertValue(VarBitInit *VB) { return 0; }
357 virtual Init *convertValue( DefInit *DI) { return 0; }
358 virtual Init *convertValue( UnOpInit *BO);
359 virtual Init *convertValue( BinOpInit *BO);
360 virtual Init *convertValue( TernOpInit *BO) { return RecTy::convertValue(BO);}
361 virtual Init *convertValue( DagInit *CI) { return (Init*)CI; }
362 virtual Init *convertValue( TypedInit *TI);
363 virtual Init *convertValue( VarInit *VI) { return RecTy::convertValue(VI);}
364 virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
366 std::string getAsString() const { return "dag"; }
368 bool typeIsConvertibleTo(const RecTy *RHS) const {
369 return RHS->baseClassOf(this);
372 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
373 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
374 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
375 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
376 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
377 virtual bool baseClassOf(const DagRecTy *RHS) const { return true; }
378 virtual bool baseClassOf(const RecordRecTy *RHS) const { return false; }
382 /// RecordRecTy - '[classname]' - Represent an instance of a class, such as:
385 class RecordRecTy : public RecTy {
387 explicit RecordRecTy(Record *R) : Rec(R) {}
390 static RecordRecTy *get(Record *R);
392 Record *getRecord() const { return Rec; }
394 virtual Init *convertValue( UnsetInit *UI) { return (Init*)UI; }
395 virtual Init *convertValue( BitInit *BI) { return 0; }
396 virtual Init *convertValue( BitsInit *BI) { return 0; }
397 virtual Init *convertValue( IntInit *II) { return 0; }
398 virtual Init *convertValue(StringInit *SI) { return 0; }
399 virtual Init *convertValue( ListInit *LI) { return 0; }
400 virtual Init *convertValue(VarBitInit *VB) { return 0; }
401 virtual Init *convertValue( UnOpInit *UI) { return RecTy::convertValue(UI);}
402 virtual Init *convertValue( BinOpInit *UI) { return RecTy::convertValue(UI);}
403 virtual Init *convertValue( TernOpInit *UI) { return RecTy::convertValue(UI);}
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;
412 bool typeIsConvertibleTo(const RecTy *RHS) const {
413 return RHS->baseClassOf(this);
415 virtual bool baseClassOf(const BitRecTy *RHS) const { return false; }
416 virtual bool baseClassOf(const BitsRecTy *RHS) const { return false; }
417 virtual bool baseClassOf(const IntRecTy *RHS) const { return false; }
418 virtual bool baseClassOf(const StringRecTy *RHS) const { return false; }
419 virtual bool baseClassOf(const ListRecTy *RHS) const { return false; }
420 virtual bool baseClassOf(const DagRecTy *RHS) const { return false; }
421 virtual bool baseClassOf(const RecordRecTy *RHS) const;
424 /// resolveTypes - Find a common type that T1 and T2 convert to.
425 /// Return 0 if no such type exists.
427 RecTy *resolveTypes(RecTy *T1, RecTy *T2);
429 //===----------------------------------------------------------------------===//
430 // Initializer Classes
431 //===----------------------------------------------------------------------===//
434 Init(const Init &); // Do not define.
435 Init &operator=(const Init &); // Do not define.
436 virtual void anchor();
444 /// isComplete - This virtual method should be overridden by values that may
445 /// not be completely specified yet.
446 virtual bool isComplete() const { return true; }
448 /// print - Print out this value.
449 void print(raw_ostream &OS) const { OS << getAsString(); }
451 /// getAsString - Convert this value to a string form.
452 virtual std::string getAsString() const = 0;
453 /// getAsUnquotedString - Convert this value to a string form,
454 /// without adding quote markers. This primaruly affects
455 /// StringInits where we will not surround the string value with
457 virtual std::string getAsUnquotedString() const { return getAsString(); }
459 /// dump - Debugging method that may be called through a debugger, just
460 /// invokes print on stderr.
463 /// convertInitializerTo - This virtual function is a simple call-back
464 /// function that should be overridden to call the appropriate
465 /// RecTy::convertValue method.
467 virtual Init *convertInitializerTo(RecTy *Ty) const = 0;
469 /// convertInitializerBitRange - This method is used to implement the bitrange
470 /// selection operator. Given an initializer, it selects the specified bits
471 /// out, returning them as a new init of bits type. If it is not legal to use
472 /// the bit subscript operator on this initializer, return null.
475 convertInitializerBitRange(const std::vector<unsigned> &Bits) const {
479 /// convertInitListSlice - This method is used to implement the list slice
480 /// selection operator. Given an initializer, it selects the specified list
481 /// elements, returning them as a new init of list type. If it is not legal
482 /// to take a slice of this, return null.
485 convertInitListSlice(const std::vector<unsigned> &Elements) const {
489 /// getFieldType - This method is used to implement the FieldInit class.
490 /// Implementors of this method should return the type of the named field if
491 /// they are of record type.
493 virtual RecTy *getFieldType(const std::string &FieldName) const { return 0; }
495 /// getFieldInit - This method complements getFieldType to return the
496 /// initializer for the specified field. If getFieldType returns non-null
497 /// this method should return non-null, otherwise it returns null.
499 virtual Init *getFieldInit(Record &R, const RecordVal *RV,
500 const std::string &FieldName) const {
504 /// resolveReferences - This method is used by classes that refer to other
505 /// variables which may not be defined at the time the expression is formed.
506 /// If a value is set for the variable later, this method will be called on
507 /// users of the value to allow the value to propagate out.
509 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const {
510 return const_cast<Init *>(this);
513 /// getBit - This method is used to return the initializer for the specified
515 virtual Init *getBit(unsigned Bit) const = 0;
517 /// getBitVar - This method is used to retrieve the initializer for bit
518 /// reference. For non-VarBitInit, it simply returns itself.
519 virtual Init *getBitVar() const { return const_cast<Init*>(this); }
521 /// getBitNum - This method is used to retrieve the bit number of a bit
522 /// reference. For non-VarBitInit, it simply returns 0.
523 virtual unsigned getBitNum() const { return 0; }
526 inline raw_ostream &operator<<(raw_ostream &OS, const Init &I) {
527 I.print(OS); return OS;
530 /// TypedInit - This is the common super-class of types that have a specific,
533 class TypedInit : public Init {
536 TypedInit(const TypedInit &Other); // Do not define.
537 TypedInit &operator=(const TypedInit &Other); // Do not define.
540 explicit TypedInit(RecTy *T) : Ty(T) {}
543 RecTy *getType() const { return Ty; }
546 convertInitializerBitRange(const std::vector<unsigned> &Bits) const;
548 convertInitListSlice(const std::vector<unsigned> &Elements) const;
550 /// getFieldType - This method is used to implement the FieldInit class.
551 /// Implementors of this method should return the type of the named field if
552 /// they are of record type.
554 virtual RecTy *getFieldType(const std::string &FieldName) const;
556 /// resolveListElementReference - This method is used to implement
557 /// VarListElementInit::resolveReferences. If the list element is resolvable
558 /// now, we return the resolved value, otherwise we return null.
559 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
560 unsigned Elt) const = 0;
564 /// UnsetInit - ? - Represents an uninitialized value
566 class UnsetInit : public Init {
567 UnsetInit() : Init() {}
568 UnsetInit(const UnsetInit &); // Do not define.
569 UnsetInit &operator=(const UnsetInit &Other); // Do not define.
570 virtual void anchor();
573 static UnsetInit *get();
575 virtual Init *convertInitializerTo(RecTy *Ty) const {
576 return Ty->convertValue(const_cast<UnsetInit *>(this));
579 virtual Init *getBit(unsigned Bit) const {
580 return const_cast<UnsetInit*>(this);
583 virtual bool isComplete() const { return false; }
584 virtual std::string getAsString() const { return "?"; }
588 /// BitInit - true/false - Represent a concrete initializer for a bit.
590 class BitInit : public Init {
593 explicit BitInit(bool V) : Value(V) {}
594 BitInit(const BitInit &Other); // Do not define.
595 BitInit &operator=(BitInit &Other); // Do not define.
596 virtual void anchor();
599 static BitInit *get(bool V);
601 bool getValue() const { return Value; }
603 virtual Init *convertInitializerTo(RecTy *Ty) const {
604 return Ty->convertValue(const_cast<BitInit *>(this));
607 virtual Init *getBit(unsigned Bit) const {
608 assert(Bit < 1 && "Bit index out of range!");
609 return const_cast<BitInit*>(this);
612 virtual std::string getAsString() const { return Value ? "1" : "0"; }
615 /// BitsInit - { a, b, c } - Represents an initializer for a BitsRecTy value.
616 /// It contains a vector of bits, whose size is determined by the type.
618 class BitsInit : public Init, public FoldingSetNode {
619 std::vector<Init*> Bits;
621 BitsInit(ArrayRef<Init *> Range) : Bits(Range.begin(), Range.end()) {}
623 BitsInit(const BitsInit &Other); // Do not define.
624 BitsInit &operator=(const BitsInit &Other); // Do not define.
627 static BitsInit *get(ArrayRef<Init *> Range);
629 void Profile(FoldingSetNodeID &ID) const;
631 unsigned getNumBits() const { return Bits.size(); }
633 virtual Init *convertInitializerTo(RecTy *Ty) const {
634 return Ty->convertValue(const_cast<BitsInit *>(this));
637 convertInitializerBitRange(const std::vector<unsigned> &Bits) const;
639 virtual bool isComplete() const {
640 for (unsigned i = 0; i != getNumBits(); ++i)
641 if (!getBit(i)->isComplete()) return false;
644 bool allInComplete() const {
645 for (unsigned i = 0; i != getNumBits(); ++i)
646 if (getBit(i)->isComplete()) return false;
649 virtual std::string getAsString() const;
651 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
653 virtual Init *getBit(unsigned Bit) const {
654 assert(Bit < Bits.size() && "Bit index out of range!");
660 /// IntInit - 7 - Represent an initalization by a literal integer value.
662 class IntInit : public TypedInit {
665 explicit IntInit(int64_t V) : TypedInit(IntRecTy::get()), Value(V) {}
667 IntInit(const IntInit &Other); // Do not define.
668 IntInit &operator=(const IntInit &Other); // Do note define.
671 static IntInit *get(int64_t V);
673 int64_t getValue() const { return Value; }
675 virtual Init *convertInitializerTo(RecTy *Ty) const {
676 return Ty->convertValue(const_cast<IntInit *>(this));
679 convertInitializerBitRange(const std::vector<unsigned> &Bits) const;
681 virtual std::string getAsString() const;
683 /// resolveListElementReference - This method is used to implement
684 /// VarListElementInit::resolveReferences. If the list element is resolvable
685 /// now, we return the resolved value, otherwise we return null.
686 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
687 unsigned Elt) const {
688 llvm_unreachable("Illegal element reference off int");
691 virtual Init *getBit(unsigned Bit) const {
692 return BitInit::get((Value & (1 << Bit)) != 0);
697 /// StringInit - "foo" - Represent an initialization by a string value.
699 class StringInit : public TypedInit {
702 explicit StringInit(const std::string &V)
703 : TypedInit(StringRecTy::get()), Value(V) {}
705 StringInit(const StringInit &Other); // Do not define.
706 StringInit &operator=(const StringInit &Other); // Do not define.
707 virtual void anchor();
710 static StringInit *get(StringRef);
712 const std::string &getValue() const { return Value; }
714 virtual Init *convertInitializerTo(RecTy *Ty) const {
715 return Ty->convertValue(const_cast<StringInit *>(this));
718 virtual std::string getAsString() const { return "\"" + Value + "\""; }
719 virtual std::string getAsUnquotedString() const { return Value; }
721 /// resolveListElementReference - This method is used to implement
722 /// VarListElementInit::resolveReferences. If the list element is resolvable
723 /// now, we return the resolved value, otherwise we return null.
724 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
725 unsigned Elt) const {
726 llvm_unreachable("Illegal element reference off string");
729 virtual Init *getBit(unsigned Bit) const {
730 llvm_unreachable("Illegal bit reference off string");
734 /// ListInit - [AL, AH, CL] - Represent a list of defs
736 class ListInit : public TypedInit, public FoldingSetNode {
737 std::vector<Init*> Values;
739 typedef std::vector<Init*>::const_iterator const_iterator;
742 explicit ListInit(ArrayRef<Init *> Range, RecTy *EltTy)
743 : TypedInit(ListRecTy::get(EltTy)), Values(Range.begin(), Range.end()) {}
745 ListInit(const ListInit &Other); // Do not define.
746 ListInit &operator=(const ListInit &Other); // Do not define.
749 static ListInit *get(ArrayRef<Init *> Range, RecTy *EltTy);
751 void Profile(FoldingSetNodeID &ID) const;
753 unsigned getSize() const { return Values.size(); }
754 Init *getElement(unsigned i) const {
755 assert(i < Values.size() && "List element index out of range!");
759 Record *getElementAsRecord(unsigned i) const;
761 Init *convertInitListSlice(const std::vector<unsigned> &Elements) const;
763 virtual Init *convertInitializerTo(RecTy *Ty) const {
764 return Ty->convertValue(const_cast<ListInit *>(this));
767 /// resolveReferences - This method is used by classes that refer to other
768 /// variables which may not be defined at the time they expression is formed.
769 /// If a value is set for the variable later, this method will be called on
770 /// users of the value to allow the value to propagate out.
772 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
774 virtual std::string getAsString() const;
776 ArrayRef<Init*> getValues() const { return Values; }
778 inline const_iterator begin() const { return Values.begin(); }
779 inline const_iterator end () const { return Values.end(); }
781 inline size_t size () const { return Values.size(); }
782 inline bool empty() const { return Values.empty(); }
784 /// resolveListElementReference - This method is used to implement
785 /// VarListElementInit::resolveReferences. If the list element is resolvable
786 /// now, we return the resolved value, otherwise we return null.
787 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
790 virtual Init *getBit(unsigned Bit) const {
791 llvm_unreachable("Illegal bit reference off list");
796 /// OpInit - Base class for operators
798 class OpInit : public TypedInit {
799 OpInit(const OpInit &Other); // Do not define.
800 OpInit &operator=(OpInit &Other); // Do not define.
803 explicit OpInit(RecTy *Type) : TypedInit(Type) {}
806 // Clone - Clone this operator, replacing arguments with the new list
807 virtual OpInit *clone(std::vector<Init *> &Operands) const = 0;
809 virtual int getNumOperands() const = 0;
810 virtual Init *getOperand(int i) const = 0;
812 // Fold - If possible, fold this to a simpler init. Return this if not
814 virtual Init *Fold(Record *CurRec, MultiClass *CurMultiClass) const = 0;
816 virtual Init *convertInitializerTo(RecTy *Ty) const {
817 return Ty->convertValue(const_cast<OpInit *>(this));
820 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
823 virtual Init *getBit(unsigned Bit) const;
827 /// UnOpInit - !op (X) - Transform an init.
829 class UnOpInit : public OpInit {
831 enum UnaryOp { CAST, HEAD, TAIL, EMPTY };
836 UnOpInit(UnaryOp opc, Init *lhs, RecTy *Type)
837 : OpInit(Type), Opc(opc), LHS(lhs) {}
839 UnOpInit(const UnOpInit &Other); // Do not define.
840 UnOpInit &operator=(const UnOpInit &Other); // Do not define.
843 static UnOpInit *get(UnaryOp opc, Init *lhs, RecTy *Type);
845 // Clone - Clone this operator, replacing arguments with the new list
846 virtual OpInit *clone(std::vector<Init *> &Operands) const {
847 assert(Operands.size() == 1 &&
848 "Wrong number of operands for unary operation");
849 return UnOpInit::get(getOpcode(), *Operands.begin(), getType());
852 int getNumOperands() const { return 1; }
853 Init *getOperand(int i) const {
854 assert(i == 0 && "Invalid operand id for unary operator");
858 UnaryOp getOpcode() const { return Opc; }
859 Init *getOperand() const { return LHS; }
861 // Fold - If possible, fold this to a simpler init. Return this if not
863 Init *Fold(Record *CurRec, MultiClass *CurMultiClass) const;
865 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
867 virtual std::string getAsString() const;
870 /// BinOpInit - !op (X, Y) - Combine two inits.
872 class BinOpInit : public OpInit {
874 enum BinaryOp { SHL, SRA, SRL, STRCONCAT, CONCAT, EQ };
879 BinOpInit(BinaryOp opc, Init *lhs, Init *rhs, RecTy *Type) :
880 OpInit(Type), Opc(opc), LHS(lhs), RHS(rhs) {}
882 BinOpInit(const BinOpInit &Other); // Do not define.
883 BinOpInit &operator=(const BinOpInit &Other); // Do not define.
886 static BinOpInit *get(BinaryOp opc, Init *lhs, Init *rhs,
889 // Clone - Clone this operator, replacing arguments with the new list
890 virtual OpInit *clone(std::vector<Init *> &Operands) const {
891 assert(Operands.size() == 2 &&
892 "Wrong number of operands for binary operation");
893 return BinOpInit::get(getOpcode(), Operands[0], Operands[1], getType());
896 int getNumOperands() const { return 2; }
897 Init *getOperand(int i) const {
898 assert((i == 0 || i == 1) && "Invalid operand id for binary operator");
906 BinaryOp getOpcode() const { return Opc; }
907 Init *getLHS() const { return LHS; }
908 Init *getRHS() const { return RHS; }
910 // Fold - If possible, fold this to a simpler init. Return this if not
912 Init *Fold(Record *CurRec, MultiClass *CurMultiClass) const;
914 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
916 virtual std::string getAsString() const;
919 /// TernOpInit - !op (X, Y, Z) - Combine two inits.
921 class TernOpInit : public OpInit {
923 enum TernaryOp { SUBST, FOREACH, IF };
926 Init *LHS, *MHS, *RHS;
928 TernOpInit(TernaryOp opc, Init *lhs, Init *mhs, Init *rhs,
930 OpInit(Type), Opc(opc), LHS(lhs), MHS(mhs), RHS(rhs) {}
932 TernOpInit(const TernOpInit &Other); // Do not define.
933 TernOpInit &operator=(const TernOpInit &Other); // Do not define.
936 static TernOpInit *get(TernaryOp opc, Init *lhs,
937 Init *mhs, Init *rhs,
940 // Clone - Clone this operator, replacing arguments with the new list
941 virtual OpInit *clone(std::vector<Init *> &Operands) const {
942 assert(Operands.size() == 3 &&
943 "Wrong number of operands for ternary operation");
944 return TernOpInit::get(getOpcode(), Operands[0], Operands[1], Operands[2],
948 int getNumOperands() const { return 3; }
949 Init *getOperand(int i) const {
950 assert((i == 0 || i == 1 || i == 2) &&
951 "Invalid operand id for ternary operator");
961 TernaryOp getOpcode() const { return Opc; }
962 Init *getLHS() const { return LHS; }
963 Init *getMHS() const { return MHS; }
964 Init *getRHS() const { return RHS; }
966 // Fold - If possible, fold this to a simpler init. Return this if not
968 Init *Fold(Record *CurRec, MultiClass *CurMultiClass) const;
970 virtual bool isComplete() const { return false; }
972 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
974 virtual std::string getAsString() const;
978 /// VarInit - 'Opcode' - Represent a reference to an entire variable object.
980 class VarInit : public TypedInit {
983 explicit VarInit(const std::string &VN, RecTy *T)
984 : TypedInit(T), VarName(StringInit::get(VN)) {}
985 explicit VarInit(Init *VN, RecTy *T)
986 : TypedInit(T), VarName(VN) {}
988 VarInit(const VarInit &Other); // Do not define.
989 VarInit &operator=(const VarInit &Other); // Do not define.
992 static VarInit *get(const std::string &VN, RecTy *T);
993 static VarInit *get(Init *VN, RecTy *T);
995 virtual Init *convertInitializerTo(RecTy *Ty) const {
996 return Ty->convertValue(const_cast<VarInit *>(this));
999 const std::string &getName() const;
1000 Init *getNameInit() const { return VarName; }
1001 std::string getNameInitAsString() const {
1002 return getNameInit()->getAsUnquotedString();
1005 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
1006 unsigned Elt) const;
1008 virtual RecTy *getFieldType(const std::string &FieldName) const;
1009 virtual Init *getFieldInit(Record &R, const RecordVal *RV,
1010 const std::string &FieldName) const;
1012 /// resolveReferences - This method is used by classes that refer to other
1013 /// variables which may not be defined at the time they expression is formed.
1014 /// If a value is set for the variable later, this method will be called on
1015 /// users of the value to allow the value to propagate out.
1017 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
1019 virtual Init *getBit(unsigned Bit) const;
1021 virtual std::string getAsString() const { return getName(); }
1025 /// VarBitInit - Opcode{0} - Represent access to one bit of a variable or field.
1027 class VarBitInit : public Init {
1031 VarBitInit(TypedInit *T, unsigned B) : TI(T), Bit(B) {
1032 assert(T->getType() &&
1033 (dynamic_cast<IntRecTy*>(T->getType()) ||
1034 (dynamic_cast<BitsRecTy*>(T->getType()) &&
1035 dynamic_cast<BitsRecTy*>(T->getType())->getNumBits() > B)) &&
1036 "Illegal VarBitInit expression!");
1039 VarBitInit(const VarBitInit &Other); // Do not define.
1040 VarBitInit &operator=(const VarBitInit &Other); // Do not define.
1043 static VarBitInit *get(TypedInit *T, unsigned B);
1045 virtual Init *convertInitializerTo(RecTy *Ty) const {
1046 return Ty->convertValue(const_cast<VarBitInit *>(this));
1049 virtual Init *getBitVar() const { return TI; }
1050 virtual unsigned getBitNum() const { return Bit; }
1052 virtual std::string getAsString() const;
1053 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
1055 virtual Init *getBit(unsigned B) const {
1056 assert(B < 1 && "Bit index out of range!");
1057 return const_cast<VarBitInit*>(this);
1061 /// VarListElementInit - List[4] - Represent access to one element of a var or
1063 class VarListElementInit : public TypedInit {
1067 VarListElementInit(TypedInit *T, unsigned E)
1068 : TypedInit(dynamic_cast<ListRecTy*>(T->getType())->getElementType()),
1070 assert(T->getType() && dynamic_cast<ListRecTy*>(T->getType()) &&
1071 "Illegal VarBitInit expression!");
1074 VarListElementInit(const VarListElementInit &Other); // Do not define.
1075 VarListElementInit &operator=(const VarListElementInit &Other); // Do
1080 static VarListElementInit *get(TypedInit *T, unsigned E);
1082 virtual Init *convertInitializerTo(RecTy *Ty) const {
1083 return Ty->convertValue(const_cast<VarListElementInit *>(this));
1086 TypedInit *getVariable() const { return TI; }
1087 unsigned getElementNum() const { return Element; }
1089 /// resolveListElementReference - This method is used to implement
1090 /// VarListElementInit::resolveReferences. If the list element is resolvable
1091 /// now, we return the resolved value, otherwise we return null.
1092 virtual Init *resolveListElementReference(Record &R,
1093 const RecordVal *RV,
1094 unsigned Elt) const;
1096 virtual std::string getAsString() const;
1097 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
1099 virtual Init *getBit(unsigned Bit) const;
1102 /// DefInit - AL - Represent a reference to a 'def' in the description
1104 class DefInit : public TypedInit {
1107 DefInit(Record *D, RecordRecTy *T) : TypedInit(T), Def(D) {}
1108 friend class Record;
1110 DefInit(const DefInit &Other); // Do not define.
1111 DefInit &operator=(const DefInit &Other); // Do not define.
1114 static DefInit *get(Record*);
1116 virtual Init *convertInitializerTo(RecTy *Ty) const {
1117 return Ty->convertValue(const_cast<DefInit *>(this));
1120 Record *getDef() const { return Def; }
1122 //virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
1124 virtual RecTy *getFieldType(const std::string &FieldName) const;
1125 virtual Init *getFieldInit(Record &R, const RecordVal *RV,
1126 const std::string &FieldName) const;
1128 virtual std::string getAsString() const;
1130 virtual Init *getBit(unsigned Bit) const {
1131 llvm_unreachable("Illegal bit reference off def");
1134 /// resolveListElementReference - This method is used to implement
1135 /// VarListElementInit::resolveReferences. If the list element is resolvable
1136 /// now, we return the resolved value, otherwise we return null.
1137 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
1138 unsigned Elt) const {
1139 llvm_unreachable("Illegal element reference off def");
1144 /// FieldInit - X.Y - Represent a reference to a subfield of a variable
1146 class FieldInit : public TypedInit {
1147 Init *Rec; // Record we are referring to
1148 std::string FieldName; // Field we are accessing
1150 FieldInit(Init *R, const std::string &FN)
1151 : TypedInit(R->getFieldType(FN)), Rec(R), FieldName(FN) {
1152 assert(getType() && "FieldInit with non-record type!");
1155 FieldInit(const FieldInit &Other); // Do not define.
1156 FieldInit &operator=(const FieldInit &Other); // Do not define.
1159 static FieldInit *get(Init *R, const std::string &FN);
1160 static FieldInit *get(Init *R, const Init *FN);
1162 virtual Init *convertInitializerTo(RecTy *Ty) const {
1163 return Ty->convertValue(const_cast<FieldInit *>(this));
1166 virtual Init *getBit(unsigned Bit) const;
1168 virtual Init *resolveListElementReference(Record &R,
1169 const RecordVal *RV,
1170 unsigned Elt) const;
1172 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
1174 virtual std::string getAsString() const {
1175 return Rec->getAsString() + "." + FieldName;
1179 /// DagInit - (v a, b) - Represent a DAG tree value. DAG inits are required
1180 /// to have at least one value then a (possibly empty) list of arguments. Each
1181 /// argument can have a name associated with it.
1183 class DagInit : public TypedInit, public FoldingSetNode {
1185 std::string ValName;
1186 std::vector<Init*> Args;
1187 std::vector<std::string> ArgNames;
1189 DagInit(Init *V, const std::string &VN,
1190 ArrayRef<Init *> ArgRange,
1191 ArrayRef<std::string> NameRange)
1192 : TypedInit(DagRecTy::get()), Val(V), ValName(VN),
1193 Args(ArgRange.begin(), ArgRange.end()),
1194 ArgNames(NameRange.begin(), NameRange.end()) {}
1196 DagInit(const DagInit &Other); // Do not define.
1197 DagInit &operator=(const DagInit &Other); // Do not define.
1200 static DagInit *get(Init *V, const std::string &VN,
1201 ArrayRef<Init *> ArgRange,
1202 ArrayRef<std::string> NameRange);
1203 static DagInit *get(Init *V, const std::string &VN,
1205 std::pair<Init*, std::string> > &args);
1207 void Profile(FoldingSetNodeID &ID) const;
1209 virtual Init *convertInitializerTo(RecTy *Ty) const {
1210 return Ty->convertValue(const_cast<DagInit *>(this));
1213 Init *getOperator() const { return Val; }
1215 const std::string &getName() const { return ValName; }
1217 unsigned getNumArgs() const { return Args.size(); }
1218 Init *getArg(unsigned Num) const {
1219 assert(Num < Args.size() && "Arg number out of range!");
1222 const std::string &getArgName(unsigned Num) const {
1223 assert(Num < ArgNames.size() && "Arg number out of range!");
1224 return ArgNames[Num];
1227 virtual Init *resolveReferences(Record &R, const RecordVal *RV) const;
1229 virtual std::string getAsString() const;
1231 typedef std::vector<Init*>::const_iterator const_arg_iterator;
1232 typedef std::vector<std::string>::const_iterator const_name_iterator;
1234 inline const_arg_iterator arg_begin() const { return Args.begin(); }
1235 inline const_arg_iterator arg_end () const { return Args.end(); }
1237 inline size_t arg_size () const { return Args.size(); }
1238 inline bool arg_empty() const { return Args.empty(); }
1240 inline const_name_iterator name_begin() const { return ArgNames.begin(); }
1241 inline const_name_iterator name_end () const { return ArgNames.end(); }
1243 inline size_t name_size () const { return ArgNames.size(); }
1244 inline bool name_empty() const { return ArgNames.empty(); }
1246 virtual Init *getBit(unsigned Bit) const {
1247 llvm_unreachable("Illegal bit reference off dag");
1250 virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
1251 unsigned Elt) const {
1252 llvm_unreachable("Illegal element reference off dag");
1256 //===----------------------------------------------------------------------===//
1257 // High-Level Classes
1258 //===----------------------------------------------------------------------===//
1266 RecordVal(Init *N, RecTy *T, unsigned P);
1267 RecordVal(const std::string &N, RecTy *T, unsigned P);
1269 const std::string &getName() const;
1270 const Init *getNameInit() const { return Name; }
1271 std::string getNameInitAsString() const {
1272 return getNameInit()->getAsUnquotedString();
1275 unsigned getPrefix() const { return Prefix; }
1276 RecTy *getType() const { return Ty; }
1277 Init *getValue() const { return Value; }
1279 bool setValue(Init *V) {
1281 Value = V->convertInitializerTo(Ty);
1289 void print(raw_ostream &OS, bool PrintSem = true) const;
1292 inline raw_ostream &operator<<(raw_ostream &OS, const RecordVal &RV) {
1293 RV.print(OS << " ");
1298 static unsigned LastID;
1300 // Unique record ID.
1303 // Location where record was instantiated, followed by the location of
1304 // multiclass prototypes used.
1305 SmallVector<SMLoc, 4> Locs;
1306 std::vector<Init *> TemplateArgs;
1307 std::vector<RecordVal> Values;
1308 std::vector<Record*> SuperClasses;
1310 // Tracks Record instances. Not owned by Record.
1311 RecordKeeper &TrackedRecords;
1320 // Constructs a record.
1321 explicit Record(const std::string &N, ArrayRef<SMLoc> locs,
1322 RecordKeeper &records) :
1323 ID(LastID++), Name(StringInit::get(N)), Locs(locs.begin(), locs.end()),
1324 TrackedRecords(records), TheInit(0) {
1327 explicit Record(Init *N, ArrayRef<SMLoc> locs, RecordKeeper &records) :
1328 ID(LastID++), Name(N), Locs(locs.begin(), locs.end()),
1329 TrackedRecords(records), TheInit(0) {
1335 static unsigned getNewUID() { return LastID++; }
1338 unsigned getID() const { return ID; }
1340 const std::string &getName() const;
1341 Init *getNameInit() const {
1344 const std::string getNameInitAsString() const {
1345 return getNameInit()->getAsUnquotedString();
1348 void setName(Init *Name); // Also updates RecordKeeper.
1349 void setName(const std::string &Name); // Also updates RecordKeeper.
1351 ArrayRef<SMLoc> getLoc() const { return Locs; }
1353 /// get the corresponding DefInit.
1354 DefInit *getDefInit();
1356 const std::vector<Init *> &getTemplateArgs() const {
1357 return TemplateArgs;
1359 const std::vector<RecordVal> &getValues() const { return Values; }
1360 const std::vector<Record*> &getSuperClasses() const { return SuperClasses; }
1362 bool isTemplateArg(Init *Name) const {
1363 for (unsigned i = 0, e = TemplateArgs.size(); i != e; ++i)
1364 if (TemplateArgs[i] == Name) return true;
1367 bool isTemplateArg(StringRef Name) const {
1368 return isTemplateArg(StringInit::get(Name.str()));
1371 const RecordVal *getValue(const Init *Name) const {
1372 for (unsigned i = 0, e = Values.size(); i != e; ++i)
1373 if (Values[i].getNameInit() == Name) return &Values[i];
1376 const RecordVal *getValue(StringRef Name) const {
1377 return getValue(StringInit::get(Name));
1379 RecordVal *getValue(const Init *Name) {
1380 for (unsigned i = 0, e = Values.size(); i != e; ++i)
1381 if (Values[i].getNameInit() == Name) return &Values[i];
1384 RecordVal *getValue(StringRef Name) {
1385 return getValue(StringInit::get(Name));
1388 void addTemplateArg(Init *Name) {
1389 assert(!isTemplateArg(Name) && "Template arg already defined!");
1390 TemplateArgs.push_back(Name);
1392 void addTemplateArg(StringRef Name) {
1393 addTemplateArg(StringInit::get(Name.str()));
1396 void addValue(const RecordVal &RV) {
1397 assert(getValue(RV.getNameInit()) == 0 && "Value already added!");
1398 Values.push_back(RV);
1399 if (Values.size() > 1)
1400 // Keep NAME at the end of the list. It makes record dumps a
1401 // bit prettier and allows TableGen tests to be written more
1402 // naturally. Tests can use CHECK-NEXT to look for Record
1403 // fields they expect to see after a def. They can't do that if
1404 // NAME is the first Record field.
1405 std::swap(Values[Values.size() - 2], Values[Values.size() - 1]);
1408 void removeValue(Init *Name) {
1409 for (unsigned i = 0, e = Values.size(); i != e; ++i)
1410 if (Values[i].getNameInit() == Name) {
1411 Values.erase(Values.begin()+i);
1414 llvm_unreachable("Cannot remove an entry that does not exist!");
1417 void removeValue(StringRef Name) {
1418 removeValue(StringInit::get(Name.str()));
1421 bool isSubClassOf(const Record *R) const {
1422 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1423 if (SuperClasses[i] == R)
1428 bool isSubClassOf(StringRef Name) const {
1429 for (unsigned i = 0, e = SuperClasses.size(); i != e; ++i)
1430 if (SuperClasses[i]->getNameInitAsString() == Name)
1435 void addSuperClass(Record *R) {
1436 assert(!isSubClassOf(R) && "Already subclassing record!");
1437 SuperClasses.push_back(R);
1440 /// resolveReferences - If there are any field references that refer to fields
1441 /// that have been filled in, we can propagate the values now.
1443 void resolveReferences() { resolveReferencesTo(0); }
1445 /// resolveReferencesTo - If anything in this record refers to RV, replace the
1446 /// reference to RV with the RHS of RV. If RV is null, we resolve all
1447 /// possible references.
1448 void resolveReferencesTo(const RecordVal *RV);
1450 RecordKeeper &getRecords() const {
1451 return TrackedRecords;
1456 //===--------------------------------------------------------------------===//
1457 // High-level methods useful to tablegen back-ends
1460 /// getValueInit - Return the initializer for a value with the specified name,
1461 /// or throw an exception if the field does not exist.
1463 Init *getValueInit(StringRef FieldName) const;
1465 /// getValueAsString - This method looks up the specified field and returns
1466 /// its value as a string, throwing an exception if the field does not exist
1467 /// or if the value is not a string.
1469 std::string getValueAsString(StringRef FieldName) const;
1471 /// getValueAsBitsInit - This method looks up the specified field and returns
1472 /// its value as a BitsInit, throwing an exception if the field does not exist
1473 /// or if the value is not the right type.
1475 BitsInit *getValueAsBitsInit(StringRef FieldName) const;
1477 /// getValueAsListInit - This method looks up the specified field and returns
1478 /// its value as a ListInit, throwing an exception if the field does not exist
1479 /// or if the value is not the right type.
1481 ListInit *getValueAsListInit(StringRef FieldName) const;
1483 /// getValueAsListOfDefs - This method looks up the specified field and
1484 /// returns its value as a vector of records, throwing an exception if the
1485 /// field does not exist or if the value is not the right type.
1487 std::vector<Record*> getValueAsListOfDefs(StringRef FieldName) const;
1489 /// getValueAsListOfInts - This method looks up the specified field and
1490 /// returns its value as a vector of integers, throwing an exception if the
1491 /// field does not exist or if the value is not the right type.
1493 std::vector<int64_t> getValueAsListOfInts(StringRef FieldName) const;
1495 /// getValueAsListOfStrings - This method looks up the specified field and
1496 /// returns its value as a vector of strings, throwing an exception if the
1497 /// field does not exist or if the value is not the right type.
1499 std::vector<std::string> getValueAsListOfStrings(StringRef FieldName) const;
1501 /// getValueAsDef - This method looks up the specified field and returns its
1502 /// value as a Record, throwing an exception if the field does not exist or if
1503 /// the value is not the right type.
1505 Record *getValueAsDef(StringRef FieldName) const;
1507 /// getValueAsBit - This method looks up the specified field and returns its
1508 /// value as a bit, throwing an exception if the field does not exist or if
1509 /// the value is not the right type.
1511 bool getValueAsBit(StringRef FieldName) const;
1513 /// getValueAsBitOrUnset - This method looks up the specified field and
1514 /// returns its value as a bit. If the field is unset, sets Unset to true and
1517 bool getValueAsBitOrUnset(StringRef FieldName, bool &Unset) const;
1519 /// getValueAsInt - This method looks up the specified field and returns its
1520 /// value as an int64_t, throwing an exception if the field does not exist or
1521 /// if the value is not the right type.
1523 int64_t getValueAsInt(StringRef FieldName) const;
1525 /// getValueAsDag - This method looks up the specified field and returns its
1526 /// value as an Dag, throwing an exception if the field does not exist or if
1527 /// the value is not the right type.
1529 DagInit *getValueAsDag(StringRef FieldName) const;
1532 raw_ostream &operator<<(raw_ostream &OS, const Record &R);
1535 Record Rec; // Placeholder for template args and Name.
1536 typedef std::vector<Record*> RecordVector;
1537 RecordVector DefPrototypes;
1541 MultiClass(const std::string &Name, SMLoc Loc, RecordKeeper &Records) :
1542 Rec(Name, Loc, Records) {}
1545 class RecordKeeper {
1546 std::map<std::string, Record*> Classes, Defs;
1550 for (std::map<std::string, Record*>::iterator I = Classes.begin(),
1551 E = Classes.end(); I != E; ++I)
1553 for (std::map<std::string, Record*>::iterator I = Defs.begin(),
1554 E = Defs.end(); I != E; ++I)
1558 const std::map<std::string, Record*> &getClasses() const { return Classes; }
1559 const std::map<std::string, Record*> &getDefs() const { return Defs; }
1561 Record *getClass(const std::string &Name) const {
1562 std::map<std::string, Record*>::const_iterator I = Classes.find(Name);
1563 return I == Classes.end() ? 0 : I->second;
1565 Record *getDef(const std::string &Name) const {
1566 std::map<std::string, Record*>::const_iterator I = Defs.find(Name);
1567 return I == Defs.end() ? 0 : I->second;
1569 void addClass(Record *R) {
1570 bool Ins = Classes.insert(std::make_pair(R->getName(), R)).second;
1572 assert(Ins && "Class already exists");
1574 void addDef(Record *R) {
1575 bool Ins = Defs.insert(std::make_pair(R->getName(), R)).second;
1577 assert(Ins && "Record already exists");
1580 /// removeClass - Remove, but do not delete, the specified record.
1582 void removeClass(const std::string &Name) {
1583 assert(Classes.count(Name) && "Class does not exist!");
1584 Classes.erase(Name);
1586 /// removeDef - Remove, but do not delete, the specified record.
1588 void removeDef(const std::string &Name) {
1589 assert(Defs.count(Name) && "Def does not exist!");
1593 //===--------------------------------------------------------------------===//
1594 // High-level helper methods, useful for tablegen backends...
1596 /// getAllDerivedDefinitions - This method returns all concrete definitions
1597 /// that derive from the specified class name. If a class with the specified
1598 /// name does not exist, an exception is thrown.
1599 std::vector<Record*>
1600 getAllDerivedDefinitions(const std::string &ClassName) const;
1605 /// LessRecord - Sorting predicate to sort record pointers by name.
1608 bool operator()(const Record *Rec1, const Record *Rec2) const {
1609 return StringRef(Rec1->getName()).compare_numeric(Rec2->getName()) < 0;
1613 /// LessRecordFieldName - Sorting predicate to sort record pointers by their
1616 struct LessRecordFieldName {
1617 bool operator()(const Record *Rec1, const Record *Rec2) const {
1618 return Rec1->getValueAsString("Name") < Rec2->getValueAsString("Name");
1622 raw_ostream &operator<<(raw_ostream &OS, const RecordKeeper &RK);
1624 /// QualifyName - Return an Init with a qualifier prefix referring
1625 /// to CurRec's name.
1626 Init *QualifyName(Record &CurRec, MultiClass *CurMultiClass,
1627 Init *Name, const std::string &Scoper);
1629 /// QualifyName - Return an Init with a qualifier prefix referring
1630 /// to CurRec's name.
1631 Init *QualifyName(Record &CurRec, MultiClass *CurMultiClass,
1632 const std::string &Name, const std::string &Scoper);
1634 } // End llvm namespace