Dwarf requires variable entries to be in the source order. Right now, since we are...
[oota-llvm.git] / utils / TableGen / Record.h
index f8a3c35b98029637192abab872c5ab43d9a0c457..5f0e4c7fa679933e1eec81a36f91463847b2e947 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -18,7 +18,7 @@
 #include <string>
 #include <vector>
 #include <map>
-#include <iostream>
+#include <ostream>
 #include <cassert>
 
 namespace llvm {
@@ -62,7 +62,8 @@ class RecordVal;
 struct RecTy {
   virtual ~RecTy() {}
 
-  virtual void print(std::ostream &OS) const = 0;
+  virtual std::string getAsString() const = 0;
+  void print(std::ostream &OS) const { OS << getAsString(); }
   void dump() const;
 
   /// typeIsConvertibleTo - Return true if all values of 'this' type can be
@@ -122,11 +123,12 @@ public:
   virtual Init *convertValue(VarBitInit *VB) { return (Init*)VB; }
   virtual Init *convertValue(   DefInit *DI) { return 0; }
   virtual Init *convertValue(   DagInit *DI) { return 0; }
+  virtual Init *convertValue( BinOpInit *UI) { return 0; }
   virtual Init *convertValue( TypedInit *TI);
   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 
-  void print(std::ostream &OS) const { OS << "bit"; }
+  std::string getAsString() const { return "bit"; }
 
   bool typeIsConvertibleTo(const RecTy *RHS) const {
     return RHS->baseClassOf(this);
@@ -163,12 +165,12 @@ public:
   virtual Init *convertValue(VarBitInit *VB) { return 0; }
   virtual Init *convertValue(   DefInit *DI) { return 0; }
   virtual Init *convertValue(   DagInit *DI) { return 0; }
+  virtual Init *convertValue( BinOpInit *UI) { return 0; }
   virtual Init *convertValue( TypedInit *TI);
   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 
-
-  void print(std::ostream &OS) const { OS << "bits<" << Size << ">"; }
+  std::string getAsString() const;
 
   bool typeIsConvertibleTo(const RecTy *RHS) const {
     return RHS->baseClassOf(this);
@@ -201,12 +203,12 @@ public:
   virtual Init *convertValue(VarBitInit *VB) { return 0; }
   virtual Init *convertValue(   DefInit *DI) { return 0; }
   virtual Init *convertValue(   DagInit *DI) { return 0; }
+  virtual Init *convertValue( BinOpInit *UI) { return 0; }
   virtual Init *convertValue( TypedInit *TI);
   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 
-
-  void print(std::ostream &OS) const { OS << "int"; }
+  std::string getAsString() const { return "int"; }
 
   bool typeIsConvertibleTo(const RecTy *RHS) const {
     return RHS->baseClassOf(this);
@@ -242,7 +244,7 @@ public:
   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 
-  void print(std::ostream &OS) const { OS << "string"; }
+  std::string getAsString() const { return "string"; }
 
   bool typeIsConvertibleTo(const RecTy *RHS) const {
     return RHS->baseClassOf(this);
@@ -280,11 +282,12 @@ public:
   virtual Init *convertValue(VarBitInit *VB) { return 0; }
   virtual Init *convertValue(   DefInit *DI) { return 0; }
   virtual Init *convertValue(   DagInit *DI) { return 0; }
+  virtual Init *convertValue( BinOpInit *UI) { return 0; }
   virtual Init *convertValue( TypedInit *TI);
   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 
-  void print(std::ostream &OS) const;
+  std::string getAsString() const;
 
   bool typeIsConvertibleTo(const RecTy *RHS) const {
     return RHS->baseClassOf(this);
@@ -316,12 +319,12 @@ public:
   virtual Init *convertValue(VarBitInit *VB) { return 0; }
   virtual Init *convertValue(   DefInit *DI) { return 0; }
   virtual Init *convertValue(   DagInit *DI) { return 0; }
+  virtual Init *convertValue( BinOpInit *UI) { return 0; }
   virtual Init *convertValue( TypedInit *TI);
   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 
-
-  void print(std::ostream &OS) const { OS << "code"; }
+  std::string getAsString() const { return "code"; }
 
   bool typeIsConvertibleTo(const RecTy *RHS) const {
     return RHS->baseClassOf(this);
@@ -349,12 +352,13 @@ public:
   virtual Init *convertValue(  CodeInit *CI) { return 0; }
   virtual Init *convertValue(VarBitInit *VB) { return 0; }
   virtual Init *convertValue(   DefInit *DI) { return 0; }
+  virtual Init *convertValue( BinOpInit *BO);
   virtual Init *convertValue(   DagInit *CI) { return (Init*)CI; }
   virtual Init *convertValue( TypedInit *TI);
   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 
-  void print(std::ostream &OS) const { OS << "dag"; }
+  std::string getAsString() const { return "dag"; }
 
   bool typeIsConvertibleTo(const RecTy *RHS) const {
     return RHS->baseClassOf(this);
@@ -389,13 +393,14 @@ public:
   virtual Init *convertValue(  ListInit *LI) { return 0; }
   virtual Init *convertValue(  CodeInit *CI) { return 0; }
   virtual Init *convertValue(VarBitInit *VB) { return 0; }
+  virtual Init *convertValue( BinOpInit *UI) { return 0; }
   virtual Init *convertValue(   DefInit *DI);
   virtual Init *convertValue(   DagInit *DI) { return 0; }
   virtual Init *convertValue( TypedInit *VI);
   virtual Init *convertValue(   VarInit *VI) { return RecTy::convertValue(VI);}
   virtual Init *convertValue( FieldInit *FI) { return RecTy::convertValue(FI);}
 
-  void print(std::ostream &OS) const;
+  std::string getAsString() const;
 
   bool typeIsConvertibleTo(const RecTy *RHS) const {
     return RHS->baseClassOf(this);
@@ -424,7 +429,10 @@ struct Init {
   virtual bool isComplete() const { return true; }
 
   /// print - Print out this value.
-  virtual void print(std::ostream &OS) const = 0;
+  void print(std::ostream &OS) const { OS << getAsString(); }
+
+  /// getAsString - Convert this value to a string form.
+  virtual std::string getAsString() const = 0;
 
   /// dump - Debugging method that may be called through a debugger, just
   /// invokes print on cerr.
@@ -492,7 +500,7 @@ public:
   }
 
   virtual bool isComplete() const { return false; }
-  virtual void print(std::ostream &OS) const { OS << "?"; }
+  virtual std::string getAsString() const { return "?"; }
 };
 
 
@@ -509,7 +517,7 @@ public:
     return Ty->convertValue(this);
   }
 
-  virtual void print(std::ostream &OS) const { OS << (Value ? "1" : "0"); }
+  virtual std::string getAsString() const { return Value ? "1" : "0"; }
 };
 
 /// BitsInit - { a, b, c } - Represents an initializer for a BitsRecTy value.
@@ -542,7 +550,7 @@ public:
       if (!getBit(i)->isComplete()) return false;
     return true;
   }
-  virtual void print(std::ostream &OS) const;
+  virtual std::string getAsString() const;
 
   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 
@@ -568,7 +576,7 @@ public:
   }
   virtual Init *convertInitializerBitRange(const std::vector<unsigned> &Bits);
 
-  virtual void print(std::ostream &OS) const { OS << Value; }
+  virtual std::string getAsString() const;
 };
 
 
@@ -585,7 +593,7 @@ public:
     return Ty->convertValue(this);
   }
 
-  virtual void print(std::ostream &OS) const { OS << "\"" << Value << "\""; }
+  virtual std::string getAsString() const { return "\"" + Value + "\""; }
 };
 
 /// CodeInit - "[{...}]" - Represent a code fragment.
@@ -601,7 +609,7 @@ public:
     return Ty->convertValue(this);
   }
 
-  virtual void print(std::ostream &OS) const { OS << "[{" << Value << "}]"; }
+  virtual std::string getAsString() const { return "[{" + Value + "}]"; }
 };
 
 /// ListInit - [AL, AH, CL] - Represent a list of defs
@@ -619,6 +627,8 @@ public:
     return Values[i];
   }
 
+  Record *getElementAsRecord(unsigned i) const;
+  
   Init *convertInitListSlice(const std::vector<unsigned> &Elements);
 
   virtual Init *convertInitializerTo(RecTy *Ty) {
@@ -632,14 +642,25 @@ public:
   ///
   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 
-  virtual void print(std::ostream &OS) const;
+  virtual std::string getAsString() const;
+
+  typedef std::vector<Init*>::iterator       iterator;
+  typedef std::vector<Init*>::const_iterator const_iterator;
+
+  inline iterator       begin()       { return Values.begin(); }
+  inline const_iterator begin() const { return Values.begin(); }
+  inline iterator       end  ()       { return Values.end();   }
+  inline const_iterator end  () const { return Values.end();   }
+
+  inline size_t         size () const { return Values.size();  }
+  inline bool           empty() const { return Values.empty(); }
 };
 
 /// BinOpInit - !op (X, Y) - Combine two inits.
 ///
 class BinOpInit : public Init {
 public:
-  enum BinaryOp { SHL, SRA, SRL, STRCONCAT };
+  enum BinaryOp { SHL, SRA, SRL, STRCONCAT, CONCAT };
 private:
   BinaryOp Opc;
   Init *LHS, *RHS;
@@ -661,7 +682,7 @@ public:
   
   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
   
-  virtual void print(std::ostream &OS) const;
+  virtual std::string getAsString() const;
 };
 
 
@@ -721,7 +742,7 @@ public:
   ///
   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 
-  virtual void print(std::ostream &OS) const { OS << VarName; }
+  virtual std::string getAsString() const { return VarName; }
 };
 
 
@@ -744,9 +765,7 @@ public:
   TypedInit *getVariable() const { return TI; }
   unsigned getBitNum() const { return Bit; }
 
-  virtual void print(std::ostream &OS) const {
-    TI->print(OS); OS << "{" << Bit << "}";
-  }
+  virtual std::string getAsString() const;
   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 };
 
@@ -779,9 +798,7 @@ public:
   virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
                                             unsigned Elt);
 
-  virtual void print(std::ostream &OS) const {
-    TI->print(OS); OS << "[" << Element << "]";
-  }
+  virtual std::string getAsString() const;
   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 };
 
@@ -803,7 +820,7 @@ public:
   virtual RecTy *getFieldType(const std::string &FieldName) const;
   virtual Init *getFieldInit(Record &R, const std::string &FieldName) const;
 
-  virtual void print(std::ostream &OS) const;
+  virtual std::string getAsString() const;
 };
 
 
@@ -829,8 +846,8 @@ public:
 
   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 
-  virtual void print(std::ostream &OS) const {
-    Rec->print(OS); OS << "." << FieldName;
+  virtual std::string getAsString() const {
+    return Rec->getAsString() + "." + FieldName;
   }
 };
 
@@ -880,7 +897,29 @@ public:
   
   virtual Init *resolveReferences(Record &R, const RecordVal *RV);
 
-  virtual void print(std::ostream &OS) const;
+  virtual std::string getAsString() const;
+
+  typedef std::vector<Init*>::iterator             arg_iterator;
+  typedef std::vector<Init*>::const_iterator       const_arg_iterator;
+  typedef std::vector<std::string>::iterator       name_iterator;
+  typedef std::vector<std::string>::const_iterator const_name_iterator;
+
+  inline arg_iterator        arg_begin()       { return Args.begin(); }
+  inline const_arg_iterator  arg_begin() const { return Args.begin(); }
+  inline arg_iterator        arg_end  ()       { return Args.end();   }
+  inline const_arg_iterator  arg_end  () const { return Args.end();   }
+
+  inline size_t              arg_size () const { return Args.size();  }
+  inline bool                arg_empty() const { return Args.empty(); }
+
+  inline name_iterator       name_begin()       { return ArgNames.begin(); }
+  inline const_name_iterator name_begin() const { return ArgNames.begin(); }
+  inline name_iterator       name_end  ()       { return ArgNames.end();   }
+  inline const_name_iterator name_end  () const { return ArgNames.end();   }
+
+  inline size_t              name_size () const { return ArgNames.size();  }
+  inline bool                name_empty() const { return ArgNames.empty(); }
+
 };
 
 //===----------------------------------------------------------------------===//
@@ -1033,11 +1072,17 @@ public:
   ListInit *getValueAsListInit(const std::string &FieldName) const;
 
   /// getValueAsListOfDefs - This method looks up the specified field and
-  /// returnsits value as a vector of records, throwing an exception if the
+  /// returns its value as a vector of records, throwing an exception if the
   /// field does not exist or if the value is not the right type.
   ///
   std::vector<Record*> getValueAsListOfDefs(const std::string &FieldName) const;
 
+  /// getValueAsListOfInts - This method looks up the specified field and returns
+  /// its value as a vector of integers, throwing an exception if the field does
+  /// not exist or if the value is not the right type.
+  ///
+  std::vector<int> getValueAsListOfInts(const std::string &FieldName) const;
+  
   /// getValueAsDef - This method looks up the specified field and returns its
   /// value as a Record, throwing an exception if the field does not exist or if
   /// the value is not the right type.