eeschema_jobs_handler.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef EESCHEMA_JOBS_HANDLER_H
#define EESCHEMA_JOBS_HANDLER_H
 
#include <jobs/job_dispatcher.h>
#include <diff_merge/diff_doc_kind.h>
#include <wx/string.h>
 
class SCH_RENDER_SETTINGS;
class KIWAY;
class SCHEMATIC;
class JOB_SYM_EXPORT_SVG;
class LIB_SYMBOL;
class DS_PROXY_VIEW_ITEM;
class REPORTER;
class wxWindow;
 
class WIDGET_DIFF_CANVAS;
 
namespace KICAD_DIFF
{
class DIFF_CANVAS_CONTEXT;
struct DOCUMENT_DIFF;
} // namespace KICAD_DIFF

class EESCHEMA_JOBS_HANDLER : public JOB_DISPATCHER
{
public:
    EESCHEMA_JOBS_HANDLER( KIWAY* aKiway );
    int JobExportBom( JOB* aJob );
    int JobExportPythonBom( JOB* aJob );
    int JobExportNetlist( JOB* aJob );
    int JobExportPlot( JOB* aJob );
    int JobSchErc( JOB* aJob );
    int JobSymUpgrade( JOB* aJob );
    int JobSymExportSvg( JOB* aJob );
    int JobUpgrade( JOB* aJob );
    int JobDowngrade( JOB* aJob );
    int JobImport( JOB* aJob );
    int JobSchDiff( JOB* aJob );
    int JobSymDiff( JOB* aJob );

    int RunMerge( KICAD_DIFF::DOC_KIND aKind, const wxString& aAncestor, const wxString& aOurs,
                  const wxString& aTheirs, const wxString& aOutput, bool aInteractive,
                  bool aSingleFile, REPORTER* aReporter );
    int OpenDiffDialog( KICAD_DIFF::DOC_KIND aKind, const wxString& aFileA, const wxString& aFileB,
                        const wxString& aLabelA, const wxString& aLabelB, wxWindow* aParent,
                        REPORTER* aReporter );

    KICAD_DIFF::DIFF_CANVAS_CONTEXT* AttachDiffCanvases( KICAD_DIFF::DOC_KIND aKind, const wxString& aFileA,
                                                         const wxString& aFileB, WIDGET_DIFF_CANVAS* aBefore,
                                                         WIDGET_DIFF_CANVAS* aAfter, KICAD_DIFF::DOCUMENT_DIFF& aDiff,
                                                         REPORTER* aReporter );
 
private:
    int runSchMerge( const wxString& aAncestor, const wxString& aOurs, const wxString& aTheirs,
                     const wxString& aOutput, bool aInteractive );
    int runSymLibMerge( const wxString& aAncestor, const wxString& aOurs, const wxString& aTheirs,
                        const wxString& aOutput );
 
public:

    void ClearCachedSchematic();

    void InitRenderSettings( SCH_RENDER_SETTINGS* aRenderSettings, const wxString& aTheme,
                             SCHEMATIC* aSch,
                             const wxString& aDrawingSheetOverride = wxEmptyString );
 
private:
    SCHEMATIC* getSchematic( const wxString& aPath, bool aRequireRoot = true );
 
    int doSymExportSvg( JOB_SYM_EXPORT_SVG* aSvgJob, SCH_RENDER_SETTINGS* aRenderSettings,
                        LIB_SYMBOL* symbol );
 
    DS_PROXY_VIEW_ITEM* getDrawingSheetProxyView( SCHEMATIC* aSch );
 
    SCHEMATIC* m_cliSchematic;
    bool       m_cliSchematicRootValidated = false;
};
 
#endif