KiCad PCB EDA Suite
Loading...
Searching...
No Matches
command_sym_export_svg.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
33#define ARG_NO_BACKGROUND_COLOR "--no-background-color"
34#define ARG_SYMBOL "--symbol"
35#define ARG_INC_HIDDEN_PINS "--include-hidden-pins"
36#define ARG_INC_HIDDEN_FIELDS "--include-hidden-fields"
37
38
40{
41 addCommonArgs( true, true, false, true );
42
43 m_argParser.add_description( UTF8STDSTR( _( "Exports the symbol or entire symbol library "
44 "to SVG" ) ) );
45
46 m_argParser.add_argument( "-t", ARG_THEME )
47 .default_value( std::string() )
48 .help( UTF8STDSTR( _( "Color theme to use (will default to symbol editor "
49 "settings)" ) ) )
50 .metavar( "THEME_NAME" );
51
52 m_argParser.add_argument( "-s", ARG_SYMBOL )
53 .default_value( std::string() )
54 .help( UTF8STDSTR( _( "Specific symbol to export within the library" ) ) )
55 .metavar( "SYMBOL" );
56
57 m_argParser.add_argument( ARG_BLACKANDWHITE )
59 .flag();
60
61 m_argParser.add_argument( ARG_INC_HIDDEN_PINS )
62 .help( UTF8STDSTR( _( "Include hidden pins" ) ) )
63 .flag();
64
66 .help( UTF8STDSTR( _( "Include hidden fields" ) ) )
67 .flag();
68}
69
70
72{
73 std::unique_ptr<JOB_SYM_EXPORT_SVG> svgJob = std::make_unique<JOB_SYM_EXPORT_SVG>( true );
74
75 svgJob->m_libraryPath = m_argInput;
76 svgJob->m_outputDirectory = m_argOutput;
77 svgJob->m_blackAndWhite = m_argParser.get<bool>( ARG_BLACKANDWHITE );
78 svgJob->m_symbol = From_UTF8( m_argParser.get<std::string>( ARG_SYMBOL ).c_str() );
79 svgJob->m_includeHiddenFields = m_argParser.get<bool>( ARG_INC_HIDDEN_FIELDS );
80 svgJob->m_includeHiddenPins = m_argParser.get<bool>( ARG_INC_HIDDEN_PINS );
81
82 if( !wxFile::Exists( svgJob->m_libraryPath ) )
83 {
84 wxFprintf( stderr, _( "Symbol file does not exist or is not accessible\n" ) );
86 }
87
88 svgJob->m_colorTheme = From_UTF8( m_argParser.get<std::string>( ARG_THEME ).c_str() );
89
90 int exitCode = aKiway.ProcessJob( KIWAY::FACE_SCH, svgJob.get() );
91
92 return exitCode;
93}
argparse::ArgumentParser m_argParser
Definition: command.h:100
void addCommonArgs(bool aInput, bool aOutput, bool aInputIsDir, bool aOutputIsDir)
Set 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_SCH
eeschema DSO
Definition: kiway.h:286
#define UTF8STDSTR(s)
Definition: command.h:27
#define ARG_THEME
#define ARG_BLACKANDWHITE_DESC
#define ARG_BLACKANDWHITE
#define ARG_SYMBOL
#define ARG_INC_HIDDEN_PINS
#define ARG_INC_HIDDEN_FIELDS
#define _(s)
This file contains miscellaneous commonly used macros and functions.
static const int ERR_INVALID_INPUT_FILE
Definition: exit_codes.h:33
wxString From_UTF8(const char *cstring)