source: src/SymTab/Indexer.h @ a40d503

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

Add base expression to Indexer MangleTable? and implement WithStmt? functionality

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