git_transfer.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 <http://www.gnu.org/licenses/>.
 */
 
 
#ifndef GIT_TRANSFER_H
#define GIT_TRANSFER_H
 
#include <functional>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
 
#include <git/kicad_git_common.h>
#include <widgets/progress_reporter_base.h>
 
namespace KIGIT
{

void CallOnUi( std::function<void()> aFn );

void CallIfAlive( const std::weak_ptr<bool>& aWatch, std::function<void()> aFn );

bool StartTransfer( const std::string& aLabel, std::function<void()> aWork );
 
} // namespace KIGIT
 

class KIGIT_STATUS_REPORTER : public PROGRESS_REPORTER_BASE
{
public:
    KIGIT_STATUS_REPORTER( const std::weak_ptr<bool>& aAlive, std::function<void( const wxString& )> aShow );
 
protected:
    bool updateUI() override;
 
private:
    std::weak_ptr<bool>                    m_alive;
    std::function<void( const wxString& )> m_show;
    wxString                               m_lastShown;
};
 
 
class KIGIT_TRANSFER
{
public:
    KIGIT_TRANSFER() = default;
    ~KIGIT_TRANSFER();
 
    KIGIT_TRANSFER( const KIGIT_TRANSFER& ) = delete;
    KIGIT_TRANSFER& operator=( const KIGIT_TRANSFER& ) = delete;

    bool IsBusy() const { return m_busy; }

    std::weak_ptr<bool> Alive() const { return m_alive; }

    void Cancel();

    bool Start( const std::string& aLabel, const std::function<void( const KIGIT_COMMON::CANCEL_TOKEN& )>& aWork,
                const std::function<void()>& aDone );
 
private:
    std::shared_ptr<bool> m_alive = std::make_shared<bool>( true );

    KIGIT_COMMON::CANCEL_TOKEN m_cancel;

    std::shared_ptr<std::function<void()>> m_completion;
 
    bool m_busy = false;
};
 

class KIGIT_QUERY
{
public:
    KIGIT_QUERY() = default;
    ~KIGIT_QUERY();
 
    KIGIT_QUERY( const KIGIT_QUERY& ) = delete;
    KIGIT_QUERY& operator=( const KIGIT_QUERY& ) = delete;

    void Run( std::shared_ptr<KIGIT_COMMON> aSession, std::function<void( KIGIT_COMMON& )> aWork,
              std::function<void()> aDone );

    void Cancel();

    bool IsBusy() const { return m_transfer.IsBusy(); }
 
private:
    struct REQUEST
    {
        std::shared_ptr<KIGIT_COMMON>        session;
        std::function<void( KIGIT_COMMON& )> work;
        std::function<void()>                done;
        uint64_t                             generation;
    };
 
    void start( REQUEST aRequest );
 
    KIGIT_TRANSFER         m_transfer;
    std::optional<REQUEST> m_pending;
    uint64_t               m_generation = 0;
};
 
#endif // GIT_TRANSFER_H