source: src/AST/Decl.hpp @ 7edd5c1

pthread-emulationqualifiedEnum
Last change on this file since 7edd5c1 was 7edd5c1, checked in by Andrew Beach <ajbeach@…>, 7 months ago

Assorted fixes to the AST, found while I was trying to add more invarant checks.

  • Property mode set to 100644
File size: 13.9 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 : Andrew Beach
12// Last Modified On : Thu May  5 12:09:00 2022
13// Update Count     : 33
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
39namespace ast {
40
41/// Base declaration class
42class Decl : public ParseNode {
43public:
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;
62private:
63        Decl * clone() const override = 0;
64        MUTATE_FRIEND
65};
66
67/// Typed declaration base class
68class DeclWithType : public Decl {
69public:
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;
96private:
97        DeclWithType * clone() const override = 0;
98        MUTATE_FRIEND
99};
100
101/// Object declaration `Foo foo = 42;`
102class ObjectDecl final : public DeclWithType {
103public:
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 ); }
119private:
120        ObjectDecl * clone() const override { return new ObjectDecl{ *this }; }
121        MUTATE_FRIEND
122};
123
124/// Object declaration `int foo()`
125class FunctionDecl : public DeclWithType {
126public:
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        // The difference between the two constructors is in how they handle
138        // assertions. The first constructor uses the assertions from the type
139        // parameters, in the style of the old ast, and puts them on the type.
140        // The second takes an explicite list of assertions and builds a list of
141        // references to them on the type.
142
143        FunctionDecl( const CodeLocation & loc, const std::string & name, std::vector<ptr<TypeDecl>>&& forall,
144                std::vector<ptr<DeclWithType>>&& params, std::vector<ptr<DeclWithType>>&& returns,
145                CompoundStmt * stmts, Storage::Classes storage = {}, Linkage::Spec linkage = Linkage::C,
146                std::vector<ptr<Attribute>>&& attrs = {}, Function::Specs fs = {}, bool isVarArgs = false);
147
148        FunctionDecl( const CodeLocation & location, const std::string & name,
149                std::vector<ptr<TypeDecl>>&& forall, std::vector<ptr<DeclWithType>>&& assertions,
150                std::vector<ptr<DeclWithType>>&& params, std::vector<ptr<DeclWithType>>&& returns,
151                CompoundStmt * stmts, Storage::Classes storage = {}, Linkage::Spec linkage = Linkage::C,
152                std::vector<ptr<Attribute>>&& attrs = {}, Function::Specs fs = {}, bool isVarArgs = false);
153
154        const Type * get_type() const override;
155        void set_type( const Type * t ) override;
156
157        bool has_body() const { return stmts; }
158
159        const DeclWithType * accept( Visitor & v ) const override { return v.visit( this ); }
160private:
161        FunctionDecl * clone() const override { return new FunctionDecl( *this ); }
162        MUTATE_FRIEND
163};
164
165/// Base class for named type aliases
166class NamedTypeDecl : public Decl {
167public:
168        ptr<Type> base;
169        std::vector<ptr<DeclWithType>> assertions;
170
171        NamedTypeDecl(
172                const CodeLocation & loc, const std::string & name, Storage::Classes storage,
173                const Type * b, Linkage::Spec spec = Linkage::Cforall )
174        : Decl( loc, name, storage, spec ), base( b ), assertions() {}
175
176        /// Produces a name for the kind of alias
177        virtual const char * typeString() const = 0;
178
179private:
180        NamedTypeDecl* clone() const override = 0;
181        MUTATE_FRIEND
182};
183
184/// Cforall type variable: `dtype T`
185class TypeDecl final : public NamedTypeDecl {
186  public:
187        enum Kind { Dtype, DStype, Otype, Ftype, Ttype, Dimension, NUMBER_OF_KINDS };
188
189        Kind kind;
190        bool sized;
191        ptr<Type> init;
192
193        /// Data extracted from a type decl
194        struct Data {
195                Kind kind;
196                bool isComplete;
197
198                Data() : kind( NUMBER_OF_KINDS ), isComplete( false ) {}
199                Data( const TypeDecl * d ) : kind( d->kind ), isComplete( d->sized ) {}
200                Data( Kind k, bool c ) : kind( k ), isComplete( c ) {}
201                Data( const Data & d1, const Data & d2 )
202                        : kind( d1.kind ), isComplete( d1.isComplete || d2.isComplete ) {}
203
204                bool operator==( const Data & o ) const { return kind == o.kind && isComplete == o.isComplete; }
205                bool operator!=( const Data & o ) const { return !(*this == o); }
206        };
207
208        TypeDecl(
209                const CodeLocation & loc, const std::string & name, Storage::Classes storage,
210                const Type * b, TypeDecl::Kind k, bool s, const Type * i = nullptr )
211        : NamedTypeDecl( loc, name, storage, b ), kind( k ), sized( k == TypeDecl::Ttype || s ),
212          init( i ) {}
213
214        const char * typeString() const override;
215        /// Produces a name for generated code
216        const char * genTypeString() const;
217
218        /// convenience accessor to match Type::isComplete()
219        bool isComplete() { return sized; }
220
221        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
222  private:
223        TypeDecl * clone() const override { return new TypeDecl{ *this }; }
224        MUTATE_FRIEND
225};
226
227std::ostream & operator<< ( std::ostream &, const TypeDecl::Data & );
228
229/// C-style typedef `typedef Foo Bar`
230class TypedefDecl final : public NamedTypeDecl {
231public:
232        TypedefDecl( const CodeLocation& loc, const std::string& name, Storage::Classes storage,
233                Type* b, Linkage::Spec spec = Linkage::Cforall )
234        : NamedTypeDecl( loc, name, storage, b, spec ) {}
235
236        const char * typeString() const override { return "typedef"; }
237
238        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
239private:
240        TypedefDecl * clone() const override { return new TypedefDecl{ *this }; }
241        MUTATE_FRIEND
242};
243
244/// Aggregate type declaration base class
245class AggregateDecl : public Decl {
246public:
247        enum Aggregate { Struct, Union, Enum, Exception, Trait, Generator, Coroutine, Monitor, Thread, NoAggregate };
248        static const char * aggrString( Aggregate aggr );
249
250        std::vector<ptr<Decl>> members;
251        std::vector<ptr<TypeDecl>> params;
252        std::vector<ptr<Attribute>> attributes;
253        bool body = false;
254        readonly<AggregateDecl> parent = {};
255
256        AggregateDecl( const CodeLocation& loc, const std::string& name,
257                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
258        : Decl( loc, name, Storage::Classes{}, linkage ), members(), params(),
259          attributes( std::move(attrs) ) {}
260
261        AggregateDecl* set_body( bool b ) { body = b; return this; }
262
263        /// Produces a name for the kind of aggregate
264        virtual const char * typeString() const = 0;
265
266private:
267        AggregateDecl * clone() const override = 0;
268        MUTATE_FRIEND
269};
270
271/// struct declaration `struct Foo { ... };`
272class StructDecl final : public AggregateDecl {
273public:
274        Aggregate kind;
275
276        StructDecl( const CodeLocation& loc, const std::string& name,
277                Aggregate kind = Struct,
278                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
279        : AggregateDecl( loc, name, std::move(attrs), linkage ), kind( kind ) {}
280
281        bool is_coroutine() const { return kind == Coroutine; }
282        bool is_generator() const { return kind == Generator; }
283        bool is_monitor  () const { return kind == Monitor  ; }
284        bool is_thread   () const { return kind == Thread   ; }
285
286        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
287
288        const char * typeString() const override { return aggrString( kind ); }
289
290private:
291        StructDecl * clone() const override { return new StructDecl{ *this }; }
292        MUTATE_FRIEND
293};
294
295/// union declaration `union Foo { ... };`
296class UnionDecl final : public AggregateDecl {
297public:
298        UnionDecl( const CodeLocation& loc, const std::string& name,
299                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
300        : AggregateDecl( loc, name, std::move(attrs), linkage ) {}
301
302        const Decl * accept( Visitor& v ) const override { return v.visit( this ); }
303
304        const char * typeString() const override { return aggrString( Union ); }
305
306private:
307        UnionDecl * clone() const override { return new UnionDecl{ *this }; }
308        MUTATE_FRIEND
309};
310
311/// enum declaration `enum Foo { ... };`
312class EnumDecl final : public AggregateDecl {
313public:
314        ptr<Type> base;
315
316        EnumDecl( const CodeLocation& loc, const std::string& name,
317                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall, Type * base = nullptr,
318                 std::unordered_map< std::string, long long > enumValues = std::unordered_map< std::string, long long >() )
319        : AggregateDecl( loc, name, std::move(attrs), linkage ), base(base), enumValues(enumValues) {}
320
321        /// gets the integer value for this enumerator, returning true iff value found
322        // Maybe it is not used in producing the enum value
323        bool valueOf( const Decl * enumerator, long long& value ) const;
324
325        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
326
327        const char * typeString() const override { return aggrString( Enum ); }
328
329        bool isTyped() {return base && base.get();}
330
331private:
332        EnumDecl * clone() const override { return new EnumDecl{ *this }; }
333        MUTATE_FRIEND
334
335        /// Map from names to enumerator values; kept private for lazy initialization
336        mutable std::unordered_map< std::string, long long > enumValues;
337};
338
339/// trait declaration `trait Foo( ... ) { ... };`
340class TraitDecl final : public AggregateDecl {
341public:
342        TraitDecl( const CodeLocation& loc, const std::string& name,
343                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
344        : AggregateDecl( loc, name, std::move(attrs), linkage ) {}
345
346        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
347
348        const char * typeString() const override { return "trait"; }
349
350private:
351        TraitDecl * clone() const override { return new TraitDecl{ *this }; }
352        MUTATE_FRIEND
353};
354
355/// With statement `with (...) ...`
356class WithStmt final : public Decl {
357public:
358        std::vector<ptr<Expr>> exprs;
359        ptr<Stmt> stmt;
360
361        WithStmt( const CodeLocation & loc, std::vector<ptr<Expr>> && exprs, const Stmt * stmt )
362        : Decl(loc, "", Storage::Auto, Linkage::Cforall), exprs(std::move(exprs)), stmt(stmt) {}
363
364        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
365private:
366        WithStmt * clone() const override { return new WithStmt{ *this }; }
367        MUTATE_FRIEND
368};
369
370class AsmDecl : public Decl {
371public:
372        ptr<AsmStmt> stmt;
373
374        AsmDecl( const CodeLocation & loc, AsmStmt * stmt )
375        : Decl( loc, "", {}, {} ), stmt(stmt) {}
376
377        const AsmDecl * accept( Visitor & v ) const override { return v.visit( this ); }
378private:
379        AsmDecl * clone() const override { return new AsmDecl( *this ); }
380        MUTATE_FRIEND
381};
382
383/// C-preprocessor directive `#...`
384class DirectiveDecl : public Decl {
385public:
386        ptr<DirectiveStmt> stmt;
387
388        DirectiveDecl( const CodeLocation & loc, DirectiveStmt * stmt )
389        : Decl( loc, "", {}, {} ), stmt(stmt) {}
390
391        const DirectiveDecl * accept( Visitor & v ) const override { return v.visit( this ); }
392private:
393        DirectiveDecl * clone() const override { return new DirectiveDecl( *this ); }
394        MUTATE_FRIEND
395};
396
397class StaticAssertDecl : public Decl {
398public:
399        ptr<Expr> cond;
400        ptr<ConstantExpr> msg;   // string literal
401
402        StaticAssertDecl( const CodeLocation & loc, const Expr * condition, const ConstantExpr * msg )
403        : Decl( loc, "", {}, {} ), cond( condition ), msg( msg ) {}
404
405        const StaticAssertDecl * accept( Visitor & v ) const override { return v.visit( this ); }
406private:
407        StaticAssertDecl * clone() const override { return new StaticAssertDecl( *this ); }
408        MUTATE_FRIEND
409};
410
411}
412
413#undef MUTATE_FRIEND
414
415// Local Variables: //
416// tab-width: 4 //
417// mode: c++ //
418// compile-command: "make install" //
419// End: //
Note: See TracBrowser for help on using the repository browser.