git_commit_pane.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_COMMIT_PANE_H
#define GIT_COMMIT_PANE_H
 
#include <atomic>
#include <functional>
#include <memory>
#include <set>
 
#include <dialogs/git/git_commit_pane_base.h>
#include <dialogs/git/git_transfer.h>
#include <git/git_editor_snapshot.h>
 
class EDA_BASE_FRAME;
class GIT_ADVANCED_DIALOG;
class KIGIT_COMMON;
enum class GitOperation;
class wxCommandEvent;
class wxMenuItem;
class wxDataViewEvent;
class wxStaticText;
 

class GIT_COMMIT_PANE : public GIT_COMMIT_PANE_BASE
{
public:
    GIT_COMMIT_PANE( EDA_BASE_FRAME* aParent );

    GIT_COMMIT_PANE( wxWindow* aParent, EDA_BASE_FRAME* aFrame );
    ~GIT_COMMIT_PANE() override;

    void SetFileSelectedHandler( std::function<void( const wxString& )> aHandler );

    wxString GetCommitMessage() const;
    void     SetCommitMessage( const wxString& aMessage );

    void SetMessageChangedHandler( std::function<void()> aHandler ) { m_messageChangedHandler = aHandler; }

    void RefreshFileList();

    void SetTransferBusy( bool aBusy, const wxString& aStatus = wxEmptyString );

    void ShowTransferProgress( const wxString& aText );

    void ReloadAdvancedWindow();

    void Pull();

    void Push();

    void BeginAmend( const wxString& aExpectedCommit = wxEmptyString );

    void SetBusyChangedHandler( std::function<void( bool )> aHandler ) { m_busyChangedHandler = aHandler; }

    int GetMinDockWidth() const { return m_minDockWidth; }
 
private:
    void onCommit( wxCommandEvent& aEvent );
    void onCommitAndPush( wxCommandEvent& aEvent );
    void onPull( wxCommandEvent& aEvent );

    void abandonOperation( std::shared_ptr<KIGIT_COMMON> aCommon );
    void finishAbandonOperation( std::shared_ptr<KIGIT_COMMON> aCommon, const std::vector<wxString>& aOutside );
    void onAmendToggled( wxCommandEvent& aEvent );
    void onNewBranchToggled( wxCommandEvent& aEvent );
    void onRecentMessage( wxCommandEvent& aEvent );
    void onShowDiff( wxCommandEvent& aEvent );
    void onFileActivated( wxDataViewEvent& aEvent );
    void onChecklistContextMenu( wxDataViewEvent& aEvent );
    void discardFile( std::shared_ptr<KIGIT_COMMON> aCommon, const wxString& aPath );
    void confirmDiscardFile( std::shared_ptr<KIGIT_COMMON> aCommon, const wxString& aPath, bool aTracked,
                             bool aConflicted, wxString aRoot );

    void doCommit( bool aAndPush );
 
    struct COMMIT_REQUEST;
    void saveForCommit( std::shared_ptr<KIGIT_COMMON> aCommon, std::shared_ptr<COMMIT_REQUEST> aRequest );
    void finishCommit( std::shared_ptr<KIGIT_COMMON> aCommon, const COMMIT_REQUEST& aRequest );
    void onChecklistChanged( wxDataViewEvent& aEvent );
    void onMessageChanged( wxCommandEvent& aEvent );
    void onIdle( wxIdleEvent& aEvent );
    void onSize( wxSizeEvent& aEvent );

    void onSettings( wxCommandEvent& aEvent );
    void setAuthor();

    void setStatusText( const wxString& aText );

    bool transferCanStart();

    void layoutWide();

    void updateSummary();
 
    struct STATUS;

    void applyStatus( const STATUS& aStatus );

    void populateBranches( const STATUS& aStatus );

    void populateRecentMessages( const std::vector<wxString>& aMessages );

    void updateDescriptionHint();
    void setDescription( const wxString& aText );

    void showDisabledState();

    void setBusy( bool aBusy, const wxString& aStatus );

    void runActionQuery( std::shared_ptr<KIGIT_COMMON> aCommon, std::function<void( KIGIT_COMMON& )> aWork,
                         std::function<void()> aDone, const wxString& aStatus );
 
    // The on*Done continuations run back on the UI thread, so credential prompts and
    // confirmations stay there.
    void submitPush( std::shared_ptr<KIGIT_COMMON> aCommon );
    void startPush( std::shared_ptr<KIGIT_COMMON> aCommon, const wxString& aBranch, const wxString& aHead );
    void onPushDone( std::shared_ptr<KIGIT_COMMON> aCommon, int aResult, const wxString& aError, bool aAuthFailure,
                     bool aCancelled );
    void submitPull( std::shared_ptr<KIGIT_COMMON> aCommon, bool aThenPush );
    void startPull( std::shared_ptr<KIGIT_COMMON> aCommon, bool aThenPush );

    void resolvePullConflicts( std::shared_ptr<KIGIT_COMMON> aCommon, bool aThenPush );
    struct MERGE_PREPARATION;
    void finishPullConflictPreparation( std::shared_ptr<KIGIT_COMMON> aCommon, bool aThenPush,
                                        std::shared_ptr<MERGE_PREPARATION> aPreparation );
    void onPullDone( std::shared_ptr<KIGIT_COMMON> aCommon, int aResult, const wxString& aError, bool aAuthFailure,
                     bool aThenPush, bool aCancelled );

    void updateMessageVisibility( bool aHasChanges );

    void updateCommitButton();

    void updateSummaryCount();

    wxString operationNoun() const;

    wxString abandonLabel() const;

    void syncListener();
 
    EDA_BASE_FRAME* m_frame;

    int m_minDockWidth = 0;

    bool m_inAdvancedWindow = false;
 
    bool m_hasUnpushedCommits;
 
    bool m_hasRemote;

    bool m_hasRepo = false;

    bool m_headDetached;

    bool m_upstreamAhead;

    bool m_operationInProgress;

    GitOperation m_operation;

    bool m_editorsDirty;

    bool m_canAmend = false;

    std::pair<wxString, wxString> m_amendHead;

    wxStaticText* m_descriptionHint = nullptr;

    std::vector<wxString> m_recentMessageTexts;

    wxMenuItem* m_commitAndPushItem = nullptr;

    bool m_commitButtonPushes = false;
 

    KIGIT_TRANSFER m_transfer;
 

    std::function<void( bool )> m_busyChangedHandler;

    wxString m_statusText;

    bool m_listenerAttached = false;

    std::weak_ptr<KIGIT_COMMON> m_listenerSession;

    std::set<wxString> m_shownPaths;

    EDITOR_SNAPSHOT m_docsBeforePull;

    std::function<void()> m_messageChangedHandler;

    wxString m_currentBranch;
 
    std::function<void( const wxString& )> m_fileSelectedHandler;
 
    // The summary box of the wide layout. Null in the docked panel.
    wxStaticText* m_summaryFiles = nullptr;
    wxStaticText* m_summaryAdded = nullptr;
    wxStaticText* m_summaryRemoved = nullptr;

    std::pair<int, int> m_lineStats;

    KIGIT_QUERY m_refresh;
    KIGIT_QUERY m_actionQuery;
    bool        m_actionPending = false;
};
 
#endif // GIT_COMMIT_PANE_H