source: src/AST/Decl.hpp @ 89c2f7c9

arm-ehcleanup-dtorsenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprpthread-emulationqualifiedEnum
Last change on this file since 89c2f7c9 was 89c2f7c9, checked in by Aaron Moss <a3moss@…>, 4 years ago

Merge branch 'master' of plg.uwaterloo.ca:software/cfa/cfa-cc

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