local_history.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, you may find one here:
 * http://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#pragma once
 
#include <vector>
#include <functional>
#include <wx/string.h>
#include <wx/window.h>

class LOCAL_HISTORY
{
public:
    static bool Init( const wxString& aProjectPath );

    static bool CommitSnapshot( const std::vector<wxString>& aFiles, const wxString& aTitle );

    static bool CommitFullProjectSnapshot( const wxString& aProjectPath, const wxString& aTitle );

    static void RegisterSaver( const std::function<void( const wxString&, std::vector<wxString>& )>& aSaver );

    static bool RunRegisteredSaversAndCommit( const wxString& aProjectPath, const wxString& aTitle );

    static void NoteFileChange( const wxString& aFile );

    static bool CommitPending();
    static bool HistoryExists( const wxString& aProjectPath );

    static bool TagSave( const wxString& aProjectPath, const wxString& aFileType );

    static bool CommitDuplicateOfLastSave( const wxString& aProjectPath, const wxString& aFileType,
                                           const wxString& aMessage );

    static bool EnforceSizeLimit( const wxString& aProjectPath, size_t aMaxBytes );

    static bool HeadNewerThanLastSave( const wxString& aProjectPath );

    static wxString GetHeadHash( const wxString& aProjectPath );

    static bool RestoreCommit( const wxString& aProjectPath, const wxString& aHash );

    static void ShowRestoreDialog( const wxString& aProjectPath, wxWindow* aParent );
};