job_import_utils.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 JOB_IMPORT_UTILS_H
#define JOB_IMPORT_UTILS_H
 
#include <kicommon.h>
#include <json_common.h>
#include <reporter.h>
#include <wx/string.h>
#include <map>
#include <utility>
#include <vector>

enum class IMPORT_REPORT_FORMAT
{
    NONE,
    JSON,
    TEXT
};
 
 
NLOHMANN_JSON_SERIALIZE_ENUM( IMPORT_REPORT_FORMAT,
                              {
                                  { IMPORT_REPORT_FORMAT::NONE, "none" },
                                  { IMPORT_REPORT_FORMAT::JSON, "json" },
                                  { IMPORT_REPORT_FORMAT::TEXT, "text" }
                              } )
 

struct KICOMMON_API IMPORT_REPORT_DATA
{
    wxString m_sourceFile;
    wxString m_sourceFormat;
    wxString m_outputFile;

    std::vector<std::pair<wxString, size_t>> m_statistics;

    nlohmann::json m_extraJson = nlohmann::json::object();
 
    std::vector<wxString> m_warnings;
    std::vector<wxString> m_errors;
};
 

class KICOMMON_API IMPORT_MESSAGE_COLLECTOR : public REPORTER
{
public:
    explicit IMPORT_MESSAGE_COLLECTOR( REPORTER& aJobReporter ) :
            m_jobReporter( aJobReporter )
    { }
 
    ~IMPORT_MESSAGE_COLLECTOR() override;
 
    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    bool HasMessage() const override { return !m_warnings.empty() || !m_errors.empty(); }
 
    void Clear() override;

    void Flush( IMPORT_REPORT_FORMAT aFormat, IMPORT_REPORT_DATA& aData );
 
private:
    void forward();
 
    REPORTER&             m_jobReporter;
    std::vector<wxString> m_warnings;
    std::vector<wxString> m_errors;
};
 

KICOMMON_API bool ParseImportReportFormat( const wxString& aText, IMPORT_REPORT_FORMAT& aFormat );
 

KICOMMON_API wxString DefaultImportOutputPath( const wxString& aInputFile,
                                               const wxString& aKiCadExt );
 

KICOMMON_API bool LoadLayerMapFile( const wxString& aFile, std::map<wxString, wxString>& aMap,
                                    wxString& aError );
 

KICOMMON_API bool WriteImportReport( REPORTER* aReporter, IMPORT_REPORT_FORMAT aFormat,
                                     const wxString& aReportFile, const IMPORT_REPORT_DATA& aData );
 
#endif