KIGIT_COMMON Class Reference

#include <kicad_git_common.h>

Inheritance diagram for KIGIT_COMMON:

Public Types
enum class	GIT_STATUS {   GIT_STATUS_UNTRACKED , GIT_STATUS_CURRENT , GIT_STATUS_MODIFIED , GIT_STATUS_ADDED ,   GIT_STATUS_DELETED , GIT_STATUS_BEHIND , GIT_STATUS_AHEAD , GIT_STATUS_CONFLICTED ,   GIT_STATUS_IGNORED , GIT_STATUS_LAST }
enum class	GIT_CONN_TYPE { GIT_CONN_HTTPS = 0 , GIT_CONN_SSH , GIT_CONN_LOCAL , GIT_CONN_LAST }

Public Member Functions
	KIGIT_COMMON (git_repository *aRepo)
	KIGIT_COMMON (const KIGIT_COMMON &aOther)
	~KIGIT_COMMON ()
git_repository *	GetRepo () const
void	SetRepo (git_repository *aRepo)
wxString	GetCurrentBranchName () const
std::vector< wxString >	GetBranchNames () const
std::vector< wxString >	GetProjectDirs ()
	Return a vector of project files in the repository.
std::pair< std::set< wxString >, std::set< wxString > >	GetDifferentFiles () const
	Return a pair of sets of files that differ locally from the remote repository The first set is files that have been committed locally but not pushed The second set is files that have been committed remotely but not pulled.
wxString	GetUsername () const
wxString	GetPassword ()
GIT_CONN_TYPE	GetConnType () const
void	SetUsername (const wxString &aUsername)
void	SetPassword (const wxString &aPassword)
void	SetSSHKey (const wxString &aSSHKey)
unsigned &	TestedTypes ()
bool	HasLocalCommits () const
bool	HasPushAndPullRemote () const
void	UpdateCurrentBranchInfo ()
wxString	GetGitRootDirectory () const
wxString	GetRemotename () const
wxString	GetRemoteNameOrDefault () const
	Returns GetRemotename() when non-empty, otherwise "origin".
void	SetProjectDir (const wxString &aProjectDir)
	Set the project directory path, preserving any symlinks in the path.
wxString	GetProjectDir () const
	Get the project directory path.
void	ResetNextKey ()
wxString	GetNextPublicKey ()
void	SetRemote (const wxString &aRemote)
const wxString &	GetRemote () const
int	HandleSSHKeyAuthentication (git_cred **aOut, const wxString &aUsername)
int	HandlePlaintextAuthentication (git_cred **aOut, const wxString &aUsername)
int	HandleSSHAgentAuthentication (git_cred **aOut, const wxString &aUsername)
bool	IsCancelled () const
void	SetCancelled (bool aCancel)
bool	WasAuthFailure () const
void	ClearAuthFailure ()
void	SetAuthFailure ()

Static Public Member Functions
static wxString	GetLastGitError ()

Protected Attributes
git_repository *	m_repo
wxString	m_projectDir
GIT_CONN_TYPE	m_connType
wxString	m_remote
wxString	m_hostname
wxString	m_username
wxString	m_password
unsigned	m_testedTypes
bool	m_authFailed = false
std::mutex	m_gitActionMutex

Private Member Functions
void	updatePublicKeys ()
void	updateConnectionType ()

Private Attributes
std::vector< wxString >	m_publicKeys
int	m_nextPublicKey
bool	m_secretFetched
std::atomic< bool >	m_cancel

Static Private Attributes
static const unsigned	KIGIT_CREDENTIAL_SSH_AGENT = 1 << sizeof( m_testedTypes - 1 )

Friends
class	GIT_PUSH_HANDLER
class	GIT_PULL_HANDLER
class	GIT_CLONE_HANDLER
class	LIBGIT_BACKEND
class	PROJECT_TREE_PANE

Detailed Description

Definition at line 39 of file kicad_git_common.h.

Member Enumeration Documentation

GIT_CONN_TYPE

enum class KIGIT_COMMON::GIT_CONN_TYPE

strong

Enumerator
GIT_CONN_HTTPS
GIT_CONN_SSH
GIT_CONN_LOCAL
GIT_CONN_LAST

Definition at line 87 of file kicad_git_common.h.

GIT_STATUS

enum class KIGIT_COMMON::GIT_STATUS

strong

Enumerator
GIT_STATUS_UNTRACKED
GIT_STATUS_CURRENT
GIT_STATUS_MODIFIED
GIT_STATUS_ADDED
GIT_STATUS_DELETED
GIT_STATUS_BEHIND
GIT_STATUS_AHEAD
GIT_STATUS_CONFLICTED
GIT_STATUS_IGNORED
GIT_STATUS_LAST

Definition at line 73 of file kicad_git_common.h.

Constructor & Destructor Documentation

KIGIT_COMMON() [1/2]

KIGIT_COMMON::KIGIT_COMMON

(

git_repository *

aRepo

)

Definition at line 41 of file kicad_git_common.cpp.

References GIT_CONN_LOCAL, m_connType, m_nextPublicKey, m_repo, m_secretFetched, and m_testedTypes.

Referenced by GIT_ADD_TO_INDEX_HANDLER::GIT_ADD_TO_INDEX_HANDLER(), GIT_COMMIT_HANDLER::GIT_COMMIT_HANDLER(), GIT_REMOVE_FROM_INDEX_HANDLER::GIT_REMOVE_FROM_INDEX_HANDLER(), and KIGIT_COMMON().

KIGIT_COMMON() [2/2]

KIGIT_COMMON::KIGIT_COMMON

(

const KIGIT_COMMON &

aOther

)

Definition at line 47 of file kicad_git_common.cpp.

References KIGIT_COMMON(), m_connType, m_gitActionMutex, m_hostname, m_nextPublicKey, m_password, m_projectDir, m_publicKeys, m_remote, m_repo, m_secretFetched, m_testedTypes, and m_username.

~KIGIT_COMMON()

KIGIT_COMMON::~KIGIT_COMMON

(

)

Definition at line 67 of file kicad_git_common.cpp.

Member Function Documentation

ClearAuthFailure()

void KIGIT_COMMON::ClearAuthFailure ( )

inline

Definition at line 184 of file kicad_git_common.h.

References m_authFailed.

Referenced by PROJECT_TREE_PANE::onGitFetch(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitPullProject(), PROJECT_TREE_PANE::onGitPushProject(), and promptForGitCredentials().

GetBranchNames()

std::vector< wxString > KIGIT_COMMON::GetBranchNames

(

)

const

Definition at line 145 of file kicad_git_common.cpp.

References m_repo, and traceGit.

GetConnType()

KIGIT_COMMON::GIT_CONN_TYPE KIGIT_COMMON::GetConnType

(

)

const

Definition at line 747 of file kicad_git_common.cpp.

References GetRemotename(), GIT_CONN_HTTPS, GIT_CONN_LOCAL, GIT_CONN_SSH, and m_remote.

Referenced by promptForGitCredentials().

GetCurrentBranchName()

wxString KIGIT_COMMON::GetCurrentBranchName

(

)

const

Definition at line 94 of file kicad_git_common.cpp.

References m_repo, and traceGit.

Referenced by TEXT_EVAL_VCS::GetBranch().

GetDifferentFiles()

std::pair< std::set< wxString >, std::set< wxString > > KIGIT_COMMON::GetDifferentFiles

(

)

const

Return a pair of sets of files that differ locally from the remote repository The first set is files that have been committed locally but not pushed The second set is files that have been committed remotely but not pulled.

Definition at line 276 of file kicad_git_common.cpp.

References delta, GetLastGitError(), IsCancelled(), m_repo, and traceGit.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

GetGitRootDirectory()

wxString KIGIT_COMMON::GetGitRootDirectory

(

)

const

Definition at line 632 of file kicad_git_common.cpp.

References m_repo, and path.

Referenced by BOOST_AUTO_TEST_CASE().

GetLastGitError()

static wxString KIGIT_COMMON::GetLastGitError ( )

inlinestatic

Definition at line 163 of file kicad_git_common.h.

Referenced by LIBGIT_BACKEND::Clone(), LIBGIT_BACKEND::Commit(), LIBGIT_BACKEND::CreateBranch(), credentials_cb(), LIBGIT_BACKEND::GetConfigString(), LIBGIT_BACKEND::GetCurrentBranchName(), getDefaultAuthorAndEmail(), GetDifferentFiles(), LIBGIT_BACKEND::GetFileStatus(), GetProjectDirs(), GetRemotename(), LIBGIT_BACKEND::GetRepositoryForFile(), LIBGIT_BACKEND::handleMerge(), LIBGIT_BACKEND::handleRebase(), HandleSSHAgentAuthentication(), HandleSSHKeyAuthentication(), LIBGIT_BACKEND::HasChangedFiles(), HasLocalCommits(), LIBGIT_BACKEND::hasUnstagedChanges(), LIBGIT_BACKEND::InitializeRepository(), KIGIT_PCB_MERGE::Merge(), DIALOG_GIT_REPOSITORY::OnTestClick(), LIBGIT_BACKEND::PerformFetch(), LIBGIT_BACKEND::Push(), LIBGIT_BACKEND::SetupRemote(), and LIBGIT_BACKEND::SwitchToBranch().

GetNextPublicKey()

wxString KIGIT_COMMON::GetNextPublicKey ( )

inline

Definition at line 139 of file kicad_git_common.h.

References m_nextPublicKey, and m_publicKeys.

Referenced by HandleSSHKeyAuthentication().

GetPassword()

wxString KIGIT_COMMON::GetPassword

(

)

Definition at line 126 of file kicad_git_common.cpp.

References KIPLATFORM::SECRETS::GetSecret(), GIT_CONN_LOCAL, m_connType, m_password, m_remote, m_secretFetched, and m_username.

Referenced by HandlePlaintextAuthentication(), and HandleSSHKeyAuthentication().

GetProjectDir()

wxString KIGIT_COMMON::GetProjectDir

(

)

const

Get the project directory path.

If a symlink-preserving path was set via SetProjectDir(), returns that path. Otherwise falls back to git_repository_workdir().

Definition at line 77 of file kicad_git_common.cpp.

References m_projectDir, and m_repo.

GetProjectDirs()

std::vector< wxString > KIGIT_COMMON::GetProjectDirs

(

)

Return a vector of project files in the repository.

Sorted by the depth of the project file in the directory tree

Returns

std::vector<wxString> of project files

Definition at line 208 of file kicad_git_common.cpp.

References GetLastGitError(), m_repo, and traceGit.

GetRemote()

const wxString & KIGIT_COMMON::GetRemote ( ) const

inline

Definition at line 155 of file kicad_git_common.h.

References m_remote.

Referenced by promptForGitCredentials().

GetRemotename()

wxString KIGIT_COMMON::GetRemotename

(

)

const

Definition at line 534 of file kicad_git_common.cpp.

References GetLastGitError(), m_repo, and traceGit.

Referenced by GetConnType(), GetRemoteNameOrDefault(), and UpdateCurrentBranchInfo().

GetRemoteNameOrDefault()

wxString KIGIT_COMMON::GetRemoteNameOrDefault

(

)

const

Returns GetRemotename() when non-empty, otherwise "origin".

Centralizes the fallback policy used by push/pull/fetch paths.

Definition at line 523 of file kicad_git_common.cpp.

References GetRemotename().

Referenced by HasPushAndPullRemote(), LIBGIT_BACKEND::PerformFetch(), and LIBGIT_BACKEND::Push().

GetRepo()

git_repository * KIGIT_COMMON::GetRepo

(

)

const

Definition at line 71 of file kicad_git_common.cpp.

References m_repo.

Referenced by LIBGIT_BACKEND::AddToIndex(), LIBGIT_BACKEND::Commit(), LIBGIT_BACKEND::PerformAddToIndex(), LIBGIT_BACKEND::PerformRemoveFromIndex(), and LIBGIT_BACKEND::RemoveFromIndex().

GetUsername()

wxString KIGIT_COMMON::GetUsername ( ) const

inline

Definition at line 95 of file kicad_git_common.h.

References m_username.

Referenced by promptForGitCredentials().

HandlePlaintextAuthentication()

int KIGIT_COMMON::HandlePlaintextAuthentication	(	git_cred **	aOut,
		const wxString &	aUsername )

Definition at line 876 of file kicad_git_common.cpp.

References GetPassword(), and m_testedTypes.

Referenced by credentials_cb().

HandleSSHAgentAuthentication()

int KIGIT_COMMON::HandleSSHAgentAuthentication	(	git_cred **	aOut,
		const wxString &	aUsername )

Definition at line 887 of file kicad_git_common.cpp.

References GetLastGitError(), KIGIT_CREDENTIAL_SSH_AGENT, m_testedTypes, and traceGit.

Referenced by HandleSSHKeyAuthentication().

HandleSSHKeyAuthentication()

int KIGIT_COMMON::HandleSSHKeyAuthentication	(	git_cred **	aOut,
		const wxString &	aUsername )

Definition at line 840 of file kicad_git_common.cpp.

References GetLastGitError(), GetNextPublicKey(), GetPassword(), HandleSSHAgentAuthentication(), KIGIT_CREDENTIAL_SSH_AGENT, m_testedTypes, and traceGit.

Referenced by credentials_cb().

HasLocalCommits()

bool KIGIT_COMMON::HasLocalCommits

(

)

const

Definition at line 407 of file kicad_git_common.cpp.

References GetLastGitError(), m_repo, and traceGit.

Referenced by PROJECT_TREE_PANE::onRight().

HasPushAndPullRemote()

bool KIGIT_COMMON::HasPushAndPullRemote

(

)

const

Definition at line 468 of file kicad_git_common.cpp.

References GetRemoteNameOrDefault(), m_repo, and traceGit.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PROJECT_TREE_PANE::onRight().

IsCancelled()

bool KIGIT_COMMON::IsCancelled ( ) const

inline

Definition at line 173 of file kicad_git_common.h.

References m_cancel.

Referenced by GetDifferentFiles(), PROJECT_TREE_PANE::gitStatusTimerHandler(), PROJECT_TREE_PANE::onGitSyncTimer(), progress_cb(), and transfer_progress_cb().

ResetNextKey()

void KIGIT_COMMON::ResetNextKey ( )

inline

Definition at line 137 of file kicad_git_common.h.

References m_nextPublicKey.

Referenced by promptForGitCredentials().

SetAuthFailure()

void KIGIT_COMMON::SetAuthFailure ( )

inline

Definition at line 185 of file kicad_git_common.h.

References m_authFailed.

Referenced by credentials_cb().

SetCancelled()

void KIGIT_COMMON::SetCancelled ( bool aCancel )

inline

Definition at line 178 of file kicad_git_common.h.

References m_cancel.

Referenced by PROJECT_TREE_PANE::EmptyTreePrj(), KICAD_MANAGER_CONTROL::NewFromRepository(), LIBGIT_BACKEND::PerformFetch(), and LIBGIT_BACKEND::Push().

SetPassword()

void KIGIT_COMMON::SetPassword ( const wxString & aPassword )

inline

Definition at line 100 of file kicad_git_common.h.

References m_password, and m_secretFetched.

Referenced by DIALOG_GIT_REPOSITORY::OnTestClick(), promptForGitCredentials(), and LIBGIT_BACKEND::SetupRemote().

SetProjectDir()

void KIGIT_COMMON::SetProjectDir ( const wxString & aProjectDir )

inline

Set the project directory path, preserving any symlinks in the path.

This is used to ensure git status paths match the paths used in the project tree.

Definition at line 129 of file kicad_git_common.h.

References m_projectDir.

SetRemote()

void KIGIT_COMMON::SetRemote ( const wxString & aRemote )

inline

Definition at line 147 of file kicad_git_common.h.

References m_password, m_remote, m_secretFetched, and updateConnectionType().

Referenced by DIALOG_GIT_REPOSITORY::OnTestClick(), and GIT_CLONE_HANDLER::SetRemote().

SetRepo()

void KIGIT_COMMON::SetRepo ( git_repository * aRepo )

inline

Definition at line 49 of file kicad_git_common.h.

References m_repo.

Referenced by LIBGIT_BACKEND::Clone(), and LIBGIT_BACKEND::InitializeRepository().

SetSSHKey()

void KIGIT_COMMON::SetSSHKey

(

const wxString &

aSSHKey

)

Definition at line 621 of file kicad_git_common.cpp.

References m_publicKeys.

Referenced by DIALOG_GIT_REPOSITORY::OnTestClick(), promptForGitCredentials(), LIBGIT_BACKEND::SetupRemote(), and updatePublicKeys().

SetUsername()

void KIGIT_COMMON::SetUsername ( const wxString & aUsername )

inline

Definition at line 99 of file kicad_git_common.h.

References m_secretFetched, and m_username.

Referenced by DIALOG_GIT_REPOSITORY::OnTestClick(), promptForGitCredentials(), and LIBGIT_BACKEND::SetupRemote().

TestedTypes()

unsigned & KIGIT_COMMON::TestedTypes ( )

inline

Definition at line 106 of file kicad_git_common.h.

References m_testedTypes.

Referenced by promptForGitCredentials().

updateConnectionType()

void KIGIT_COMMON::updateConnectionType ( )

private

Definition at line 768 of file kicad_git_common.cpp.

References GIT_CONN_HTTPS, GIT_CONN_LOCAL, GIT_CONN_SSH, m_connType, m_hostname, m_password, m_remote, m_secretFetched, and m_username.

Referenced by PROJECT_TREE_PANE, SetRemote(), and UpdateCurrentBranchInfo().

UpdateCurrentBranchInfo()

void KIGIT_COMMON::UpdateCurrentBranchInfo

(

)

Definition at line 718 of file kicad_git_common.cpp.

References GetRemotename(), m_password, m_remote, m_repo, m_secretFetched, updateConnectionType(), and updatePublicKeys().

updatePublicKeys()

void KIGIT_COMMON::updatePublicKeys ( )

private

Definition at line 649 of file kicad_git_common.cpp.

References m_hostname, m_publicKeys, and SetSSHKey().

Referenced by PROJECT_TREE_PANE, and UpdateCurrentBranchInfo().

WasAuthFailure()

bool KIGIT_COMMON::WasAuthFailure ( ) const

inline

Definition at line 183 of file kicad_git_common.h.

References m_authFailed.

Referenced by PROJECT_TREE_PANE::onGitFetch(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitPullProject(), and PROJECT_TREE_PANE::onGitPushProject().

Friends And Related Symbol Documentation

GIT_CLONE_HANDLER

friend class GIT_CLONE_HANDLER

friend

Definition at line 207 of file kicad_git_common.h.

References GIT_CLONE_HANDLER.

Referenced by GIT_CLONE_HANDLER.

GIT_PULL_HANDLER

friend class GIT_PULL_HANDLER

friend

Definition at line 206 of file kicad_git_common.h.

References GIT_PULL_HANDLER.

Referenced by GIT_PULL_HANDLER.

GIT_PUSH_HANDLER

friend class GIT_PUSH_HANDLER

friend

Definition at line 205 of file kicad_git_common.h.

References GIT_PUSH_HANDLER.

Referenced by GIT_PUSH_HANDLER.

LIBGIT_BACKEND

friend class LIBGIT_BACKEND

friend

Definition at line 208 of file kicad_git_common.h.

References LIBGIT_BACKEND.

Referenced by LIBGIT_BACKEND.

PROJECT_TREE_PANE

friend class PROJECT_TREE_PANE

friend

Definition at line 209 of file kicad_git_common.h.

References PROJECT_TREE_PANE, updateConnectionType(), and updatePublicKeys().

Referenced by PROJECT_TREE_PANE.

Member Data Documentation

KIGIT_CREDENTIAL_SSH_AGENT

const unsigned KIGIT_COMMON::KIGIT_CREDENTIAL_SSH_AGENT = 1 << sizeof( m_testedTypes - 1 )

staticprivate

Definition at line 223 of file kicad_git_common.h.

Referenced by HandleSSHAgentAuthentication(), and HandleSSHKeyAuthentication().

m_authFailed

bool KIGIT_COMMON::m_authFailed = false

protected

Definition at line 200 of file kicad_git_common.h.

Referenced by ClearAuthFailure(), SetAuthFailure(), and WasAuthFailure().

m_cancel

std::atomic<bool> KIGIT_COMMON::m_cancel

private

Definition at line 219 of file kicad_git_common.h.

Referenced by IsCancelled(), and SetCancelled().

m_connType

GIT_CONN_TYPE KIGIT_COMMON::m_connType

protected

Definition at line 192 of file kicad_git_common.h.

Referenced by GetPassword(), KIGIT_COMMON(), KIGIT_COMMON(), and updateConnectionType().

m_gitActionMutex

std::mutex KIGIT_COMMON::m_gitActionMutex

protected

Definition at line 202 of file kicad_git_common.h.

Referenced by LIBGIT_BACKEND::Clone(), PROJECT_TREE_PANE::EmptyTreePrj(), KIGIT_COMMON(), LIBGIT_BACKEND::PerformFetch(), LIBGIT_BACKEND::PerformPull(), and LIBGIT_BACKEND::Push().

m_hostname

wxString KIGIT_COMMON::m_hostname

protected

Definition at line 194 of file kicad_git_common.h.

Referenced by KIGIT_COMMON(), updateConnectionType(), and updatePublicKeys().

m_nextPublicKey

int KIGIT_COMMON::m_nextPublicKey

private

Definition at line 216 of file kicad_git_common.h.

Referenced by GetNextPublicKey(), KIGIT_COMMON(), KIGIT_COMMON(), and ResetNextKey().

m_password

wxString KIGIT_COMMON::m_password

protected

Definition at line 196 of file kicad_git_common.h.

Referenced by GetPassword(), KIGIT_COMMON(), SetPassword(), SetRemote(), updateConnectionType(), and UpdateCurrentBranchInfo().

m_projectDir

wxString KIGIT_COMMON::m_projectDir

protected

Definition at line 190 of file kicad_git_common.h.

Referenced by GetProjectDir(), KIGIT_COMMON(), and SetProjectDir().

m_publicKeys

std::vector<wxString> KIGIT_COMMON::m_publicKeys

private

Definition at line 215 of file kicad_git_common.h.

Referenced by GetNextPublicKey(), KIGIT_COMMON(), SetSSHKey(), and updatePublicKeys().

m_remote

wxString KIGIT_COMMON::m_remote

protected

Definition at line 193 of file kicad_git_common.h.

Referenced by LIBGIT_BACKEND::Clone(), GetConnType(), GetPassword(), GetRemote(), KIGIT_COMMON(), SetRemote(), updateConnectionType(), and UpdateCurrentBranchInfo().

m_repo

git_repository* KIGIT_COMMON::m_repo

protected

Definition at line 188 of file kicad_git_common.h.

Referenced by GetBranchNames(), GetCurrentBranchName(), GetDifferentFiles(), GetGitRootDirectory(), GetProjectDir(), GetProjectDirs(), GetRemotename(), GetRepo(), HasLocalCommits(), HasPushAndPullRemote(), KIGIT_COMMON(), KIGIT_COMMON(), SetRepo(), and UpdateCurrentBranchInfo().

m_secretFetched

bool KIGIT_COMMON::m_secretFetched

private

Definition at line 217 of file kicad_git_common.h.

Referenced by GetPassword(), KIGIT_COMMON(), KIGIT_COMMON(), SetPassword(), SetRemote(), SetUsername(), updateConnectionType(), and UpdateCurrentBranchInfo().

m_testedTypes

unsigned KIGIT_COMMON::m_testedTypes

protected

Definition at line 198 of file kicad_git_common.h.

Referenced by HandlePlaintextAuthentication(), HandleSSHAgentAuthentication(), HandleSSHKeyAuthentication(), KIGIT_COMMON(), KIGIT_COMMON(), and TestedTypes().

m_username

wxString KIGIT_COMMON::m_username

protected

Definition at line 195 of file kicad_git_common.h.

Referenced by GetPassword(), GetUsername(), KIGIT_COMMON(), SetUsername(), and updateConnectionType().

---

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

• kicad_git_common.h
• kicad_git_common.cpp