source: src/AST/Decl.hpp @ 93c10de

ADTast-experimental
Last change on this file since 93c10de was 93c10de, checked in by Andrew Beach <ajbeach@…>, 18 months ago

Minimal changes to pull out nested types, TypeInstType::TypeEnvKey? and TypeDecl::Data (now TypeData?) from there parent types. Although they do connect to the parent types they were nested in they are used on their own most of the time.

  • Property mode set to 100644
File size: 15.1 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 Nov 24  9:44:00 2022
13// Update Count     : 34
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::Cforall, 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<TypeDecl>> type_params;
128        std::vector<ptr<DeclWithType>> assertions;
129        std::vector<ptr<DeclWithType>> params;
130        std::vector<ptr<DeclWithType>> returns;
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::Cforall,
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::Cforall,
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        TypeDecl(
194                const CodeLocation & loc, const std::string & name, Storage::Classes storage,
195                const Type * b, TypeDecl::Kind k, bool s, const Type * i = nullptr )
196        : NamedTypeDecl( loc, name, storage, b ), kind( k ), sized( k == TypeDecl::Ttype || s ),
197          init( i ) {}
198
199        const char * typeString() const override;
200        /// Produces a name for generated code
201        const char * genTypeString() const;
202
203        /// convenience accessor to match Type::isComplete()
204        bool isComplete() const { return sized; }
205
206        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
207  private:
208        TypeDecl * clone() const override { return new TypeDecl{ *this }; }
209        MUTATE_FRIEND
210};
211
212/// Data extracted from a TypeDecl.
213struct TypeData {
214        TypeDecl::Kind kind;
215        bool isComplete;
216
217        TypeData() : kind( TypeDecl::NUMBER_OF_KINDS ), isComplete( false ) {}
218        TypeData( const TypeDecl * d ) : kind( d->kind ), isComplete( d->sized ) {}
219        TypeData( TypeDecl::Kind k, bool c ) : kind( k ), isComplete( c ) {}
220        TypeData( const TypeData & d1, const TypeData & d2 )
221                : kind( d1.kind ), isComplete( d1.isComplete || d2.isComplete ) {}
222
223        bool operator==( const TypeData & o ) const { return kind == o.kind && isComplete == o.isComplete; }
224        bool operator!=( const TypeData & o ) const { return !(*this == o); }
225};
226
227std::ostream & operator<< ( std::ostream &, const TypeData & );
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        bool isTyped; // isTyped indicated if the enum has a declaration like:
315        // enum (type_optional) Name {...}
316        ptr<Type> base; // if isTyped == true && base.get() == nullptr, it is a "void" type enum
317        enum class EnumHiding { Visible, Hide } hide;
318
319        EnumDecl( const CodeLocation& loc, const std::string& name, bool isTyped = false,
320                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall,
321                Type const * base = nullptr, EnumHiding hide = EnumHiding::Hide,
322                std::unordered_map< std::string, long long > enumValues = std::unordered_map< std::string, long long >() )
323        : AggregateDecl( loc, name, std::move(attrs), linkage ), isTyped(isTyped), base(base), hide(hide), enumValues(enumValues) {}
324
325        /// gets the integer value for this enumerator, returning true iff value found
326        // Maybe it is not used in producing the enum value
327        bool valueOf( const Decl * enumerator, long long& value ) const;
328
329        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
330
331        const char * typeString() const override { return aggrString( Enum ); }
332
333
334private:
335        EnumDecl * clone() const override { return new EnumDecl{ *this }; }
336        MUTATE_FRIEND
337
338        /// Map from names to enumerator values; kept private for lazy initialization
339        mutable std::unordered_map< std::string, long long > enumValues;
340};
341
342/// trait declaration `trait Foo( ... ) { ... };`
343class TraitDecl final : public AggregateDecl {
344public:
345        TraitDecl( const CodeLocation& loc, const std::string& name,
346                std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall )
347        : AggregateDecl( loc, name, std::move(attrs), linkage ) {}
348
349        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
350
351        const char * typeString() const override { return "trait"; }
352
353private:
354        TraitDecl * clone() const override { return new TraitDecl{ *this }; }
355        MUTATE_FRIEND
356};
357
358/// With statement `with (...) ...`
359class WithStmt final : public Decl {
360public:
361        std::vector<ptr<Expr>> exprs;
362        ptr<Stmt> stmt;
363
364        WithStmt( const CodeLocation & loc, std::vector<ptr<Expr>> && exprs, const Stmt * stmt )
365        : Decl(loc, "", Storage::Auto, Linkage::Cforall), exprs(std::move(exprs)), stmt(stmt) {}
366
367        const Decl * accept( Visitor & v ) const override { return v.visit( this ); }
368private:
369        WithStmt * clone() const override { return new WithStmt{ *this }; }
370        MUTATE_FRIEND
371};
372
373class AsmDecl : public Decl {
374public:
375        ptr<AsmStmt> stmt;
376
377        AsmDecl( const CodeLocation & loc, AsmStmt * stmt )
378        : Decl( loc, "", {}, {} ), stmt(stmt) {}
379
380        const AsmDecl * accept( Visitor & v ) const override { return v.visit( this ); }
381private:
382        AsmDecl * clone() const override { return new AsmDecl( *this ); }
383        MUTATE_FRIEND
384};
385
386/// C-preprocessor directive `#...`
387class DirectiveDecl : public Decl {
388public:
389        ptr<DirectiveStmt> stmt;
390
391        DirectiveDecl( const CodeLocation & loc, DirectiveStmt * stmt )
392        : Decl( loc, "", {}, {} ), stmt(stmt) {}
393
394        const DirectiveDecl * accept( Visitor & v ) const override { return v.visit( this ); }
395private:
396        DirectiveDecl * clone() const override { return new DirectiveDecl( *this ); }
397        MUTATE_FRIEND
398};
399
400/// Static Assertion `_Static_assert( ... , ... );`
401class StaticAssertDecl : public Decl {
402public:
403        ptr<Expr> cond;
404        ptr<ConstantExpr> msg;   // string literal
405
406        StaticAssertDecl( const CodeLocation & loc, const Expr * condition, const ConstantExpr * msg )
407        : Decl( loc, "", {}, {} ), cond( condition ), msg( msg ) {}
408
409        const StaticAssertDecl * accept( Visitor & v ) const override { return v.visit( this ); }
410private:
411        StaticAssertDecl * clone() const override { return new StaticAssertDecl( *this ); }
412        MUTATE_FRIEND
413};
414
415/// Inline Member Declaration `inline TypeName;`
416class InlineMemberDecl final : public DeclWithType {
417public:
418        ptr<Type> type;
419
420        InlineMemberDecl( const CodeLocation & loc, const std::string & name, const Type * type,
421                Storage::Classes storage = {}, Linkage::Spec linkage = Linkage::Cforall,
422                std::vector< ptr<Attribute> > && attrs = {}, Function::Specs fs = {} )
423        : DeclWithType( loc, name, storage, linkage, std::move(attrs), fs ), type( type ) {}
424
425        const Type * get_type() const override { return type; }
426        void set_type( const Type * ty ) override { type = ty; }
427
428        const DeclWithType * accept( Visitor& v ) const override { return v.visit( this ); }
429private:
430        InlineMemberDecl * clone() const override { return new InlineMemberDecl{ *this }; }
431        MUTATE_FRIEND
432};
433
434}
435
436#undef MUTATE_FRIEND
437
438// Local Variables: //
439// tab-width: 4 //
440// mode: c++ //
441// compile-command: "make install" //
442// End: //
Note: See TracBrowser for help on using the repository browser.