KiCad PCB EDA Suite
Loading...
Searching...
No Matches
command_pcb_drc.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2022 Mark Roszko <[email protected]>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include "command_pcb_drc.h"
22#include <cli/exit_codes.h>
23#include "jobs/job_pcb_drc.h"
24#include <kiface_base.h>
25#include <layer_ids.h>
26#include <string_utils.h>
27#include <wx/crt.h>
28
29#include <macros.h>
30#include <wx/tokenzr.h>
31
32#define ARG_FORMAT "--format"
33#define ARG_ALL_TRACK_ERRORS "--all-track-errors"
34#define ARG_UNITS "--units"
35#define ARG_SEVERITY_ALL "--severity-all"
36#define ARG_SEVERITY_ERROR "--severity-error"
37#define ARG_SEVERITY_WARNING "--severity-warning"
38#define ARG_SEVERITY_EXCLUSIONS "--severity-exclusions"
39#define ARG_EXIT_CODE_VIOLATIONS "--exit-code-violations"
40#define ARG_PARITY "--schematic-parity"
41#define ARG_ZONE_FILL "--refill-zones"
42#define ARG_SAVE_BOARD "--save-board"
43
45{
46 addCommonArgs( true, true, false, false );
48
49 m_argParser.add_description( UTF8STDSTR( _( "Runs the Design Rules Check (DRC) on the PCB "
50 "and creates a report" ) ) );
51
52 m_argParser.add_argument( ARG_FORMAT )
53 .default_value( std::string( "report" ) )
54 .help( UTF8STDSTR( _( "Output file format, options: json, report" ) ) )
55 .metavar( "FORMAT" );
56
57 m_argParser.add_argument( ARG_ALL_TRACK_ERRORS )
58 .help( UTF8STDSTR( _( "Report all errors for each track" ) ) )
59 .flag();
60
61 m_argParser.add_argument( ARG_PARITY )
62 .help( UTF8STDSTR( _( "Test for parity between PCB and schematic" ) ) )
63 .flag();
64
65 m_argParser.add_argument( ARG_UNITS )
66 .default_value( std::string( "mm" ) )
67 .help( UTF8STDSTR( _( "Report units; valid options: in, mm, mils" ) ) )
68 .metavar( "UNITS" );
69
70 m_argParser.add_argument( ARG_SEVERITY_ALL )
71 .help( UTF8STDSTR( _( "Report all DRC violations, this is equivalent to including "
72 "all the other severity arguments" ) ) )
73 .flag();
74
75 m_argParser.add_argument( ARG_SEVERITY_ERROR )
76 .help( UTF8STDSTR( _( "Report all DRC error level violations, this can be combined "
77 "with the other severity arguments" ) ) )
78 .flag();
79
80 m_argParser.add_argument( ARG_SEVERITY_WARNING )
81 .help( UTF8STDSTR( _( "Report all DRC warning level violations, this can be combined "
82 "with the other severity arguments" ) ) )
83 .flag();
84
86 .help( UTF8STDSTR( _( "Report all excluded DRC violations, this can be combined with "
87 "the other severity arguments" ) ) )
88 .flag();
89
91 .help( UTF8STDSTR( _( "Return a nonzero exit code if DRC violations exist" ) ) )
92 .flag();
93
94 m_argParser.add_argument( ARG_ZONE_FILL )
95 .help( UTF8STDSTR( _( "Refill zones before running DRC" ) ) )
96 .flag();
97
98 m_argParser.add_argument( ARG_SAVE_BOARD )
99 .help( UTF8STDSTR( _( "Save the board after DRC, must be used with --refill-zones" ) ) )
100 .flag();
101}
102
103
105{
106 std::unique_ptr<JOB_PCB_DRC> drcJob( new JOB_PCB_DRC() );
107
108 drcJob->SetConfiguredOutputPath( m_argOutput );
109 drcJob->m_filename = m_argInput;
110 drcJob->SetVarOverrides( m_argDefineVars );
111 drcJob->m_reportAllTrackErrors = m_argParser.get<bool>( ARG_ALL_TRACK_ERRORS );
112 drcJob->m_exitCodeViolations = m_argParser.get<bool>( ARG_EXIT_CODE_VIOLATIONS );
113
114 int severity = 0;
115 if( m_argParser.get<bool>( ARG_SEVERITY_ALL ) )
116 {
118 }
119
120 if( m_argParser.get<bool>( ARG_SEVERITY_ERROR ) )
121 {
122 severity |= RPT_SEVERITY_ERROR;
123 }
124
125 if( m_argParser.get<bool>( ARG_SEVERITY_WARNING ) )
126 {
127 severity |= RPT_SEVERITY_WARNING;
128 }
129
130 if( m_argParser.get<bool>( ARG_SEVERITY_EXCLUSIONS ) )
131 {
132 severity |= RPT_SEVERITY_EXCLUSION;
133 }
134
135 if( severity ) // override the default only if something we configured
136 drcJob->m_severity = severity;
137
138 drcJob->m_reportAllTrackErrors = m_argParser.get<bool>( ARG_ALL_TRACK_ERRORS );
139
140 wxString units = From_UTF8( m_argParser.get<std::string>( ARG_UNITS ).c_str() );
141
142 if( units == wxS( "mm" ) )
143 {
144 drcJob->m_units = JOB_PCB_DRC::UNITS::MM;
145 }
146 else if( units == wxS( "in" ) )
147 {
148 drcJob->m_units = JOB_PCB_DRC::UNITS::INCH;
149 }
150 else if( units == wxS( "mils" ) )
151 {
152 drcJob->m_units = JOB_PCB_DRC::UNITS::MILS;
153 }
154 else if( !units.IsEmpty() )
155 {
156 wxFprintf( stderr, _( "Invalid units specified\n" ) );
158 }
159
160 wxString format = From_UTF8( m_argParser.get<std::string>( ARG_FORMAT ).c_str() );
161 if( format == "report" )
162 {
163 drcJob->m_format = JOB_PCB_DRC::OUTPUT_FORMAT::REPORT;
164 }
165 else if( format == "json" )
166 {
167 drcJob->m_format = JOB_PCB_DRC::OUTPUT_FORMAT::JSON;
168 }
169 else
170 {
171 wxFprintf( stderr, _( "Invalid report format\n" ) );
173 }
174
175 drcJob->m_parity = m_argParser.get<bool>( ARG_PARITY );
176 drcJob->m_refillZones = m_argParser.get<bool>( ARG_ZONE_FILL );
177 drcJob->m_saveBoard = m_argParser.get<bool>( ARG_SAVE_BOARD );
178
179 int exitCode = aKiway.ProcessJob( KIWAY::FACE_PCB, drcJob.get() );
180
181 return exitCode;
182}
void addCommonArgs(bool aInput, bool aOutput, bool aInputCanBeDir, bool aOutputIsDir)
Set up the most common of args used across cli.
Definition: command.cpp:115
argparse::ArgumentParser m_argParser
Definition: command.h:100
void addDefineArg()
Set up the drawing sheet arg used by many of the export commands.
Definition: command.cpp:168
int doPerform(KIWAY &aKiway) override
The internal handler that should be overloaded to implement command specific processing and work.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:286
int ProcessJob(KIWAY::FACE_T aFace, JOB *aJob, REPORTER *aReporter=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr)
Definition: kiway.cpp:678
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:294
#define UTF8STDSTR(s)
Definition: command.h:27
#define ARG_SEVERITY_EXCLUSIONS
#define ARG_SAVE_BOARD
#define ARG_ALL_TRACK_ERRORS
#define ARG_PARITY
#define ARG_ZONE_FILL
#define ARG_SEVERITY_ERROR
#define ARG_UNITS
#define ARG_SEVERITY_WARNING
#define ARG_EXIT_CODE_VIOLATIONS
#define ARG_SEVERITY_ALL
#define ARG_FORMAT
#define _(s)
This file contains miscellaneous commonly used macros and functions.
static const int ERR_ARGS
Definition: exit_codes.h:31
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_EXCLUSION
wxString From_UTF8(const char *cstring)