Bernhard KirchenandWayne Stambaugh
a5f5298cad
an ERC or DRC report without violations or without violations of a
particular kind does not tell the user whether there actually are no
violations of that severity, or if the severity was filtered.
we now list the severities by name that are included in the report.
(cherry picked from commit cd03794b23)
132 lines
3.8 KiB
C++
132 lines
3.8 KiB
C++
/*
|
|
* 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 RC_JSON_SCHEMA_H
|
|
#define RC_JSON_SCHEMA_H
|
|
|
|
#include <json_common.h>
|
|
#include <wx/string.h>
|
|
#include <vector>
|
|
#include <json_conversions.h>
|
|
|
|
/**
|
|
* Contains the json serialization structs for DRC and ERC reports
|
|
* If you are trying to change the output schema
|
|
* Please update the schemas located in /resources/schemas/ as both documentation
|
|
* and use by end user implementations
|
|
*/
|
|
namespace RC_JSON
|
|
{
|
|
struct COORDINATE
|
|
{
|
|
double x;
|
|
double y;
|
|
};
|
|
NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE( COORDINATE, x, y )
|
|
|
|
struct AFFECTED_ITEM
|
|
{
|
|
wxString uuid;
|
|
wxString description;
|
|
COORDINATE pos;
|
|
};
|
|
|
|
NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE( AFFECTED_ITEM, uuid, description, pos )
|
|
|
|
struct VIOLATION
|
|
{
|
|
wxString type;
|
|
wxString description;
|
|
wxString severity;
|
|
std::vector<AFFECTED_ITEM> items;
|
|
bool excluded;
|
|
wxString comment;
|
|
};
|
|
|
|
inline void to_json( nlohmann::json& aJson, const VIOLATION& aViolation )
|
|
{
|
|
aJson["type"] = aViolation.type;
|
|
aJson["description"] = aViolation.description;
|
|
aJson["severity"] = aViolation.severity;
|
|
aJson["items"] = aViolation.items;
|
|
|
|
if( aViolation.excluded )
|
|
{
|
|
aJson["excluded"] = aViolation.excluded;
|
|
aJson["comment"] = aViolation.comment;
|
|
}
|
|
}
|
|
inline void from_json( const nlohmann::json& aJson, VIOLATION& aViolation )
|
|
{
|
|
aJson.at( "type" ).get_to( aViolation.type );
|
|
aJson.at( "description" ).get_to( aViolation.description );
|
|
aJson.at( "severity" ).get_to( aViolation.severity );
|
|
aJson.at( "items" ).get_to( aViolation.items );
|
|
aJson.at( "excluded" ).get_to( aViolation.excluded );
|
|
aJson.at( "comment" ).get_to( aViolation.comment );
|
|
}
|
|
|
|
struct REPORT_BASE
|
|
{
|
|
wxString $schema;
|
|
wxString source;
|
|
wxString date;
|
|
wxString kicad_version;
|
|
wxString type;
|
|
wxString coordinate_units;
|
|
};
|
|
|
|
struct DRC_REPORT : REPORT_BASE
|
|
{
|
|
DRC_REPORT() { type = wxS( "drc" ); }
|
|
|
|
std::vector<VIOLATION> violations;
|
|
std::vector<VIOLATION> unconnected_items;
|
|
std::vector<VIOLATION> schematic_parity;
|
|
std::vector<wxString> included_severities;
|
|
};
|
|
|
|
NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE( DRC_REPORT, $schema, source, date, kicad_version, violations,
|
|
unconnected_items, schematic_parity, coordinate_units,
|
|
included_severities )
|
|
|
|
struct ERC_SHEET
|
|
{
|
|
wxString uuid_path;
|
|
wxString path;
|
|
std::vector<VIOLATION> violations;
|
|
};
|
|
|
|
NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE( ERC_SHEET, uuid_path, path, violations )
|
|
|
|
struct ERC_REPORT : REPORT_BASE
|
|
{
|
|
ERC_REPORT() { type = wxS( "erc" ); }
|
|
|
|
std::vector<ERC_SHEET> sheets;
|
|
std::vector<wxString> included_severities;
|
|
};
|
|
|
|
NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE( ERC_REPORT, $schema, source, date, kicad_version, sheets,
|
|
coordinate_units, included_severities )
|
|
|
|
} // namespace RC_JSON
|
|
|
|
#endif
|