git_status_entries.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 GIT_STATUS_ENTRIES_H
#define GIT_STATUS_ENTRIES_H
 
#include <functional>
#include <vector>
 
#include <gestfich.h>
#include <git/git_editor_snapshot.h>
#include <widgets/file_checklist_ctrl.h>
#include <diff_merge/diff_doc_kind.h>
 
class EDA_BASE_FRAME;
class KIWAY;
class KIGIT_COMMON;
class KIGIT_QUERY;
class wxWindow;
struct git_repository;
 

class GIT_DIFF_WORKSPACE
{
public:
    GIT_DIFF_WORKSPACE();
 
    GIT_DIFF_WORKSPACE( const GIT_DIFF_WORKSPACE& ) = delete;
    GIT_DIFF_WORKSPACE& operator=( const GIT_DIFF_WORKSPACE& ) = delete;

    bool IsOk() const { return !m_root.Path().IsEmpty(); }

    const wxString& Root() const { return m_root.Path(); }

    wxString Materialize( git_repository* aRepo, const wxString& aRef, const wxString& aRelPath,
                          KICAD_DIFF::DOC_KIND aKind );
 
private:
    SCOPED_TEMP_PATH m_root;
    int              m_slot = 0;
};

std::vector<FILE_CHECKLIST_ENTRY> BuildGitChangeEntries( KIGIT_COMMON& aCommon, const wxString& aProjectPath,
                                                         bool aDarkTheme );

enum class GIT_EDITOR_PREP
{
    COMMIT,      
    WORKING_TREE 
};

bool PrepareEditorsForGitOperation( EDA_BASE_FRAME* aFrame, GIT_EDITOR_PREP aPurpose, bool* aSavedEditors = nullptr );

bool DocumentEditorsDirty( KIWAY& aKiway );

bool EditorsDirty( KIWAY& aKiway );

std::vector<wxString> LibraryEditorsWithUnsavedChanges( KIWAY& aKiway );

std::vector<wxString> ChangedTrackedFilesOutsideProject( KIGIT_COMMON& aCommon, const wxString& aProjectPath );

struct GIT_WORKTREE_STATUS
{
    bool                  checked = false;
    bool                  hasTrackedChanges = false;
    wxString              lfsMessage;
    std::vector<wxString> outsideProject;

    wxString RefusalMessage( const std::vector<wxString>& aUnsavedEditors, bool aAllowTrackedChanges = false ) const;
};

GIT_WORKTREE_STATUS ReadGitWorktreeStatus( KIGIT_COMMON& aCommon, const wxString& aProjectPath );

bool ProjectSafeToRewrite( EDA_BASE_FRAME* aFrame, wxWindow* aParent, const GIT_WORKTREE_STATUS& aStatus,
                           bool aAllowTrackedChanges = false );

EDITOR_SNAPSHOT CaptureOpenEditorDocs( KIWAY& aKiway );

void ReloadOpenEditors( KIWAY& aKiway, const EDITOR_SNAPSHOT& aBefore );

void ProjectClearOfUncommittedWork( EDA_BASE_FRAME* aFrame, wxWindow* aParent, KIGIT_QUERY& aQuery,
                                    std::function<void( const GIT_WORKTREE_STATUS& )> aReady );

void SwitchProjectToBranch( EDA_BASE_FRAME* aFrame, wxWindow* aParent, const wxString& aBranch, KIGIT_QUERY& aQuery,
                            std::function<void()> aFinished = {} );

void ShowGitFileDiff( EDA_BASE_FRAME* aFrame, const wxString& aRelativePath );

void ShowGitCommitDiff( EDA_BASE_FRAME* aFrame, const wxString& aCommitHash, wxWindow* aParentWindow = nullptr,
                        const wxString& aRelativePath = wxEmptyString );

struct GIT_FILE_SIDES
{
    wxString             before; 
    wxString             after;
    KICAD_DIFF::DOC_KIND kind = KICAD_DIFF::DOC_KIND::UNKNOWN;
    wxString             error;  
};

bool MaterializeCommitFile( KIGIT_COMMON& aCommon, GIT_DIFF_WORKSPACE& aWorkspace, const wxString& aCommitHash,
                            const wxString& aRelativePath, GIT_FILE_SIDES& aSides );

bool MaterializeWorkingFile( KIGIT_COMMON& aCommon, GIT_DIFF_WORKSPACE& aWorkspace, const wxString& aRelativePath,
                             GIT_FILE_SIDES& aSides );
 
#endif // GIT_STATUS_ENTRIES_H