source: icGREP/icgrep-devel/icgrep/pablo/codegenstate.h @ 5160

Last change on this file since 5160 was 5160, checked in by nmedfort, 3 years ago

Initial work for incorporating Types into Pablo AST.

File size: 9.6 KB
Line 
1/*
2 *  Copyright (c) 2014 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 *  icgrep is a trademark of International Characters.
5 */
6
7#ifndef PS_PABLOS_H
8#define PS_PABLOS_H
9
10#include <pablo/pabloAST.h>
11#include <pablo/symbol_generator.h>
12#include <pablo/pe_advance.h>
13#include <pablo/pe_lookahead.h>
14#include <pablo/pe_and.h>
15#include <pablo/pe_call.h>
16#include <pablo/pe_matchstar.h>
17#include <pablo/pe_next.h>
18#include <pablo/pe_not.h>
19#include <pablo/pe_ones.h>
20#include <pablo/pe_or.h>
21#include <pablo/pe_scanthru.h>
22#include <pablo/pe_sel.h>
23#include <pablo/pe_infile.h>
24#include <pablo/pe_integer.h>
25#include <pablo/pe_string.h>
26#include <pablo/pe_var.h>
27#include <pablo/pe_xor.h>
28#include <pablo/pe_zeroes.h>
29#include <pablo/pe_count.h>
30#include <pablo/ps_assign.h>
31#include <pablo/ps_if.h>
32#include <pablo/ps_while.h>
33#include <pablo/function.h>
34#include <llvm/ADT/ArrayRef.h>
35#include <stdexcept>
36
37namespace pablo {
38
39class PabloBlock : public PabloAST, public StatementList {
40    friend class PabloAST;
41    friend class If;
42    friend class While;
43    friend class PabloBuilder;
44public:
45
46    static inline bool classof(const PabloBlock *) {
47        return true;
48    }
49    static inline bool classof(const Statement *) {
50        return false;
51    }
52    static inline bool classof(const PabloAST * e) {
53        return e->getClassTypeId() == ClassTypeId::Block;
54    }
55    static inline bool classof(const void *) {
56        return false;
57    }
58
59    inline static PabloBlock * Create(PabloFunction & parent) noexcept {
60        return new PabloBlock(&parent, nullptr);
61    }
62
63    inline static PabloBlock * Create(PabloBlock * const predecessor) noexcept {
64        return new PabloBlock(predecessor->mParent, predecessor);
65    }
66
67    PabloAST * createAdvance(PabloAST * expr, const Integer::Type shiftAmount);
68
69    PabloAST * createAdvance(PabloAST * expr, PabloAST * shiftAmount);
70
71    PabloAST * createAdvance(PabloAST * expr, const Integer::Type shiftAmount, const std::string prefix);
72
73    PabloAST * createAdvance(PabloAST * expr, PabloAST * shiftAmount, const std::string prefix);
74
75    PabloAST * createLookahead(PabloAST * expr, const Integer::Type shiftAmount);
76
77    PabloAST * createLookahead(PabloAST * expr, PabloAST * shiftAmount);
78
79    PabloAST * createLookahead(PabloAST * expr, const Integer::Type shiftAmount, const std::string prefix);
80
81    PabloAST * createLookahead(PabloAST * expr, PabloAST * shiftAmount, const std::string prefix);
82
83    inline Zeroes * createZeroes(const PabloType * const type = nullptr) {
84        return mParent->getNullValue(type);
85    }
86
87    inline Ones * createOnes(const PabloType * const type = nullptr) {
88        return mParent->getAllOnesValue(type);
89    }
90
91    inline Call * createCall(Prototype * prototype, const std::vector<Var *> & args) {
92        return createCall(prototype, reinterpret_cast<const std::vector<PabloAST *> &>(args));
93    }
94
95    inline Call * createCall(Prototype * prototype, const std::vector<PabloAST *> & args) {
96        if (prototype == nullptr) {
97            throw std::runtime_error("Call object cannot be created with a Null prototype!");
98        }
99        if (args.size() != cast<Prototype>(prototype)->getNumOfParameters()) {
100            throw std::runtime_error("Invalid number of arguments passed into Call object!");
101        }
102        return createCall(static_cast<PabloAST *>(prototype), args);
103    }
104
105    Assign * createAssign(const std::string && prefix, PabloAST * const expr);
106
107    inline Var * createVar(const std::string name, const PabloType * const type) {
108        return createVar(getName(name, false), type);
109    }
110
111    inline Var * createVar(String * name, const PabloType * const type) {
112        return createVar(cast<PabloAST>(name), type);
113    }
114
115    Next * createNext(Assign * assign, PabloAST * expr);
116
117    PabloAST * createAnd(PabloAST * expr1, PabloAST * expr2);
118
119    PabloAST * createAnd(PabloAST * expr1, PabloAST * expr2, const std::string prefix);
120
121    And * createAnd(const PabloType * const type, const unsigned reserved);
122
123    And * createAnd(const PabloType * const type, const unsigned reserved, const std::string prefix);
124
125    And * createAnd(const PabloType * const type, std::vector<PabloAST *>::iterator begin, std::vector<PabloAST *>::iterator end);
126
127    And * createAnd(const PabloType * const type, Variadic::iterator begin, Variadic::iterator end);
128
129    PabloAST * createNot(PabloAST * expr);
130
131    PabloAST * createNot(PabloAST * expr, const std::string prefix);
132
133    PabloAST * createOr(PabloAST * expr1, PabloAST * expr2);
134
135    PabloAST * createOr(PabloAST * expr1, PabloAST * expr2, const std::string prefix);
136
137    Or * createOr(const PabloType * const type, std::vector<PabloAST *>::iterator begin, std::vector<PabloAST *>::iterator end);
138
139    Or * createOr(const PabloType * const type, Variadic::iterator begin, Variadic::iterator end);
140
141    Or * createOr(const PabloType * const type, const unsigned reserved);
142
143    Or * createOr(const PabloType * const type, const unsigned reserved, const std::string prefix);
144
145    PabloAST * createXor(PabloAST * expr1, PabloAST * expr2);
146
147    PabloAST * createXor(PabloAST * expr1, PabloAST * expr2, const std::string prefix);
148
149    Xor * createXor(const PabloType * const type, std::vector<PabloAST *>::iterator begin, std::vector<PabloAST *>::iterator end);
150
151    Xor * createXor(const PabloType * const type, Variadic::iterator begin, Variadic::iterator end);
152
153    Xor * createXor(const PabloType * const type, const unsigned reserved);
154
155    Xor * createXor(const PabloType * const type, const unsigned reserved, const std::string prefix);
156
157    PabloAST * createMatchStar(PabloAST * marker, PabloAST * charclass);
158
159    PabloAST * createMatchStar(PabloAST * marker, PabloAST * charclass, const std::string prefix);
160
161    PabloAST * createScanThru(PabloAST * from, PabloAST * thru);
162
163    PabloAST * createScanThru(PabloAST * from, PabloAST * thru, const std::string prefix);
164
165    PabloAST * createSel(PabloAST * condition, PabloAST * trueExpr, PabloAST * falseExpr);
166
167    PabloAST * createSel(PabloAST * condition, PabloAST * trueExpr, PabloAST * falseExpr, const std::string prefix);
168
169    Count * createCount(const std::string counter, PabloAST * const expr);
170   
171    PabloAST * createInFile(PabloAST * expr);
172   
173    PabloAST * createInFile(PabloAST * expr, const std::string prefix);
174   
175    PabloAST * createAtEOF(PabloAST * expr);
176   
177    PabloAST * createAtEOF(PabloAST * expr, const std::string prefix);
178   
179    If * createIf(PabloAST * condition, const std::initializer_list<Assign *> definedVars, PabloBlock * body);
180
181    If * createIf(PabloAST * condition, const std::vector<Assign *> & definedVars, PabloBlock * body);
182
183    If * createIf(PabloAST * condition, std::vector<Assign *> && definedVars, PabloBlock * body);
184
185    While * createWhile(PabloAST * condition, const std::initializer_list<Next *> nextVars, PabloBlock * body);
186
187    While * createWhile(PabloAST * condition, const std::vector<Next *> & nextVars, PabloBlock * body);
188
189    While * createWhile(PabloAST * condition, std::vector<Next *> && nextVars, PabloBlock * body);
190
191    inline StatementList & statements() {
192        return *this;
193    }
194
195    inline const StatementList & statements() const {
196        return *this;
197    }
198
199    inline String * getName(const std::string name, const bool generated = true) const {
200        return getSymbolTable()->get(name, generated);
201    }
202
203    inline String * makeName(const std::string prefix, const bool generated = true) const {
204        return getSymbolTable()->make(prefix, generated);
205    }
206
207    inline Integer * getInteger(Integer::Type value) {
208        return getSymbolTable()->getInteger(value);
209    }
210
211    inline PabloBlock * getPredecessor() const {
212        return mPredecessor;
213    }
214   
215    void setPredecessor(PabloBlock * const predecessor) {
216        mPredecessor = predecessor;
217    }
218
219    inline PabloFunction * getParent() const {
220        return mParent;
221    }
222
223    void setParent(PabloFunction * const parent) {
224        mParent = parent;
225    }
226
227    void insert(Statement * const statement);
228
229    unsigned enumerateScopes(unsigned baseScopeIndex);
230   
231    inline unsigned getScopeIndex() const {
232        return mScopeIndex;
233    }
234   
235    void eraseFromParent(const bool recursively = false);
236
237    inline Statement * getBranch() const {
238        return mBranch;
239    }
240
241    SymbolGenerator * getSymbolTable() const {
242        return mParent->getSymbolTable();
243    }
244
245    virtual ~PabloBlock();
246
247protected:
248
249    explicit PabloBlock(PabloFunction * parent, PabloBlock * predecessor) noexcept;
250
251    PabloAST * renameNonNamedNode(PabloAST * expr, const std::string && prefix);
252
253    template<typename Type>
254    inline Type * insertAtInsertionPoint(Type * expr) {
255        if (isa<Statement>(expr)) {
256            if (LLVM_UNLIKELY(isa<If>(expr) || isa<While>(expr))) {
257                PabloBlock * const body = isa<If>(expr) ? cast<If>(expr)->getBody() : cast<While>(expr)->getBody();
258                body->setPredecessor (this);
259                addUser(body);
260            }
261            insert(cast<Statement>(expr));
262        }
263        return expr;
264    }
265
266    inline void setBranch(Statement * const branch) {
267        mBranch = branch;
268    }
269
270private:
271
272    Call * createCall(PabloAST * prototype, const std::vector<PabloAST *> &);
273
274    Var * createVar(PabloAST * name, const PabloType * const type);
275
276private:       
277    PabloFunction *                                     mParent;
278    PabloBlock *                                        mPredecessor;
279    Statement *                                         mBranch; // What statement branches into this scope block?
280    unsigned                                            mScopeIndex;
281};
282
283}
284
285#endif // PS_PABLOS_H
Note: See TracBrowser for help on using the repository browser.