jobs_output.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 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 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 <kicommon.h>
#include <vector>
#include <optional>
#include <jobs/job.h>
 
class PROJECT;
 
class KICOMMON_API JOBS_OUTPUT_HANDLER
{
public:
    JOBS_OUTPUT_HANDLER()
    {
    }
 
    virtual ~JOBS_OUTPUT_HANDLER() {}

    virtual bool OutputPrecheck() { return true; }
    virtual bool HandleOutputs( const wxString&                aBaseTempPath,
                                PROJECT*                       aProject,
                                const std::vector<wxString>&   aPathsWithOverwriteDisallowed,
                                const std::vector<JOB_OUTPUT>& aOutputsToHandle,
                                std::optional<wxString>&       aResolvedOutputPath ) = 0;
 
    virtual void FromJson( const nlohmann::json& j ) = 0;
    virtual void ToJson( nlohmann::json& j ) const = 0;
 
 
    void SetOutputPath( const wxString& aPath ) { m_outputPath = aPath; }
    wxString GetOutputPath() const { return m_outputPath; }
 
    virtual wxString GetDefaultDescription() const { return wxEmptyString; }
 
protected:
    wxString m_outputPath;
};