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 | // Declaration.h -- |
---|
8 | // |
---|
9 | // Author : Richard C. Bilson |
---|
10 | // Created On : Mon May 18 07:44:20 2015 |
---|
11 | // Last Modified By : Peter A. Buhr |
---|
12 | // Last Modified On : Sun Sep 3 19:24:06 2017 |
---|
13 | // Update Count : 131 |
---|
14 | // |
---|
15 | |
---|
16 | #pragma once |
---|
17 | |
---|
18 | #include <cassert> // for assertf |
---|
19 | #include <iosfwd> // for ostream |
---|
20 | #include <list> // for list |
---|
21 | #include <string> // for string, operator+, allocator, to_string |
---|
22 | |
---|
23 | #include "BaseSyntaxNode.h" // for BaseSyntaxNode |
---|
24 | #include "Mutator.h" // for Mutator |
---|
25 | #include "Parser/LinkageSpec.h" // for Spec, Cforall |
---|
26 | #include "Parser/ParseNode.h" // for DeclarationNode, DeclarationNode::Ag... |
---|
27 | #include "SynTree.h" // for UniqueId |
---|
28 | #include "SynTree/Type.h" // for Type, Type::StorageClasses, Type::Fu... |
---|
29 | #include "Visitor.h" // for Visitor |
---|
30 | |
---|
31 | class AsmStmt; |
---|
32 | class Attribute; |
---|
33 | class CompoundStmt; |
---|
34 | class ConstantExpr; |
---|
35 | class Expression; |
---|
36 | class Initializer; |
---|
37 | class TypeDecl; |
---|
38 | |
---|
39 | class Declaration : public BaseSyntaxNode { |
---|
40 | public: |
---|
41 | std::string name; |
---|
42 | LinkageSpec::Spec linkage; |
---|
43 | bool extension = false; |
---|
44 | |
---|
45 | Declaration( const std::string &name, Type::StorageClasses scs, LinkageSpec::Spec linkage ); |
---|
46 | Declaration( const Declaration &other ); |
---|
47 | virtual ~Declaration(); |
---|
48 | |
---|
49 | const std::string &get_name() const { return name; } |
---|
50 | void set_name( std::string newValue ) { name = newValue; } |
---|
51 | |
---|
52 | Type::StorageClasses get_storageClasses() const { return storageClasses; } |
---|
53 | |
---|
54 | LinkageSpec::Spec get_linkage() const { return linkage; } |
---|
55 | void set_linkage( LinkageSpec::Spec newValue ) { linkage = newValue; } |
---|
56 | |
---|
57 | UniqueId get_uniqueId() const { return uniqueId; } |
---|
58 | |
---|
59 | bool get_extension() const { return extension; } |
---|
60 | Declaration *set_extension( bool exten ) { extension = exten; return this; } |
---|
61 | |
---|
62 | void fixUniqueId( void ); |
---|
63 | virtual Declaration *clone() const = 0; |
---|
64 | virtual void accept( Visitor &v ) override = 0; |
---|
65 | virtual Declaration *acceptMutator( Mutator &m ) = 0; |
---|
66 | virtual void print( std::ostream &os, int indent = 0 ) const override = 0; |
---|
67 | virtual void printShort( std::ostream &os, int indent = 0 ) const = 0; |
---|
68 | |
---|
69 | static void dumpIds( std::ostream &os ); |
---|
70 | static Declaration *declFromId( UniqueId id ); |
---|
71 | |
---|
72 | private: |
---|
73 | Type::StorageClasses storageClasses; |
---|
74 | UniqueId uniqueId; |
---|
75 | }; |
---|
76 | |
---|
77 | class DeclarationWithType : public Declaration { |
---|
78 | public: |
---|
79 | // this represents the type with all types and typedefs expanded it is generated by SymTab::Validate::Pass2 |
---|
80 | std::string mangleName; |
---|
81 | // need to remember the scope level at which the variable was declared, so that shadowed identifiers can be accessed |
---|
82 | int scopeLevel = 0; |
---|
83 | |
---|
84 | Expression *asmName; |
---|
85 | std::list< Attribute * > attributes; |
---|
86 | |
---|
87 | DeclarationWithType( const std::string &name, Type::StorageClasses scs, LinkageSpec::Spec linkage, const std::list< Attribute * > & attributes, Type::FuncSpecifiers fs ); |
---|
88 | DeclarationWithType( const DeclarationWithType &other ); |
---|
89 | virtual ~DeclarationWithType(); |
---|
90 | |
---|
91 | std::string get_mangleName() const { return mangleName; } |
---|
92 | DeclarationWithType * set_mangleName( std::string newValue ) { mangleName = newValue; return this; } |
---|
93 | |
---|
94 | std::string get_scopedMangleName() const { return mangleName + "_" + std::to_string(scopeLevel); } |
---|
95 | |
---|
96 | int get_scopeLevel() const { return scopeLevel; } |
---|
97 | DeclarationWithType * set_scopeLevel( int newValue ) { scopeLevel = newValue; return this; } |
---|
98 | |
---|
99 | Expression *get_asmName() const { return asmName; } |
---|
100 | DeclarationWithType * set_asmName( Expression *newValue ) { asmName = newValue; return this; } |
---|
101 | |
---|
102 | std::list< Attribute * >& get_attributes() { return attributes; } |
---|
103 | const std::list< Attribute * >& get_attributes() const { return attributes; } |
---|
104 | |
---|
105 | Type::FuncSpecifiers get_funcSpec() const { return fs; } |
---|
106 | //void set_functionSpecifiers( Type::FuncSpecifiers newValue ) { fs = newValue; } |
---|
107 | |
---|
108 | virtual DeclarationWithType *clone() const override = 0; |
---|
109 | virtual DeclarationWithType *acceptMutator( Mutator &m ) override = 0; |
---|
110 | |
---|
111 | virtual Type * get_type() const = 0; |
---|
112 | virtual void set_type(Type *) = 0; |
---|
113 | |
---|
114 | private: |
---|
115 | Type::FuncSpecifiers fs; |
---|
116 | }; |
---|
117 | |
---|
118 | class ObjectDecl : public DeclarationWithType { |
---|
119 | typedef DeclarationWithType Parent; |
---|
120 | public: |
---|
121 | Type *type; |
---|
122 | Initializer *init; |
---|
123 | Expression *bitfieldWidth; |
---|
124 | |
---|
125 | ObjectDecl( const std::string &name, Type::StorageClasses scs, LinkageSpec::Spec linkage, Expression *bitfieldWidth, Type *type, Initializer *init, |
---|
126 | const std::list< Attribute * > attributes = std::list< Attribute * >(), Type::FuncSpecifiers fs = Type::FuncSpecifiers() ); |
---|
127 | ObjectDecl( const ObjectDecl &other ); |
---|
128 | virtual ~ObjectDecl(); |
---|
129 | |
---|
130 | virtual Type * get_type() const override { return type; } |
---|
131 | virtual void set_type(Type *newType) override { type = newType; } |
---|
132 | |
---|
133 | Initializer *get_init() const { return init; } |
---|
134 | void set_init( Initializer *newValue ) { init = newValue; } |
---|
135 | |
---|
136 | Expression *get_bitfieldWidth() const { return bitfieldWidth; } |
---|
137 | void set_bitfieldWidth( Expression *newValue ) { bitfieldWidth = newValue; } |
---|
138 | |
---|
139 | static ObjectDecl * newObject( const std::string & name, Type * type, Initializer * init ); |
---|
140 | |
---|
141 | virtual ObjectDecl *clone() const override { return new ObjectDecl( *this ); } |
---|
142 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
143 | virtual DeclarationWithType *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
144 | virtual void print( std::ostream &os, int indent = 0 ) const override; |
---|
145 | virtual void printShort( std::ostream &os, int indent = 0 ) const override; |
---|
146 | }; |
---|
147 | |
---|
148 | class FunctionDecl : public DeclarationWithType { |
---|
149 | typedef DeclarationWithType Parent; |
---|
150 | public: |
---|
151 | FunctionType *type; |
---|
152 | CompoundStmt *statements; |
---|
153 | |
---|
154 | FunctionDecl( const std::string &name, Type::StorageClasses scs, LinkageSpec::Spec linkage, FunctionType *type, CompoundStmt *statements, |
---|
155 | const std::list< Attribute * > attributes = std::list< Attribute * >(), Type::FuncSpecifiers fs = Type::FuncSpecifiers() ); |
---|
156 | FunctionDecl( const FunctionDecl &other ); |
---|
157 | virtual ~FunctionDecl(); |
---|
158 | |
---|
159 | virtual Type * get_type() const override { return type; } |
---|
160 | virtual void set_type(Type * t) override { type = strict_dynamic_cast< FunctionType* >( t ); } |
---|
161 | |
---|
162 | FunctionType * get_functionType() const { return type; } |
---|
163 | void set_functionType( FunctionType *newValue ) { type = newValue; } |
---|
164 | CompoundStmt *get_statements() const { return statements; } |
---|
165 | void set_statements( CompoundStmt *newValue ) { statements = newValue; } |
---|
166 | |
---|
167 | static FunctionDecl * newFunction( const std::string & name, FunctionType * type, CompoundStmt * statements ); |
---|
168 | |
---|
169 | virtual FunctionDecl *clone() const override { return new FunctionDecl( *this ); } |
---|
170 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
171 | virtual DeclarationWithType *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
172 | virtual void print( std::ostream &os, int indent = 0 ) const override; |
---|
173 | virtual void printShort( std::ostream &os, int indent = 0 ) const override; |
---|
174 | }; |
---|
175 | |
---|
176 | class NamedTypeDecl : public Declaration { |
---|
177 | typedef Declaration Parent; |
---|
178 | public: |
---|
179 | Type *base; |
---|
180 | std::list< TypeDecl* > parameters; |
---|
181 | std::list< DeclarationWithType* > assertions; |
---|
182 | |
---|
183 | NamedTypeDecl( const std::string &name, Type::StorageClasses scs, Type *type ); |
---|
184 | NamedTypeDecl( const NamedTypeDecl &other ); |
---|
185 | virtual ~NamedTypeDecl(); |
---|
186 | |
---|
187 | Type *get_base() const { return base; } |
---|
188 | void set_base( Type *newValue ) { base = newValue; } |
---|
189 | std::list< TypeDecl* >& get_parameters() { return parameters; } |
---|
190 | std::list< DeclarationWithType* >& get_assertions() { return assertions; } |
---|
191 | |
---|
192 | virtual std::string typeString() const = 0; |
---|
193 | |
---|
194 | virtual NamedTypeDecl *clone() const override = 0; |
---|
195 | virtual void print( std::ostream &os, int indent = 0 ) const override; |
---|
196 | virtual void printShort( std::ostream &os, int indent = 0 ) const override; |
---|
197 | }; |
---|
198 | |
---|
199 | class TypeDecl : public NamedTypeDecl { |
---|
200 | typedef NamedTypeDecl Parent; |
---|
201 | public: |
---|
202 | enum Kind { Any, Dtype, Ftype, Ttype }; |
---|
203 | |
---|
204 | Type * init; |
---|
205 | bool sized; |
---|
206 | |
---|
207 | /// Data extracted from a type decl |
---|
208 | struct Data { |
---|
209 | TypeDecl::Kind kind; |
---|
210 | bool isComplete; |
---|
211 | Data() : kind( (TypeDecl::Kind)-1 ), isComplete( false ) {} |
---|
212 | Data( TypeDecl * typeDecl ) : Data( typeDecl->get_kind(), typeDecl->isComplete() ) {} |
---|
213 | Data( Kind kind, bool isComplete ) : kind( kind ), isComplete( isComplete ) {} |
---|
214 | bool operator==(const Data & other) const { return kind == other.kind && isComplete == other.isComplete; } |
---|
215 | bool operator!=(const Data & other) const { return !(*this == other);} |
---|
216 | }; |
---|
217 | |
---|
218 | TypeDecl( const std::string &name, Type::StorageClasses scs, Type *type, Kind kind, Type * init = nullptr ); |
---|
219 | TypeDecl( const TypeDecl &other ); |
---|
220 | virtual ~TypeDecl(); |
---|
221 | |
---|
222 | Kind get_kind() const { return kind; } |
---|
223 | |
---|
224 | Type * get_init() const { return init; } |
---|
225 | TypeDecl * set_init( Type * newValue ) { init = newValue; return this; } |
---|
226 | |
---|
227 | bool isComplete() const { return kind == Any || sized; } |
---|
228 | bool get_sized() const { return sized; } |
---|
229 | TypeDecl * set_sized( bool newValue ) { sized = newValue; return this; } |
---|
230 | |
---|
231 | virtual std::string typeString() const override; |
---|
232 | virtual std::string genTypeString() const; |
---|
233 | |
---|
234 | virtual TypeDecl *clone() const override { return new TypeDecl( *this ); } |
---|
235 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
236 | virtual Declaration *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
237 | virtual void print( std::ostream &os, int indent = 0 ) const override; |
---|
238 | |
---|
239 | private: |
---|
240 | Kind kind; |
---|
241 | }; |
---|
242 | |
---|
243 | class TypedefDecl : public NamedTypeDecl { |
---|
244 | typedef NamedTypeDecl Parent; |
---|
245 | public: |
---|
246 | TypedefDecl( const std::string &name, Type::StorageClasses scs, Type *type, LinkageSpec::Spec spec = LinkageSpec::Cforall ) : Parent( name, scs, type ) { set_linkage( spec ); } |
---|
247 | TypedefDecl( const TypedefDecl &other ) : Parent( other ) {} |
---|
248 | |
---|
249 | virtual std::string typeString() const override; |
---|
250 | |
---|
251 | virtual TypedefDecl *clone() const override { return new TypedefDecl( *this ); } |
---|
252 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
253 | virtual Declaration *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
254 | private: |
---|
255 | }; |
---|
256 | |
---|
257 | class AggregateDecl : public Declaration { |
---|
258 | typedef Declaration Parent; |
---|
259 | public: |
---|
260 | std::list<Declaration*> members; |
---|
261 | std::list<TypeDecl*> parameters; |
---|
262 | bool body; |
---|
263 | std::list< Attribute * > attributes; |
---|
264 | |
---|
265 | AggregateDecl( const std::string &name, const std::list< Attribute * > & attributes = std::list< class Attribute * >(), LinkageSpec::Spec linkage = LinkageSpec::Cforall ); |
---|
266 | AggregateDecl( const AggregateDecl &other ); |
---|
267 | virtual ~AggregateDecl(); |
---|
268 | |
---|
269 | std::list<Declaration*>& get_members() { return members; } |
---|
270 | std::list<TypeDecl*>& get_parameters() { return parameters; } |
---|
271 | |
---|
272 | std::list< Attribute * >& get_attributes() { return attributes; } |
---|
273 | const std::list< Attribute * >& get_attributes() const { return attributes; } |
---|
274 | |
---|
275 | bool has_body() const { return body; } |
---|
276 | AggregateDecl * set_body( bool body ) { AggregateDecl::body = body; return this; } |
---|
277 | |
---|
278 | virtual void print( std::ostream &os, int indent = 0 ) const override; |
---|
279 | virtual void printShort( std::ostream &os, int indent = 0 ) const override; |
---|
280 | protected: |
---|
281 | virtual std::string typeString() const = 0; |
---|
282 | }; |
---|
283 | |
---|
284 | class StructDecl : public AggregateDecl { |
---|
285 | typedef AggregateDecl Parent; |
---|
286 | public: |
---|
287 | StructDecl( const std::string &name, DeclarationNode::Aggregate kind = DeclarationNode::Struct, const std::list< Attribute * > & attributes = std::list< class Attribute * >(), LinkageSpec::Spec linkage = LinkageSpec::Cforall ) : Parent( name, attributes, linkage ), kind( kind ) {} |
---|
288 | StructDecl( const StructDecl &other ) : Parent( other ), kind( other.kind ) {} |
---|
289 | |
---|
290 | bool is_coroutine() { return kind == DeclarationNode::Coroutine; } |
---|
291 | bool is_monitor() { return kind == DeclarationNode::Monitor; } |
---|
292 | bool is_thread() { return kind == DeclarationNode::Thread; } |
---|
293 | |
---|
294 | virtual StructDecl *clone() const override { return new StructDecl( *this ); } |
---|
295 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
296 | virtual Declaration *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
297 | private: |
---|
298 | DeclarationNode::Aggregate kind; |
---|
299 | virtual std::string typeString() const override; |
---|
300 | }; |
---|
301 | |
---|
302 | class UnionDecl : public AggregateDecl { |
---|
303 | typedef AggregateDecl Parent; |
---|
304 | public: |
---|
305 | UnionDecl( const std::string &name, const std::list< Attribute * > & attributes = std::list< class Attribute * >(), LinkageSpec::Spec linkage = LinkageSpec::Cforall ) : Parent( name, attributes, linkage ) {} |
---|
306 | UnionDecl( const UnionDecl &other ) : Parent( other ) {} |
---|
307 | |
---|
308 | virtual UnionDecl *clone() const override { return new UnionDecl( *this ); } |
---|
309 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
310 | virtual Declaration *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
311 | private: |
---|
312 | virtual std::string typeString() const override; |
---|
313 | }; |
---|
314 | |
---|
315 | class EnumDecl : public AggregateDecl { |
---|
316 | typedef AggregateDecl Parent; |
---|
317 | public: |
---|
318 | EnumDecl( const std::string &name, const std::list< Attribute * > & attributes = std::list< class Attribute * >(), LinkageSpec::Spec linkage = LinkageSpec::Cforall ) : Parent( name, attributes, linkage ) {} |
---|
319 | EnumDecl( const EnumDecl &other ) : Parent( other ) {} |
---|
320 | |
---|
321 | virtual EnumDecl *clone() const override { return new EnumDecl( *this ); } |
---|
322 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
323 | virtual Declaration *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
324 | private: |
---|
325 | virtual std::string typeString() const override; |
---|
326 | }; |
---|
327 | |
---|
328 | class TraitDecl : public AggregateDecl { |
---|
329 | typedef AggregateDecl Parent; |
---|
330 | public: |
---|
331 | TraitDecl( const std::string &name, const std::list< Attribute * > & attributes, LinkageSpec::Spec linkage ) : Parent( name, attributes, linkage ) { |
---|
332 | assertf( attributes.empty(), "attribute unsupported for traits" ); |
---|
333 | } |
---|
334 | TraitDecl( const TraitDecl &other ) : Parent( other ) {} |
---|
335 | |
---|
336 | virtual TraitDecl *clone() const override { return new TraitDecl( *this ); } |
---|
337 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
338 | virtual Declaration *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
339 | private: |
---|
340 | virtual std::string typeString() const override; |
---|
341 | }; |
---|
342 | |
---|
343 | class AsmDecl : public Declaration { |
---|
344 | public: |
---|
345 | AsmStmt *stmt; |
---|
346 | |
---|
347 | AsmDecl( AsmStmt *stmt ); |
---|
348 | AsmDecl( const AsmDecl &other ); |
---|
349 | virtual ~AsmDecl(); |
---|
350 | |
---|
351 | AsmStmt *get_stmt() { return stmt; } |
---|
352 | void set_stmt( AsmStmt *newValue ) { stmt = newValue; } |
---|
353 | |
---|
354 | virtual AsmDecl *clone() const override { return new AsmDecl( *this ); } |
---|
355 | virtual void accept( Visitor &v ) override { v.visit( this ); } |
---|
356 | virtual AsmDecl *acceptMutator( Mutator &m ) override { return m.mutate( this ); } |
---|
357 | virtual void print( std::ostream &os, int indent = 0 ) const override; |
---|
358 | virtual void printShort( std::ostream &os, int indent = 0 ) const override; |
---|
359 | }; |
---|
360 | |
---|
361 | std::ostream & operator<<( std::ostream & os, const TypeDecl::Data & data ); |
---|
362 | |
---|
363 | // Local Variables: // |
---|
364 | // tab-width: 4 // |
---|
365 | // mode: c++ // |
---|
366 | // compile-command: "make install" // |
---|
367 | // End: // |
---|