topducontextdynamicdata.h

Go to the documentation of this file.

/* This 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_TOPDUCONTEXTDYNAMICDATA_H
#define KDEVPLATFORM_TOPDUCONTEXTDYNAMICDATA_H
 
#include <QVector>
#include <QByteArray>
#include "problem.h"
 
class QFile;
 
namespace KDevelop {
class TopDUContext;
class DUContext;
class Declaration;
class IndexedString;
class IndexedDUContext;
class DUChainBaseData;
 
class TopDUContextDynamicData
{
public:
    explicit TopDUContextDynamicData(TopDUContext* topContext);
    ~TopDUContextDynamicData();
 
    void clear();
 
    uint allocateDeclarationIndex(Declaration* decl, bool temporary);
 
    Declaration* declarationForIndex(uint index) const;
 
    bool isDeclarationForIndexLoaded(uint index) const;
 
    void clearDeclarationIndex(Declaration* decl);
 
    uint allocateContextIndex(DUContext* ctx, bool temporary);
 
    DUContext* contextForIndex(uint index) const;
 
    bool isContextForIndexLoaded(uint index) const;
 
    void clearContextIndex(DUContext* ctx);
 
    uint allocateProblemIndex(const ProblemPointer& problem);
    ProblemPointer problemForIndex(uint index) const;
    void clearProblems();
 
    void store();
 
    void deleteOnDisk();
 
    bool isOnDisk() const;
 
    static TopDUContext* load(uint topContextIndex);
 
    static IndexedString loadUrl(uint topContextIndex);
 
    static bool fileExists(uint topContextIndex);
 
    static QList<IndexedDUContext> loadImporters(uint topContextIndex);
 
    static QList<IndexedDUContext> loadImports(uint topContextIndex);
 
    bool isTemporaryContextIndex(uint index) const;
    bool isTemporaryDeclarationIndex(uint index) const;
 
    bool m_deleting; 
 
    struct ItemDataInfo
    {
        uint dataOffset; 
        uint parentContext; 
    };
 
    struct ArrayWithPosition
    {
        QByteArray array;
        uint position;
    };
 
private:
    bool hasChanged() const;
 
    void unmap();
    //Converts away from an mmap opened file to a data array
 
    QString filePath() const;
 
    void loadData() const;
 
    const char* pointerInData(uint offset) const;
 
    ItemDataInfo writeDataInfo(const ItemDataInfo& info, const DUChainBaseData* data, uint& totalDataOffset);
 
    TopDUContext* m_topContext;
 
    template <class Item>
    struct DUChainItemStorage
    {
        explicit DUChainItemStorage(TopDUContextDynamicData* data);
        ~DUChainItemStorage();
 
        void clearItems();
        bool itemsHaveChanged() const;
 
        void storeData(uint& currentDataOffset, const QVector<ArrayWithPosition>& oldData);
        Item itemForIndex(uint index) const;
 
        void clearItemIndex(const Item& item, const uint index);
 
        uint allocateItemIndex(const Item& item, const bool temporary);
 
        void deleteOnDisk();
        bool isItemForIndexLoaded(uint index) const;
 
        void loadData(QFile* file) const;
        void writeData(QFile* file);
 
        //May contain zero items if they were deleted
        mutable QVector<Item> items;
        mutable QVector<ItemDataInfo> offsets;
        QVector<Item> temporaryItems;
        TopDUContextDynamicData* const data;
    };
 
    DUChainItemStorage<DUContext*> m_contexts;
    DUChainItemStorage<Declaration*> m_declarations;
    DUChainItemStorage<ProblemPointer> m_problems;
 
    //For temporary declarations that will not be stored to disk, like template instantiations
 
    mutable QVector<ArrayWithPosition> m_data;
    mutable QVector<ArrayWithPosition> m_topContextData;
    bool m_onDisk;
    mutable bool m_dataLoaded;
 
    mutable QFile* m_mappedFile;
    mutable uchar* m_mappedData;
    mutable size_t m_mappedDataSize;
    mutable bool m_itemRetrievalForbidden;
};
}
 
Q_DECLARE_TYPEINFO(KDevelop::TopDUContextDynamicData::ItemDataInfo, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(KDevelop::TopDUContextDynamicData::ArrayWithPosition, Q_MOVABLE_TYPE);
 
#endif