| 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 | |
|---|
| 25 | namespace 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 | /// Gets all declarations with the given ID |
|---|
| 42 | void lookupId( const std::string &id, std::list< DeclarationWithType* > &out ) const; |
|---|
| 43 | /// Gets the top-most type declaration with the given ID |
|---|
| 44 | NamedTypeDecl *lookupType( const std::string &id ) const; |
|---|
| 45 | /// Gets the top-most struct declaration with the given ID |
|---|
| 46 | StructDecl *lookupStruct( const std::string &id ) const; |
|---|
| 47 | /// Gets the top-most enum declaration with the given ID |
|---|
| 48 | EnumDecl *lookupEnum( const std::string &id ) const; |
|---|
| 49 | /// Gets the top-most union declaration with the given ID |
|---|
| 50 | UnionDecl *lookupUnion( const std::string &id ) const; |
|---|
| 51 | /// Gets the top-most trait declaration with the given ID |
|---|
| 52 | TraitDecl *lookupTrait( const std::string &id ) const; |
|---|
| 53 | |
|---|
| 54 | void print( std::ostream &os, int indent = 0 ) const; |
|---|
| 55 | |
|---|
| 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; |
|---|
| 58 | /// returns true if there exists a declaration with C linkage and the given name with a different mangled name |
|---|
| 59 | bool hasIncompatibleCDecl( const std::string &id, const std::string &mangleName, unsigned long scope ) const; |
|---|
| 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; |
|---|
| 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; |
|---|
| 68 | |
|---|
| 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 ); |
|---|
| 77 | |
|---|
| 78 | bool doDebug = false; ///< Display debugging trace? |
|---|
| 79 | private: |
|---|
| 80 | struct Impl; |
|---|
| 81 | |
|---|
| 82 | Impl *tables; ///< Copy-on-write instance of table data structure |
|---|
| 83 | unsigned long scope; ///< Scope index of this pointer |
|---|
| 84 | |
|---|
| 85 | /// Takes a new ref to a table (returns null if null) |
|---|
| 86 | static Impl *newRef( Impl *toClone ); |
|---|
| 87 | /// Clears a ref to a table (does nothing if null) |
|---|
| 88 | static void deleteRef( Impl *toFree ); |
|---|
| 89 | |
|---|
| 90 | // Removes matching autogenerated constructors and destructors |
|---|
| 91 | // so that they will not be selected |
|---|
| 92 | // void removeSpecialOverrides( FunctionDecl *decl ); |
|---|
| 93 | void removeSpecialOverrides( const std::string &id, std::list< DeclarationWithType * > & out ) const; |
|---|
| 94 | |
|---|
| 95 | /// Ensures that tables variable is writable (i.e. allocated, uniquely owned by this Indexer, and at the current scope) |
|---|
| 96 | void makeWritable(); |
|---|
| 97 | }; |
|---|
| 98 | } // namespace SymTab |
|---|
| 99 | |
|---|
| 100 | // Local Variables: // |
|---|
| 101 | // tab-width: 4 // |
|---|
| 102 | // mode: c++ // |
|---|
| 103 | // compile-command: "make install" // |
|---|
| 104 | // End: // |
|---|
