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 (C) 1992-2023 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
42{
43 addCommonArgs( true, true, false, false );
45
46 m_argParser.add_description( UTF8STDSTR( _( "Runs the Design Rules Check (DRC) on the PCB and creates a report" ) ) );
47
48 m_argParser.add_argument( ARG_FORMAT )
49 .default_value( std::string( "report" ) )
50 .help( UTF8STDSTR( _( "Output file format, options: json, report" ) ) )
51 .metavar( "FORMAT" );
52
53 m_argParser.add_argument( ARG_ALL_TRACK_ERRORS )
54 .help( UTF8STDSTR( _( "Report all errors for each track" ) ) )
55 .implicit_value( true )
56 .default_value( false );
57
58 m_argParser.add_argument( ARG_UNITS )
59 .default_value( std::string( "mm" ) )
60 .help( UTF8STDSTR( _( "Report units; valid options: in, mm, mils" ) ) )
61 .metavar( "UNITS" );
62
63 m_argParser.add_argument( ARG_SEVERITY_ALL )
64 .help( UTF8STDSTR( _( "Report all DRC violations, this is equivalent to including all the other severity arguments" ) ) )
65 .implicit_value( true )
66 .default_value( false );
67
68 m_argParser.add_argument( ARG_SEVERITY_ERROR )
69 .help( UTF8STDSTR( _( "Report all DRC error level violations, this can be combined with the other severity arguments" ) ) )
70 .implicit_value( true )
71 .default_value( false );
72
73 m_argParser.add_argument( ARG_SEVERITY_WARNING )
74 .help( UTF8STDSTR( _( "Report all DRC warning level violations, this can be combined with the other severity arguments" ) ) )
75 .implicit_value( true )
76 .default_value( false );
77
79 .help( UTF8STDSTR( _( "Report all excluded DRC violations, this can be combined with the other severity arguments" ) ) )
80 .implicit_value( true )
81 .default_value( false );
82
84 .help( UTF8STDSTR( _( "Return a exit code depending on whether or not violations exist" ) ) )
85 .implicit_value( true )
86 .default_value( false );
87}
88
89
91{
92 std::unique_ptr<JOB_PCB_DRC> drcJob( new JOB_PCB_DRC( true ) );
93
94 drcJob->m_outputFile = m_argOutput;
95 drcJob->m_filename = m_argInput;
96 drcJob->SetVarOverrides( m_argDefineVars );
97 drcJob->m_reportAllTrackErrors = m_argParser.get<bool>( ARG_ALL_TRACK_ERRORS );
98 drcJob->m_exitCodeViolations = m_argParser.get<bool>( ARG_EXIT_CODE_VIOLATIONS );
99
100 if( m_argParser.get<bool>( ARG_SEVERITY_ALL ) )
101 {
103 }
104
105 if( m_argParser.get<bool>( ARG_SEVERITY_ERROR ) )
106 {
107 drcJob->m_severity |= RPT_SEVERITY_ERROR;
108 }
109
110 if( m_argParser.get<bool>( ARG_SEVERITY_WARNING ) )
111 {
112 drcJob->m_severity |= RPT_SEVERITY_WARNING;
113 }
114
115 if( m_argParser.get<bool>( ARG_SEVERITY_EXCLUSIONS ) )
116 {
117 drcJob->m_severity |= RPT_SEVERITY_EXCLUSION;
118 }
119
120 drcJob->m_reportAllTrackErrors = m_argParser.get<bool>( ARG_ALL_TRACK_ERRORS );
121
122 wxString units = From_UTF8( m_argParser.get<std::string>( ARG_UNITS ).c_str() );
123
124 if( units == wxS( "mm" ) )
125 {
126 drcJob->m_units = JOB_PCB_DRC::UNITS::MILLIMETERS;
127 }
128 else if( units == wxS( "in" ) )
129 {
130 drcJob->m_units = JOB_PCB_DRC::UNITS::INCHES;
131 }
132 else if( units == wxS( "mils" ) )
133 {
134 drcJob->m_units = JOB_PCB_DRC::UNITS::MILS;
135 }
136 else if( !units.IsEmpty() )
137 {
138 wxFprintf( stderr, _( "Invalid units specified\n" ) );
140 }
141
142 wxString format = From_UTF8( m_argParser.get<std::string>( ARG_FORMAT ).c_str() );
143 if( format == "report" )
144 {
145 drcJob->m_format = JOB_PCB_DRC::OUTPUT_FORMAT::REPORT;
146 }
147 else if( format == "json" )
148 {
149 drcJob->m_format = JOB_PCB_DRC::OUTPUT_FORMAT::JSON;
150 }
151 else
152 {
153 wxFprintf( stderr, _( "Invalid report format\n" ) );
155 }
156
157 int exitCode = aKiway.ProcessJob( KIWAY::FACE_PCB, drcJob.get() );
158
159 return exitCode;
160}
argparse::ArgumentParser m_argParser
Definition: command.h:98
void addDefineArg()
Sets up the drawing sheet arg used by many of the export commands.
Definition: command.cpp:168
void addCommonArgs(bool aInput, bool aOutput, bool aInputIsDir, bool aOutputIsDir)
Sets up the most common of args used across cli.
Definition: command.cpp:115
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:279
int ProcessJob(KIWAY::FACE_T aFace, JOB *job)
Definition: kiway.cpp:729
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:287
#define UTF8STDSTR(s)
Definition: command.h:27
#define ARG_SEVERITY_EXCLUSIONS
#define ARG_ALL_TRACK_ERRORS
#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)