history_lock.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef HISTORY_LOCK_H
#define HISTORY_LOCK_H
 
#include <kicommon.h>
 
#include <memory>
#include <wx/string.h>
 
struct git_repository;
struct git_index;
class LOCKFILE;

class KICOMMON_API HISTORY_LOCK_MANAGER
{
public:
    HISTORY_LOCK_MANAGER( const wxString& aProjectPath, int aStaleTimeoutSec = 0 );

    ~HISTORY_LOCK_MANAGER();
 
    // Non-copyable
    HISTORY_LOCK_MANAGER( const HISTORY_LOCK_MANAGER& ) = delete;
    HISTORY_LOCK_MANAGER& operator=( const HISTORY_LOCK_MANAGER& ) = delete;

    bool IsLocked() const;

    git_repository* GetRepository() { return m_repo; }

    git_index* GetIndex() { return m_index; }

    wxString GetLockError() const;

    wxString GetLockHolder() const;

    static bool IsLockStale( const wxString& aProjectPath, int aStaleTimeoutSec = 0 );

    static bool BreakStaleLock( const wxString& aProjectPath );

    void ReleaseRepository();
 
private:
    wxString                      m_projectPath;
    wxString                      m_historyPath;
    std::unique_ptr<LOCKFILE>     m_fileLock;
    git_repository*               m_repo;
    git_index*                    m_index;
    bool                          m_repoOwned;
    bool                          m_indexOwned;
    wxString                      m_lockError;
    int                           m_staleTimeoutSec;
 
    bool acquireFileLock();
    bool openRepository();
    bool acquireIndexLock();
};
 
#endif // HISTORY_LOCK_H