KiCad PCB EDA Suite
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
GIT_COMMIT_HANDLER Class Reference

#include <git_commit_handler.h>

Inheritance diagram for GIT_COMMIT_HANDLER:
KIGIT_COMMON

Public Types

enum class  CommitResult { Success , Error , Cancelled }
 
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

 GIT_COMMIT_HANDLER (git_repository *aRepo)
 
virtual ~GIT_COMMIT_HANDLER ()
 
CommitResult PerformCommit (const std::vector< std::string > &aFilesToCommit)
 
std::string GetErrorString () const
 
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 () const
 
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
 
void ResetNextKey ()
 
wxString GetNextPublicKey ()
 
void SetRemote (const wxString &aRemote)
 
int HandleSSHKeyAuthentication (git_cred **aOut, const wxString &aUsername)
 
int HandlePlaintextAuthentication (git_cred **aOut, const wxString &aUsername)
 
int HandleSSHAgentAuthentication (git_cred **aOut, const wxString &aUsername)
 

Static Public Member Functions

static wxString GetLastGitError ()
 

Protected Attributes

git_repository * m_repo
 
GIT_CONN_TYPE m_connType
 
wxString m_remote
 
wxString m_hostname
 
wxString m_username
 
wxString m_password
 
unsigned m_testedTypes
 
std::mutex m_gitActionMutex
 

Private Member Functions

void AddErrorString (const std::string &aErrorString)
 
void updatePublicKeys ()
 
void updateConnectionType ()
 

Private Attributes

std::string m_errorString
 
std::vector< wxString > m_publicKeys
 
int m_nextPublicKey
 

Static Private Attributes

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

Detailed Description

Definition at line 35 of file git_commit_handler.h.

Member Enumeration Documentation

◆ CommitResult

enum class GIT_COMMIT_HANDLER::CommitResult
strong
Enumerator
Success 
Error 
Cancelled 

Definition at line 41 of file git_commit_handler.h.

◆ GIT_CONN_TYPE

enum class KIGIT_COMMON::GIT_CONN_TYPE
stronginherited
Enumerator
GIT_CONN_HTTPS 
GIT_CONN_SSH 
GIT_CONN_LOCAL 
GIT_CONN_LAST 

Definition at line 83 of file kicad_git_common.h.

◆ GIT_STATUS

enum class KIGIT_COMMON::GIT_STATUS
stronginherited
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 69 of file kicad_git_common.h.

Constructor & Destructor Documentation

◆ GIT_COMMIT_HANDLER()

GIT_COMMIT_HANDLER::GIT_COMMIT_HANDLER ( git_repository *  aRepo)

Definition at line 26 of file git_commit_handler.cpp.

◆ ~GIT_COMMIT_HANDLER()

GIT_COMMIT_HANDLER::~GIT_COMMIT_HANDLER ( )
virtual

Definition at line 31 of file git_commit_handler.cpp.

Member Function Documentation

◆ AddErrorString()

void GIT_COMMIT_HANDLER::AddErrorString ( const std::string &  aErrorString)
private

Definition at line 48 of file git_commit_handler.cpp.

References m_errorString.

◆ GetBranchNames()

std::vector< wxString > KIGIT_COMMON::GetBranchNames ( ) const
inherited

Definition at line 103 of file kicad_git_common.cpp.

References KIGIT_COMMON::m_repo, and traceGit.

Referenced by KIGIT_REPO_MIXIN::GetBranchNames(), PROJECT_TREE_PANE::onGitSwitchBranch(), and PROJECT_TREE_PANE::onRight().

◆ GetConnType()

KIGIT_COMMON::GIT_CONN_TYPE KIGIT_COMMON::GetConnType ( ) const
inherited

Definition at line 665 of file kicad_git_common.cpp.

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

Referenced by KIGIT_REPO_MIXIN::GetConnType().

◆ GetCurrentBranchName()

wxString KIGIT_COMMON::GetCurrentBranchName ( ) const
inherited

Definition at line 71 of file kicad_git_common.cpp.

References KIGIT_COMMON::m_repo, and traceGit.

Referenced by KIGIT_REPO_MIXIN::GetCurrentBranchName().

◆ GetDifferentFiles()

std::pair< std::set< wxString >, std::set< wxString > > KIGIT_COMMON::GetDifferentFiles ( ) const
inherited

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 234 of file kicad_git_common.cpp.

References delta, KIGIT_COMMON::GetLastGitError(), KIGIT_COMMON::m_repo, and traceGit.

Referenced by KIGIT_REPO_MIXIN::GetDifferentFiles(), and PROJECT_TREE_PANE::updateGitStatusIconMap().

◆ GetErrorString()

std::string GIT_COMMIT_HANDLER::GetErrorString ( ) const

Definition at line 42 of file git_commit_handler.cpp.

References m_errorString.

◆ GetGitRootDirectory()

wxString KIGIT_COMMON::GetGitRootDirectory ( ) const
inherited

Definition at line 558 of file kicad_git_common.cpp.

References KIGIT_COMMON::m_repo, and path.

Referenced by KIGIT_REPO_MIXIN::GetGitRootDirectory(), and PROJECT_TREE_PANE::onRight().

◆ GetLastGitError()

static wxString KIGIT_COMMON::GetLastGitError ( )
inlinestaticinherited

Definition at line 139 of file kicad_git_common.h.

Referenced by PROJECT_TREE_PANE::canFileBeAddedToVCS(), credentials_cb(), get_git_repository_for_file(), getDefaultAuthorAndEmail(), KIGIT_COMMON::GetDifferentFiles(), KIGIT_COMMON::GetProjectDirs(), KIGIT_COMMON::GetRemotename(), git_create_branch(), GIT_PULL_HANDLER::handleRebase(), KIGIT_COMMON::HandleSSHAgentAuthentication(), KIGIT_COMMON::HandleSSHKeyAuthentication(), PROJECT_TREE_PANE::hasChangedFiles(), KIGIT_COMMON::HasLocalCommits(), KIGIT_PCB_MERGE::Merge(), PROJECT_TREE_PANE::onGitCommit(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitSwitchBranch(), DIALOG_GIT_REPOSITORY::OnTestClick(), GIT_PULL_HANDLER::PerformFetch(), GIT_PUSH_HANDLER::PerformPush(), and PROJECT_TREE_PANE::updateGitStatusIconMap().

◆ GetNextPublicKey()

wxString KIGIT_COMMON::GetNextPublicKey ( )
inlineinherited

Definition at line 119 of file kicad_git_common.h.

References KIGIT_COMMON::m_nextPublicKey, and KIGIT_COMMON::m_publicKeys.

Referenced by KIGIT_REPO_MIXIN::GetNextPublicKey(), and KIGIT_COMMON::HandleSSHKeyAuthentication().

◆ GetPassword()

wxString KIGIT_COMMON::GetPassword ( ) const
inlineinherited

Definition at line 92 of file kicad_git_common.h.

References KIGIT_COMMON::m_password.

Referenced by KIGIT_REPO_MIXIN::GetPassword(), KIGIT_COMMON::HandlePlaintextAuthentication(), and KIGIT_COMMON::HandleSSHKeyAuthentication().

◆ GetProjectDirs()

std::vector< wxString > KIGIT_COMMON::GetProjectDirs ( )
inherited

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 166 of file kicad_git_common.cpp.

References KIGIT_COMMON::GetLastGitError(), KIGIT_COMMON::m_repo, and traceGit.

Referenced by KIGIT_REPO_MIXIN::GetProjectDirs().

◆ GetRemotename()

wxString KIGIT_COMMON::GetRemotename ( ) const
inherited

Definition at line 477 of file kicad_git_common.cpp.

References KIGIT_COMMON::GetLastGitError(), KIGIT_COMMON::m_repo, and traceGit.

Referenced by KIGIT_COMMON::GetConnType(), KIGIT_REPO_MIXIN::GetRemotename(), and KIGIT_COMMON::UpdateCurrentBranchInfo().

◆ GetRepo()

git_repository * KIGIT_COMMON::GetRepo ( ) const
inherited

Definition at line 66 of file kicad_git_common.cpp.

References KIGIT_COMMON::m_repo.

Referenced by KIGIT_REPO_MIXIN::GetRepo().

◆ GetUsername()

wxString KIGIT_COMMON::GetUsername ( ) const
inlineinherited

Definition at line 91 of file kicad_git_common.h.

References KIGIT_COMMON::m_username.

Referenced by KIGIT_REPO_MIXIN::GetUsername().

◆ HandlePlaintextAuthentication()

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

Definition at line 786 of file kicad_git_common.cpp.

References KIGIT_COMMON::GetPassword(), and KIGIT_COMMON::m_testedTypes.

Referenced by credentials_cb().

◆ HandleSSHAgentAuthentication()

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

Definition at line 796 of file kicad_git_common.cpp.

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

Referenced by KIGIT_COMMON::HandleSSHKeyAuthentication().

◆ HandleSSHKeyAuthentication()

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

Definition at line 754 of file kicad_git_common.cpp.

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

Referenced by credentials_cb().

◆ HasLocalCommits()

bool KIGIT_COMMON::HasLocalCommits ( ) const
inherited

Definition at line 388 of file kicad_git_common.cpp.

References KIGIT_COMMON::GetLastGitError(), KIGIT_COMMON::m_repo, and traceGit.

Referenced by PROJECT_TREE_PANE::onRight().

◆ HasPushAndPullRemote()

bool KIGIT_COMMON::HasPushAndPullRemote ( ) const
inherited

Definition at line 449 of file kicad_git_common.cpp.

References KIGIT_COMMON::m_repo, and traceGit.

Referenced by PROJECT_TREE_PANE::onRight().

◆ PerformCommit()

GIT_COMMIT_HANDLER::CommitResult GIT_COMMIT_HANDLER::PerformCommit ( const std::vector< std::string > &  aFilesToCommit)

Definition at line 36 of file git_commit_handler.cpp.

References Success.

◆ ResetNextKey()

void KIGIT_COMMON::ResetNextKey ( )
inlineinherited

Definition at line 117 of file kicad_git_common.h.

References KIGIT_COMMON::m_nextPublicKey.

Referenced by KIGIT_REPO_MIXIN::ResetNextKey().

◆ SetPassword()

void KIGIT_COMMON::SetPassword ( const wxString &  aPassword)
inlineinherited

Definition at line 96 of file kicad_git_common.h.

References KIGIT_COMMON::m_password.

Referenced by PROJECT_TREE_PANE::onGitInitializeProject(), DIALOG_GIT_REPOSITORY::OnTestClick(), and KIGIT_REPO_MIXIN::SetPassword().

◆ SetRemote()

void KIGIT_COMMON::SetRemote ( const wxString &  aRemote)
inlineinherited

Definition at line 127 of file kicad_git_common.h.

References KIGIT_COMMON::m_remote, and KIGIT_COMMON::updateConnectionType().

Referenced by DIALOG_GIT_REPOSITORY::OnTestClick().

◆ SetRepo()

void KIGIT_COMMON::SetRepo ( git_repository *  aRepo)
inlineinherited

Definition at line 45 of file kicad_git_common.h.

References KIGIT_COMMON::m_repo.

Referenced by GIT_CLONE_HANDLER::PerformClone().

◆ SetSSHKey()

void KIGIT_COMMON::SetSSHKey ( const wxString &  aSSHKey)
inherited

Definition at line 547 of file kicad_git_common.cpp.

References KIGIT_COMMON::m_publicKeys.

Referenced by PROJECT_TREE_PANE::onGitInitializeProject(), DIALOG_GIT_REPOSITORY::OnTestClick(), PROJECT_TREE_PANE::ReCreateTreePrj(), KIGIT_REPO_MIXIN::SetSSHKey(), and KIGIT_COMMON::updatePublicKeys().

◆ SetUsername()

void KIGIT_COMMON::SetUsername ( const wxString &  aUsername)
inlineinherited

Definition at line 95 of file kicad_git_common.h.

References KIGIT_COMMON::m_username.

Referenced by PROJECT_TREE_PANE::onGitInitializeProject(), DIALOG_GIT_REPOSITORY::OnTestClick(), PROJECT_TREE_PANE::ReCreateTreePrj(), and KIGIT_REPO_MIXIN::SetUsername().

◆ TestedTypes()

unsigned & KIGIT_COMMON::TestedTypes ( )
inlineinherited

Definition at line 102 of file kicad_git_common.h.

References KIGIT_COMMON::m_testedTypes.

Referenced by KIGIT_REPO_MIXIN::TestedTypes().

◆ updateConnectionType()

void KIGIT_COMMON::updateConnectionType ( )
privateinherited

Definition at line 685 of file kicad_git_common.cpp.

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

Referenced by KIGIT_COMMON::SetRemote(), and KIGIT_COMMON::UpdateCurrentBranchInfo().

◆ UpdateCurrentBranchInfo()

void KIGIT_COMMON::UpdateCurrentBranchInfo ( )
inherited

Definition at line 638 of file kicad_git_common.cpp.

References KIGIT_COMMON::GetRemotename(), KIPLATFORM::SECRETS::GetSecret(), KIGIT_COMMON::m_password, KIGIT_COMMON::m_remote, KIGIT_COMMON::m_repo, KIGIT_COMMON::m_username, KIGIT_COMMON::updateConnectionType(), and KIGIT_COMMON::updatePublicKeys().

Referenced by PROJECT_TREE_PANE::ReCreateTreePrj().

◆ updatePublicKeys()

void KIGIT_COMMON::updatePublicKeys ( )
privateinherited

Definition at line 569 of file kicad_git_common.cpp.

References KIGIT_COMMON::m_hostname, KIGIT_COMMON::m_publicKeys, and KIGIT_COMMON::SetSSHKey().

Referenced by KIGIT_COMMON::UpdateCurrentBranchInfo().

Member Data Documentation

◆ KIGIT_CREDENTIAL_SSH_AGENT

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

Definition at line 176 of file kicad_git_common.h.

Referenced by KIGIT_COMMON::HandleSSHAgentAuthentication(), and KIGIT_COMMON::HandleSSHKeyAuthentication().

◆ m_connType

GIT_CONN_TYPE KIGIT_COMMON::m_connType
protectedinherited

Definition at line 152 of file kicad_git_common.h.

Referenced by KIGIT_COMMON::updateConnectionType().

◆ m_errorString

std::string GIT_COMMIT_HANDLER::m_errorString
private

Definition at line 55 of file git_commit_handler.h.

Referenced by AddErrorString(), and GetErrorString().

◆ m_gitActionMutex

std::mutex KIGIT_COMMON::m_gitActionMutex
protectedinherited

Definition at line 160 of file kicad_git_common.h.

◆ m_hostname

wxString KIGIT_COMMON::m_hostname
protectedinherited

Definition at line 154 of file kicad_git_common.h.

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

◆ m_nextPublicKey

int KIGIT_COMMON::m_nextPublicKey
privateinherited

Definition at line 172 of file kicad_git_common.h.

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

◆ m_password

wxString KIGIT_COMMON::m_password
protectedinherited

Definition at line 156 of file kicad_git_common.h.

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

◆ m_publicKeys

std::vector<wxString> KIGIT_COMMON::m_publicKeys
privateinherited

Definition at line 171 of file kicad_git_common.h.

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

◆ m_remote

wxString KIGIT_COMMON::m_remote
protectedinherited

Definition at line 153 of file kicad_git_common.h.

Referenced by KIGIT_COMMON::GetConnType(), GIT_CLONE_HANDLER::PerformClone(), GIT_CLONE_HANDLER::SetRemote(), KIGIT_COMMON::SetRemote(), KIGIT_COMMON::updateConnectionType(), and KIGIT_COMMON::UpdateCurrentBranchInfo().

◆ m_repo

git_repository* KIGIT_COMMON::m_repo
protectedinherited

Definition at line 150 of file kicad_git_common.h.

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

◆ m_testedTypes

unsigned KIGIT_COMMON::m_testedTypes
protectedinherited

Definition at line 158 of file kicad_git_common.h.

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

◆ m_username

wxString KIGIT_COMMON::m_username
protectedinherited

Definition at line 155 of file kicad_git_common.h.

Referenced by KIGIT_COMMON::GetUsername(), KIGIT_COMMON::SetUsername(), KIGIT_COMMON::updateConnectionType(), and KIGIT_COMMON::UpdateCurrentBranchInfo().

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