KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
GIT_BACKEND Class Referenceabstract

#include <git_backend.h>

Inheritance diagram for GIT_BACKEND:
LIBGIT_BACKEND

Public Member Functions

virtual ~GIT_BACKEND ()=default
 
virtual void Init ()=0
 
virtual void Shutdown ()=0
 
KIGIT_ORPHAN_REGISTRY & OrphanRegistry ()
 Return the process-wide orphan thread registry owned by this backend.
 
virtual bool IsLibraryAvailable ()=0
 
virtual bool Clone (GIT_CLONE_HANDLER *aHandler)=0
 
virtual CommitResult Commit (GIT_COMMIT_HANDLER *aHandler, const std::vector< wxString > &aFiles, const wxString &aMessage, const wxString &aAuthorName, const wxString &aAuthorEmail)=0
 
virtual PushResult Push (GIT_PUSH_HANDLER *aHandler)=0
 
virtual bool HasChangedFiles (GIT_STATUS_HANDLER *aHandler)=0
 
virtual std::map< wxString, FileStatus > GetFileStatus (GIT_STATUS_HANDLER *aHandler, const wxString &aPathspec)=0
 
virtual wxString GetCurrentBranchName (GIT_STATUS_HANDLER *aHandler)=0
 
virtual void UpdateRemoteStatus (GIT_STATUS_HANDLER *aHandler, const std::set< wxString > &aLocalChanges, const std::set< wxString > &aRemoteChanges, std::map< wxString, FileStatus > &aFileStatus)=0
 
virtual wxString GetWorkingDirectory (GIT_STATUS_HANDLER *aHandler)=0
 
virtual wxString GetWorkingDirectory (GIT_CONFIG_HANDLER *aHandler)=0
 
virtual bool GetConfigString (GIT_CONFIG_HANDLER *aHandler, const wxString &aKey, wxString &aValue)=0
 
virtual bool IsRepository (GIT_INIT_HANDLER *aHandler, const wxString &aPath)=0
 
virtual InitResult InitializeRepository (GIT_INIT_HANDLER *aHandler, const wxString &aPath)=0
 
virtual bool SetupRemote (GIT_INIT_HANDLER *aHandler, const RemoteConfig &aConfig)=0
 
virtual BranchResult SwitchToBranch (GIT_BRANCH_HANDLER *aHandler, const wxString &aBranchName)=0
 
virtual bool BranchExists (GIT_BRANCH_HANDLER *aHandler, const wxString &aBranchName)=0
 
virtual bool PerformFetch (GIT_PULL_HANDLER *aHandler, bool aSkipLock)=0
 
virtual PullResult PerformPull (GIT_PULL_HANDLER *aHandler)=0
 
virtual void PerformRevert (GIT_REVERT_HANDLER *aHandler)=0
 
virtual git_repository * GetRepositoryForFile (const char *aFilename)=0
 
virtual int CreateBranch (git_repository *aRepo, const wxString &aBranchName)=0
 
virtual bool RemoveVCS (git_repository *&aRepo, const wxString &aProjectPath, bool aRemoveGitDir, wxString *aErrors)=0
 
virtual bool AddToIndex (GIT_ADD_TO_INDEX_HANDLER *aHandler, const wxString &aFilePath)=0
 
virtual bool PerformAddToIndex (GIT_ADD_TO_INDEX_HANDLER *aHandler)=0
 
virtual bool RemoveFromIndex (GIT_REMOVE_FROM_INDEX_HANDLER *aHandler, const wxString &aFilePath)=0
 
virtual void PerformRemoveFromIndex (GIT_REMOVE_FROM_INDEX_HANDLER *aHandler)=0
 

Protected Attributes

KIGIT_ORPHAN_REGISTRY m_orphanRegistry
 

Detailed Description

Definition at line 62 of file git_backend.h.

Constructor & Destructor Documentation

◆ ~GIT_BACKEND()

virtual GIT_BACKEND::~GIT_BACKEND ( )
virtualdefault

Member Function Documentation

◆ AddToIndex()

virtual bool GIT_BACKEND::AddToIndex ( GIT_ADD_TO_INDEX_HANDLER * aHandler,
const wxString & aFilePath )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_ADD_TO_INDEX_HANDLER::AddToIndex().

◆ BranchExists()

virtual bool GIT_BACKEND::BranchExists ( GIT_BRANCH_HANDLER * aHandler,
const wxString & aBranchName )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_BRANCH_HANDLER::BranchExists().

◆ Clone()

virtual bool GIT_BACKEND::Clone ( GIT_CLONE_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_CLONE_HANDLER::PerformClone().

◆ Commit()

virtual CommitResult GIT_BACKEND::Commit ( GIT_COMMIT_HANDLER * aHandler,
const std::vector< wxString > & aFiles,
const wxString & aMessage,
const wxString & aAuthorName,
const wxString & aAuthorEmail )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_COMMIT_HANDLER::PerformCommit().

◆ CreateBranch()

virtual int GIT_BACKEND::CreateBranch ( git_repository * aRepo,
const wxString & aBranchName )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by KIGIT::PROJECT_GIT_UTILS::CreateBranch().

◆ GetConfigString()

virtual bool GIT_BACKEND::GetConfigString ( GIT_CONFIG_HANDLER * aHandler,
const wxString & aKey,
wxString & aValue )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_CONFIG_HANDLER::GetConfigString().

◆ GetCurrentBranchName()

virtual wxString GIT_BACKEND::GetCurrentBranchName ( GIT_STATUS_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_STATUS_HANDLER::GetCurrentBranchName().

◆ GetFileStatus()

virtual std::map< wxString, FileStatus > GIT_BACKEND::GetFileStatus ( GIT_STATUS_HANDLER * aHandler,
const wxString & aPathspec )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_STATUS_HANDLER::GetFileStatus().

◆ GetRepositoryForFile()

virtual git_repository * GIT_BACKEND::GetRepositoryForFile ( const char * aFilename)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by KIGIT::PROJECT_GIT_UTILS::GetRepositoryForFile().

◆ GetWorkingDirectory() [1/2]

virtual wxString GIT_BACKEND::GetWorkingDirectory ( GIT_CONFIG_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

◆ GetWorkingDirectory() [2/2]

virtual wxString GIT_BACKEND::GetWorkingDirectory ( GIT_STATUS_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_CONFIG_HANDLER::GetWorkingDirectory(), and GIT_STATUS_HANDLER::GetWorkingDirectory().

◆ HasChangedFiles()

virtual bool GIT_BACKEND::HasChangedFiles ( GIT_STATUS_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_STATUS_HANDLER::HasChangedFiles().

◆ Init()

virtual void GIT_BACKEND::Init ( )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by PGM_KICAD::OnPgmInit().

◆ InitializeRepository()

virtual InitResult GIT_BACKEND::InitializeRepository ( GIT_INIT_HANDLER * aHandler,
const wxString & aPath )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_INIT_HANDLER::InitializeRepository().

◆ IsLibraryAvailable()

virtual bool GIT_BACKEND::IsLibraryAvailable ( )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by PROJECT_TREE_PANE::onRight().

◆ IsRepository()

virtual bool GIT_BACKEND::IsRepository ( GIT_INIT_HANDLER * aHandler,
const wxString & aPath )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_INIT_HANDLER::IsRepository().

◆ OrphanRegistry()

KIGIT_ORPHAN_REGISTRY & GIT_BACKEND::OrphanRegistry ( )
inline

Return the process-wide orphan thread registry owned by this backend.

Callers that abandon a long-running git operation must route their cleanup thread through this registry so the shutdown path can wait for libgit2 workers to finish before calling git_libgit2_shutdown().

Definition at line 77 of file git_backend.h.

References m_orphanRegistry.

Referenced by PROJECT_TREE_PANE::EmptyTreePrj().

◆ PerformAddToIndex()

virtual bool GIT_BACKEND::PerformAddToIndex ( GIT_ADD_TO_INDEX_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_ADD_TO_INDEX_HANDLER::PerformAddToIndex().

◆ PerformFetch()

virtual bool GIT_BACKEND::PerformFetch ( GIT_PULL_HANDLER * aHandler,
bool aSkipLock )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_PULL_HANDLER::PerformFetch().

◆ PerformPull()

virtual PullResult GIT_BACKEND::PerformPull ( GIT_PULL_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_PULL_HANDLER::PerformPull().

◆ PerformRemoveFromIndex()

virtual void GIT_BACKEND::PerformRemoveFromIndex ( GIT_REMOVE_FROM_INDEX_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_REMOVE_FROM_INDEX_HANDLER::PerformRemoveFromIndex().

◆ PerformRevert()

virtual void GIT_BACKEND::PerformRevert ( GIT_REVERT_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_REVERT_HANDLER::PerformRevert().

◆ Push()

virtual PushResult GIT_BACKEND::Push ( GIT_PUSH_HANDLER * aHandler)
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_PUSH_HANDLER::PerformPush().

◆ RemoveFromIndex()

virtual bool GIT_BACKEND::RemoveFromIndex ( GIT_REMOVE_FROM_INDEX_HANDLER * aHandler,
const wxString & aFilePath )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_REMOVE_FROM_INDEX_HANDLER::RemoveFromIndex().

◆ RemoveVCS()

virtual bool GIT_BACKEND::RemoveVCS ( git_repository *& aRepo,
const wxString & aProjectPath,
bool aRemoveGitDir,
wxString * aErrors )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by KIGIT::PROJECT_GIT_UTILS::RemoveVCS().

◆ SetupRemote()

virtual bool GIT_BACKEND::SetupRemote ( GIT_INIT_HANDLER * aHandler,
const RemoteConfig & aConfig )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_INIT_HANDLER::SetupRemote().

◆ Shutdown()

virtual void GIT_BACKEND::Shutdown ( )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by PGM_KICAD::OnPgmExit().

◆ SwitchToBranch()

virtual BranchResult GIT_BACKEND::SwitchToBranch ( GIT_BRANCH_HANDLER * aHandler,
const wxString & aBranchName )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_BRANCH_HANDLER::SwitchToBranch().

◆ UpdateRemoteStatus()

virtual void GIT_BACKEND::UpdateRemoteStatus ( GIT_STATUS_HANDLER * aHandler,
const std::set< wxString > & aLocalChanges,
const std::set< wxString > & aRemoteChanges,
std::map< wxString, FileStatus > & aFileStatus )
pure virtual

Implemented in LIBGIT_BACKEND.

Referenced by GIT_STATUS_HANDLER::UpdateRemoteStatus().

Member Data Documentation

◆ m_orphanRegistry

KIGIT_ORPHAN_REGISTRY GIT_BACKEND::m_orphanRegistry
protected

Definition at line 136 of file git_backend.h.

Referenced by OrphanRegistry(), and LIBGIT_BACKEND::Shutdown().

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