source: src/SymTab/Indexer.h @ 78d69da7

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 78d69da7 was 78d69da7, checked in by Rob Schluntz <rschlunt@…>, 4 years ago

Fix build failure on gcc-4.9

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