git_credentials_prompt.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_CREDENTIALS_PROMPT_H
#define GIT_CREDENTIALS_PROMPT_H
 
#include <git/git_config_handler.h>
#include <settings/common_settings.h>
 
#include <memory>
#include <wx/string.h>
 
class EDA_BASE_FRAME;
class wxWindow;
class KIGIT_COMMON;
class PROJECT;
 
namespace KIGIT
{

bool PromptForCredentials( wxWindow* aParent, KIGIT_COMMON* aCommon, PROJECT* aProject = nullptr );

struct GIT_IDENTITY
{
    GitUserConfig config;
    bool          configured = false;
};

GIT_IDENTITY ReadGitIdentity( KIGIT_COMMON& aCommon );

GitUserConfig ResolveGitIdentity( const GIT_IDENTITY& aIdentity, const COMMON_SETTINGS::GIT& aPreferences,
                                  const wxString& aUserName );

bool EditGitIdentity( wxWindow* aParent, EDA_BASE_FRAME* aFrame, const std::shared_ptr<KIGIT_COMMON>& aCommon,
                      const GIT_IDENTITY& aIdentity );

bool EnsureGitIdentity( wxWindow* aParent, EDA_BASE_FRAME* aFrame, const std::shared_ptr<KIGIT_COMMON>& aCommon,
                        const GIT_IDENTITY& aIdentity );
 
} // namespace KIGIT
 
#endif // GIT_CREDENTIALS_PROMPT_H