source: src/SymTab/Indexer.h @ ed34540

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprno_listpersistent-indexer
Last change on this file since ed34540 was ed34540, checked in by Rob Schluntz <rschlunt@…>, 3 years ago

Update Indexer handling for typedefs

  • Property mode set to 100644
File size: 6.5 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// Indexer.h --
8//
9// Author           : Richard C. Bilson
10// Created On       : Sun May 17 21:38:55 2015
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Thu Aug 17 16:09:12 2017
13// Update Count     : 8
14//
15
16#pragma once
17
18#include <iosfwd>             // for ostream
19#include <list>               // for list
20#include <string>             // for string
21#include <functional>         // for function
22
23#include "SynTree/Visitor.h"  // for Visitor
24#include "SynTree/SynTree.h"  // for AST nodes
25
26namespace ResolvExpr {
27class Cost;
28}
29
30namespace SymTab {
31        class Indexer {
32          public:
33                explicit Indexer();
34
35                Indexer( const Indexer &that );
36                Indexer( Indexer &&that );
37                virtual ~Indexer();
38                Indexer& operator= ( const Indexer &that );
39                Indexer& operator= ( Indexer &&that );
40
41                // when using an indexer manually (e.g., within a mutator traversal), it is necessary to tell the indexer
42                // explicitly when scopes begin and end
43                void enterScope();
44                void leaveScope();
45
46                struct IdData {
47                        DeclarationWithType * id = nullptr;
48                        Expression * baseExpr = nullptr; // WithExpr
49
50                        /// non-null if this declaration is deleted
51                        BaseSyntaxNode * deleteStmt = nullptr;
52
53                        // NOTE: shouldn't need either of these constructors, but gcc-4 does not properly support initializer lists with default members.
54                        IdData() = default;
55                        IdData( DeclarationWithType * id, Expression * baseExpr, BaseSyntaxNode * deleteStmt ) : id( id ), baseExpr( baseExpr ), deleteStmt( deleteStmt ) {}
56
57                        Expression * combine( ResolvExpr::Cost & cost ) const;
58                };
59
60                /// Gets all declarations with the given ID
61                void lookupId( const std::string &id, std::list< IdData > &out ) const;
62                /// Gets the top-most type declaration with the given ID
63                NamedTypeDecl *lookupType( const std::string &id ) const;
64                /// Gets the top-most struct declaration with the given ID
65                StructDecl *lookupStruct( const std::string &id ) const;
66                /// Gets the top-most enum declaration with the given ID
67                EnumDecl *lookupEnum( const std::string &id ) const;
68                /// Gets the top-most union declaration with the given ID
69                UnionDecl *lookupUnion( const std::string &id ) const;
70                /// Gets the top-most trait declaration with the given ID
71                TraitDecl *lookupTrait( const std::string &id ) const;
72
73                /// Gets the type declaration with the given ID at global scope
74                NamedTypeDecl *globalLookupType( const std::string &id ) const;
75                /// Gets the struct declaration with the given ID at global scope
76                StructDecl *globalLookupStruct( const std::string &id ) const;
77                /// Gets the union declaration with the given ID at global scope
78                UnionDecl *globalLookupUnion( const std::string &id ) const;
79                /// Gets the enum declaration with the given ID at global scope
80                EnumDecl *globalLookupEnum( const std::string &id ) const;
81
82                void print( std::ostream &os, int indent = 0 ) const;
83
84                /// looks up a specific mangled ID at the given scope
85                IdData * lookupIdAtScope( const std::string &id, const std::string &mangleName, unsigned long scope );
86                const IdData * lookupIdAtScope( const std::string &id, const std::string &mangleName, unsigned long scope ) const;
87                /// returns true if there exists a declaration with C linkage and the given name with a different mangled name
88                bool hasIncompatibleCDecl( const std::string &id, const std::string &mangleName, unsigned long scope ) const;
89                /// returns true if there exists a declaration with C linkage and the given name with the same mangled name
90                bool hasCompatibleCDecl( const std::string &id, const std::string &mangleName, unsigned long scope ) const;
91                // equivalents to lookup functions that only look at tables at scope `scope` (which should be >= tables->scope)
92                NamedTypeDecl *lookupTypeAtScope( const std::string &id, unsigned long scope ) const;
93                StructDecl *lookupStructAtScope( const std::string &id, unsigned long scope ) const;
94                EnumDecl *lookupEnumAtScope( const std::string &id, unsigned long scope ) const;
95                UnionDecl *lookupUnionAtScope( const std::string &id, unsigned long scope ) const;
96                TraitDecl *lookupTraitAtScope( const std::string &id, unsigned long scope ) const;
97
98                typedef std::function<bool(IdData &, const std::string &)> ConflictFunction;
99
100                void addId( DeclarationWithType * decl, Expression * baseExpr = nullptr );
101                void addDeletedId( DeclarationWithType * decl, BaseSyntaxNode * deleteStmt );
102
103                void addType( NamedTypeDecl *decl );
104                void addStruct( const std::string &id );
105                void addStruct( StructDecl *decl );
106                void addEnum( EnumDecl *decl );
107                void addUnion( const std::string &id );
108                void addUnion( UnionDecl *decl );
109                void addTrait( TraitDecl *decl );
110
111                /// adds all of the IDs from WithStmt exprs
112                void addWith( std::list< Expression * > & withExprs, BaseSyntaxNode * withStmt );
113
114                /// adds all of the members of the Aggregate (addWith helper)
115                void addMembers( AggregateDecl * aggr, Expression * expr, ConflictFunction );
116
117                /// convenience function for adding a list of Ids to the indexer
118                void addIds( const std::list< DeclarationWithType * > & decls );
119
120                /// convenience function for adding a list of forall parameters to the indexer
121                void addTypes( const std::list< TypeDecl * > & tds );
122
123                /// convenience function for adding all of the declarations in a function type to the indexer
124                void addFunctionType( FunctionType * ftype );
125
126                bool doDebug = false; ///< Display debugging trace?
127          private:
128                struct Impl;
129
130                Impl *tables;         ///< Copy-on-write instance of table data structure
131                unsigned long scope;  ///< Scope index of this pointer
132
133                /// Takes a new ref to a table (returns null if null)
134                static Impl *newRef( Impl *toClone );
135                /// Clears a ref to a table (does nothing if null)
136                static void deleteRef( Impl *toFree );
137
138                // Removes matching autogenerated constructors and destructors
139                // so that they will not be selected
140                // void removeSpecialOverrides( FunctionDecl *decl );
141                void removeSpecialOverrides( const std::string &id, std::list< IdData > & out ) const;
142
143                /// Ensures that tables variable is writable (i.e. allocated, uniquely owned by this Indexer, and at the current scope)
144                void makeWritable();
145
146                /// common code for addId, addDeletedId, etc.
147                void addId( DeclarationWithType * decl, ConflictFunction, Expression * baseExpr = nullptr, BaseSyntaxNode * deleteStmt = nullptr );
148        };
149} // namespace SymTab
150
151// Local Variables: //
152// tab-width: 4 //
153// mode: c++ //
154// compile-command: "make install" //
155// End: //
Note: See TracBrowser for help on using the repository browser.