KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | Private Attributes | List of all members
KIGIT_COMMON Class Reference

#include <kicad_git_common.h>

Inheritance diagram for KIGIT_COMMON:
KIGIT_ERRORS GIT_CLONE_HANDLER GIT_COMMIT_HANDLER GIT_PULL_HANDLER GIT_PUSH_HANDLER

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_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 ()
 
git_repository * GetRepo () const
 
void SetRepo (git_repository *aRepo)
 
wxString GetCurrentBranchName () const
 
std::vector< wxString > GetBranchNames () const
 
virtual void UpdateProgress (int aCurrent, int aTotal, const wxString &aMessage)
 
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
 
wxString GetSSHKey () const
 
GIT_CONN_TYPE GetConnType () const
 
void SetUsername (const wxString &aUsername)
 
void SetPassword (const wxString &aPassword)
 
void SetSSHKey (const wxString &aSSHKey)
 
void SetConnType (GIT_CONN_TYPE aConnType)
 
void SetConnType (unsigned aConnType)
 
unsigned & TestedTypes ()
 
bool HasLocalCommits () const
 
bool HasPushAndPullRemote () const
 
const std::vector< wxString > & GetErrorStrings () const
 
const wxString & PeekErrorString () const
 
wxString GetErrorString ()
 
void AddErrorString (const wxString aErrorString)
 
void AddErrorString (const std::string aErrorString)
 
void ClearErrorStrings ()
 

Protected Attributes

git_repository * m_repo
 
GIT_CONN_TYPE m_connType
 
wxString m_username
 
wxString m_password
 
wxString m_sshKey
 
unsigned m_testedTypes
 

Private Attributes

std::vector< wxString > m_errorStrings
 

Detailed Description

Definition at line 34 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 82 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_LAST 

Definition at line 69 of file kicad_git_common.h.

Constructor & Destructor Documentation

◆ KIGIT_COMMON()

KIGIT_COMMON::KIGIT_COMMON ( git_repository *  aRepo)

Definition at line 31 of file kicad_git_common.cpp.

◆ ~KIGIT_COMMON()

KIGIT_COMMON::~KIGIT_COMMON ( )

Definition at line 35 of file kicad_git_common.cpp.

Member Function Documentation

◆ AddErrorString() [1/2]

void KIGIT_ERRORS::AddErrorString ( const std::string  aErrorString)
inlineinherited

Definition at line 66 of file kicad_git_errors.h.

References KIGIT_ERRORS::m_errorStrings.

◆ AddErrorString() [2/2]

void KIGIT_ERRORS::AddErrorString ( const wxString  aErrorString)
inlineinherited

Definition at line 61 of file kicad_git_errors.h.

References KIGIT_ERRORS::m_errorStrings.

Referenced by GIT_PULL_HANDLER::handleFastForward(), GIT_PULL_HANDLER::handleMerge(), GIT_CLONE_HANDLER::PerformClone(), GIT_PULL_HANDLER::PerformFetch(), GIT_PULL_HANDLER::PerformPull(), and GIT_PUSH_HANDLER::PerformPush().

◆ ClearErrorStrings()

void KIGIT_ERRORS::ClearErrorStrings ( )
inlineinherited

Definition at line 71 of file kicad_git_errors.h.

References KIGIT_ERRORS::m_errorStrings.

◆ GetBranchNames()

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

Definition at line 75 of file kicad_git_common.cpp.

References m_repo.

Referenced by PROJECT_TREE_PANE::onRight().

◆ GetConnType()

GIT_CONN_TYPE KIGIT_COMMON::GetConnType ( ) const
inline

Definition at line 93 of file kicad_git_common.h.

References m_connType.

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

◆ GetCurrentBranchName()

wxString KIGIT_COMMON::GetCurrentBranchName ( ) const

Definition at line 43 of file kicad_git_common.cpp.

References m_repo.

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

References delta, and m_repo.

Referenced by PROJECT_TREE_PANE::updateGitStatusIcons().

◆ GetErrorString()

wxString KIGIT_ERRORS::GetErrorString ( )
inlineinherited

Definition at line 51 of file kicad_git_errors.h.

References _, and KIGIT_ERRORS::m_errorStrings.

Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), and PROJECT_TREE_PANE::onGitPushProject().

◆ GetErrorStrings()

const std::vector< wxString > & KIGIT_ERRORS::GetErrorStrings ( ) const
inlineinherited

Definition at line 38 of file kicad_git_errors.h.

References KIGIT_ERRORS::m_errorStrings.

◆ GetPassword()

wxString KIGIT_COMMON::GetPassword ( ) const
inline

Definition at line 91 of file kicad_git_common.h.

References m_password.

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

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

References m_repo.

Referenced by KICAD_MANAGER_CONTROL::NewFromRepository().

◆ GetRepo()

git_repository * KIGIT_COMMON::GetRepo ( ) const

Definition at line 38 of file kicad_git_common.cpp.

References m_repo.

◆ GetSSHKey()

wxString KIGIT_COMMON::GetSSHKey ( ) const
inline

Definition at line 92 of file kicad_git_common.h.

References m_sshKey.

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

◆ GetUsername()

wxString KIGIT_COMMON::GetUsername ( ) const
inline

Definition at line 90 of file kicad_git_common.h.

References m_username.

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

◆ HasLocalCommits()

bool KIGIT_COMMON::HasLocalCommits ( ) const

Definition at line 311 of file kicad_git_common.cpp.

References m_repo.

Referenced by PROJECT_TREE_PANE::onRight().

◆ HasPushAndPullRemote()

bool KIGIT_COMMON::HasPushAndPullRemote ( ) const

Definition at line 360 of file kicad_git_common.cpp.

References m_repo.

Referenced by PROJECT_TREE_PANE::onRight().

◆ PeekErrorString()

const wxString & KIGIT_ERRORS::PeekErrorString ( ) const
inlineinherited

Definition at line 43 of file kicad_git_errors.h.

References _, and KIGIT_ERRORS::m_errorStrings.

◆ SetConnType() [1/2]

void KIGIT_COMMON::SetConnType ( GIT_CONN_TYPE  aConnType)
inline

Definition at line 99 of file kicad_git_common.h.

References m_connType.

Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitPullProject(), PROJECT_TREE_PANE::onGitPushProject(), and PROJECT_TREE_PANE::ReCreateTreePrj().

◆ SetConnType() [2/2]

void KIGIT_COMMON::SetConnType ( unsigned  aConnType)
inline

Definition at line 100 of file kicad_git_common.h.

References GIT_CONN_LAST, and m_connType.

◆ SetPassword()

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

Definition at line 96 of file kicad_git_common.h.

References m_password.

Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitPullProject(), PROJECT_TREE_PANE::onGitPushProject(), and PROJECT_TREE_PANE::ReCreateTreePrj().

◆ SetRepo()

void KIGIT_COMMON::SetRepo ( git_repository *  aRepo)
inline

Definition at line 43 of file kicad_git_common.h.

References m_repo.

◆ SetSSHKey()

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

Definition at line 97 of file kicad_git_common.h.

References m_sshKey.

Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitPullProject(), PROJECT_TREE_PANE::onGitPushProject(), and PROJECT_TREE_PANE::ReCreateTreePrj().

◆ SetUsername()

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

Definition at line 95 of file kicad_git_common.h.

References m_username.

Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitPullProject(), PROJECT_TREE_PANE::onGitPushProject(), and PROJECT_TREE_PANE::ReCreateTreePrj().

◆ TestedTypes()

unsigned & KIGIT_COMMON::TestedTypes ( )
inline

Definition at line 109 of file kicad_git_common.h.

References m_testedTypes.

Referenced by credentials_cb().

◆ UpdateProgress()

virtual void KIGIT_COMMON::UpdateProgress ( int  aCurrent,
int  aTotal,
const wxString &  aMessage 
)
inlinevirtual

Reimplemented in GIT_CLONE_HANDLER, GIT_PULL_HANDLER, and GIT_PUSH_HANDLER.

Definition at line 52 of file kicad_git_common.h.

Referenced by clone_progress_cb(), progress_cb(), push_transfer_progress_cb(), push_update_reference_cb(), transfer_progress_cb(), and update_cb().

Member Data Documentation

◆ m_connType

GIT_CONN_TYPE KIGIT_COMMON::m_connType
protected

Definition at line 120 of file kicad_git_common.h.

Referenced by GetConnType(), and SetConnType().

◆ m_errorStrings

std::vector<wxString> KIGIT_ERRORS::m_errorStrings
privateinherited

Definition at line 78 of file kicad_git_errors.h.

Referenced by KIGIT_ERRORS::AddErrorString(), KIGIT_ERRORS::ClearErrorStrings(), KIGIT_ERRORS::GetErrorString(), KIGIT_ERRORS::GetErrorStrings(), and KIGIT_ERRORS::PeekErrorString().

◆ m_password

wxString KIGIT_COMMON::m_password
protected

Definition at line 122 of file kicad_git_common.h.

Referenced by GetPassword(), and SetPassword().

◆ m_repo

git_repository* KIGIT_COMMON::m_repo
protected

Definition at line 118 of file kicad_git_common.h.

Referenced by GetBranchNames(), GetCurrentBranchName(), GetDifferentFiles(), GetProjectDirs(), GetRepo(), GIT_PULL_HANDLER::handleFastForward(), GIT_PULL_HANDLER::handleMerge(), HasLocalCommits(), HasPushAndPullRemote(), GIT_CLONE_HANDLER::PerformClone(), GIT_PULL_HANDLER::PerformFetch(), GIT_PULL_HANDLER::PerformPull(), GIT_PUSH_HANDLER::PerformPush(), SetRepo(), and GIT_CLONE_HANDLER::~GIT_CLONE_HANDLER().

◆ m_sshKey

wxString KIGIT_COMMON::m_sshKey
protected

Definition at line 123 of file kicad_git_common.h.

Referenced by GetSSHKey(), and SetSSHKey().

◆ m_testedTypes

unsigned KIGIT_COMMON::m_testedTypes
protected

Definition at line 125 of file kicad_git_common.h.

Referenced by GIT_CLONE_HANDLER::PerformClone(), and TestedTypes().

◆ m_username

wxString KIGIT_COMMON::m_username
protected

Definition at line 121 of file kicad_git_common.h.

Referenced by GetUsername(), and SetUsername().

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