source: src/AST/Decl.hpp @ 881f590

ADTarm-ehast-experimentalcleanup-dtorsenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprpthread-emulationqualifiedEnum
Last change on this file since 881f590 was e0115286, checked in by Thierry Delisle <tdelisle@…>, 5 years ago

Fix a cyclic dependency with ptr and nodes

  • Property mode set to 100644
File size: 12.7 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 "Type.hpp"            // for Type, ptr<Type>
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        virtual Decl* accept( Visitor& v ) override = 0;
60private:
61        virtual 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        virtual DeclWithType* accept( Visitor& v ) override = 0;
92private:
93        virtual 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        DeclWithType* accept( Visitor& v ) override { return v.visit( this ); }
113private:
114        ObjectDecl* clone() const override { return new ObjectDecl{ *this }; }
115};
116
117/// Base class for named type aliases
118class NamedTypeDecl : public Decl {
119public:
120        ptr<Type> base;
121        std::vector<ptr<TypeDecl>> parameters;
122        std::vector<ptr<DeclWithType>> assertions;
123
124        NamedTypeDecl( const CodeLocation& loc, const std::string& name, Storage::Classes storage,
125                Type* b, Linkage::Spec spec = Linkage::Cforall )
126        : Decl( loc, name, storage, spec ), base( b ), parameters(), assertions() {}
127
128        /// Produces a name for the kind of alias
129        virtual std::string typeString() const = 0;
130
131private:
132        NamedTypeDecl* clone() const override = 0;
133};
134
135/// Cforall type variable: `dtype T`
136class TypeDecl final : public NamedTypeDecl {
137public:
138        /// type variable variants. otype is a specialized dtype
139        enum Kind { Dtype, Ftype, Ttype, NUMBER_OF_KINDS } kind;
140        bool sized;
141        ptr<Type> init;
142
143        /// Data extracted from a type decl
144        struct Data {
145                Kind kind;
146                bool isComplete;
147
148                Data() : kind( (Kind)-1 ), isComplete( false ) {}
149                Data( TypeDecl* d ) : kind( d->kind ), isComplete( d->sized ) {}
150                Data( Kind k, bool c ) : kind( k ), isComplete( c ) {}
151                Data( const Data& d1, const Data& d2 )
152                : kind( d1.kind ), isComplete( d1.isComplete || d2.isComplete ) {}
153
154                bool operator== ( const Data& o ) const {
155                        return kind == o.kind && isComplete == o.isComplete;
156                }
157                bool operator!= ( const Data& o ) const { return !(*this == o); }
158        };
159
160        TypeDecl( const CodeLocation& loc, const std::string& name, Storage::Classes storage, Type* b,
161                Kind k, bool s, Type* i = nullptr )
162        : NamedTypeDecl( loc, name, storage, b ), kind( k ), sized( k == Ttype || s ), init( i ) {}
163
164        std::string typeString() const override;
165        /// Produces a name for generated code
166        std::string genTypeString() const;
167
168        Decl* accept( Visitor& v ) override { return v.visit( this ); }
169private:
170        TypeDecl* clone() const override { return new TypeDecl{ *this }; }
171};
172
173/// C-style typedef `typedef Foo Bar`
174class TypedefDecl final : public NamedTypeDecl {
175public:
176        TypedefDecl( const CodeLocation& loc, const std::string& name, Storage::Classes storage,
177                Type* b, Linkage::Spec spec = Linkage::Cforall )
178        : NamedTypeDecl( loc, name, storage, b, spec ) {}
179
180        std::string typeString() const override { return "typedef"; }
181
182        Decl* accept( Visitor& v ) override { return v.visit( this ); }
183private:
184        TypedefDecl* clone() const override { return new TypedefDecl{ *this }; }
185};
186
187/// Aggregate type declaration base class
188class AggregateDecl : public Decl {
189public:
190        std::vector<ptr<Decl>> members;
191        std::vector<ptr<TypeDecl>> parameters;
192        std::vector<ptr<Attribute>> attributes;
193        bool body = false;
194        readonly<AggregateDecl> parent = {};
195
196        AggregateDecl( const CodeLocation& loc, const std::string& name,
197                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
198        : Decl( loc, name, Storage::Classes{}, linkage ), members(), parameters(),
199          attributes( std::move(attrs) ) {}
200
201        AggregateDecl* set_body( bool b ) { body = b; return this; }
202
203protected:
204        /// Produces a name for the kind of aggregate
205        virtual std::string typeString() const = 0;
206};
207
208/// struct declaration `struct Foo { ... };`
209class StructDecl final : public AggregateDecl {
210public:
211        DeclarationNode::Aggregate kind;
212
213        StructDecl( const CodeLocation& loc, const std::string& name,
214                DeclarationNode::Aggregate kind = DeclarationNode::Struct,
215                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
216        : AggregateDecl( loc, name, std::move(attrs), linkage ), kind( kind ) {}
217
218        bool is_coroutine() { return kind == DeclarationNode::Coroutine; }
219        bool is_monitor() { return kind == DeclarationNode::Monitor; }
220        bool is_thread() { return kind == DeclarationNode::Thread; }
221
222        Decl* accept( Visitor& v ) override { return v.visit( this ); }
223private:
224        StructDecl* clone() const override { return new StructDecl{ *this }; }
225
226        std::string typeString() const override { return "struct"; }
227};
228
229/// union declaration `union Foo { ... };`
230class UnionDecl final : public AggregateDecl {
231public:
232        UnionDecl( const CodeLocation& loc, const std::string& name,
233                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
234        : AggregateDecl( loc, name, std::move(attrs), linkage ) {}
235
236        Decl* accept( Visitor& v ) override { return v.visit( this ); }
237private:
238        UnionDecl* clone() const override { return new UnionDecl{ *this }; }
239
240        std::string typeString() const override { return "union"; }
241};
242
243/// enum declaration `enum Foo { ... };`
244class EnumDecl final : public AggregateDecl {
245public:
246        EnumDecl( const CodeLocation& loc, const std::string& name,
247                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
248        : AggregateDecl( loc, name, std::move(attrs), linkage ), enumValues() {}
249
250        /// gets the integer value for this enumerator, returning true iff value found
251        bool valueOf( Decl* enumerator, long long& value ) const;
252
253        Decl* accept( Visitor& v ) override { return v.visit( this ); }
254private:
255        EnumDecl* clone() const override { return new EnumDecl{ *this }; }
256
257        std::string typeString() const override { return "enum"; }
258
259        /// Map from names to enumerator values; kept private for lazy initialization
260        mutable std::unordered_map< std::string, long long > enumValues;
261};
262
263/// trait declaration `trait Foo( ... ) { ... };`
264class TraitDecl final : public AggregateDecl {
265public:
266        TraitDecl( const CodeLocation& loc, const std::string& name,
267                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
268        : AggregateDecl( loc, name, std::move(attrs), linkage ) {}
269
270        Decl* accept( Visitor& v ) override { return v.visit( this ); }
271private:
272        TraitDecl* clone() const override { return new TraitDecl{ *this }; }
273
274        std::string typeString() const override { return "trait"; }
275};
276
277
278//=================================================================================================
279/// This disgusting and giant piece of boiler-plate is here to solve a cyclic dependency
280/// remove only if there is a better solution
281/// The problem is that ast::ptr< ... > uses increment/decrement which won't work well with
282/// forward declarations
283inline void increment( const class Decl * node, Node::ref_type ref ) { node->increment(ref); }
284inline void decrement( const class Decl * node, Node::ref_type ref ) { node->decrement(ref); }
285inline void increment( const class DeclWithType * node, Node::ref_type ref ) { node->increment(ref); }
286inline void decrement( const class DeclWithType * node, Node::ref_type ref ) { node->decrement(ref); }
287inline void increment( const class ObjectDecl * node, Node::ref_type ref ) { node->increment(ref); }
288inline void decrement( const class ObjectDecl * node, Node::ref_type ref ) { node->decrement(ref); }
289inline void increment( const class FunctionDecl * node, Node::ref_type ref ) { node->increment(ref); }
290inline void decrement( const class FunctionDecl * node, Node::ref_type ref ) { node->decrement(ref); }
291inline void increment( const class AggregateDecl * node, Node::ref_type ref ) { node->increment(ref); }
292inline void decrement( const class AggregateDecl * node, Node::ref_type ref ) { node->decrement(ref); }
293inline void increment( const class StructDecl * node, Node::ref_type ref ) { node->increment(ref); }
294inline void decrement( const class StructDecl * node, Node::ref_type ref ) { node->decrement(ref); }
295inline void increment( const class UnionDecl * node, Node::ref_type ref ) { node->increment(ref); }
296inline void decrement( const class UnionDecl * node, Node::ref_type ref ) { node->decrement(ref); }
297inline void increment( const class EnumDecl * node, Node::ref_type ref ) { node->increment(ref); }
298inline void decrement( const class EnumDecl * node, Node::ref_type ref ) { node->decrement(ref); }
299inline void increment( const class TraitDecl * node, Node::ref_type ref ) { node->increment(ref); }
300inline void decrement( const class TraitDecl * node, Node::ref_type ref ) { node->decrement(ref); }
301inline void increment( const class NamedTypeDecl * node, Node::ref_type ref ) { node->increment(ref); }
302inline void decrement( const class NamedTypeDecl * node, Node::ref_type ref ) { node->decrement(ref); }
303inline void increment( const class TypeDecl * node, Node::ref_type ref ) { node->increment(ref); }
304inline void decrement( const class TypeDecl * node, Node::ref_type ref ) { node->decrement(ref); }
305inline void increment( const class FtypeDecl * node, Node::ref_type ref ) { node->increment(ref); }
306inline void decrement( const class FtypeDecl * node, Node::ref_type ref ) { node->decrement(ref); }
307inline void increment( const class DtypeDecl * node, Node::ref_type ref ) { node->increment(ref); }
308inline void decrement( const class DtypeDecl * node, Node::ref_type ref ) { node->decrement(ref); }
309inline void increment( const class TypedefDecl * node, Node::ref_type ref ) { node->increment(ref); }
310inline void decrement( const class TypedefDecl * node, Node::ref_type ref ) { node->decrement(ref); }
311inline void increment( const class AsmDecl * node, Node::ref_type ref ) { node->increment(ref); }
312inline void decrement( const class AsmDecl * node, Node::ref_type ref ) { node->decrement(ref); }
313inline void increment( const class StaticAssertDecl * node, Node::ref_type ref ) { node->increment(ref); }
314inline void decrement( const class StaticAssertDecl * node, Node::ref_type ref ) { node->decrement(ref); }
315
316}
317
318// Local Variables: //
319// tab-width: 4 //
320// mode: c++ //
321// compile-command: "make install" //
322// End: //
Note: See TracBrowser for help on using the repository browser.