panel_git_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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef PANEL_GIT_HISTORY_H
#define PANEL_GIT_HISTORY_H
 
#include <map>
#include <set>
#include <string>
#include <atomic>
#include <thread>
#include <vector>
 
#include <wx/bitmap.h>
#include <wx/timer.h>
 
#include <dialogs/git/panel_git_history_base.h>
#include <dialogs/git/git_transfer.h>
#include <widgets/wx_debounced_action.h>
 
class EDA_BASE_FRAME;
class GIT_ADVANCED_DIALOG;
class GIT_FILE_DIFF_AREA;
struct KIGIT_BRANCH_INFO;
struct KIGIT_COMMIT_DETAIL;
struct KIGIT_COMMIT_INFO;
struct KIGIT_HISTORY_FILTER;
namespace KIGIT
{
struct GIT_IDENTITY;
}
 

class PANEL_GIT_HISTORY : public PANEL_GIT_HISTORY_BASE
{
public:
    PANEL_GIT_HISTORY( wxWindow* aParent, GIT_ADVANCED_DIALOG* aDialog, EDA_BASE_FRAME* aFrame );
    ~PANEL_GIT_HISTORY() override;

    void Populate();

    void SetBranches( const std::vector<KIGIT_BRANCH_INFO>& aBranches );

    void ShowHistoryForFile( const wxString& aPath );
 
private:
    void reloadHistory();

    void fillHistory( const std::vector<KIGIT_COMMIT_INFO>& aCommits, size_t aLimit );

    KIGIT_HISTORY_FILTER historyFilter() const;

    void showCommitDetail( const wxString& aHash );
    void fillCommitDetail( const KIGIT_COMMIT_DETAIL& aDetail );
    void clearCommitDetail();

    void showFileDiff( const wxString& aPath );
    void hideFileDiff();

    void appendHistoryRows( const std::vector<KIGIT_COMMIT_INFO>& aCommits, size_t aFrom );

    void onHistoryScrollTick();

    void requestAvatar( const wxString& aEmail, int aDiameter );

    void applyAvatar( const wxString& aEmail, int aDiameter, const std::string& aBytes );

    void onRestoreVersion( const wxString& aCommitHash );
    void restoreVersion( const wxString& aCommitHash, const KIGIT::GIT_IDENTITY& aIdentity );
 
    GIT_ADVANCED_DIALOG* m_dialog;
    EDA_BASE_FRAME*      m_frame;
 
    wxDataViewColumn*   m_historyRefsColumn;
    GIT_FILE_DIFF_AREA* m_fileDiff;

    std::atomic<bool> m_avatarCancel{ false };

    std::vector<std::thread> m_avatarWorkers;

    std::vector<wxString> m_historyEmails;

    std::vector<bool> m_historyAtHead;

    std::map<wxString, wxBitmap> m_avatarCache;

    std::set<wxString> m_avatarRequested;

    KIGIT_QUERY m_historyQuery;
    KIGIT_QUERY m_detailQuery;

    KIGIT_QUERY m_actionQuery;

    WX_DEBOUNCED_ACTION m_historySearchDebounce;

    wxTimer m_historyScrollTimer;

    size_t m_historyLimit = 50;

    wxString m_historyBranchName;

    wxString m_historyPath;

    wxString m_detailHash;

    wxString m_detailEmail;

    wxString m_detailParent;

    int m_historySashPos = 0;

    int m_detailSashPos = 0;

    bool m_historyComplete = false;

    bool m_fillingHistory = false;
};
 
#endif // PANEL_GIT_HISTORY_H