tokendatabase.h

#ifndef TOKENDATABASE_H
#define TOKENDATABASE_H

#include "clangpluginapi.h"

#include <vector>
#include <wx/thread.h>
#include <wx/string.h>
#include <wx/archive.h>

template<typename _Tp> class ClTreeMap;
class wxString;
typedef int ClFileId;

struct ClAbstractToken
{
    ClAbstractToken() :
        tokenType(ClTokenType_Unknown), fileId(-1), location(ClTokenPosition( 0, 0 )), identifier(), tokenHash(0) {}
    ClAbstractToken(ClTokenType typ, ClFileId fId, ClTokenPosition loc, wxString name, unsigned tknHash) :
        tokenType(typ), fileId(fId), location(loc), identifier(name), tokenHash(tknHash) {}
    ClAbstractToken( const ClAbstractToken& other ) :
        tokenType(other.tokenType), fileId(other.fileId), location(other.location),
        identifier(other.identifier), tokenHash(other.tokenHash) {}

    static bool ReadIn(ClAbstractToken& token, wxInputStream& in);
    static bool WriteOut(const ClAbstractToken& token,  wxOutputStream& out);

    ClTokenType tokenType;
    ClFileId fileId;
    ClTokenPosition location;
    wxString identifier;
    unsigned tokenHash;
};

class ClFilenameEntry
{
public:
    ClFilenameEntry(wxString _filename, wxDateTime _timestamp) :
        filename(_filename),
        timestamp(_timestamp) {}
    wxString filename;
    wxDateTime timestamp;
};

class ClFilenameDatabase
{
public:
    ClFilenameDatabase();
    ~ClFilenameDatabase();

    static bool ReadIn(ClFilenameDatabase& tokenDatabase, wxInputStream& in);
    static bool WriteOut(const ClFilenameDatabase& db, wxOutputStream& out);

    ClFileId GetFilenameId(const wxString& filename) const;
    wxString GetFilename(const ClFileId fId) const;
    const wxDateTime GetFilenameTimestamp(const ClFileId fId) const;
    void UpdateFilenameTimestamp(const ClFileId fId, const wxDateTime& timestamp);
private:
    ClTreeMap<ClFilenameEntry>* m_pFileEntries;
    mutable wxMutex m_Mutex;
};

class ClTokenDatabase
{
public:
    ClTokenDatabase(ClFilenameDatabase& fileDB);
    ClTokenDatabase(const ClTokenDatabase& other);
    ~ClTokenDatabase();

    friend void swap(ClTokenDatabase& first, ClTokenDatabase& second);


    static bool ReadIn(ClTokenDatabase& tokenDatabase, wxInputStream& in);
    static bool WriteOut(const ClTokenDatabase& tokenDatabase, wxOutputStream& out);

    ClFileId GetFilenameId(const wxString& filename) const;
    wxString GetFilename(const ClFileId fId) const;
    wxDateTime GetFilenameTimestamp(const ClFileId fId) const;
    ClTokenId GetTokenId(const wxString& identifier, ClFileId fId, ClTokenType tokenType, unsigned tokenHash) const; ///< returns wxNOT_FOUND on failure
    ClTokenId InsertToken(const ClAbstractToken& token); // duplicate tokens are discarded
    ClAbstractToken GetToken(const ClTokenId tId) const;
    ClFilenameDatabase& GetFileDB() const
    {
        return m_FileDB;
    }
    void RemoveToken(const ClTokenId tokenId);
    /**
     * Return a list of tokenId's for the given token identifier
     */
    std::vector<ClTokenId> GetTokenMatches(const wxString& identifier) const;
    /**
     * Return a list of tokenId's that are found in the given file
     */
    std::vector<ClTokenId> GetFileTokens(const ClFileId fId) const;

    /**
     * Clears the database
     */
    void Clear();
    /**
     * Shrinks the database by removing all unnecessary elements and memory
     */
    void Shrink();

    /**
     * Updates the data from the argument into the database. This invalidates any token previously present in the database, replacing it by the matching token from the merged-in database.
     */
    void Update(const ClFileId fileId, const ClTokenDatabase& db);
    unsigned long GetTokenCount();
private:
    void UpdateToken(const ClTokenId tokenId, const ClAbstractToken& token);
private:
    ClFilenameDatabase& m_FileDB;
    ClTreeMap<ClAbstractToken>* m_pTokens;
    ClTreeMap<int>* m_pFileTokens;
    mutable wxMutex m_Mutex;
};

#endif // TOKENDATABASE_H