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

#include <kicad_git_errors.h>

Inheritance diagram for KIGIT_ERRORS:
GIT_COMMIT_HANDLER KIGIT_REPO_MIXIN GIT_BRANCH_HANDLER GIT_CLONE_HANDLER GIT_CONFIG_HANDLER GIT_INIT_HANDLER GIT_PULL_HANDLER GIT_PUSH_HANDLER GIT_STATUS_HANDLER

Public Member Functions

 KIGIT_ERRORS ()=default
 
virtual ~KIGIT_ERRORS ()=default
 
const std::vector< wxString > & GetErrorStrings () const
 
wxString GetErrorString ()
 
KIGIT_ERROR_MESSAGE PopError ()
 Take the newest error with its details. Both are empty when none is queued.
 
void AddError (const wxString &aSummary, const wxString &aDetails)
 A summary the user can act on, with the raw text that explains it kept apart for the details.
 
void AddError (const KIGIT_ERROR_MESSAGE &aMessage)
 
void AddGitError (const wxString &aSummary)
 Queue the summary with libgit2's last error as its details.
 
void AddErrorString (const wxString aErrorString)
 
void AddErrorString (const std::string aErrorString)
 

Private Attributes

std::vector< wxString > m_errorStrings
 
std::vector< wxString > m_errorDetails
 One per entry in m_errorStrings.
 

Detailed Description

Definition at line 37 of file kicad_git_errors.h.

Constructor & Destructor Documentation

◆ KIGIT_ERRORS()

KIGIT_ERRORS::KIGIT_ERRORS ( )
default

◆ ~KIGIT_ERRORS()

virtual KIGIT_ERRORS::~KIGIT_ERRORS ( )
virtualdefault

Member Function Documentation

◆ AddError() [1/2]

void KIGIT_ERRORS::AddError ( const KIGIT_ERROR_MESSAGE & aMessage)
inline

Definition at line 76 of file kicad_git_errors.h.

References AddError(), KIGIT_ERROR_MESSAGE::details, and KIGIT_ERROR_MESSAGE::summary.

Referenced by AddError().

◆ AddError() [2/2]

void KIGIT_ERRORS::AddError ( const wxString & aSummary,
const wxString & aDetails )

A summary the user can act on, with the raw text that explains it kept apart for the details.

Both are shown, so any credentials in a URL inside either one are removed here.

Definition at line 27 of file kicad_git_errors.cpp.

References m_errorDetails, m_errorStrings, and KIGIT::StripEmbeddedUserinfo().

Referenced by AddErrorString(), AddErrorString(), AddGitError(), adoptRemoteHistory(), LIBGIT_BACKEND::Amend(), LIBGIT_BACKEND::Commit(), LIBGIT_BACKEND::handleFastForward(), LIBGIT_BACKEND::handleMerge(), LIBGIT_BACKEND::InitializeRepository(), rebaseOnto(), reportRemoteLookupFailure(), KIGIT_REPO_MIXIN::ReportTransferFailure(), LIBGIT_BACKEND::SetupRemote(), and LIBGIT_BACKEND::SwitchToBranch().

◆ AddErrorString() [1/2]

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

Definition at line 86 of file kicad_git_errors.h.

References AddError().

◆ AddErrorString() [2/2]

void KIGIT_ERRORS::AddErrorString ( const wxString aErrorString)
inline

Definition at line 81 of file kicad_git_errors.h.

References AddError().

Referenced by adoptRemoteHistory(), LIBGIT_BACKEND::Amend(), LIBGIT_BACKEND::Clone(), LIBGIT_BACKEND::Commit(), LIBGIT_BACKEND::handleFastForward(), LIBGIT_BACKEND::handleMerge(), LIBGIT_BACKEND::handleRebase(), LIBGIT_BACKEND::PerformFetch(), LIBGIT_BACKEND::PerformPull(), LIBGIT_BACKEND::Push(), rebaseOnto(), LIBGIT_BACKEND::SetupRemote(), and LIBGIT_BACKEND::SwitchToBranch().

◆ AddGitError()

void KIGIT_ERRORS::AddGitError ( const wxString & aSummary)

Queue the summary with libgit2's last error as its details.

Definition at line 34 of file kicad_git_errors.cpp.

References AddError(), and KIGIT_COMMON::GetLastGitError().

Referenced by adoptRemoteHistory(), LIBGIT_BACKEND::Amend(), LIBGIT_BACKEND::Commit(), LIBGIT_BACKEND::handleFastForward(), LIBGIT_BACKEND::handleMerge(), LIBGIT_BACKEND::PerformPull(), and rebaseOnto().

◆ GetErrorString()

wxString KIGIT_ERRORS::GetErrorString ( )
inline

Definition at line 49 of file kicad_git_errors.h.

References _, m_errorDetails, and m_errorStrings.

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

◆ GetErrorStrings()

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

Definition at line 44 of file kicad_git_errors.h.

References m_errorStrings.

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

◆ PopError()

KIGIT_ERROR_MESSAGE KIGIT_ERRORS::PopError ( )
inline

Take the newest error with its details. Both are empty when none is queued.

Definition at line 61 of file kicad_git_errors.h.

References m_errorDetails, m_errorStrings, and message.

Referenced by GIT_COMMIT_PANE::finishCommit(), moveToNewBranch(), KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitRemoteSettings(), PROJECT_TREE_PANE::onGitSyncTimer(), and SwitchProjectToBranch().

Member Data Documentation

◆ m_errorDetails

std::vector<wxString> KIGIT_ERRORS::m_errorDetails
private

One per entry in m_errorStrings.

Definition at line 94 of file kicad_git_errors.h.

Referenced by AddError(), GetErrorString(), and PopError().

◆ m_errorStrings

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

Definition at line 93 of file kicad_git_errors.h.

Referenced by AddError(), GetErrorString(), GetErrorStrings(), and PopError().

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