source: src/SymTab/Indexer.h @ 8a78dd3

ADTaaron-thesisarm-ehast-experimentalcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newwith_gc
Last change on this file since 8a78dd3 was 5fe35d6, checked in by Rob Schluntz <rschlunt@…>, 7 years ago

Move addIds and addTypes to Indexer

  • Property mode set to 100644
File size: 4.6 KB
RevLine 
[0dd3a2f]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//
[1e1e15b]7// Indexer.h --
[0dd3a2f]8//
9// Author           : Richard C. Bilson
10// Created On       : Sun May 17 21:38:55 2015
[4040425]11// Last Modified By : Peter A. Buhr
[6d49ea3]12// Last Modified On : Thu Aug 17 16:09:12 2017
13// Update Count     : 8
[0dd3a2f]14//
15
[6b0b624]16#pragma once
[51b7345]17
[30f9072]18#include <iosfwd>             // for ostream
19#include <list>               // for list
20#include <string>             // for string
[51b7345]21
[30f9072]22#include "SynTree/Visitor.h"  // for Visitor
23#include "SynTree/SynTree.h"  // for AST nodes
[51b7345]24
25namespace SymTab {
[33a25f9]26        class Indexer {
[a08ba92]27          public:
[8b11840]28                explicit Indexer();
[e8032b0]29
30                Indexer( const Indexer &that );
31                Indexer( Indexer &&that );
[a08ba92]32                virtual ~Indexer();
[e8032b0]33                Indexer& operator= ( const Indexer &that );
34                Indexer& operator= ( Indexer &&that );
[17cd4eb]35
[a08ba92]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();
[17cd4eb]40
[bed4c63e]41                /// Gets all declarations with the given ID
[e8032b0]42                void lookupId( const std::string &id, std::list< DeclarationWithType* > &out ) const;
[bed4c63e]43                /// Gets the top-most type declaration with the given ID
[a08ba92]44                NamedTypeDecl *lookupType( const std::string &id ) const;
[bed4c63e]45                /// Gets the top-most struct declaration with the given ID
[a08ba92]46                StructDecl *lookupStruct( const std::string &id ) const;
[bed4c63e]47                /// Gets the top-most enum declaration with the given ID
[a08ba92]48                EnumDecl *lookupEnum( const std::string &id ) const;
[bed4c63e]49                /// Gets the top-most union declaration with the given ID
[a08ba92]50                UnionDecl *lookupUnion( const std::string &id ) const;
[bed4c63e]51                /// Gets the top-most trait declaration with the given ID
[4040425]52                TraitDecl *lookupTrait( const std::string &id ) const;
[1e1e15b]53
[a08ba92]54                void print( std::ostream &os, int indent = 0 ) const;
[522363e]55
[bed4c63e]56                /// looks up a specific mangled ID at the given scope
57                DeclarationWithType *lookupIdAtScope( const std::string &id, const std::string &mangleName, unsigned long scope ) const;
[5447e09]58                /// returns true if there exists a declaration with C linkage and the given name with a different mangled name
[09d1ad0]59                bool hasIncompatibleCDecl( const std::string &id, const std::string &mangleName, unsigned long scope ) const;
[8884112]60                /// returns true if there exists a declaration with C linkage and the given name with the same mangled name
61                bool hasCompatibleCDecl( const std::string &id, const std::string &mangleName, unsigned long scope ) const;
[52c2a72]62                // equivalents to lookup functions that only look at tables at scope `scope` (which should be >= tables->scope)
63                NamedTypeDecl *lookupTypeAtScope( const std::string &id, unsigned long scope ) const;
64                StructDecl *lookupStructAtScope( const std::string &id, unsigned long scope ) const;
65                EnumDecl *lookupEnumAtScope( const std::string &id, unsigned long scope ) const;
66                UnionDecl *lookupUnionAtScope( const std::string &id, unsigned long scope ) const;
67                TraitDecl *lookupTraitAtScope( const std::string &id, unsigned long scope ) const;
[1e1e15b]68
[e8032b0]69                void addId( DeclarationWithType *decl );
70                void addType( NamedTypeDecl *decl );
71                void addStruct( const std::string &id );
72                void addStruct( StructDecl *decl );
73                void addEnum( EnumDecl *decl );
74                void addUnion( const std::string &id );
75                void addUnion( UnionDecl *decl );
76                void addTrait( TraitDecl *decl );
[1e1e15b]77
[5fe35d6]78                /// convenience function for adding a list of Ids to the indexer
79                void addIds( const std::list< DeclarationWithType * > & decls );
80
81                /// convenience function for adding a list of forall parameters to the indexer
82                void addTypes( const std::list< TypeDecl * > & tds );
83
84                /// convenience function for adding all of the declarations in a function type to the indexer
85                void addFunctionType( FunctionType * ftype );
86
[8b11840]87                bool doDebug = false; ///< Display debugging trace?
[522363e]88          private:
[e8032b0]89                struct Impl;
[30f9072]90
[52c2a72]91                Impl *tables;         ///< Copy-on-write instance of table data structure
92                unsigned long scope;  ///< Scope index of this pointer
[e8032b0]93
94                /// Takes a new ref to a table (returns null if null)
95                static Impl *newRef( Impl *toClone );
96                /// Clears a ref to a table (does nothing if null)
97                static void deleteRef( Impl *toFree );
98
[1ba88a0]99                // Removes matching autogenerated constructors and destructors
100                // so that they will not be selected
101                // void removeSpecialOverrides( FunctionDecl *decl );
102                void removeSpecialOverrides( const std::string &id, std::list< DeclarationWithType * > & out ) const;
103
[52c2a72]104                /// Ensures that tables variable is writable (i.e. allocated, uniquely owned by this Indexer, and at the current scope)
[e8032b0]105                void makeWritable();
[a08ba92]106        };
[51b7345]107} // namespace SymTab
108
[0dd3a2f]109// Local Variables: //
110// tab-width: 4 //
111// mode: c++ //
112// compile-command: "make install" //
113// End: //
Note: See TracBrowser for help on using the repository browser.