1 | // |
---|
2 | // Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo |
---|
3 | // |
---|
4 | // The contents of this file are covered under the licence agreement in the |
---|
5 | // file "LICENCE" distributed with Cforall. |
---|
6 | // |
---|
7 | // Decl.hpp -- |
---|
8 | // |
---|
9 | // Author : Aaron B. Moss |
---|
10 | // Created On : Thu May 9 10:00:00 2019 |
---|
11 | // Last Modified By : Peter A. Buhr |
---|
12 | // Last Modified On : Fri Mar 12 18:25:05 2021 |
---|
13 | // Update Count : 32 |
---|
14 | // |
---|
15 | |
---|
16 | #pragma once |
---|
17 | |
---|
18 | #include <iosfwd> |
---|
19 | #include <string> // for string, to_string |
---|
20 | #include <unordered_map> |
---|
21 | #include <vector> |
---|
22 | #include <algorithm> |
---|
23 | |
---|
24 | #include "FunctionSpec.hpp" |
---|
25 | #include "Fwd.hpp" // for UniqueId |
---|
26 | #include "LinkageSpec.hpp" |
---|
27 | #include "Node.hpp" // for ptr, readonly |
---|
28 | #include "ParseNode.hpp" |
---|
29 | #include "StorageClasses.hpp" |
---|
30 | #include "Visitor.hpp" |
---|
31 | #include "Common/utility.h" |
---|
32 | #include "Common/SemanticError.h" // error_str |
---|
33 | |
---|
34 | // Must be included in *all* AST classes; should be #undef'd at the end of the file |
---|
35 | #define MUTATE_FRIEND \ |
---|
36 | template<typename node_t> friend node_t * mutate(const node_t * node); \ |
---|
37 | template<typename node_t> friend node_t * shallowCopy(const node_t * node); |
---|
38 | |
---|
39 | namespace ast { |
---|
40 | |
---|
41 | /// Base declaration class |
---|
42 | class Decl : public ParseNode { |
---|
43 | public: |
---|
44 | std::string name; |
---|
45 | Storage::Classes storage; |
---|
46 | Linkage::Spec linkage; |
---|
47 | UniqueId uniqueId = 0; |
---|
48 | bool extension = false; |
---|
49 | |
---|
50 | Decl( const CodeLocation& loc, const std::string& name, Storage::Classes storage, |
---|
51 | Linkage::Spec linkage ) |
---|
52 | : ParseNode( loc ), name( name ), storage( storage ), linkage( linkage ) {} |
---|
53 | |
---|
54 | Decl* set_extension( bool ex ) { extension = ex; return this; } |
---|
55 | |
---|
56 | /// Ensures this node has a unique ID |
---|
57 | void fixUniqueId(); |
---|
58 | /// Get canonical declaration for unique ID |
---|
59 | static readonly<Decl> fromId( UniqueId id ); |
---|
60 | |
---|
61 | const Decl * accept( Visitor & v ) const override = 0; |
---|
62 | private: |
---|
63 | Decl * clone() const override = 0; |
---|
64 | MUTATE_FRIEND |
---|
65 | }; |
---|
66 | |
---|
67 | /// Typed declaration base class |
---|
68 | class DeclWithType : public Decl { |
---|
69 | public: |
---|
70 | /// Represents the type with all types and typedefs expanded. |
---|
71 | /// This field is generated by SymTab::Validate::Pass2 |
---|
72 | std::string mangleName; |
---|
73 | /// Stores the scope level at which the variable was declared. |
---|
74 | /// Used to access shadowed identifiers. |
---|
75 | int scopeLevel = 0; |
---|
76 | |
---|
77 | std::vector<ptr<Attribute>> attributes; |
---|
78 | Function::Specs funcSpec; |
---|
79 | ptr<Expr> asmName; |
---|
80 | bool isDeleted = false; |
---|
81 | bool isTypeFixed = false; |
---|
82 | |
---|
83 | DeclWithType( const CodeLocation& loc, const std::string& name, Storage::Classes storage, |
---|
84 | Linkage::Spec linkage, std::vector<ptr<Attribute>>&& attrs, Function::Specs fs ) |
---|
85 | : Decl( loc, name, storage, linkage ), mangleName(), attributes( std::move(attrs) ), |
---|
86 | funcSpec(fs), asmName() {} |
---|
87 | |
---|
88 | std::string scopedMangleName() const { return mangleName + "_" + std::to_string(scopeLevel); } |
---|
89 | |
---|
90 | /// Get type of this declaration. May be generated by subclass |
---|
91 | virtual const Type * get_type() const = 0; |
---|
92 | /// Set type of this declaration. May be verified by subclass |
---|
93 | virtual void set_type( const Type * ) = 0; |
---|
94 | |
---|
95 | const DeclWithType * accept( Visitor & v ) const override = 0; |
---|
96 | private: |
---|
97 | DeclWithType * clone() const override = 0; |
---|
98 | MUTATE_FRIEND |
---|
99 | }; |
---|
100 | |
---|
101 | /// Object declaration `Foo foo = 42;` |
---|
102 | class ObjectDecl final : public DeclWithType { |
---|
103 | public: |
---|
104 | ptr<Type> type; |
---|
105 | ptr<Init> init; |
---|
106 | ptr<Expr> bitfieldWidth; |
---|
107 | |
---|
108 | ObjectDecl( const CodeLocation & loc, const std::string & name, const Type * type, |
---|
109 | const Init * init = nullptr, Storage::Classes storage = {}, |
---|
110 | Linkage::Spec linkage = Linkage::C, const Expr * bitWd = nullptr, |
---|
111 | std::vector< ptr<Attribute> > && attrs = {}, Function::Specs fs = {} ) |
---|
112 | : DeclWithType( loc, name, storage, linkage, std::move(attrs), fs ), type( type ), |
---|
113 | init( init ), bitfieldWidth( bitWd ) {} |
---|
114 | |
---|
115 | const Type* get_type() const override { return type; } |
---|
116 | void set_type( const Type * ty ) override { type = ty; } |
---|
117 | |
---|
118 | const DeclWithType * accept( Visitor& v ) const override { return v.visit( this ); } |
---|
119 | private: |
---|
120 | ObjectDecl * clone() const override { return new ObjectDecl{ *this }; } |
---|
121 | MUTATE_FRIEND |
---|
122 | }; |
---|
123 | |
---|
124 | /// Object declaration `int foo()` |
---|
125 | class FunctionDecl : public DeclWithType { |
---|
126 | public: |
---|
127 | std::vector<ptr<DeclWithType>> params; |
---|
128 | std::vector<ptr<DeclWithType>> returns; |
---|
129 | std::vector<ptr<TypeDecl>> type_params; |
---|
130 | std::vector<ptr<DeclWithType>> assertions; |
---|
131 | // declared type, derived from parameter declarations |
---|
132 | ptr<FunctionType> type; |
---|
133 | /// Null for the forward declaration of a function. |
---|
134 | ptr<CompoundStmt> stmts; |
---|
135 | std::vector< ptr<Expr> > withExprs; |
---|
136 | |
---|
137 | |
---|
138 | FunctionDecl( const CodeLocation & loc, const std::string & name, std::vector<ptr<TypeDecl>>&& forall, |
---|
139 | std::vector<ptr<DeclWithType>>&& params, std::vector<ptr<DeclWithType>>&& returns, |
---|
140 | CompoundStmt * stmts, Storage::Classes storage = {}, Linkage::Spec linkage = Linkage::C, |
---|
141 | std::vector<ptr<Attribute>>&& attrs = {}, Function::Specs fs = {}, bool isVarArgs = false); |
---|
142 | // : DeclWithType( loc, name, storage, linkage, std::move(attrs), fs ), params(std::move(params)), returns(std::move(returns)), |
---|
143 | // stmts( stmts ) {} |
---|
144 | |
---|
145 | const Type * get_type() const override; |
---|
146 | void set_type( const Type * t ) override; |
---|
147 | |
---|
148 | bool has_body() const { return stmts; } |
---|
149 | |
---|
150 | const DeclWithType * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
151 | private: |
---|
152 | FunctionDecl * clone() const override { return new FunctionDecl( *this ); } |
---|
153 | MUTATE_FRIEND |
---|
154 | }; |
---|
155 | |
---|
156 | /// Base class for named type aliases |
---|
157 | class NamedTypeDecl : public Decl { |
---|
158 | public: |
---|
159 | ptr<Type> base; |
---|
160 | std::vector<ptr<DeclWithType>> assertions; |
---|
161 | |
---|
162 | NamedTypeDecl( |
---|
163 | const CodeLocation & loc, const std::string & name, Storage::Classes storage, |
---|
164 | const Type * b, Linkage::Spec spec = Linkage::Cforall ) |
---|
165 | : Decl( loc, name, storage, spec ), base( b ), assertions() {} |
---|
166 | |
---|
167 | /// Produces a name for the kind of alias |
---|
168 | virtual const char * typeString() const = 0; |
---|
169 | |
---|
170 | private: |
---|
171 | NamedTypeDecl* clone() const override = 0; |
---|
172 | MUTATE_FRIEND |
---|
173 | }; |
---|
174 | |
---|
175 | /// Cforall type variable: `dtype T` |
---|
176 | class TypeDecl final : public NamedTypeDecl { |
---|
177 | public: |
---|
178 | enum Kind { Dtype, DStype, Otype, Ftype, Ttype, Dimension, NUMBER_OF_KINDS }; |
---|
179 | |
---|
180 | Kind kind; |
---|
181 | bool sized; |
---|
182 | ptr<Type> init; |
---|
183 | |
---|
184 | /// Data extracted from a type decl |
---|
185 | struct Data { |
---|
186 | Kind kind; |
---|
187 | bool isComplete; |
---|
188 | |
---|
189 | Data() : kind( NUMBER_OF_KINDS ), isComplete( false ) {} |
---|
190 | Data( const TypeDecl * d ) : kind( d->kind ), isComplete( d->sized ) {} |
---|
191 | Data( Kind k, bool c ) : kind( k ), isComplete( c ) {} |
---|
192 | Data( const Data & d1, const Data & d2 ) |
---|
193 | : kind( d1.kind ), isComplete( d1.isComplete || d2.isComplete ) {} |
---|
194 | |
---|
195 | bool operator==( const Data & o ) const { return kind == o.kind && isComplete == o.isComplete; } |
---|
196 | bool operator!=( const Data & o ) const { return !(*this == o); } |
---|
197 | }; |
---|
198 | |
---|
199 | TypeDecl( |
---|
200 | const CodeLocation & loc, const std::string & name, Storage::Classes storage, |
---|
201 | const Type * b, TypeDecl::Kind k, bool s, const Type * i = nullptr ) |
---|
202 | : NamedTypeDecl( loc, name, storage, b ), kind( k ), sized( k == TypeDecl::Ttype || s ), |
---|
203 | init( i ) {} |
---|
204 | |
---|
205 | const char * typeString() const override; |
---|
206 | /// Produces a name for generated code |
---|
207 | const char * genTypeString() const; |
---|
208 | |
---|
209 | /// convenience accessor to match Type::isComplete() |
---|
210 | bool isComplete() { return sized; } |
---|
211 | |
---|
212 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
213 | private: |
---|
214 | TypeDecl * clone() const override { return new TypeDecl{ *this }; } |
---|
215 | MUTATE_FRIEND |
---|
216 | }; |
---|
217 | |
---|
218 | std::ostream & operator<< ( std::ostream &, const TypeDecl::Data & ); |
---|
219 | |
---|
220 | /// C-style typedef `typedef Foo Bar` |
---|
221 | class TypedefDecl final : public NamedTypeDecl { |
---|
222 | public: |
---|
223 | TypedefDecl( const CodeLocation& loc, const std::string& name, Storage::Classes storage, |
---|
224 | Type* b, Linkage::Spec spec = Linkage::Cforall ) |
---|
225 | : NamedTypeDecl( loc, name, storage, b, spec ) {} |
---|
226 | |
---|
227 | const char * typeString() const override { return "typedef"; } |
---|
228 | |
---|
229 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
230 | private: |
---|
231 | TypedefDecl * clone() const override { return new TypedefDecl{ *this }; } |
---|
232 | MUTATE_FRIEND |
---|
233 | }; |
---|
234 | |
---|
235 | /// Aggregate type declaration base class |
---|
236 | class AggregateDecl : public Decl { |
---|
237 | public: |
---|
238 | enum Aggregate { Struct, Union, Enum, Exception, Trait, Generator, Coroutine, Monitor, Thread, NoAggregate }; |
---|
239 | static const char * aggrString( Aggregate aggr ); |
---|
240 | |
---|
241 | std::vector<ptr<Decl>> members; |
---|
242 | std::vector<ptr<TypeDecl>> params; |
---|
243 | std::vector<ptr<Attribute>> attributes; |
---|
244 | bool body = false; |
---|
245 | readonly<AggregateDecl> parent = {}; |
---|
246 | |
---|
247 | AggregateDecl( const CodeLocation& loc, const std::string& name, |
---|
248 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
249 | : Decl( loc, name, Storage::Classes{}, linkage ), members(), params(), |
---|
250 | attributes( std::move(attrs) ) {} |
---|
251 | |
---|
252 | AggregateDecl* set_body( bool b ) { body = b; return this; } |
---|
253 | |
---|
254 | /// Produces a name for the kind of aggregate |
---|
255 | virtual const char * typeString() const = 0; |
---|
256 | |
---|
257 | private: |
---|
258 | AggregateDecl * clone() const override = 0; |
---|
259 | MUTATE_FRIEND |
---|
260 | }; |
---|
261 | |
---|
262 | /// struct declaration `struct Foo { ... };` |
---|
263 | class StructDecl final : public AggregateDecl { |
---|
264 | public: |
---|
265 | Aggregate kind; |
---|
266 | |
---|
267 | StructDecl( const CodeLocation& loc, const std::string& name, |
---|
268 | Aggregate kind = Struct, |
---|
269 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
270 | : AggregateDecl( loc, name, std::move(attrs), linkage ), kind( kind ) {} |
---|
271 | |
---|
272 | bool is_coroutine() { return kind == Coroutine; } |
---|
273 | bool is_generator() { return kind == Generator; } |
---|
274 | bool is_monitor () { return kind == Monitor ; } |
---|
275 | bool is_thread () { return kind == Thread ; } |
---|
276 | |
---|
277 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
278 | |
---|
279 | const char * typeString() const override { return aggrString( kind ); } |
---|
280 | |
---|
281 | private: |
---|
282 | StructDecl * clone() const override { return new StructDecl{ *this }; } |
---|
283 | MUTATE_FRIEND |
---|
284 | }; |
---|
285 | |
---|
286 | /// union declaration `union Foo { ... };` |
---|
287 | class UnionDecl final : public AggregateDecl { |
---|
288 | public: |
---|
289 | UnionDecl( const CodeLocation& loc, const std::string& name, |
---|
290 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
291 | : AggregateDecl( loc, name, std::move(attrs), linkage ) {} |
---|
292 | |
---|
293 | const Decl * accept( Visitor& v ) const override { return v.visit( this ); } |
---|
294 | |
---|
295 | const char * typeString() const override { return aggrString( Union ); } |
---|
296 | |
---|
297 | private: |
---|
298 | UnionDecl * clone() const override { return new UnionDecl{ *this }; } |
---|
299 | MUTATE_FRIEND |
---|
300 | }; |
---|
301 | |
---|
302 | /// enum declaration `enum Foo { ... };` |
---|
303 | class EnumDecl final : public AggregateDecl { |
---|
304 | public: |
---|
305 | EnumDecl( const CodeLocation& loc, const std::string& name, |
---|
306 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
307 | : AggregateDecl( loc, name, std::move(attrs), linkage ), enumValues() {} |
---|
308 | |
---|
309 | /// gets the integer value for this enumerator, returning true iff value found |
---|
310 | bool valueOf( const Decl * enumerator, long long& value ) const; |
---|
311 | |
---|
312 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
313 | |
---|
314 | const char * typeString() const override { return aggrString( Enum ); } |
---|
315 | |
---|
316 | private: |
---|
317 | EnumDecl * clone() const override { return new EnumDecl{ *this }; } |
---|
318 | MUTATE_FRIEND |
---|
319 | |
---|
320 | /// Map from names to enumerator values; kept private for lazy initialization |
---|
321 | mutable std::unordered_map< std::string, long long > enumValues; |
---|
322 | }; |
---|
323 | |
---|
324 | /// trait declaration `trait Foo( ... ) { ... };` |
---|
325 | class TraitDecl final : public AggregateDecl { |
---|
326 | public: |
---|
327 | TraitDecl( const CodeLocation& loc, const std::string& name, |
---|
328 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
329 | : AggregateDecl( loc, name, std::move(attrs), linkage ) {} |
---|
330 | |
---|
331 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
332 | |
---|
333 | const char * typeString() const override { return "trait"; } |
---|
334 | |
---|
335 | private: |
---|
336 | TraitDecl * clone() const override { return new TraitDecl{ *this }; } |
---|
337 | MUTATE_FRIEND |
---|
338 | }; |
---|
339 | |
---|
340 | /// With statement `with (...) ...` |
---|
341 | class WithStmt final : public Decl { |
---|
342 | public: |
---|
343 | std::vector<ptr<Expr>> exprs; |
---|
344 | ptr<Stmt> stmt; |
---|
345 | |
---|
346 | WithStmt( const CodeLocation & loc, std::vector<ptr<Expr>> && exprs, const Stmt * stmt ) |
---|
347 | : Decl(loc, "", Storage::Auto, Linkage::Cforall), exprs(std::move(exprs)), stmt(stmt) {} |
---|
348 | |
---|
349 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
350 | private: |
---|
351 | WithStmt * clone() const override { return new WithStmt{ *this }; } |
---|
352 | MUTATE_FRIEND |
---|
353 | }; |
---|
354 | |
---|
355 | class AsmDecl : public Decl { |
---|
356 | public: |
---|
357 | ptr<AsmStmt> stmt; |
---|
358 | |
---|
359 | AsmDecl( const CodeLocation & loc, AsmStmt * stmt ) |
---|
360 | : Decl( loc, "", {}, {} ), stmt(stmt) {} |
---|
361 | |
---|
362 | const AsmDecl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
363 | private: |
---|
364 | AsmDecl * clone() const override { return new AsmDecl( *this ); } |
---|
365 | MUTATE_FRIEND |
---|
366 | }; |
---|
367 | |
---|
368 | /// C-preprocessor directive `#...` |
---|
369 | class DirectiveDecl : public Decl { |
---|
370 | public: |
---|
371 | ptr<DirectiveStmt> stmt; |
---|
372 | |
---|
373 | DirectiveDecl( const CodeLocation & loc, DirectiveStmt * stmt ) |
---|
374 | : Decl( loc, "", {}, {} ), stmt(stmt) {} |
---|
375 | |
---|
376 | const DirectiveDecl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
377 | private: |
---|
378 | DirectiveDecl * clone() const override { return new DirectiveDecl( *this ); } |
---|
379 | MUTATE_FRIEND |
---|
380 | }; |
---|
381 | |
---|
382 | class StaticAssertDecl : public Decl { |
---|
383 | public: |
---|
384 | ptr<Expr> cond; |
---|
385 | ptr<ConstantExpr> msg; // string literal |
---|
386 | |
---|
387 | StaticAssertDecl( const CodeLocation & loc, const Expr * condition, const ConstantExpr * msg ) |
---|
388 | : Decl( loc, "", {}, {} ), cond( condition ), msg( msg ) {} |
---|
389 | |
---|
390 | const StaticAssertDecl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
391 | private: |
---|
392 | StaticAssertDecl * clone() const override { return new StaticAssertDecl( *this ); } |
---|
393 | MUTATE_FRIEND |
---|
394 | }; |
---|
395 | |
---|
396 | } |
---|
397 | |
---|
398 | #undef MUTATE_FRIEND |
---|
399 | |
---|
400 | // Local Variables: // |
---|
401 | // tab-width: 4 // |
---|
402 | // mode: c++ // |
---|
403 | // compile-command: "make install" // |
---|
404 | // End: // |
---|