kicad-source/common/git/git_branch_handler.h
2025-07-31 08:32:07 -07:00

71 lines
2.3 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/gpl-3.0.html
* or you may search the http://www.gnu.org website for the version 3 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef GIT_BRANCH_HANDLER_H
#define GIT_BRANCH_HANDLER_H
#include <git/git_repo_mixin.h>
#include <wx/string.h>
#include <vector>
enum class BranchResult
{
Success,
BranchNotFound,
CheckoutFailed,
Error
};
class GIT_BRANCH_HANDLER : public KIGIT_REPO_MIXIN
{
public:
GIT_BRANCH_HANDLER( KIGIT_COMMON* aCommon );
virtual ~GIT_BRANCH_HANDLER();
/**
* Switch to the specified branch
* @param aBranchName Name of the branch to switch to
* @return BranchResult indicating the outcome of the operation
*/
BranchResult SwitchToBranch( const wxString& aBranchName );
/**
* Check if a branch exists
* @param aBranchName Name of the branch to check
* @return True if branch exists, false otherwise
*/
bool BranchExists( const wxString& aBranchName );
void UpdateProgress( int aCurrent, int aTotal, const wxString& aMessage ) override;
private:
/**
* Look up a branch reference by name
* @param aBranchName Name of the branch
* @param aReference Output parameter for the reference
* @return True if successful, false otherwise
*/
bool LookupBranchReference( const wxString& aBranchName, git_reference** aReference );
};
#endif // GIT_BRANCH_HANDLER_H