8b41134d4ff1b5cde7d86fffbbe1ac37895722a3
[oota-llvm.git] / lib / TableGen / TGParser.h
1 //===- TGParser.h - Parser for TableGen Files -------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This class represents the Parser for tablegen files.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_TABLEGEN_TGPARSER_H
15 #define LLVM_LIB_TABLEGEN_TGPARSER_H
16
17 #include "TGLexer.h"
18 #include "llvm/ADT/Twine.h"
19 #include "llvm/Support/SourceMgr.h"
20 #include "llvm/TableGen/Error.h"
21 #include "llvm/TableGen/Record.h"
22 #include <map>
23
24 namespace llvm {
25   class Record;
26   class RecordVal;
27   class RecordKeeper;
28   class RecTy;
29   class Init;
30   struct MultiClass;
31   struct SubClassReference;
32   struct SubMultiClassReference;
33
34   struct LetRecord {
35     std::string Name;
36     std::vector<unsigned> Bits;
37     Init *Value;
38     SMLoc Loc;
39     LetRecord(const std::string &N, const std::vector<unsigned> &B, Init *V,
40               SMLoc L)
41       : Name(N), Bits(B), Value(V), Loc(L) {
42     }
43   };
44
45   /// ForeachLoop - Record the iteration state associated with a for loop.
46   /// This is used to instantiate items in the loop body.
47   struct ForeachLoop {
48     VarInit *IterVar;
49     ListInit *ListValue;
50
51     ForeachLoop(VarInit *IVar, ListInit *LValue)
52       : IterVar(IVar), ListValue(LValue) {}
53   };
54
55 class TGParser {
56   TGLexer Lex;
57   std::vector<std::vector<LetRecord> > LetStack;
58   std::map<std::string, std::unique_ptr<MultiClass>> MultiClasses;
59
60   /// Loops - Keep track of any foreach loops we are within.
61   ///
62   typedef std::vector<ForeachLoop> LoopVector;
63   LoopVector Loops;
64
65   /// CurMultiClass - If we are parsing a 'multiclass' definition, this is the
66   /// current value.
67   MultiClass *CurMultiClass;
68
69   // Record tracker
70   RecordKeeper &Records;
71
72   unsigned AnonCounter;
73
74   // A "named boolean" indicating how to parse identifiers.  Usually
75   // identifiers map to some existing object but in special cases
76   // (e.g. parsing def names) no such object exists yet because we are
77   // in the middle of creating in.  For those situations, allow the
78   // parser to ignore missing object errors.
79   enum IDParseMode {
80     ParseValueMode,   // We are parsing a value we expect to look up.
81     ParseNameMode,    // We are parsing a name of an object that does not yet
82                       // exist.
83     ParseForeachMode  // We are parsing a foreach init.
84   };
85
86 public:
87   TGParser(SourceMgr &SrcMgr, RecordKeeper &records)
88       : Lex(SrcMgr), CurMultiClass(nullptr), Records(records), AnonCounter(0) {}
89
90   /// ParseFile - Main entrypoint for parsing a tblgen file.  These parser
91   /// routines return true on error, or false on success.
92   bool ParseFile();
93
94   bool Error(SMLoc L, const Twine &Msg) const {
95     PrintError(L, Msg);
96     return true;
97   }
98   bool TokError(const Twine &Msg) const {
99     return Error(Lex.getLoc(), Msg);
100   }
101   const TGLexer::DependenciesMapTy &getDependencies() const {
102     return Lex.getDependencies();
103   }
104
105 private:  // Semantic analysis methods.
106   bool AddValue(Record *TheRec, SMLoc Loc, const RecordVal &RV);
107   bool SetValue(Record *TheRec, SMLoc Loc, Init *ValName,
108                 const std::vector<unsigned> &BitList, Init *V);
109   bool SetValue(Record *TheRec, SMLoc Loc, const std::string &ValName,
110                 const std::vector<unsigned> &BitList, Init *V) {
111     return SetValue(TheRec, Loc, StringInit::get(ValName), BitList, V);
112   }
113   bool AddSubClass(Record *Rec, SubClassReference &SubClass);
114   bool AddSubMultiClass(MultiClass *CurMC,
115                         SubMultiClassReference &SubMultiClass);
116
117   std::string GetNewAnonymousName();
118
119   // IterRecord: Map an iterator name to a value.
120   struct IterRecord {
121     VarInit *IterVar;
122     Init *IterValue;
123     IterRecord(VarInit *Var, Init *Val) : IterVar(Var), IterValue(Val) {}
124   };
125
126   // IterSet: The set of all iterator values at some point in the
127   // iteration space.
128   typedef std::vector<IterRecord> IterSet;
129
130   bool ProcessForeachDefs(Record *CurRec, SMLoc Loc);
131   bool ProcessForeachDefs(Record *CurRec, SMLoc Loc, IterSet &IterVals);
132
133 private:  // Parser methods.
134   bool ParseObjectList(MultiClass *MC = nullptr);
135   bool ParseObject(MultiClass *MC);
136   bool ParseClass();
137   bool ParseMultiClass();
138   Record *InstantiateMulticlassDef(MultiClass &MC, Record *DefProto,
139                                    Init *&DefmPrefix, SMRange DefmPrefixRange,
140                                    ArrayRef<Init *> TArgs,
141                                    std::vector<Init *> &TemplateVals);
142   bool ResolveMulticlassDefArgs(MultiClass &MC, Record *DefProto,
143                                 SMLoc DefmPrefixLoc, SMLoc SubClassLoc,
144                                 ArrayRef<Init *> TArgs,
145                                 std::vector<Init *> &TemplateVals,
146                                 bool DeleteArgs);
147   bool ResolveMulticlassDef(MultiClass &MC,
148                             Record *CurRec,
149                             Record *DefProto,
150                             SMLoc DefmPrefixLoc);
151   bool ParseDefm(MultiClass *CurMultiClass);
152   bool ParseDef(MultiClass *CurMultiClass);
153   bool ParseForeach(MultiClass *CurMultiClass);
154   bool ParseTopLevelLet(MultiClass *CurMultiClass);
155   std::vector<LetRecord> ParseLetList();
156
157   bool ParseObjectBody(Record *CurRec);
158   bool ParseBody(Record *CurRec);
159   bool ParseBodyItem(Record *CurRec);
160
161   bool ParseTemplateArgList(Record *CurRec);
162   Init *ParseDeclaration(Record *CurRec, bool ParsingTemplateArgs);
163   VarInit *ParseForeachDeclaration(ListInit *&ForeachListValue);
164
165   SubClassReference ParseSubClassReference(Record *CurRec, bool isDefm);
166   SubMultiClassReference ParseSubMultiClassReference(MultiClass *CurMC);
167
168   Init *ParseIDValue(Record *CurRec, const std::string &Name, SMLoc NameLoc,
169                      IDParseMode Mode = ParseValueMode);
170   Init *ParseSimpleValue(Record *CurRec, RecTy *ItemType = nullptr,
171                          IDParseMode Mode = ParseValueMode);
172   Init *ParseValue(Record *CurRec, RecTy *ItemType = nullptr,
173                    IDParseMode Mode = ParseValueMode);
174   std::vector<Init*> ParseValueList(Record *CurRec, Record *ArgsRec = nullptr,
175                                     RecTy *EltTy = nullptr);
176   std::vector<std::pair<llvm::Init*, std::string> > ParseDagArgList(Record *);
177   bool ParseOptionalRangeList(std::vector<unsigned> &Ranges);
178   bool ParseOptionalBitList(std::vector<unsigned> &Ranges);
179   std::vector<unsigned> ParseRangeList();
180   bool ParseRangePiece(std::vector<unsigned> &Ranges);
181   RecTy *ParseType();
182   Init *ParseOperation(Record *CurRec, RecTy *ItemType);
183   RecTy *ParseOperatorType();
184   Init *ParseObjectName(MultiClass *CurMultiClass);
185   Record *ParseClassID();
186   MultiClass *ParseMultiClassID();
187   bool ApplyLetStack(Record *CurRec);
188 };
189
190 } // end namespace llvm
191
192 #endif