project_tree_pane.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2012 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * 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 2
 * 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 TREEPRJ_FRAME_H
#define TREEPRJ_FRAME_H
 
#include <map>
#include <memory>
#include <mutex>
#include <unordered_map>
#include <vector>
#include <future>
#include <wx/datetime.h>
#include <wx/fswatcher.h>
#include <wx/laywin.h>
#include <wx/timer.h>
#include <wx/treebase.h>
 
#include <git/kicad_git_common.h>
#include <git/kigit_failure.h>
#include "tree_file_type.h"
 
 
class KICAD_MANAGER_FRAME;
class KIGIT_QUERY;
class PROJECT_TREE_ITEM;
class PROJECT_TREE;

class PROJECT_TREE_PANE : public wxSashLayoutWindow
{
    friend class PROJECT_TREE_ITEM;
 
public:
    PROJECT_TREE_PANE( KICAD_MANAGER_FRAME* parent );
    ~PROJECT_TREE_PANE();

    void ReCreateTreePrj();

    void FileWatcherReset();

    void EmptyTreePrj();

    void WaitForGitOperations();
 
protected:
    static wxString GetFileExt( TREE_FILE_TYPE type );

    std::vector<PROJECT_TREE_ITEM*> GetSelectedData();

    PROJECT_TREE_ITEM* GetItemIdData( wxTreeItemId aId );
 
private:
    void onSelect( wxTreeEvent& Event );

    void onExpand( wxTreeEvent& Event );

    void onRight( wxTreeEvent& Event );
 
    void showContextMenu();

    void onOpenSelectedFileWithTextEditor( wxCommandEvent& event );

    void onDeleteFile( wxCommandEvent& event );

    void onRenameFile( wxCommandEvent& event );

    void onOpenDirectory( wxCommandEvent& event );

    void onCreateNewDirectory( wxCommandEvent& event );

    void onSwitchToSelectedProject( wxCommandEvent& event );

    void onIdle( wxIdleEvent& aEvent );

    void onPaint( wxPaintEvent& aEvent );

    void onGitInitializeProject( wxCommandEvent& event );

    void onGitRemoteSettings( wxCommandEvent& event );

    void onGitSwitchBranch( wxCommandEvent& event );
    void switchGitBranch( std::shared_ptr<KIGIT_COMMON> aCommon, const wxString& aBranchName, bool aCreate );

    void onGitRemoveVCS( wxCommandEvent& event );

    void onRunSelectedJobsFile( wxCommandEvent& event );

    void updateGitStatusIcons();

    void updateGitStatusIconMap( std::shared_ptr<KIGIT_COMMON> aGitCommon, const wxString& aProjectFullName );

    void updateTreeCache();

    void releaseGitRepo();

    std::shared_ptr<KIGIT_COMMON> gitCommon() const;

    void syncGitListener();
 
    git_repository* gitRepo() const;

    bool hasLocalCommits();

    void shutdownFileWatcher();

    wxTreeItemId addItemToProjectTree( const wxString& aName, const wxTreeItemId& aParent,
                                       std::vector<wxString>* aProjectNames, bool aRecurse );

    wxTreeItemId findSubdirTreeItem( const wxString& aSubDir );

    void onFileSystemEvent( wxFileSystemWatcherEvent& event );
 
    void onThemeChanged( wxSysColourChangedEvent &aEvent );
 
    void onGitSyncTimer( wxTimerEvent& event );
 
    void onGitStatusTimer( wxTimerEvent& event );
 
    void gitStatusTimerHandler();

    void reportGitSyncResult( bool aFetched, std::optional<KIGIT_FAILURE> aKind, const wxString& aSummary );
 
public:
    KICAD_MANAGER_FRAME*    m_Parent;
    PROJECT_TREE*           m_TreeProject;
 
private:
    bool                    m_isRenaming;       // Are we in the process of renaming a file
    wxTreeItemId            m_root;
    std::vector<wxString>   m_filters;
    wxFileSystemWatcher*    m_watcher;          // file system watcher
    PROJECT_TREE_ITEM*      m_selectedItem;
    bool                    m_watcherNeedReset; // true if FileWatcherReset() must be called
                                                // (during an idle time for instance) after
                                                // the main loop event handler is started
    wxString                m_gitCurrentBranchName;
    wxTimer                 m_gitSyncTimer;
    wxTimer                 m_gitStatusTimer;
    std::future<void>       m_gitSyncTask;
    std::future<void>       m_gitStatusIconTask;
 
    std::weak_ptr<KIGIT_COMMON> m_gitListenerSession;

    std::vector<wxString>       m_gitMenuBranches;
    std::weak_ptr<KIGIT_COMMON> m_gitMenuSession;

    std::unique_ptr<KIGIT_QUERY> m_branchQuery;
 
    std::mutex                                       m_gitTreeCacheMutex;
    std::unordered_map<wxString, wxTreeItemId>       m_gitTreeCache;
    std::mutex                                       m_gitStatusMutex;
    std::map<wxTreeItemId, KIGIT_COMMON::GIT_STATUS> m_gitStatusIcons;
    bool                                             m_gitIconsInitialized;
 
    DECLARE_EVENT_TABLE()
};
 
#endif    // TREEPRJ_FRAME_H