Window to display the tree files. More...

#include <project_tree_pane.h>

Inheritance diagram for PROJECT_TREE_PANE:

Public Member Functions
	PROJECT_TREE_PANE (KICAD_MANAGER_FRAME *parent)

	~PROJECT_TREE_PANE ()

void	ReCreateTreePrj ()
	Create or modify the tree showing project file names.

void	FileWatcherReset ()
	Reinit the watched paths Should be called after opening a new project to rebuild the list of watched paths.

void	EmptyTreePrj ()
	Delete all m_TreeProject entries.

Public Attributes
KICAD_MANAGER_FRAME *	m_Parent

PROJECT_TREE *	m_TreeProject

Protected Member Functions
std::vector< PROJECT_TREE_ITEM * >	GetSelectedData ()
	Return the item data from item currently selected (highlighted)

PROJECT_TREE_ITEM *	GetItemIdData (wxTreeItemId aId)
	Return the item data corresponding to a wxTreeItemId identifier.

Static Protected Member Functions
static wxString	GetFileExt (TREE_FILE_TYPE type)

Private Member Functions
void	onSelect (wxTreeEvent &Event)
	Called on a double click on an item.

void	onExpand (wxTreeEvent &Event)
	Called on a click on the + or - button of an item with children.

void	onRight (wxTreeEvent &Event)
	Called on a right click on an item.

void	onOpenSelectedFileWithTextEditor (wxCommandEvent &event)
	Call the text editor to open the selected file in the tree project.

void	onDeleteFile (wxCommandEvent &event)
	Delete the selected file or directory in the tree project.

void	onRenameFile (wxCommandEvent &event)
	Rename the selected file or directory in the tree project.

void	onOpenDirectory (wxCommandEvent &event)
	Handles the right-click menu for opening a directory in the current system file browser.

void	onCreateNewDirectory (wxCommandEvent &event)
	Creates a new subdirectory inside the current kicad project directory the user is prompted to enter a directory name.

void	onSwitchToSelectedProject (wxCommandEvent &event)
	Switch to a other project selected from the tree project (by selecting an other .pro file inside the current project folder)

void	onIdle (wxIdleEvent &aEvent)
	Idle event handler, used process the selected items at a point in time when all other events have been consumed.

void	onPaint (wxPaintEvent &aEvent)
	We don't have uniform borders so we have to draw them ourselves.

void	onGitInitializeProject (wxCommandEvent &event)
	Initialize a new git repository in the current project directory.

void	onGitRemoteSettings (wxCommandEvent &event)
	Configure (or change) the default remote on an already-initialized repository.

void	onGitCommit (wxCommandEvent &event)
	Commit the current project saved changes to the git repository.

void	onGitAmendCommit (wxCommandEvent &event)
	Amend (rewrite) the last commit on the current branch.

void	onGitPullProject (wxCommandEvent &event)
	Pull the latest changes from the git repository.

void	onGitPushProject (wxCommandEvent &event)
	Push the current project changes to the git repository.

void	onGitSwitchBranch (wxCommandEvent &event)
	Switch to a different branch in the git repository.

void	onGitCompare (wxCommandEvent &event)
	Compare the current project to a different branch in the git repository.

void	onGitRemoveVCS (wxCommandEvent &event)
	Remove the git repository from the current project directory.

void	onGitAddToIndex (wxCommandEvent &event)
	Add a file to the git index.

void	onGitRemoveFromIndex (wxCommandEvent &event)
	Remove a file from the git index.

void	onGitSyncProject (wxCommandEvent &event)
	Sync the current project with the git repository.

void	onGitFetch (wxCommandEvent &event)
	Fetch the latest changes from the git repository.

void	onGitResolveConflict (wxCommandEvent &event)
	Resolve conflicts in the git repository.

void	onGitRevertLocal (wxCommandEvent &event)
	Revert the local repository to the last commit.

void	onRunSelectedJobsFile (wxCommandEvent &event)
	Run a selected jobs file.

void	updateGitStatusIcons ()
	Updates the icons shown in the tree project to reflect the current git status.

void	updateGitStatusIconMap ()
	This is a threaded call that will change the map of git status icons for use in the main thread.

void	updateTreeCache ()
	Updates the map of the wxtreeitemid to the name of each file for use in the thread.

void	releaseGitRepo ()
	Releases the git repository handle, deferring the free to the orphan registry while a background git operation still holds the action mutex.

bool	hasChangedFiles ()
	Returns true if the current project has any uncommitted changes.

bool	hasLocalCommits ()
	Returns true if the current project has local commits that have not been pushed to the remote repository.

void	shutdownFileWatcher ()
	Shutdown the file watcher.

wxTreeItemId	addItemToProjectTree (const wxString &aName, const wxTreeItemId &aParent, std::vector< wxString > *aProjectNames, bool aRecurse)
	Add the file or directory aName to the project tree.

wxTreeItemId	findSubdirTreeItem (const wxString &aSubDir)
	Search for the item in tree project which is the node of the subdirectory aSubDir.

void	onFileSystemEvent (wxFileSystemWatcherEvent &event)
	called when a file or directory is modified/created/deleted The tree project is modified when a file or directory is created/deleted/renamed to reflect the file change

void	onThemeChanged (wxSysColourChangedEvent &aEvent)

bool	canFileBeAddedToVCS (const wxString &aFilePath)
	Returns true if the file has already been added to the repository or false if it has not been added yet.

void	onGitSyncTimer (wxTimerEvent &event)

void	onGitStatusTimer (wxTimerEvent &event)

void	gitStatusTimerHandler ()

void	showGitFeedback (const wxString &aText)
	Show a short message in the project status bar after a git operation.

void	onGitFeedbackTimer (wxTimerEvent &event)

Private Attributes
bool	m_isRenaming

wxTreeItemId	m_root

std::vector< wxString >	m_filters

wxFileSystemWatcher *	m_watcher

PROJECT_TREE_ITEM *	m_selectedItem

bool	m_watcherNeedReset

int	m_gitLastError

wxString	m_gitCurrentBranchName

wxString	m_gitCurrentUpstream

wxTimer	m_gitSyncTimer

wxTimer	m_gitStatusTimer

wxTimer	m_gitFeedbackTimer

std::future< void >	m_gitSyncTask

std::future< void >	m_gitStatusIconTask

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

Friends
class	PROJECT_TREE_ITEM

Detailed Description

Window to display the tree files.

Definition at line 51 of file project_tree_pane.h.

Constructor & Destructor Documentation

◆ PROJECT_TREE_PANE()

PROJECT_TREE_PANE::PROJECT_TREE_PANE ( KICAD_MANAGER_FRAME * parent )

Definition at line 235 of file project_tree_pane.cpp.

References ID_LEFT_FRAME, m_filters, m_gitFeedbackTimer, m_gitIconsInitialized, m_gitLastError, m_gitStatusTimer, m_gitSyncTimer, m_isRenaming, m_Parent, m_selectedItem, m_TreeProject, m_watcher, m_watcherNeedReset, onFileSystemEvent(), onGitFeedbackTimer(), onGitStatusTimer(), onGitSyncTimer(), onThemeChanged(), PROJECT_TREE_PANE(), ReCreateTreePrj(), and s_allowedExtensionsToList.

Referenced by PROJECT_TREE_PANE().

◆ ~PROJECT_TREE_PANE()

PROJECT_TREE_PANE::~PROJECT_TREE_PANE ( )

Definition at line 272 of file project_tree_pane.cpp.

References m_gitFeedbackTimer, m_gitStatusIconTask, m_gitStatusTimer, m_gitSyncTask, m_gitSyncTimer, onFileSystemEvent(), onGitFeedbackTimer(), onGitStatusTimer(), onGitSyncTimer(), onThemeChanged(), and shutdownFileWatcher().

Member Function Documentation

◆ addItemToProjectTree()

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

private

Add the file or directory aName to the project tree.

Parameters

aName	= the filename or the directory name to add in tree
aParent	= the wxTreeItemId item where to add sub tree items
aProjectNames
aRecurse	= true to add file or subdir names to the current tree item false to stop file add.

Returns: the Id for the new tree item

Definition at line 447 of file project_tree_pane.cpp.

References addItemToProjectTree(), alg::contains(), DIRECTORY, PROJECT_TREE_ITEM::GetDir(), GetFileExt(), PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), getProjects(), PROJECT_TREE_ITEM::GetType(), KIPLATFORM::IO::IsFileHidden(), JSON_PROJECT, LEGACY_PROJECT, LEGACY_SCHEMATIC, m_filters, m_Parent, m_TreeProject, m_watcherNeedReset, MAX, path, PROJECT_TREE_ITEM, PROJECT_TREE_ITEM::SetPopulated(), PROJECT_TREE_ITEM::SetRootFile(), PROJECT_TREE_ITEM::SetState(), SEXPR_SCHEMATIC, and UNKNOWN.

Referenced by addItemToProjectTree(), onCreateNewDirectory(), onExpand(), onFileSystemEvent(), and ReCreateTreePrj().

◆ canFileBeAddedToVCS()

bool PROJECT_TREE_PANE::canFileBeAddedToVCS ( const wxString & aFilePath )

private

Returns true if the file has already been added to the repository or false if it has not been added yet.

Definition at line 3095 of file project_tree_pane.cpp.

References GIT_STATUS_HANDLER::GetFileStatus(), KIGIT_COMMON::GIT_STATUS_UNTRACKED, and m_TreeProject.

◆ EmptyTreePrj()

void PROJECT_TREE_PANE::EmptyTreePrj ( )

Delete all m_TreeProject entries.

Definition at line 1694 of file project_tree_pane.cpp.

References _, GetGitBackend(), KIGIT_COMMON::m_gitActionMutex, m_TreeProject, GIT_BACKEND::OrphanRegistry(), KIGIT_ORPHAN_REGISTRY::Register(), registered, KIGIT::PROJECT_GIT_UTILS::RemoveVCS(), KIGIT_COMMON::SetCancelled(), and shutdownFileWatcher().

◆ FileWatcherReset()

void PROJECT_TREE_PANE::FileWatcherReset ( )

Reinit the watched paths Should be called after opening a new project to rebuild the list of watched paths.

Should be called after the main loop event handler is started

Definition at line 1509 of file project_tree_pane.cpp.

References _, KIPLATFORM::ENV::IsNetworkPath(), m_Parent, m_watcher, m_watcherNeedReset, text, TO_UTF8, tracePathsAndFiles, and wxFileSystemWatcher.

Referenced by onIdle().

◆ findSubdirTreeItem()

wxTreeItemId PROJECT_TREE_PANE::findSubdirTreeItem ( const wxString & aSubDir )

private

Search for the item in tree project which is the node of the subdirectory aSubDir.

Parameters

aSubDir = the directory to find in tree

Returns: the opaque reference to the tree item; if not found, return an invalid tree item so that wxTreeItemId::IsOk() can be used to test the returned value

Definition at line 1323 of file project_tree_pane.cpp.

References DIRECTORY, PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), PROJECT_TREE_ITEM::GetType(), PROJECT_TREE_ITEM::IsPopulated(), m_Parent, m_root, m_TreeProject, and PROJECT_TREE_ITEM.

Referenced by onFileSystemEvent().

◆ GetFileExt()

wxString PROJECT_TREE_PANE::GetFileExt ( TREE_FILE_TYPE type )

staticprotected

Definition at line 379 of file project_tree_pane.cpp.

Referenced by addItemToProjectTree(), and PROJECT_TREE_ITEM::Rename().

◆ GetItemIdData()

PROJECT_TREE_ITEM * PROJECT_TREE_PANE::GetItemIdData ( wxTreeItemId aId )

protected

Return the item data corresponding to a wxTreeItemId identifier.

Parameters

aId	= the wxTreeItemId identifier.

Returns: a PROJECT_TREE_ITEM pointer corresponding to item id aId

Definition at line 1317 of file project_tree_pane.cpp.

References m_TreeProject, and PROJECT_TREE_ITEM.

Referenced by addItemToProjectTree(), findSubdirTreeItem(), GetSelectedData(), onExpand(), onFileSystemEvent(), onGitInitializeProject(), onIdle(), updateGitStatusIcons(), and updateTreeCache().

◆ GetSelectedData()

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

protected

Return the item data from item currently selected (highlighted)

Note: This is not necessary the "clicked" item. When expanding and collapsing an item this item is not selected.

Definition at line 1293 of file project_tree_pane.cpp.

References GetItemIdData(), m_TreeProject, PROJECT_TREE_ITEM, and traceGit.

Referenced by onCreateNewDirectory(), onDeleteFile(), onGitCommit(), onOpenDirectory(), onOpenSelectedFileWithTextEditor(), onRenameFile(), onRight(), onSelect(), and onSwitchToSelectedProject().

◆ gitStatusTimerHandler()

void PROJECT_TREE_PANE::gitStatusTimerHandler ( )

private

Definition at line 3265 of file project_tree_pane.cpp.

References GetKiCadThreadPool(), KIGIT_COMMON::IsCancelled(), m_gitStatusIconTask, m_TreeProject, tp, updateGitStatusIconMap(), and updateTreeCache().

Referenced by onGitStatusTimer(), and onGitSyncTimer().

◆ hasChangedFiles()

bool PROJECT_TREE_PANE::hasChangedFiles ( )

private

Returns true if the current project has any uncommitted changes.

Definition at line 802 of file project_tree_pane.cpp.

References GIT_STATUS_HANDLER::HasChangedFiles(), and m_TreeProject.

Referenced by onRight().

◆ hasLocalCommits()

bool PROJECT_TREE_PANE::hasLocalCommits ( )

private

Returns true if the current project has local commits that have not been pushed to the remote repository.

◆ onCreateNewDirectory()

void PROJECT_TREE_PANE::onCreateNewDirectory ( wxCommandEvent & event )

private

Creates a new subdirectory inside the current kicad project directory the user is prompted to enter a directory name.

Definition at line 349 of file project_tree_pane.cpp.

References _, addItemToProjectTree(), GetSelectedData(), m_Parent, and PROJECT_TREE_ITEM.

◆ onDeleteFile()

void PROJECT_TREE_PANE::onDeleteFile ( wxCommandEvent & event )

private

Delete the selected file or directory in the tree project.

Definition at line 1143 of file project_tree_pane.cpp.

References GetSelectedData(), and PROJECT_TREE_ITEM.

◆ onExpand()

void PROJECT_TREE_PANE::onExpand ( wxTreeEvent & Event )

private

Called on a click on the + or - button of an item with children.

Definition at line 1228 of file project_tree_pane.cpp.

References addItemToProjectTree(), DIRECTORY, PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), getProjects(), PROJECT_TREE_ITEM::GetType(), PROJECT_TREE_ITEM::IsPopulated(), m_TreeProject, m_watcherNeedReset, name, PROJECT_TREE_ITEM, and PROJECT_TREE_ITEM::SetPopulated().

◆ onFileSystemEvent()

void PROJECT_TREE_PANE::onFileSystemEvent ( wxFileSystemWatcherEvent & event )

private

called when a file or directory is modified/created/deleted The tree project is modified when a file or directory is created/deleted/renamed to reflect the file change

Definition at line 1381 of file project_tree_pane.cpp.

References addItemToProjectTree(), findSubdirTreeItem(), PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), m_gitStatusTimer, m_isRenaming, m_TreeProject, m_watcher, PROJECT_TREE_ITEM, and traceGit.

Referenced by PROJECT_TREE_PANE(), and ~PROJECT_TREE_PANE().

◆ onGitAddToIndex()

void PROJECT_TREE_PANE::onGitAddToIndex ( wxCommandEvent & event )

private

Add a file to the git index.

Definition at line 3089 of file project_tree_pane.cpp.

◆ onGitAmendCommit()

void PROJECT_TREE_PANE::onGitAmendCommit ( wxCommandEvent & event )

private

Amend (rewrite) the last commit on the current branch.

Definition at line 2796 of file project_tree_pane.cpp.

References _, GitUserConfig::authorEmail, GitUserConfig::authorName, FILEEXT::BackupFileSuffix, candidates(), KIGIT::CollectDiffDeltas(), DisplayErrorMessage(), flag, FRAME_PCB_EDITOR, FRAME_SCH, DIALOG_GIT_COMMIT::GetAuthorEmail(), DIALOG_GIT_COMMIT::GetAuthorName(), DIALOG_GIT_COMMIT::GetCommitMessage(), GIT_COMMIT_HANDLER::GetErrorString(), GIT_STATUS_HANDLER::GetFileStatus(), PROJECT::GetProjectPath(), KIGIT::PROJECT_GIT_UTILS::GetRepositoryForFile(), DIALOG_GIT_COMMIT::GetSelectedFiles(), GIT_CONFIG_HANDLER::GetUserConfig(), GIT_STATUS_HANDLER::GetWorkingDirectory(), KIGIT_COMMON::GIT_STATUS_CONFLICTED, KIGIT_COMMON::GIT_STATUS_CURRENT, KIGIT_COMMON::GIT_STATUS_IGNORED, EDA_BASE_FRAME::IsContentModified(), KIGIT::PROJECT_GIT_UTILS::IsWithinProjectPath(), FILEEXT::LockFileExtension, FILEEXT::LockFilePrefix, m_gitStatusTimer, m_Parent, m_TreeProject, MAIL_PCB_SAVE, MAIL_SCH_SAVE, path, GIT_COMMIT_HANDLER::PerformAmend(), Prj(), result, DIALOG_GIT_COMMIT::SetCommitMessage(), DIALOG_GIT_COMMIT::SetFileSelectionRequired(), DIALOG_SHIM::ShowModal(), Success, and traceGit.

◆ onGitCommit()

void PROJECT_TREE_PANE::onGitCommit ( wxCommandEvent & event )

private

Commit the current project saved changes to the git repository.

Definition at line 2585 of file project_tree_pane.cpp.

References _, GitUserConfig::authorEmail, GitUserConfig::authorName, FILEEXT::BackupFileSuffix, candidates(), DIRECTORY, DisplayErrorMessage(), FRAME_PCB_EDITOR, FRAME_SCH, DIALOG_GIT_COMMIT::GetAuthorEmail(), DIALOG_GIT_COMMIT::GetAuthorName(), DIALOG_GIT_COMMIT::GetCommitMessage(), GIT_COMMIT_HANDLER::GetErrorString(), GIT_STATUS_HANDLER::GetFileStatus(), PROJECT::GetProjectPath(), GetSelectedData(), DIALOG_GIT_COMMIT::GetSelectedFiles(), GIT_CONFIG_HANDLER::GetUserConfig(), GIT_STATUS_HANDLER::GetWorkingDirectory(), KIGIT_COMMON::GIT_STATUS_CONFLICTED, KIGIT_COMMON::GIT_STATUS_CURRENT, KIGIT_COMMON::GIT_STATUS_IGNORED, KIGIT_COMMON::GIT_STATUS_UNTRACKED, ID_GIT_COMMIT_PROJECT, EDA_BASE_FRAME::IsContentModified(), KIGIT::PROJECT_GIT_UTILS::IsWithinProjectPath(), FILEEXT::LockFileExtension, FILEEXT::LockFilePrefix, m_gitStatusTimer, m_Parent, m_TreeProject, MAIL_PCB_SAVE, MAIL_SCH_SAVE, GIT_COMMIT_HANDLER::PerformCommit(), Prj(), PROJECT_TREE_ITEM, FILEEXT::ProjectLocalSettingsFileExtension, result, DIALOG_SHIM::ShowModal(), Success, and traceGit.

◆ onGitCompare()

void PROJECT_TREE_PANE::onGitCompare ( wxCommandEvent & event )

private

Compare the current project to a different branch in the git repository.

Definition at line 2069 of file project_tree_pane.cpp.

◆ onGitFeedbackTimer()

void PROJECT_TREE_PANE::onGitFeedbackTimer ( wxTimerEvent & event )

private

Definition at line 3300 of file project_tree_pane.cpp.

References m_Parent.

Referenced by PROJECT_TREE_PANE(), and ~PROJECT_TREE_PANE().

◆ onGitFetch()

void PROJECT_TREE_PANE::onGitFetch ( wxCommandEvent & event )

private

Fetch the latest changes from the git repository.

Definition at line 3134 of file project_tree_pane.cpp.

References _, KIGIT_COMMON::ClearAuthFailure(), KIGIT_COMMON::GetRemoteNameOrDefault(), m_gitStatusTimer, m_TreeProject, GIT_PULL_HANDLER::PerformFetch(), promptForGitCredentials(), showGitFeedback(), and KIGIT_COMMON::WasAuthFailure().

◆ onGitInitializeProject()

void PROJECT_TREE_PANE::onGitInitializeProject ( wxCommandEvent & event )

private

Initialize a new git repository in the current project directory.

Definition at line 1913 of file project_tree_pane.cpp.

References _, KIGIT_COMMON::ClearAuthFailure(), KIGIT::PROJECT_GIT_UTILS::ComputeSymlinkPreservingWorkDir(), RemoteConfig::connType, DisplayErrorMessage(), DisplayInfoMessage(), PROJECT_TREE_ITEM::GetDir(), KIGIT_ERRORS::GetErrorString(), GetItemIdData(), PROJECT::GetLocalSettings(), DIALOG_GIT_REPOSITORY::GetPassword(), KIGIT_REPO_MIXIN::GetRepo(), DIALOG_GIT_REPOSITORY::GetRepoSSHPath(), DIALOG_GIT_REPOSITORY::GetRepoType(), DIALOG_GIT_REPOSITORY::GetRepoURL(), DIALOG_GIT_REPOSITORY::GetUsername(), KIGIT_COMMON::GIT_CONN_HTTPS, KIGIT_COMMON::GIT_CONN_SSH, GIT_INIT_HANDLER::InitializeRepository(), GIT_INIT_HANDLER::IsRepository(), m_gitLastError, PROJECT_LOCAL_SETTINGS::m_GitRepoType, PROJECT_LOCAL_SETTINGS::m_GitRepoUsername, PROJECT_LOCAL_SETTINGS::m_GitSSHKey, m_TreeProject, RemoteConfig::password, GIT_PULL_HANDLER::PerformFetch(), PR_NO_ABORT, Prj(), PROJECT_TREE_ITEM, promptForGitCredentials(), result, GIT_PROGRESS::SetProgressReporter(), DIALOG_GIT_REPOSITORY::SetSkipButtonLabel(), GIT_INIT_HANDLER::SetupRemote(), DIALOG_SHIM::ShowModal(), RemoteConfig::sshKey, KIPLATFORM::SECRETS::StoreSecret(), Success, RemoteConfig::url, RemoteConfig::username, and KIGIT_COMMON::WasAuthFailure().

◆ onGitPullProject()

void PROJECT_TREE_PANE::onGitPullProject ( wxCommandEvent & event )

private

Pull the latest changes from the git repository.

Definition at line 2075 of file project_tree_pane.cpp.

References _, KIGIT_COMMON::ClearAuthFailure(), Conflict, DisplayErrorMessage(), FastForward, KIGIT_COMMON::GetCurrentBranchName(), KIGIT_ERRORS::GetErrorString(), KIGIT_COMMON::GetUpstreamShorthand(), m_gitStatusTimer, m_TreeProject, GIT_PULL_HANDLER::PerformPull(), PR_NO_ABORT, promptForGitCredentials(), GIT_PULL_HANDLER::RebaseOntoUpstream(), GIT_PULL_HANDLER::ResetToUpstream(), GIT_PROGRESS::SetProgressReporter(), showGitFeedback(), Success, UpToDate, and KIGIT_COMMON::WasAuthFailure().

◆ onGitPushProject()

void PROJECT_TREE_PANE::onGitPushProject ( wxCommandEvent & event )

private

Push the current project changes to the git repository.

Definition at line 2173 of file project_tree_pane.cpp.

References _, KIGIT_COMMON::ClearAuthFailure(), DisplayErrorMessage(), KIGIT_COMMON::GetCurrentBranchName(), KIGIT_ERRORS::GetErrorString(), KIGIT_COMMON::GetUpstreamShorthand(), m_gitStatusTimer, m_TreeProject, NonFastForward, GIT_PUSH_HANDLER::PerformPush(), PR_NO_ABORT, promptForGitCredentials(), GIT_PROGRESS::SetProgressReporter(), showGitFeedback(), Success, and KIGIT_COMMON::WasAuthFailure().

◆ onGitRemoteSettings()

void PROJECT_TREE_PANE::onGitRemoteSettings ( wxCommandEvent & event )

private

Configure (or change) the default remote on an already-initialized repository.

Definition at line 2012 of file project_tree_pane.cpp.

References _, RemoteConfig::connType, DisplayErrorMessage(), KIGIT_ERRORS::GetErrorString(), PROJECT::GetLocalSettings(), DIALOG_GIT_REPOSITORY::GetPassword(), KIGIT_COMMON::GetRepo(), DIALOG_GIT_REPOSITORY::GetRepoSSHPath(), DIALOG_GIT_REPOSITORY::GetRepoType(), DIALOG_GIT_REPOSITORY::GetRepoURL(), DIALOG_GIT_REPOSITORY::GetUsername(), KIGIT_COMMON::GIT_CONN_HTTPS, KIGIT_COMMON::GIT_CONN_SSH, PROJECT_LOCAL_SETTINGS::m_GitRepoType, PROJECT_LOCAL_SETTINGS::m_GitRepoUsername, PROJECT_LOCAL_SETTINGS::m_GitSSHKey, m_gitStatusTimer, m_TreeProject, RemoteConfig::password, Prj(), GIT_INIT_HANDLER::SetupRemote(), DIALOG_SHIM::ShowModal(), RemoteConfig::sshKey, KIPLATFORM::SECRETS::StoreSecret(), KIGIT_COMMON::UpdateCurrentBranchInfo(), RemoteConfig::url, and RemoteConfig::username.

◆ onGitRemoveFromIndex()

void PROJECT_TREE_PANE::onGitRemoveFromIndex ( wxCommandEvent & event )

private

Remove a file from the git index.

Definition at line 3191 of file project_tree_pane.cpp.

References m_TreeProject, and GIT_REMOVE_FROM_INDEX_HANDLER::PerformRemoveFromIndex().

◆ onGitRemoveVCS()

void PROJECT_TREE_PANE::onGitRemoveVCS ( wxCommandEvent & event )

private

Remove the git repository from the current project directory.

Definition at line 2282 of file project_tree_pane.cpp.

References KIGIT::PROJECT_GIT_UTILS::ComputeSymlinkPreservingWorkDir(), PROJECT::GetLocalSettings(), KIGIT::PROJECT_GIT_UTILS::GetRepositoryForFile(), m_gitIconsInitialized, PROJECT_LOCAL_SETTINGS::m_GitIntegrationDisabled, PROJECT_LOCAL_SETTINGS::m_GitRepoUsername, PROJECT_LOCAL_SETTINGS::m_GitSSHKey, m_TreeProject, Prj(), releaseGitRepo(), PROJECT_LOCAL_SETTINGS::SaveToFile(), and traceGit.

◆ onGitResolveConflict()

void PROJECT_TREE_PANE::onGitResolveConflict ( wxCommandEvent & event )

private

Resolve conflicts in the git repository.

Definition at line 3167 of file project_tree_pane.cpp.

References m_TreeProject, and GIT_RESOLVE_CONFLICT_HANDLER::PerformResolveConflict().

◆ onGitRevertLocal()

void PROJECT_TREE_PANE::onGitRevertLocal ( wxCommandEvent & event )

private

Revert the local repository to the last commit.

Definition at line 3179 of file project_tree_pane.cpp.

References m_TreeProject, and GIT_REVERT_HANDLER::PerformRevert().

◆ onGitStatusTimer()

void PROJECT_TREE_PANE::onGitStatusTimer ( wxTimerEvent & event )

private

Definition at line 3279 of file project_tree_pane.cpp.

References gitStatusTimerHandler(), m_TreeProject, Pgm(), and traceGit.

Referenced by PROJECT_TREE_PANE(), and ~PROJECT_TREE_PANE().

◆ onGitSwitchBranch()

void PROJECT_TREE_PANE::onGitSwitchBranch ( wxCommandEvent & event )

private

Switch to a different branch in the git repository.

Definition at line 2239 of file project_tree_pane.cpp.

References KIGIT::PROJECT_GIT_UTILS::CreateBranch(), DisplayError(), DIALOG_GIT_SWITCH::GetBranchName(), KIGIT_ERRORS::GetErrorString(), ID_GIT_SWITCH_BRANCH, m_gitStatusTimer, m_TreeProject, DIALOG_SHIM::ShowModal(), Success, GIT_BRANCH_HANDLER::SwitchToBranch(), and traceGit.

◆ onGitSyncProject()

void PROJECT_TREE_PANE::onGitSyncProject ( wxCommandEvent & event )

private

Sync the current project with the git repository.

Definition at line 3118 of file project_tree_pane.cpp.

References m_TreeProject, GIT_SYNC_HANDLER::PerformSync(), and traceGit.

◆ onGitSyncTimer()

void PROJECT_TREE_PANE::onGitSyncTimer ( wxTimerEvent & event )

private

Definition at line 3209 of file project_tree_pane.cpp.

References COMMON_SETTINGS::GIT::enableGit, PGM_BASE::GetCommonSettings(), gitStatusTimerHandler(), COMMON_SETTINGS::m_Git, m_gitSyncTask, m_gitSyncTimer, m_TreeProject, GIT_PULL_HANDLER::PerformFetch(), Pgm(), traceGit, and COMMON_SETTINGS::GIT::updatInterval.

Referenced by PROJECT_TREE_PANE(), and ~PROJECT_TREE_PANE().

◆ onIdle()

void PROJECT_TREE_PANE::onIdle ( wxIdleEvent & aEvent )

private

Idle event handler, used process the selected items at a point in time when all other events have been consumed.

Definition at line 1195 of file project_tree_pane.cpp.

References PROJECT_TREE_ITEM::Activate(), FileWatcherReset(), GetItemIdData(), m_selectedItem, m_TreeProject, m_watcherNeedReset, and PROJECT_TREE_ITEM.

◆ onOpenDirectory()

void PROJECT_TREE_PANE::onOpenDirectory ( wxCommandEvent & event )

private

Handles the right-click menu for opening a directory in the current system file browser.

Definition at line 321 of file project_tree_pane.cpp.

References PATHS::GetDefaultUserProjectsPath(), GetSelectedData(), LaunchExternal(), m_Parent, and PROJECT_TREE_ITEM.

◆ onOpenSelectedFileWithTextEditor()

void PROJECT_TREE_PANE::onOpenSelectedFileWithTextEditor ( wxCommandEvent & event )

private

Call the text editor to open the selected file in the tree project.

Definition at line 1119 of file project_tree_pane.cpp.

References _, ExecuteFile(), GetSelectedData(), PGM_BASE::GetTextEditor(), Pgm(), and PROJECT_TREE_ITEM.

◆ onPaint()

void PROJECT_TREE_PANE::onPaint ( wxPaintEvent & aEvent )

private

We don't have uniform borders so we have to draw them ourselves.

Definition at line 1865 of file project_tree_pane.cpp.

◆ onRenameFile()

void PROJECT_TREE_PANE::onRenameFile ( wxCommandEvent & event )

private

Rename the selected file or directory in the tree project.

Definition at line 1152 of file project_tree_pane.cpp.

References _, GetSelectedData(), m_isRenaming, and m_TreeProject.

◆ onRight()

void PROJECT_TREE_PANE::onRight ( wxTreeEvent & Event )

private

Called on a right click on an item.

Definition at line 812 of file project_tree_pane.cpp.

References _, KIUI::AddMenuItem(), DIRECTORY, directory, directory_browser, editor, COMMON_SETTINGS::GIT::enableGit, exchange, PGM_BASE::GetCommonSettings(), GetGitBackend(), PROJECT::GetLocalSettings(), GetSelectedData(), hasChangedFiles(), KIGIT_COMMON::HasLocalCommits(), KIGIT_COMMON::HasPushAndPullRemote(), ID_GIT_AMEND_COMMIT, ID_GIT_COMMIT_FILE, ID_GIT_COMMIT_PROJECT, ID_GIT_INITIALIZE_PROJECT, ID_GIT_PULL, ID_GIT_PUSH, ID_GIT_REMOTE_SETTINGS, ID_GIT_REMOVE_VCS, ID_GIT_SWITCH_BRANCH, ID_JOBS_RUN, ID_PROJECT_DELETE, ID_PROJECT_NEWDIR, ID_PROJECT_OPEN_DIR, ID_PROJECT_RENAME, ID_PROJECT_SWITCH_TO_OTHER, ID_PROJECT_TXTEDIT, GIT_BACKEND::IsLibraryAvailable(), JOBSET_FILE, JSON_PROJECT, KI_FALLTHROUGH, KiBitmap(), LEGACY_PROJECT, COMMON_SETTINGS::m_Git, m_gitCurrentBranchName, m_gitCurrentUpstream, PROJECT_LOCAL_SETTINGS::m_GitIntegrationDisabled, m_TreeProject, open_project, PDF, Pgm(), Prj(), PROJECT_TREE_ITEM, right, SEXPR_PCB, SEXPR_SCHEMATIC, text, trash, and ZIP_ARCHIVE.

◆ onRunSelectedJobsFile()

void PROJECT_TREE_PANE::onRunSelectedJobsFile ( wxCommandEvent & event )

private

Run a selected jobs file.

Definition at line 3203 of file project_tree_pane.cpp.

◆ onSelect()

void PROJECT_TREE_PANE::onSelect ( wxTreeEvent & Event )

private

Called on a double click on an item.

Definition at line 1181 of file project_tree_pane.cpp.

References GetSelectedData(), and m_selectedItem.

◆ onSwitchToSelectedProject()

void PROJECT_TREE_PANE::onSwitchToSelectedProject ( wxCommandEvent & event )

private

Switch to a other project selected from the tree project (by selecting an other .pro file inside the current project folder)

Definition at line 308 of file project_tree_pane.cpp.

References GetSelectedData(), and m_Parent.

◆ onThemeChanged()

void PROJECT_TREE_PANE::onThemeChanged ( wxSysColourChangedEvent & aEvent )

private

Definition at line 1855 of file project_tree_pane.cpp.

References GetBitmapStore(), m_TreeProject, and BITMAP_STORE::ThemeChanged().

Referenced by PROJECT_TREE_PANE(), and ~PROJECT_TREE_PANE().

◆ ReCreateTreePrj()

void PROJECT_TREE_PANE::ReCreateTreePrj ( )

Create or modify the tree showing project file names.

Definition at line 662 of file project_tree_pane.cpp.

References addItemToProjectTree(), KIGIT::PROJECT_GIT_UTILS::ComputeSymlinkPreservingWorkDir(), PATHS::GetDefaultUserProjectsPath(), getProjects(), KIGIT::PROJECT_GIT_UTILS::GetRepositoryForFile(), JSON_PROJECT, FILEEXT::LegacyProjectFileExtension, m_gitIconsInitialized, m_gitStatusIcons, m_gitStatusMutex, m_gitStatusTimer, m_gitSyncTimer, m_gitTreeCache, m_gitTreeCacheMutex, m_Parent, m_root, m_TreeProject, name, NAMELESS_PROJECT, Pgm(), Prj(), PROJECT_TREE_ITEM, FILEEXT::ProjectFileExtension, releaseGitRepo(), ROOT, and traceGit.

Referenced by PROJECT_TREE_PANE().

◆ releaseGitRepo()

void PROJECT_TREE_PANE::releaseGitRepo ( )

private

Releases the git repository handle, deferring the free to the orphan registry while a background git operation still holds the action mutex.

Definition at line 1804 of file project_tree_pane.cpp.

References GetGitBackend(), KIGIT_COMMON::m_gitActionMutex, m_TreeProject, GIT_BACKEND::OrphanRegistry(), KIGIT_ORPHAN_REGISTRY::Register(), registered, and KIGIT_COMMON::SetCancelled().

Referenced by onGitRemoveVCS(), and ReCreateTreePrj().

◆ showGitFeedback()

void PROJECT_TREE_PANE::showGitFeedback ( const wxString & aText )

private

Show a short message in the project status bar after a git operation.

Definition at line 3290 of file project_tree_pane.cpp.

References m_gitFeedbackTimer, and m_Parent.

Referenced by onGitFetch(), onGitPullProject(), and onGitPushProject().

◆ shutdownFileWatcher()

void PROJECT_TREE_PANE::shutdownFileWatcher ( )

private

Shutdown the file watcher.

Used when closing to prevent post-free access into the project tree. (Using the destructor doesn't work as wxWidgets defers destruction in some cases.)

Definition at line 296 of file project_tree_pane.cpp.

References m_watcher.

Referenced by EmptyTreePrj(), and ~PROJECT_TREE_PANE().

◆ updateGitStatusIconMap()

void PROJECT_TREE_PANE::updateGitStatusIconMap ( )

private

This is a threaded call that will change the map of git status icons for use in the main thread.

Definition at line 2464 of file project_tree_pane.cpp.

References ADVANCED_CFG::GetCfg(), GIT_STATUS_HANDLER::GetCurrentBranchName(), GIT_STATUS_HANDLER::GetFileStatus(), GIT_STATUS_HANDLER::GetWorkingDirectory(), KIPLATFORM::ENV::IsNetworkPath(), m_gitCurrentBranchName, m_gitCurrentUpstream, ADVANCED_CFG::m_GitIconRefreshInterval, m_gitIconsInitialized, m_gitStatusIcons, m_gitStatusMutex, m_gitStatusTimer, m_gitTreeCache, m_gitTreeCacheMutex, m_Parent, m_TreeProject, Pgm(), Prj(), refresh, traceGit, updateGitStatusIcons(), and GIT_STATUS_HANDLER::UpdateRemoteStatus().

Referenced by gitStatusTimerHandler().

◆ updateGitStatusIcons()

void PROJECT_TREE_PANE::updateGitStatusIcons ( )

private

Updates the icons shown in the tree project to reflect the current git status.

Definition at line 2348 of file project_tree_pane.cpp.

References PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), m_gitCurrentBranchName, m_gitIconsInitialized, m_gitStatusIcons, m_gitStatusMutex, m_gitStatusTimer, m_TreeProject, Pgm(), PROJECT_TREE_ITEM, and traceGit.

Referenced by updateGitStatusIconMap().

◆ updateTreeCache()

void PROJECT_TREE_PANE::updateTreeCache ( )

private

Updates the map of the wxtreeitemid to the name of each file for use in the thread.

Definition at line 2408 of file project_tree_pane.cpp.

References PROJECT_TREE_ITEM::GetFileName(), GetItemIdData(), m_gitTreeCache, m_gitTreeCacheMutex, m_TreeProject, PROJECT_TREE_ITEM, and traceGit.

Referenced by gitStatusTimerHandler().

Friends And Related Symbol Documentation

◆ PROJECT_TREE_ITEM

friend class PROJECT_TREE_ITEM

friend

Definition at line 53 of file project_tree_pane.h.

References PROJECT_TREE_ITEM.

Referenced by addItemToProjectTree(), findSubdirTreeItem(), GetItemIdData(), GetSelectedData(), onCreateNewDirectory(), onDeleteFile(), onExpand(), onFileSystemEvent(), onGitCommit(), onGitInitializeProject(), onIdle(), onOpenDirectory(), onOpenSelectedFileWithTextEditor(), onRight(), PROJECT_TREE_ITEM, ReCreateTreePrj(), updateGitStatusIcons(), and updateTreeCache().

Member Data Documentation

◆ m_filters

std::vector<wxString> PROJECT_TREE_PANE::m_filters

private

Definition at line 326 of file project_tree_pane.h.

Referenced by addItemToProjectTree(), and PROJECT_TREE_PANE().

◆ m_gitCurrentBranchName

wxString PROJECT_TREE_PANE::m_gitCurrentBranchName

private

Definition at line 333 of file project_tree_pane.h.

Referenced by onRight(), updateGitStatusIconMap(), and updateGitStatusIcons().

◆ m_gitCurrentUpstream

wxString PROJECT_TREE_PANE::m_gitCurrentUpstream

private

Definition at line 334 of file project_tree_pane.h.

Referenced by onRight(), and updateGitStatusIconMap().

◆ m_gitFeedbackTimer

wxTimer PROJECT_TREE_PANE::m_gitFeedbackTimer

private

Definition at line 337 of file project_tree_pane.h.

Referenced by PROJECT_TREE_PANE(), showGitFeedback(), and ~PROJECT_TREE_PANE().

◆ m_gitIconsInitialized

bool PROJECT_TREE_PANE::m_gitIconsInitialized

private

Definition at line 345 of file project_tree_pane.h.

Referenced by onGitRemoveVCS(), PROJECT_TREE_PANE(), ReCreateTreePrj(), updateGitStatusIconMap(), and updateGitStatusIcons().

◆ m_gitLastError

int PROJECT_TREE_PANE::m_gitLastError

private

Definition at line 332 of file project_tree_pane.h.

Referenced by onGitInitializeProject(), and PROJECT_TREE_PANE().

◆ m_gitStatusIcons

std::map<wxTreeItemId, KIGIT_COMMON::GIT_STATUS> PROJECT_TREE_PANE::m_gitStatusIcons

private

Definition at line 344 of file project_tree_pane.h.

Referenced by ReCreateTreePrj(), updateGitStatusIconMap(), and updateGitStatusIcons().

◆ m_gitStatusIconTask

std::future<void> PROJECT_TREE_PANE::m_gitStatusIconTask

private

Definition at line 339 of file project_tree_pane.h.

Referenced by gitStatusTimerHandler(), and ~PROJECT_TREE_PANE().

◆ m_gitStatusMutex

std::mutex PROJECT_TREE_PANE::m_gitStatusMutex

private

Definition at line 343 of file project_tree_pane.h.

Referenced by ReCreateTreePrj(), updateGitStatusIconMap(), and updateGitStatusIcons().

◆ m_gitStatusTimer

wxTimer PROJECT_TREE_PANE::m_gitStatusTimer

private

Definition at line 336 of file project_tree_pane.h.

Referenced by onFileSystemEvent(), onGitAmendCommit(), onGitCommit(), onGitFetch(), onGitPullProject(), onGitPushProject(), onGitRemoteSettings(), onGitSwitchBranch(), PROJECT_TREE_PANE(), ReCreateTreePrj(), updateGitStatusIconMap(), updateGitStatusIcons(), and ~PROJECT_TREE_PANE().

◆ m_gitSyncTask

std::future<void> PROJECT_TREE_PANE::m_gitSyncTask

private

Definition at line 338 of file project_tree_pane.h.

Referenced by onGitSyncTimer(), and ~PROJECT_TREE_PANE().

◆ m_gitSyncTimer

wxTimer PROJECT_TREE_PANE::m_gitSyncTimer

private

Definition at line 335 of file project_tree_pane.h.

Referenced by onGitSyncTimer(), PROJECT_TREE_PANE(), ReCreateTreePrj(), and ~PROJECT_TREE_PANE().

◆ m_gitTreeCache

std::unordered_map<wxString, wxTreeItemId> PROJECT_TREE_PANE::m_gitTreeCache

private

Definition at line 342 of file project_tree_pane.h.

Referenced by ReCreateTreePrj(), updateGitStatusIconMap(), and updateTreeCache().

◆ m_gitTreeCacheMutex

std::mutex PROJECT_TREE_PANE::m_gitTreeCacheMutex

private

Definition at line 341 of file project_tree_pane.h.

Referenced by ReCreateTreePrj(), updateGitStatusIconMap(), and updateTreeCache().

◆ m_isRenaming

bool PROJECT_TREE_PANE::m_isRenaming

private

Definition at line 324 of file project_tree_pane.h.

Referenced by onFileSystemEvent(), onRenameFile(), and PROJECT_TREE_PANE().

◆ m_Parent

KICAD_MANAGER_FRAME* PROJECT_TREE_PANE::m_Parent

Definition at line 320 of file project_tree_pane.h.

Referenced by PROJECT_TREE_ITEM::Activate(), addItemToProjectTree(), FileWatcherReset(), findSubdirTreeItem(), onCreateNewDirectory(), onGitAmendCommit(), onGitCommit(), onGitFeedbackTimer(), onOpenDirectory(), onSwitchToSelectedProject(), PROJECT_TREE_PANE(), ReCreateTreePrj(), showGitFeedback(), and updateGitStatusIconMap().

◆ m_root

wxTreeItemId PROJECT_TREE_PANE::m_root

private

Definition at line 325 of file project_tree_pane.h.

Referenced by findSubdirTreeItem(), and ReCreateTreePrj().

◆ m_selectedItem

PROJECT_TREE_ITEM* PROJECT_TREE_PANE::m_selectedItem

private

Definition at line 328 of file project_tree_pane.h.

Referenced by onIdle(), onSelect(), and PROJECT_TREE_PANE().

◆ m_TreeProject

PROJECT_TREE* PROJECT_TREE_PANE::m_TreeProject

◆ m_watcher

wxFileSystemWatcher* PROJECT_TREE_PANE::m_watcher

private

Definition at line 327 of file project_tree_pane.h.

Referenced by FileWatcherReset(), onFileSystemEvent(), PROJECT_TREE_PANE(), and shutdownFileWatcher().

◆ m_watcherNeedReset

bool PROJECT_TREE_PANE::m_watcherNeedReset

private

Definition at line 329 of file project_tree_pane.h.

Referenced by addItemToProjectTree(), FileWatcherReset(), onExpand(), onIdle(), and PROJECT_TREE_PANE().

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PROJECT_TREE_PANE()

◆ ~PROJECT_TREE_PANE()

Member Function Documentation

◆ addItemToProjectTree()

◆ canFileBeAddedToVCS()

◆ EmptyTreePrj()

◆ FileWatcherReset()

◆ findSubdirTreeItem()

◆ GetFileExt()

◆ GetItemIdData()

◆ GetSelectedData()

◆ gitStatusTimerHandler()

◆ hasChangedFiles()

◆ hasLocalCommits()

◆ onCreateNewDirectory()

◆ onDeleteFile()

◆ onExpand()

◆ onFileSystemEvent()

◆ onGitAddToIndex()

◆ onGitAmendCommit()

◆ onGitCommit()

◆ onGitCompare()

◆ onGitFeedbackTimer()

◆ onGitFetch()

◆ onGitInitializeProject()

◆ onGitPullProject()

◆ onGitPushProject()

◆ onGitRemoteSettings()

◆ onGitRemoveFromIndex()

◆ onGitRemoveVCS()

◆ onGitResolveConflict()

◆ onGitRevertLocal()

◆ onGitStatusTimer()

◆ onGitSwitchBranch()

◆ onGitSyncProject()

◆ onGitSyncTimer()

◆ onIdle()

◆ onOpenDirectory()

◆ onOpenSelectedFileWithTextEditor()

◆ onPaint()

◆ onRenameFile()

◆ onRight()

◆ onRunSelectedJobsFile()

◆ onSelect()

◆ onSwitchToSelectedProject()

◆ onThemeChanged()

◆ ReCreateTreePrj()

◆ releaseGitRepo()

◆ showGitFeedback()

◆ shutdownFileWatcher()

◆ updateGitStatusIconMap()

◆ updateGitStatusIcons()

◆ updateTreeCache()

Friends And Related Symbol Documentation

◆ PROJECT_TREE_ITEM

Member Data Documentation

◆ m_filters

◆ m_gitCurrentBranchName

◆ m_gitCurrentUpstream

◆ m_gitFeedbackTimer

◆ m_gitIconsInitialized

◆ m_gitLastError

◆ m_gitStatusIcons

◆ m_gitStatusIconTask

◆ m_gitStatusMutex

◆ m_gitStatusTimer

◆ m_gitSyncTask

◆ m_gitSyncTimer

◆ m_gitTreeCache

◆ m_gitTreeCacheMutex

◆ m_isRenaming