KiCad PCB EDA Suite
Loading...
Searching...
No Matches
command_pcb_export_pos.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-2022 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
22#include <cli/exit_codes.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
31#include <locale_io.h>
32
33#define ARG_SIDE "--side"
34#define ARG_FORMAT "--format"
35#define ARG_UNITS "--units"
36#define ARG_NEGATE_BOTTOM_X "--bottom-negate-x"
37#define ARG_USE_DRILL_FILE_ORIGIN "--use-drill-file-origin"
38#define ARG_SMD_ONLY "--smd-only"
39#define ARG_EXCLUDE_FOOTPRINTS_TH "--exclude-fp-th"
40#define ARG_EXCLUDE_DNP "--exclude-dnp"
41#define ARG_GERBER_BOARD_EDGE "--gerber-board-edge"
42
43
45{
46 m_argParser.add_description( UTF8STDSTR( _( "Generate Position File" ) ) );
47
48 m_argParser.add_argument( ARG_SIDE )
49 .default_value( std::string( "both" ) )
50 .help( UTF8STDSTR( _(
51 "Valid options: front,back,both. Gerber format only supports \"both\"." ) ) );
52
53 m_argParser.add_argument( ARG_FORMAT )
54 .default_value( std::string( "ascii" ) )
55 .help( UTF8STDSTR( _( "Valid options: ascii,csv,gerber" ) ) )
56 .metavar( "FORMAT" );
57
58 m_argParser.add_argument( ARG_UNITS )
59 .default_value( std::string( "in" ) )
60 .help( UTF8STDSTR(
61 _( "Output units; ascii or csv format only; valid options: in,mm" ) ) )
62 .metavar( "UNITS" );
63
64 m_argParser.add_argument( ARG_NEGATE_BOTTOM_X )
65 .help( UTF8STDSTR( _( "Use negative X coordinates for footprints on bottom layer "
66 "(ascii or csv formats only)" ) ) )
67 .implicit_value( true )
68 .default_value( false );
69
71 .help( UTF8STDSTR( _( "Use drill/place file origin (ascii or csv only)" ) ) )
72 .implicit_value( true )
73 .default_value( false );
74
75 m_argParser.add_argument( ARG_SMD_ONLY )
76 .help( UTF8STDSTR( _( "Include only SMD footprints (ascii or csv only)" ) ) )
77 .implicit_value( true )
78 .default_value( false );
79
81 .help( UTF8STDSTR(
82 _( "Exclude all footprints with through-hole pads (ascii or csv only)" ) ) )
83 .implicit_value( true )
84 .default_value( false );
85
86 m_argParser.add_argument( ARG_EXCLUDE_DNP )
87 .help( UTF8STDSTR(
88 _( "Exclude all footprints with the Do Not Populate flag set" ) ) )
89 .implicit_value( true )
90 .default_value( false );
91
93 .help( UTF8STDSTR( _( "Include board edge layer (Gerber only)" ) ) )
94 .implicit_value( true )
95 .default_value( false );
96}
97
98
100{
101 int baseExit = PCB_EXPORT_BASE_COMMAND::doPerform( aKiway );
102 if( baseExit != EXIT_CODES::OK )
103 return baseExit;
104
105 std::unique_ptr<JOB_EXPORT_PCB_POS> aPosJob( new JOB_EXPORT_PCB_POS( true ) );
106
107 aPosJob->m_filename = m_argInput;
108 aPosJob->m_outputFile = m_argOutput;
109
110 if( !wxFile::Exists( aPosJob->m_filename ) )
111 {
112 wxFprintf( stderr, _( "Board file does not exist or is not accessible\n" ) );
114 }
115
116 aPosJob->m_negateBottomX = m_argParser.get<bool>( ARG_NEGATE_BOTTOM_X );
117 aPosJob->m_smdOnly = m_argParser.get<bool>( ARG_SMD_ONLY );
118 aPosJob->m_excludeFootprintsWithTh = m_argParser.get<bool>( ARG_EXCLUDE_FOOTPRINTS_TH );
119 aPosJob->m_useDrillPlaceFileOrigin = m_argParser.get<bool>( ARG_USE_DRILL_FILE_ORIGIN );
120 aPosJob->m_excludeDNP = m_argParser.get<bool>( ARG_EXCLUDE_DNP );
121 aPosJob->m_gerberBoardEdge = m_argParser.get<bool>( ARG_GERBER_BOARD_EDGE );
122
123 wxString format = From_UTF8( m_argParser.get<std::string>( ARG_FORMAT ).c_str() );
124 if( format == wxS( "ascii" ) )
125 {
126 aPosJob->m_format = JOB_EXPORT_PCB_POS::FORMAT::ASCII;
127 }
128 else if( format == wxS( "csv" ) )
129 {
130 aPosJob->m_format = JOB_EXPORT_PCB_POS::FORMAT::CSV;
131 }
132 else if( format == wxS( "gerber" ) )
133 {
134 aPosJob->m_format = JOB_EXPORT_PCB_POS::FORMAT::GERBER;
135 }
136 else
137 {
138 wxFprintf( stderr, _( "Invalid format\n" ) );
140 }
141
142 wxString units = From_UTF8( m_argParser.get<std::string>( ARG_UNITS ).c_str() );
143
144 if( units == wxS( "mm" ) )
145 {
147 }
148 else if( units == wxS( "in" ) )
149 {
150 aPosJob->m_units = JOB_EXPORT_PCB_POS::UNITS::INCHES;
151 }
152 else
153 {
154 wxFprintf( stderr, _( "Invalid units specified\n" ) );
156 }
157
158 wxString side = From_UTF8( m_argParser.get<std::string>( ARG_SIDE ).c_str() );
159
160 if( side == wxS( "both" ) )
161 {
162 if( aPosJob->m_format == JOB_EXPORT_PCB_POS::FORMAT::GERBER )
163 {
164 wxFprintf( stderr, _( "\"both\" not supported for Gerber format\n" ) );
166 }
167
168 aPosJob->m_side = JOB_EXPORT_PCB_POS::SIDE::BOTH;
169 }
170 else if( side == wxS( "front" ) )
171 {
172 aPosJob->m_side = JOB_EXPORT_PCB_POS::SIDE::FRONT;
173 }
174 else if( side == wxS( "back" ) )
175 {
176 aPosJob->m_side = JOB_EXPORT_PCB_POS::SIDE::BACK;
177 }
178 else
179 {
180 wxFprintf( stderr, _( "Invalid side specified\n" ) );
182 }
183
184
186 int exitCode = aKiway.ProcessJob( KIWAY::FACE_PCB, aPosJob.get() );
187
188 return exitCode;
189}
argparse::ArgumentParser m_argParser
Definition: command.h:98
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
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:49
#define UTF8STDSTR(s)
Definition: command.h:27
#define ARG_UNITS
#define ARG_FORMAT
#define ARG_USE_DRILL_FILE_ORIGIN
#define ARG_EXCLUDE_FOOTPRINTS_TH
#define ARG_GERBER_BOARD_EDGE
#define ARG_NEGATE_BOTTOM_X
#define ARG_SIDE
#define ARG_SMD_ONLY
#define ARG_EXCLUDE_DNP
#define _(s)
This file contains miscellaneous commonly used macros and functions.
static const int ERR_ARGS
Definition: exit_codes.h:31
static const int OK
Definition: exit_codes.h:30
static const int ERR_INVALID_INPUT_FILE
Definition: exit_codes.h:33
std::vector< FAB_LAYER_COLOR > dummy
wxString From_UTF8(const char *cstring)
int doPerform(KIWAY &aKiway) override
The internal handler that should be overloaded to implement command specific processing and work.