KiCad PCB EDA Suite
Loading...
Searching...
No Matches
command_pcb_export_pdf.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
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#include <wx/tokenzr.h>
31
32#include <locale_io.h>
33
34#define ARG_DRILL_SHAPE_OPTION "--drill-shape-opt"
35
36
38{
39 m_argParser.add_description( UTF8STDSTR( _( "Generate PDF from a list of layers" ) ) );
40
41 addLayerArg( true );
44
45 m_argParser.add_argument( "-m", ARG_MIRROR )
46 .help( UTF8STDSTR( _( "Mirror the board (useful for trying to show bottom layers)" ) ) )
47 .implicit_value( true )
48 .default_value( false );
49
50 m_argParser.add_argument( "--erd", ARG_EXCLUDE_REFDES )
51 .help( UTF8STDSTR( _( "Exclude the reference designator text" ) ) )
52 .implicit_value( true )
53 .default_value( false );
54
55 m_argParser.add_argument( "--ev", ARG_EXCLUDE_VALUE )
56 .help( UTF8STDSTR( _( "Exclude the value text" ) ) )
57 .implicit_value( true )
58 .default_value( false );
59
60 m_argParser.add_argument( "--ibt", ARG_INCLUDE_BORDER_TITLE )
61 .help( UTF8STDSTR( _( "Include the border and title block" ) ) )
62 .implicit_value( true )
63 .default_value( false );
64
66 .help( UTF8STDSTR( _( ARG_NEGATIVE_DESC ) ) )
67 .implicit_value( true )
68 .default_value( false );
69
70 m_argParser.add_argument( ARG_BLACKANDWHITE )
72 .implicit_value( true )
73 .default_value( false );
74
75 m_argParser.add_argument( "-t", ARG_THEME )
76 .default_value( std::string() )
77 .help( UTF8STDSTR( _( "Color theme to use (will default to PCB Editor settings)" ) ) )
78 .metavar( "THEME_NAME" );
79
81 .help( UTF8STDSTR( _( "Set pad/via drill shape option (0 = no shape, 1 = "
82 "small shape, 2 = actual shape)" ) ) )
83 .scan<'i', int>()
84 .default_value( 2 );
85}
86
87
89{
90 int baseExit = PCB_EXPORT_BASE_COMMAND::doPerform( aKiway );
91
92 if( baseExit != EXIT_CODES::OK )
93 return baseExit;
94
95 std::unique_ptr<JOB_EXPORT_PCB_PDF> pdfJob( new JOB_EXPORT_PCB_PDF( true ) );
96
97 pdfJob->m_filename = m_argInput;
98 pdfJob->m_outputFile = m_argOutput;
99 pdfJob->m_drawingSheet = m_argDrawingSheet;
100 pdfJob->SetVarOverrides( m_argDefineVars );
101
102 if( !wxFile::Exists( pdfJob->m_filename ) )
103 {
104 wxFprintf( stderr, _( "Board file does not exist or is not accessible\n" ) );
106 }
107
108 pdfJob->m_plotFootprintValues = !m_argParser.get<bool>( ARG_EXCLUDE_VALUE );
109 pdfJob->m_plotRefDes = !m_argParser.get<bool>( ARG_EXCLUDE_REFDES );
110
111 pdfJob->m_plotBorderTitleBlocks = m_argParser.get<bool>( ARG_INCLUDE_BORDER_TITLE );
112
113 pdfJob->m_mirror = m_argParser.get<bool>( ARG_MIRROR );
114 pdfJob->m_blackAndWhite = m_argParser.get<bool>( ARG_BLACKANDWHITE );
115 pdfJob->m_colorTheme = From_UTF8( m_argParser.get<std::string>( ARG_THEME ).c_str() );
116 pdfJob->m_negative = m_argParser.get<bool>( ARG_NEGATIVE );
117
118 pdfJob->m_drillShapeOption = m_argParser.get<int>( ARG_DRILL_SHAPE_OPTION );
119
120 pdfJob->m_printMaskLayer = m_selectedLayers;
121
122 LOCALE_IO dummy; // Switch to "C" locale
123 int exitCode = aKiway.ProcessJob( KIWAY::FACE_PCB, pdfJob.get() );
124
125 return exitCode;
126}
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 addDrawingSheetArg()
Sets up the drawing sheet arg used by many of the export commands.
Definition: command.cpp:157
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_THEME
#define ARG_NEGATIVE
#define ARG_INCLUDE_BORDER_TITLE
#define ARG_EXCLUDE_REFDES
#define ARG_BLACKANDWHITE_DESC
#define ARG_NEGATIVE_SHORT
#define ARG_EXCLUDE_VALUE
#define ARG_BLACKANDWHITE
#define ARG_MIRROR
#define ARG_NEGATIVE_DESC
#define ARG_DRILL_SHAPE_OPTION
#define _(s)
This file contains miscellaneous commonly used macros and functions.
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.