persistentsymboltable.h

Go to the documentation of this file.

/* This file is part of KDevelop
    Copyright 2008 David Nolden <[email protected]>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
 */
 
#ifndef KDEVPLATFORM_PERSISTENTSYMBOLTABLE_H
#define KDEVPLATFORM_PERSISTENTSYMBOLTABLE_H
 
#include <util/convenientfreelist.h>
#include <language/util/setrepository.h>
#include <language/languageexport.h>
#include "indexeddeclaration.h"
#include "ducontext.h"
#include "topducontext.h"
 
namespace KDevelop {
class Declaration;
class IndexedDeclaration;
class IndexedDUContext;
class DeclarationId;
class TopDUContext;
class IndexedQualifiedIdentifier;
class PersistentSymbolTablePrivate;
 
class KDEVPLATFORMLANGUAGE_EXPORT IndexedDeclarationHandler
{
public:
    inline static int leftChild(const IndexedDeclaration& m_data)
    {
        return (( int )(m_data.dummyData().first)) - 1;
    }
    inline static void setLeftChild(IndexedDeclaration& m_data, int child)
    {
        m_data.setDummyData(qMakePair(( uint )(child + 1), m_data.dummyData().second));
    }
    inline static int rightChild(const IndexedDeclaration& m_data)
    {
        return (( int )m_data.dummyData().second) - 1;
    }
    inline static void setRightChild(IndexedDeclaration& m_data, int child)
    {
        m_data.setDummyData(qMakePair(m_data.dummyData().first, ( uint )(child + 1)));
    }
    inline static void createFreeItem(IndexedDeclaration& data)
    {
        data = IndexedDeclaration();
        data.setIsDummy(true);
        data.setDummyData(qMakePair(0u, 0u)); //Since we subtract 1, this equals children -1, -1
    }
    //Copies this item into the given one
    inline static void copyTo(const IndexedDeclaration& m_data, IndexedDeclaration& data)
    {
        data = m_data;
    }
 
    inline static bool isFree(const IndexedDeclaration& m_data)
    {
        return m_data.isDummy();
    }
 
    inline static bool equals(const IndexedDeclaration& m_data, const IndexedDeclaration& rhs)
    {
        return m_data == rhs;
    }
};
 
struct DeclarationTopContextExtractor
{
    inline static IndexedTopDUContext extract(const IndexedDeclaration& decl)
    {
        return decl.indexedTopContext();
    }
};
 
struct DUContextTopContextExtractor
{
    inline static IndexedTopDUContext extract(const IndexedDUContext& ctx)
    {
        return ctx.indexedTopContext();
    }
};
 
struct KDEVPLATFORMLANGUAGE_EXPORT RecursiveImportCacheRepository
{
    static Utils::BasicSetRepository* repository();
};
 
class KDEVPLATFORMLANGUAGE_EXPORT PersistentSymbolTable
{
public:
    PersistentSymbolTable();
    ~PersistentSymbolTable();
 
    void addDeclaration(const IndexedQualifiedIdentifier& id, const IndexedDeclaration& declaration);
 
    void removeDeclaration(const IndexedQualifiedIdentifier& id, const IndexedDeclaration& declaration);
 
    void declarations(const IndexedQualifiedIdentifier& id, uint& count, const IndexedDeclaration*& declarations) const;
 
    using Declarations = ConstantConvenientEmbeddedSet<IndexedDeclaration, IndexedDeclarationHandler>;
 
    Declarations declarations(const IndexedQualifiedIdentifier& id) const;
 
    using CachedIndexedRecursiveImports =
        Utils::StorableSet<IndexedTopDUContext, IndexedTopDUContextIndexConversion, RecursiveImportCacheRepository,
        true>;
 
    using FilteredDeclarationIterator =
        ConvenientEmbeddedSetTreeFilterIterator<IndexedDeclaration, IndexedDeclarationHandler, IndexedTopDUContext,
        CachedIndexedRecursiveImports, DeclarationTopContextExtractor>;
    FilteredDeclarationIterator filteredDeclarations(const IndexedQualifiedIdentifier& id,
                                                     const TopDUContext::IndexedRecursiveImports& visibility) const;
 
    static PersistentSymbolTable& self();
 
    //Very expensive: Checks for problems in the symbol table
    void dump(const QTextStream& out);
 
    //Clears the internal cache. Should be called regularly to save memory
    //The duchain must be read-locked
    void clearCache();
 
private:
    // cannot use QScopedPointer yet, see comment in ~PersistentSymbolTable()
    class PersistentSymbolTablePrivate* const d_ptr;
    Q_DECLARE_PRIVATE(PersistentSymbolTable)
};
}
 
#endif