git_init_handler.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 GIT_INIT_HANDLER_H
#define GIT_INIT_HANDLER_H
 
#include <git/git_repo_mixin.h>
#include <import_export.h>
#include <wx/string.h>
 
enum class InitResult
{
    Success,
    AlreadyExists,
    Error
};
 
struct RemoteConfig
{
    wxString url;
    wxString username;
    wxString password;
    wxString sshKey;
    KIGIT_COMMON::GIT_CONN_TYPE connType;
};
 
class APIEXPORT GIT_INIT_HANDLER : public KIGIT_REPO_MIXIN
{
public:
    GIT_INIT_HANDLER( KIGIT_COMMON* aCommon );
    virtual ~GIT_INIT_HANDLER();

    bool IsRepository( const wxString& aPath );

    InitResult InitializeRepository( const wxString& aPath );

    bool SetupRemote( const RemoteConfig& aConfig );
 
    void UpdateProgress( int aCurrent, int aTotal, const wxString& aMessage ) override;
};
 

APIEXPORT void ApplyKicadGitConventions( const wxString& aProjectPath );
 
 
#endif // GIT_INIT_HANDLER_H