KiCad PCB EDA Suite
dialog_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) 2012 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2012 KiCad Developers, see change_log.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 
26 #include <pcb_edit_frame.h>
27 #include <pcbnew_settings.h>
29 #include <reporter.h>
30 #include <confirm.h>
31 #include <core/arraydim.h>
32 #include <core/kicad_algo.h>
33 #include <pcbplot.h>
34 #include <locale_io.h>
35 #include <board.h>
36 #include <dialog_export_svg_base.h>
37 #include <wx_html_report_panel.h>
38 #include <bitmaps.h>
39 #include <widgets/unit_binder.h>
41 
43 {
44 public:
45  DIALOG_EXPORT_SVG( PCB_EDIT_FRAME* aParent, BOARD* aBoard );
46  ~DIALOG_EXPORT_SVG() override;
47 
48 private:
52  // the list of existing board layers in wxCheckListBox, with the
53  // board layers id:
54  std::pair<wxCheckListBox*, int> m_boxSelectLayer[PCB_LAYER_ID_COUNT];
55  bool m_printBW;
59 
60  void initDialog();
61 
62  void OnButtonPlot( wxCommandEvent& event ) override;
63 
64  void OnOutputDirectoryBrowseClicked( wxCommandEvent& event ) override;
65  void ExportSVGFile( bool aOnlyOneFile );
66 
67  bool CreateSVGFile( const wxString& FullFileName );
68 
70 };
71 
72 
73 /*
74  * DIALOG_EXPORT_SVG functions
75  */
77  DIALOG_EXPORT_SVG_BASE( aParent ),
78  m_board( aBoard ),
79  m_parent( aParent ),
80  m_printBW( false ),
81  m_printMirror( false ),
82  m_oneFileOnly( false )
83 {
84  m_browseButton->SetBitmap( KiBitmap( small_folder_xpm ) );
85 
86  m_messagesPanel->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
87 
88  initDialog();
89 
90  // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
91  // that requires us to correct the button labels here.
92  m_sdbSizer1OK->SetLabel( _( "Export" ) );
93  m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
94  m_sdbSizer1->Layout();
95 
97 }
98 
99 
101 {
102  m_printBW = m_ModeColorOption->GetSelection();
103  m_oneFileOnly = m_rbFileOpt->GetSelection() == 1;
105  m_outputDirectory.Replace( wxT( "\\" ), wxT( "/" ) );
106 
107  auto cfg = m_parent->GetPcbNewSettings();
108 
110  cfg->m_ExportSvg.mirror = m_printMirror;
111  cfg->m_ExportSvg.one_file = m_oneFileOnly;
112  cfg->m_ExportSvg.plot_board_edges = m_PrintBoardEdgesCtrl->GetValue();
113  cfg->m_ExportSvg.page_size = m_rbSvgPageSizeOpt->GetSelection();
114  cfg->m_ExportSvg.output_dir = m_outputDirectory.ToStdString();
115 
116  cfg->m_ExportSvg.layers.clear();
117 
118  for( unsigned layer = 0; layer < arrayDim( m_boxSelectLayer ); ++layer )
119  {
120  if( !m_boxSelectLayer[layer].first )
121  continue;
122 
123  if( m_boxSelectLayer[layer].first->IsChecked( m_boxSelectLayer[layer].second ) )
124  cfg->m_ExportSvg.layers.push_back( m_boxSelectLayer[layer].second );
125  }
126 }
127 
128 
130 {
131  auto cfg = m_parent->GetPcbNewSettings();
132 
133  m_printBW = cfg->m_ExportSvg.black_and_white;
134  m_printMirror = cfg->m_ExportSvg.mirror;
135  m_oneFileOnly = cfg->m_ExportSvg.one_file;
136  m_outputDirectory = cfg->m_ExportSvg.output_dir;
137 
138  m_rbSvgPageSizeOpt->SetSelection( cfg->m_ExportSvg.page_size );
139  m_PrintBoardEdgesCtrl->SetValue( cfg->m_ExportSvg.plot_board_edges );
140 
142 
143  m_ModeColorOption->SetSelection( m_printBW ? 1 : 0 );
144  m_printMirrorOpt->SetValue( m_printMirror );
145  m_rbFileOpt->SetSelection( m_oneFileOnly ? 1 : 0 );
146 
147  for( LSEQ seq = m_board->GetEnabledLayers().UIOrder(); seq; ++seq )
148  {
149  PCB_LAYER_ID layer = *seq;
150  int checkIndex;
151 
152  if( IsCopperLayer( layer ) )
153  {
154  checkIndex = m_CopperLayersList->Append( m_board->GetLayerName( layer ) );
155  m_boxSelectLayer[layer] = std::make_pair( m_CopperLayersList, checkIndex );
156  }
157  else
158  {
159  checkIndex = m_TechnicalLayersList->Append( m_board->GetLayerName( layer ) );
160  m_boxSelectLayer[layer] = std::make_pair( m_TechnicalLayersList, checkIndex );
161  }
162 
163  if( alg::contains( cfg->m_ExportSvg.layers, layer ) )
164  m_boxSelectLayer[layer].first->Check( checkIndex, true );
165  }
166 }
167 
168 
170 {
171  LSET ret;
172 
173  for( unsigned layer = 0; layer < arrayDim(m_boxSelectLayer); ++layer )
174  {
175  if( !m_boxSelectLayer[layer].first )
176  continue;
177 
178  if( m_boxSelectLayer[layer].first->IsChecked( m_boxSelectLayer[layer].second ) )
179  ret.set( layer );
180  }
181 
182  return ret;
183 }
184 
185 
187 {
188  // Build the absolute path of current output directory to preselect it in the file browser.
189  wxString path = ExpandEnvVarSubstitutions( m_outputDirectoryName->GetValue(), &Prj() );
190  path = Prj().AbsolutePath( path );
191 
192  wxDirDialog dirDialog( this, _( "Select Output Directory" ), path );
193 
194  if( dirDialog.ShowModal() == wxID_CANCEL )
195  return;
196 
197  wxFileName dirName = wxFileName::DirName( dirDialog.GetPath() );
198 
199  wxMessageDialog dialog( this, _( "Use a relative path?" ), _( "Plot Output Directory" ),
200  wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
201 
202  if( dialog.ShowModal() == wxID_YES )
203  {
204  wxString boardFilePath = Prj().AbsolutePath( m_board->GetFileName() );
205 
206  boardFilePath = wxPathOnly( boardFilePath );
207 
208  if( !dirName.MakeRelativeTo( boardFilePath ) )
209  wxMessageBox( _( "Cannot make path relative (target volume different from board file volume)!" ),
210  _( "Plot Output Directory" ), wxOK | wxICON_ERROR );
211  }
212 
213  m_outputDirectoryName->SetValue( dirName.GetFullPath() );
215 }
216 
217 
218 void DIALOG_EXPORT_SVG::ExportSVGFile( bool aOnlyOneFile )
219 {
221 
222  // Create output directory if it does not exist (also transform it in
223  // absolute form). Bail if it fails
224  wxString path = ExpandEnvVarSubstitutions( m_outputDirectory, &Prj() );
225  wxFileName outputDir = wxFileName::DirName( path );
226  wxString boardFilename = m_board->GetFileName();
227 
228  REPORTER& reporter = m_messagesPanel->Reporter();
229 
230  if( !EnsureFileDirectoryExists( &outputDir, boardFilename, &reporter ) )
231  {
232  wxString msg = wxString::Format( _( "Could not write plot files to folder \"%s\"." ),
233  outputDir.GetPath() );
234  DisplayError( this, msg );
235  return;
236  }
237 
238  m_printMirror = m_printMirrorOpt->GetValue();
239  m_printBW = m_ModeColorOption->GetSelection();
240 
241  LSET all_selected = getCheckBoxSelectedLayers();
242 
243  for( LSEQ seq = all_selected.Seq(); seq; ++seq )
244  {
245  PCB_LAYER_ID layer = *seq;
246  wxFileName fn( boardFilename );
247  wxString suffix = aOnlyOneFile ? wxT( "brd" ) : m_board->GetStandardLayerName( layer );
248 
249  BuildPlotFileName( &fn, outputDir.GetPath(), suffix, SVGFileExtension );
250  wxString svgPath = fn.GetFullPath();
251 
252  m_printMaskLayer = aOnlyOneFile ? all_selected : LSET( layer );
253 
254  if( m_PrintBoardEdgesCtrl->IsChecked() )
256 
257  if( CreateSVGFile( svgPath ) )
258  {
259  reporter.Report( wxString::Format( _( "Exported \"%s\"." ), svgPath ), RPT_SEVERITY_ACTION );
260  }
261  else // Error
262  {
263  reporter.Report( wxString::Format( _( "Unable to create file \"%s\"." ), svgPath ),
265  }
266 
267  if( aOnlyOneFile )
268  break;
269  }
270 }
271 
272 
273 // Actual SVG file export function.
274 bool DIALOG_EXPORT_SVG::CreateSVGFile( const wxString& aFullFileName )
275 {
276  PCB_PLOT_PARAMS plot_opts;
277 
278  plot_opts.SetPlotFrameRef( m_rbSvgPageSizeOpt->GetSelection() == 0 );
279 
280  // Adding drill marks, for copper layers
281  if( ( m_printMaskLayer & LSET::AllCuMask() ).any() )
283  else
285 
286  plot_opts.SetSkipPlotNPTH_Pads( false );
287 
288  plot_opts.SetMirror( m_printMirror );
289  plot_opts.SetFormat( PLOT_FORMAT::SVG );
290 
291  PAGE_INFO savedPageInfo = m_board->GetPageSettings();
292  wxPoint savedAuxOrigin = m_board->GetDesignSettings().m_AuxOrigin;
293 
294  if( m_rbSvgPageSizeOpt->GetSelection() == 2 ) // Page is board boundary size
295  {
297  PAGE_INFO currpageInfo = m_board->GetPageSettings();
298 
299  currpageInfo.SetWidthMils( bbox.GetWidth() / IU_PER_MILS );
300  currpageInfo.SetHeightMils( bbox.GetHeight() / IU_PER_MILS );
301  m_board->SetPageSettings( currpageInfo );
302  plot_opts.SetUseAuxOrigin( true );
303  wxPoint origin = bbox.GetOrigin();
305  }
306 
307  SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
309 
310  plot_opts.SetColorSettings( mgr.GetColorSettings( cfg->m_ColorTheme ) );
311 
312  LOCALE_IO toggle;
313 
314  SVG_PLOTTER* plotter = (SVG_PLOTTER*) StartPlotBoard( m_board, &plot_opts, UNDEFINED_LAYER,
315  aFullFileName, wxEmptyString );
316 
317  if( plotter )
318  {
319  plotter->SetColorMode( !m_printBW );
320 
321  for( LSEQ seq = m_printMaskLayer.SeqStackupBottom2Top(); seq; ++seq )
322  PlotOneBoardLayer( m_board, plotter, *seq, plot_opts );
323 
324  plotter->EndPlot();
325  }
326 
327  delete plotter;
328 
329  // reset to the values saved earlier
330  m_board->GetDesignSettings().m_AuxOrigin = savedAuxOrigin;
331  m_board->SetPageSettings( savedPageInfo );
332 
333  return true;
334 }
335 
336 
337 void DIALOG_EXPORT_SVG::OnButtonPlot( wxCommandEvent& event )
338 {
339  m_oneFileOnly = m_rbFileOpt->GetSelection() == 1;
341 }
342 
343 
344 bool InvokeExportSVG( PCB_EDIT_FRAME* aCaller, BOARD* aBoard )
345 {
346  DIALOG_EXPORT_SVG dlg( aCaller, aBoard );
347 
348  dlg.ShowModal();
349 
350  return true;
351 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:253
const PAGE_INFO & GetPageSettings() const
Definition: board.h:606
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:342
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
void OnOutputDirectoryBrowseClicked(wxCommandEvent &event) override
void SetUseAuxOrigin(bool aAux)
wxCheckListBox * m_CopperLayersList
This file is part of the common library.
const BITMAP_OPAQUE small_folder_xpm[1]
void PlotOneBoardLayer(BOARD *aBoard, PLOTTER *aPlotter, PCB_LAYER_ID aLayer, const PCB_PLOT_PARAMS &aPlotOpt)
Function PlotOneBoardLayer main function to plot one copper or technical layer.
virtual void SetColorMode(bool aColorMode)
Plot in B/W or color.
Definition: plotter.h:151
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: board.h:607
bool CreateSVGFile(const wxString &FullFileName)
int GetWidth() const
Definition: eda_rect.h:114
void SetMirror(bool aFlag)
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:591
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings Returns a bit-mask of all t...
Definition: board.cpp:447
LSEQ SeqStackupBottom2Top() const
Return the sequence that is typical for a bottom-to-top stack-up.
Definition: lset.cpp:461
void SetDrillMarksType(DrillMarksType aVal)
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:269
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:411
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
const wxString & GetFileName() const
Definition: board.h:298
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Board plot function definition file.
virtual bool EndPlot() override
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:82
void SetPlotFrameRef(bool aFlag)
PCB_LAYER_ID
A quick note on layer IDs:
DIALOG_EXPORT_SVG m_ExportSvg
LSET is a set of PCB_LAYER_IDs.
wxCheckListBox * m_TechnicalLayersList
DIALOG_EXPORT_SVG(PCB_EDIT_FRAME *aParent, BOARD *aBoard)
void OnButtonPlot(wxCommandEvent &event) override
void SetColorSettings(COLOR_SETTINGS *aSettings)
const wxPoint GetOrigin() const
Definition: eda_rect.h:106
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.
Definition: common.cpp:297
void SetSkipPlotNPTH_Pads(bool aSkip)
Definition of file extensions used in Kicad.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
AppSettings * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
LSET getCheckBoxSelectedLayers() const
void SetFormat(PLOT_FORMAT aFormat)
PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:257
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
int GetHeight() const
Definition: eda_rect.h:115
Plotting engines similar to ps (PostScript, Gerber, svg)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void BuildPlotFileName(wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
Function BuildPlotFileName (helper function) Complete a plot filename: forces the output directory,...
Definition: pcbplot.cpp:369
Class DIALOG_EXPORT_SVG_BASE.
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
wxStdDialogButtonSizer * m_sdbSizer1
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
#define _(s)
Definition: 3d_actions.cpp:33
WX_HTML_REPORT_PANEL * m_messagesPanel
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:243
Handle the component boundary box.
Definition: eda_rect.h:42
The main frame for Pcbnew.
PCBNEW_SETTINGS * GetPcbNewSettings() const
const std::string SVGFileExtension
#define IU_PER_MILS
Definition: plotter.cpp:137
bool InvokeExportSVG(PCB_EDIT_FRAME *aCaller, BOARD *aBoard)
Function InvokeExportSVG shows the Export SVG dialog.
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
Definition: board.cpp:1029
bool IsCopperLayer(LAYER_NUM aLayerId)
Tests whether a layer is a copper layer.
PCB_EDIT_FRAME * m_parent
void ExportSVGFile(bool aOnlyOneFile)
PLOTTER * StartPlotBoard(BOARD *aBoard, PCB_PLOT_PARAMS *aPlotOpts, int aLayer, const wxString &aFullFileName, const wxString &aSheetDesc)
Open a new plotfile using the options (and especially the format) specified in the options and prepar...
void SetFileName(const wxString &aReportFileName)
LSEQ UIOrder() const
Definition: lset.cpp:895
wxPoint m_AuxOrigin
origin for plot exports
std::pair< wxCheckListBox *, int > m_boxSelectLayer[PCB_LAYER_ID_COUNT]
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:674
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184