kicad-source/kicad/jobs_runner.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 Mark Roszko <mark.roszko@gmail.com>
 * 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/>.
 */

#pragma once

#include <widgets/wx_progress_reporters.h>

class JOBSET;
struct JOBSET_DESTINATION;
struct JOBSET_JOB;
class KIWAY;
class REPORTER;
class PROGRESS_REPORTER;
class PROJECT;

class JOBS_PROGRESS_REPORTER : public WX_PROGRESS_REPORTER
{
public:
    JOBS_PROGRESS_REPORTER(wxWindow* aParent, const wxString& aTitle ) :
            WX_PROGRESS_REPORTER( aParent, aTitle, 1000, PR_NO_ABORT )
    {}

    void AdvancePhase() override
    {
    }

    void AdvanceJob( const wxString& aMessage )
    {
        m_jobStatus = aMessage;
        WX_PROGRESS_REPORTER::Report( aMessage );
    }

    void Report( const wxString& aMessage ) override
    {
        WX_PROGRESS_REPORTER::Report( m_jobStatus + wxS( "\n" ) + aMessage );
    }

private:
    wxString m_jobStatus;
};


class JOBS_RUNNER
{
public:
    JOBS_RUNNER( KIWAY* aKiway, JOBSET* aJobsFile, PROJECT* aProject,
                 REPORTER& aReporter, JOBS_PROGRESS_REPORTER* aProgressReporter );

    bool RunJobsAllDestinations( bool aBail = false );
    bool RunJobsForDestination( JOBSET_DESTINATION* aDestination, bool aBail = false );

private:
    int runSpecialExecute( const JOBSET_JOB* aJob, REPORTER* aReporter, PROJECT* aProject );
    int runSpecialCopyFiles( const JOBSET_JOB* aJob, PROJECT* aProject );

private:
    KIWAY*                  m_kiway;
    JOBSET*                 m_jobsFile;
    REPORTER&               m_reporter;
    JOBS_PROGRESS_REPORTER* m_progressReporter;
    PROJECT*                m_project;
};