source: src/AST/SymbolTable.hpp @ e5c3811

arm-ehenumforall-pointer-decayjacob/cs343-translationnew-ast-unique-expr
Last change on this file since e5c3811 was e5c3811, checked in by Fangren Yu <f37yu@…>, 19 months ago

create dedicated symbol tables for big 3 operators
note: arbitrary this param type is not supported; it is currently allowed although never used

  • Property mode set to 100644
File size: 8.8 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// SymbolTable.hpp --
8//
9// Author           : Aaron B. Moss
10// Created On       : Wed May 29 11:00:00 2019
11// Last Modified By : Aaron B. Moss
12// Last Modified On : Wed May 29 11:00:00 2019
13// Update Count     : 1
14//
15
16#pragma once
17
18#include <memory>                  // for shared_ptr, enable_shared_from_this
19#include <vector>
20
21#include "Fwd.hpp"
22#include "Node.hpp"                // for ptr, readonly
23#include "Common/CodeLocation.h"
24#include "Common/PersistentMap.h"
25
26namespace ResolvExpr {
27        class Cost;
28}
29
30namespace ast {
31
32/// Builds and stores the symbol table, mapping identifiers to declarations.
33class SymbolTable final : public std::enable_shared_from_this<ast::SymbolTable> {
34public:
35        /// special functions stored in dedicated tables, with different lookup keys
36        enum SpecialFunctionKind {CTOR, DTOR, ASSIGN, NUMBER_OF_KINDS};
37        static SpecialFunctionKind getSpecialFunctionKind(const std::string & name);
38
39        /// Stored information about a declaration
40        struct IdData {
41                readonly<DeclWithType> id = nullptr;  ///< Identifier of declaration
42                readonly<Expr> baseExpr = nullptr;    ///< Implied containing aggregate (from WithExpr)
43                readonly<Decl> deleter = nullptr;     ///< Node deleting this declaration (if non-null)
44                unsigned long scope = 0;              ///< Scope of identifier
45
46                IdData() = default;
47                IdData( const DeclWithType * i, const Expr * base, const Decl * del, unsigned long s )
48                : id( i ), baseExpr( base ), deleter( del ), scope( s ) {}
49
50                /// Modify an existing node with a new deleter
51                IdData( const IdData & o, const Decl * del )
52                : id( o.id ), baseExpr( o.baseExpr ), deleter( del ), scope( o.scope ) {}
53
54                /// Constructs an expression referring to this identifier.
55                /// Increments `cost` by cost of reference conversion
56                Expr * combine( const CodeLocation & loc, ResolvExpr::Cost & cost ) const;
57        };
58
59private:
60        /// wraps a reference to D with a scope
61        template<typename D>
62        struct scoped {
63                readonly<D> decl;     ///< wrapped declaration
64                unsigned long scope;  ///< scope of this declaration
65
66                scoped(const D * d, unsigned long s) : decl(d), scope(s) {}
67        };
68
69        using MangleTable = PersistentMap< std::string, IdData >;
70        using IdTable = PersistentMap< std::string, MangleTable::Ptr >;
71        using TypeTable = PersistentMap< std::string, scoped<NamedTypeDecl> >;
72        using StructTable = PersistentMap< std::string, scoped<StructDecl> >;
73        using EnumTable = PersistentMap< std::string, scoped<EnumDecl> >;
74        using UnionTable = PersistentMap< std::string, scoped<UnionDecl> >;
75        using TraitTable = PersistentMap< std::string, scoped<TraitDecl> >;
76
77        IdTable::Ptr idTable;          ///< identifier namespace
78        TypeTable::Ptr typeTable;      ///< type namespace
79        StructTable::Ptr structTable;  ///< struct namespace
80        EnumTable::Ptr enumTable;      ///< enum namespace
81        UnionTable::Ptr unionTable;    ///< union namespace
82        TraitTable::Ptr traitTable;    ///< trait namespace
83        IdTable::Ptr specialFunctionTable[NUMBER_OF_KINDS];
84
85        // using SpecialFuncTable = PersistentMap< std::string, IdTable::Ptr >; // fname (ctor/dtor/assign) - otypekey
86        // SpecialFuncTable::Ptr specialFuncTable;
87
88        using Ptr = std::shared_ptr<const SymbolTable>;
89
90        Ptr prevScope;                 ///< Indexer for parent scope
91        unsigned long scope;           ///< Scope index of this indexer
92        unsigned long repScope;        ///< Scope index of currently represented scope
93
94public:
95        SymbolTable();
96        ~SymbolTable();
97
98        // when using an indexer manually (e.g., within a mutator traversal), it is necessary to
99        // tell the indexer explicitly when scopes begin and end
100        void enterScope();
101        void leaveScope();
102
103        /// Gets all declarations with the given ID
104        std::vector<IdData> lookupId( const std::string &id ) const;
105        /// Gets special functions associated with a type; if no key is given, returns everything
106        std::vector<IdData> specialLookupId( SpecialFunctionKind kind, const std::string & otypeKey = "" ) const;
107        /// Gets the top-most type declaration with the given ID
108        const NamedTypeDecl * lookupType( const std::string &id ) const;
109        /// Gets the top-most struct declaration with the given ID
110        const StructDecl * lookupStruct( const std::string &id ) const;
111        /// Gets the top-most enum declaration with the given ID
112        const EnumDecl * lookupEnum( const std::string &id ) const;
113        /// Gets the top-most union declaration with the given ID
114        const UnionDecl * lookupUnion( const std::string &id ) const;
115        /// Gets the top-most trait declaration with the given ID
116        const TraitDecl * lookupTrait( const std::string &id ) const;
117
118        /// Gets the type declaration with the given ID at global scope
119        const NamedTypeDecl * globalLookupType( const std::string &id ) const;
120        /// Gets the struct declaration with the given ID at global scope
121        const StructDecl * globalLookupStruct( const std::string &id ) const;
122        /// Gets the union declaration with the given ID at global scope
123        const UnionDecl * globalLookupUnion( const std::string &id ) const;
124        /// Gets the enum declaration with the given ID at global scope
125        const EnumDecl * globalLookupEnum( const std::string &id ) const;
126
127        /// Adds an identifier declaration to the symbol table
128        void addId( const DeclWithType * decl, const Expr * baseExpr = nullptr );
129        /// Adds a deleted identifier declaration to the symbol table
130        void addDeletedId( const DeclWithType * decl, const Decl * deleter );
131
132        /// Adds a type to the symbol table
133        void addType( const NamedTypeDecl * decl );
134        /// Adds a struct declaration to the symbol table by name
135        void addStruct( const std::string & id );
136        /// Adds a struct declaration to the symbol table
137        void addStruct( const StructDecl * decl );
138        /// Adds an enum declaration to the symbol table
139        void addEnum( const EnumDecl * decl );
140        /// Adds a union declaration to the symbol table by name
141        void addUnion( const std::string & id );
142        /// Adds a union declaration to the symbol table
143        void addUnion( const UnionDecl * decl );
144        /// Adds a trait declaration to the symbol table
145        void addTrait( const TraitDecl * decl );
146
147        /// adds all of the IDs from WithStmt exprs
148        void addWith( const std::vector< ptr<Expr> > & withExprs, const Decl * withStmt );
149
150        /// convenience function for adding a list of Ids to the indexer
151        void addIds( const std::vector< ptr<DeclWithType> > & decls );
152
153        /// convenience function for adding a list of forall parameters to the indexer
154        void addTypes( const std::vector< ptr<TypeDecl> > & tds );
155
156        /// convenience function for adding all of the declarations in a function type to the indexer
157        void addFunction( const FunctionDecl * );
158
159private:
160        /// Ensures that a proper backtracking scope exists before a mutation
161        void lazyInitScope();
162
163        /// Gets the symbol table at a given scope
164        const SymbolTable * atScope( unsigned long i ) const;
165
166        /// Removes matching autogenerated constructors and destructors so that they will not be
167        /// selected. If returns false, passed decl should not be added.
168        bool removeSpecialOverrides( IdData & decl, MangleTable::Ptr & mangleTable );
169
170        /// Options for handling identifier conflicts
171        struct OnConflict {
172                enum {
173                        Error,  ///< Throw a semantic error
174                        Delete  ///< Delete the earlier version with the delete statement
175                } mode;
176                const Decl * deleter;  ///< Statement that deletes this expression
177
178        private:
179                OnConflict() : mode(Error), deleter(nullptr) {}
180                OnConflict( const Decl * d ) : mode(Delete), deleter(d) {}
181        public:
182                OnConflict( const OnConflict& ) = default;
183
184                static OnConflict error() { return {}; }
185                static OnConflict deleteWith( const Decl * d ) { return { d }; }
186        };
187
188        /// true if the existing identifier conflicts with the added identifier
189        bool addedIdConflicts(
190                const IdData & existing, const DeclWithType * added, OnConflict handleConflicts,
191                const Decl * deleter );
192
193        /// common code for addId, addDeletedId, etc.
194        void addId(
195                const DeclWithType * decl, OnConflict handleConflicts, const Expr * baseExpr = nullptr,
196                const Decl * deleter = nullptr );
197
198        /// common code for addId when special decls are placed into separate tables
199        void addId(
200                const DeclWithType * decl, const std::string & lookupKey, IdTable::Ptr & idTable, OnConflict handleConflicts, 
201                const Expr * baseExpr = nullptr, const Decl * deleter = nullptr);
202       
203        /// adds all of the members of the Aggregate (addWith helper)
204        void addMembers( const AggregateDecl * aggr, const Expr * expr, OnConflict handleConflicts );
205
206        /// returns true if there exists a declaration with C linkage and the given name with the same mangled name
207        bool hasCompatibleCDecl( const std::string &id, const std::string &mangleName ) const;
208        /// returns true if there exists a declaration with C linkage and the given name with a different mangled name
209        bool hasIncompatibleCDecl( const std::string &id, const std::string &mangleName ) const;
210};
211
212}
213
214// Local Variables: //
215// tab-width: 4 //
216// mode: c++ //
217// compile-command: "make install" //
218// End: //
Note: See TracBrowser for help on using the repository browser.