project_git_utils.h

Go to the documentation of this file.

/*
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PROJECT_GIT_UTILS_H
#define PROJECT_GIT_UTILS_H
 
#include <git2.h>
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include <wx/string.h>
#include <wx/filename.h>
#include <import_export.h>
 
class KIGIT_COMMON;
 
namespace KIGIT
{

class APIEXPORT PROJECT_GIT_UTILS
{
public:
    static git_repository* GetRepositoryForFile( const char* aFilename, wxString* aError = nullptr,
                                                 wxString* aTrustCommand = nullptr );

    static int CreateBranch( git_repository* aRepo, const wxString& aBranchName );

    static wxString GetCurrentHash( const wxString& aProjectFile, bool aShort );

    static git_oid GetCapturedHeadOid( git_repository* aRepo );

    static bool RemoveVCS( git_repository*& aRepo, const wxString& aProjectPath = wxEmptyString,
                           bool aRemoveGitDir = false, wxString* aErrors = nullptr );

    static wxString ComputeSymlinkPreservingWorkDir( const wxString& aUserProjectPath,
                                                     const wxString& aCanonicalWorkDir );

    static bool IsWithinProjectPath( const wxString& aAbsPath, const wxString& aProjectPath );

    static void SafeFreeRepository( std::shared_ptr<KIGIT_COMMON> aCommon, const std::string& aLabel );

    static const std::vector<wxString>& TransientGitIgnorePatterns();

    static bool IsTransientGitFile( const wxFileName& aFile );

    static std::optional<wxString> ProjectPrefix( const wxString& aWorkDir, const wxString& aProjectPath );

    static bool PathUsesGitLfs( git_repository* aRepo, const wxString& aPath, const git_oid* aCommit = nullptr );

    static bool ProjectUsesGitLfs( const KIGIT_COMMON& aCommon, wxString* aExample = nullptr,
                                   const git_oid* aCommit = nullptr );

    static wxString LfsRefusal( KIGIT_COMMON* aCommon );

    static bool WriteBlobToFile( git_repository* aRepo, const wxString& aRef, const wxString& aPath,
                                 const wxString& aDestPath );

    static bool WriteTreeToDir( git_repository* aRepo, const wxString& aRef, const wxString& aDestDir );
};
 
} // namespace KIGIT
 
#endif // PROJECT_GIT_UTILS_H