background_jobs_monitor.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Mark Roszko <[email protected]>
 * 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 2
 * 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 BACKGROUND_JOBS_MONITOR_H
#define BACKGROUND_JOBS_MONITOR_H
 
#include <kicommon.h>
#include <widgets/progress_reporter_base.h>
#include <atomic>
#include <functional>
#include <memory>
#include <mutex>
#include <shared_mutex>
#include <vector>
 
class PROGRESS_REPORTER;
class wxString;
class KISTATUSBAR;
struct BACKGROUND_JOB;
class BACKGROUND_JOB_REPORTER;
class BACKGROUND_JOB_LIST;
class BACKGROUND_JOBS_MONITOR;
class wxWindow;
class wxCloseEvent;
class wxWindowDestroyEvent;
 
class KICOMMON_API BACKGROUND_JOB_REPORTER : public PROGRESS_REPORTER_BASE
{
public:
    BACKGROUND_JOB_REPORTER( BACKGROUND_JOBS_MONITOR*               aMonitor,
                             const std::shared_ptr<BACKGROUND_JOB>& aJob );
 
    void SetTitle( const wxString& aTitle ) override
    {
    }
 
    void Report( const wxString& aMessage ) override;
 
    void Cancel() { m_cancelled.store( true ); }
 
    void AdvancePhase() override;
 
    void SetNumPhases( int aNumPhases ) override;
 
    void SetCurrentProgress( double aProgress ) override;
 
private:
    bool updateUI() override;
 
    BACKGROUND_JOBS_MONITOR* m_monitor;
    std::shared_ptr<BACKGROUND_JOB> m_job;
    wxString m_title;
    wxString m_report;
};
 
 
struct KICOMMON_API BACKGROUND_JOB
{
public:
    wxString GetStatus() const
    {
        std::lock_guard<std::mutex> lock( m_statusMutex );
        return m_status;
    }
 
    void SetStatus( const wxString& aStatus )
    {
        std::lock_guard<std::mutex> lock( m_statusMutex );
        m_status = aStatus;
    }
 
    wxString m_name;
    std::shared_ptr<BACKGROUND_JOB_REPORTER> m_reporter;
 
    std::atomic<int> m_maxProgress;
    std::atomic<int> m_currentProgress;
 
private:
    mutable std::mutex m_statusMutex;
    wxString           m_status;
};
 
 
class KICOMMON_API BACKGROUND_JOBS_MONITOR
{
    friend class BACKGROUND_JOB_REPORTER;
    friend class BACKGROUND_JOB_LIST;
 
public:
    BACKGROUND_JOBS_MONITOR();

    std::shared_ptr<BACKGROUND_JOB> Create( const wxString& aName );

    void Remove( std::shared_ptr<BACKGROUND_JOB> job );

    void ShowList( wxWindow* aParent, wxPoint aPos );

    void RegisterStatusBar( KISTATUSBAR* aStatusBar );

    void UnregisterStatusBar( KISTATUSBAR* aStatusBar );
 
private:
    void onListWindowClosed( wxCloseEvent& aEvent );

    void onListWindowDestroyed( wxWindowDestroyEvent& aEvent );

    void removeShownDialog( wxObject* aWindow );

    void jobUpdated( std::shared_ptr<BACKGROUND_JOB> aJob );

    std::vector<std::shared_ptr<BACKGROUND_JOB>> m_jobs;
    std::vector<BACKGROUND_JOB_LIST*> m_shownDialogs;
 
    std::vector<KISTATUSBAR*> m_statusBars;

    mutable std::shared_mutex m_mutex;
};
 
#endif