KiCad PCB EDA Suite
pcbplot.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) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
30 #include <fctsys.h>
31 #include <plotter.h>
32 #include <confirm.h>
33 #include <pcb_edit_frame.h>
34 #include <pcbplot.h>
35 #include <base_units.h>
36 #include <reporter.h>
37 #include <class_board.h>
38 #include <pcbnew.h>
39 #include <plotcontroller.h>
40 #include <pcb_plot_params.h>
41 #include <wx/ffile.h>
42 #include <dialog_plot.h>
43 #include <macros.h>
44 #include <build_version.h>
45 #include <gbr_metadata.h>
46 
47 
48 const wxString GetGerberProtelExtension( LAYER_NUM aLayer )
49 {
50  if( IsCopperLayer( aLayer ) )
51  {
52  if( aLayer == F_Cu )
53  return wxT( "gtl" );
54  else if( aLayer == B_Cu )
55  return wxT( "gbl" );
56  else
57  {
58  return wxString::Format( wxT( "g%d" ), aLayer+1 );
59  }
60  }
61  else
62  {
63  switch( aLayer )
64  {
65  case B_Adhes: return wxT( "gba" );
66  case F_Adhes: return wxT( "gta" );
67 
68  case B_Paste: return wxT( "gbp" );
69  case F_Paste: return wxT( "gtp" );
70 
71  case B_SilkS: return wxT( "gbo" );
72  case F_SilkS: return wxT( "gto" );
73 
74  case B_Mask: return wxT( "gbs" );
75  case F_Mask: return wxT( "gts" );
76 
77  case Edge_Cuts: return wxT( "gm1" );
78 
79  case Dwgs_User:
80  case Cmts_User:
81  case Eco1_User:
82  case Eco2_User:
83  default: return wxT( "gbr" );
84  }
85  }
86 }
87 
88 
89 const wxString GetGerberFileFunctionAttribute( const BOARD *aBoard, LAYER_NUM aLayer )
90 {
91  wxString attrib;
92 
93  switch( aLayer )
94  {
95  case F_Adhes:
96  attrib = "Glue,Top";
97  break;
98 
99  case B_Adhes:
100  attrib = "Glue,Bot";
101  break;
102 
103  case F_SilkS:
104  attrib = "Legend,Top";
105  break;
106 
107  case B_SilkS:
108  attrib = "Legend,Bot";
109  break;
110 
111  case F_Mask:
112  attrib = "Soldermask,Top";
113  break;
114 
115  case B_Mask:
116  attrib = "Soldermask,Bot";
117  break;
118 
119  case F_Paste:
120  attrib = "Paste,Top";
121  break;
122 
123  case B_Paste:
124  attrib = "Paste,Bot";
125  break;
126 
127  case Edge_Cuts:
128  // Board outline.
129  // Can be "Profile,NP" (Not Plated: usual) or "Profile,P"
130  // This last is the exception (Plated)
131  attrib = "Profile,NP";
132  break;
133 
134  case Dwgs_User:
135  attrib = "Drawing";
136  break;
137 
138  case Cmts_User:
139  attrib = "Other,Comment";
140  break;
141 
142  case Eco1_User:
143  attrib = "Other,ECO1";
144  break;
145 
146  case Eco2_User:
147  attrib = "Other,ECO2";
148  break;
149 
150  case B_Fab:
151  attrib = "Other,Fab,Bot";
152  break;
153 
154  case F_Fab:
155  attrib = "Other,Fab,Top";
156  break;
157 
158  case B_Cu:
159  attrib.Printf( wxT( "Copper,L%d,Bot" ), aBoard->GetCopperLayerCount() );
160  break;
161 
162  case F_Cu:
163  attrib = "Copper,L1,Top";
164  break;
165 
166  default:
167  if( IsCopperLayer( aLayer ) )
168  attrib.Printf( wxT( "Copper,L%d,Inr" ), aLayer+1 );
169  else
170  attrib.Printf( wxT( "Other,User" ), aLayer+1 );
171  break;
172  }
173 
174  // This code adds a optional parameter: the type of copper layers.
175  // Because it is not used by Pcbnew (it can be used only by external autorouters)
176  // user do not really set this parameter.
177  // Therefore do not add it.
178  // However, this code is left here, for perhaps a future usage.
179 #if 0
180  // Add the signal type of the layer, if relevant
181  if( IsCopperLayer( aLayer ) )
182  {
183  LAYER_T type = aBoard->GetLayerType( ToLAYER_ID( aLayer ) );
184 
185  switch( type )
186  {
187  case LT_SIGNAL:
188  attrib += ",Signal";
189  break;
190  case LT_POWER:
191  attrib += ",Plane";
192  break;
193  case LT_MIXED:
194  attrib += ",Mixed";
195  break;
196  default:
197  break; // do nothing (but avoid a warning for unhandled LAYER_T values from GCC)
198  }
199  }
200 #endif
201 
202  wxString fileFct;
203  fileFct.Printf( "%%TF.FileFunction,%s*%%", GetChars( attrib ) );
204 
205  return fileFct;
206 }
207 
208 
209 static const wxString GetGerberFilePolarityAttribute( LAYER_NUM aLayer )
210 {
211  /* build the string %TF.FilePolarity,Positive*%
212  * or %TF.FilePolarity,Negative*%
213  * an emply string for layers which do not use a polarity
214  *
215  * The value of the .FilePolarity specifies whether the image represents the
216  * presence or absence of material.
217  * This attribute can only be used when the file represents a pattern in a material layer,
218  * e.g. copper, solder mask, legend.
219  * Together with.FileFunction it defines the role of that image in
220  * the layer structure of the PCB.
221  * Note that the .FilePolarity attribute does not change the image -
222  * no attribute does.
223  * It changes the interpretation of the image.
224  * For example, in a copper layer in positive polarity a round flash generates a copper pad.
225  * In a copper layer in negative polarity it generates a clearance.
226  * Solder mask images usually represent solder mask openings and are then negative.
227  * This may be counter-intuitive.
228  */
229  int polarity = 0;
230 
231  switch( aLayer )
232  {
233  case F_Adhes:
234  case B_Adhes:
235  case F_SilkS:
236  case B_SilkS:
237  case F_Paste:
238  case B_Paste:
239  polarity = 1;
240  break;
241 
242  case F_Mask:
243  case B_Mask:
244  polarity = -1;
245  break;
246 
247  default:
248  if( IsCopperLayer( aLayer ) )
249  polarity = 1;
250  break;
251  }
252 
253  wxString filePolarity;
254 
255  if( polarity == 1 )
256  filePolarity = "%TF.FilePolarity,Positive*%";
257  if( polarity == -1 )
258  filePolarity = "%TF.FilePolarity,Negative*%";
259 
260  return filePolarity;
261 }
262 
263 /* Add some X2 attributes to the file header, as defined in the
264  * Gerber file format specification J4 and "Revision 2015.06"
265  */
266 
267 // A helper function to convert a X2 attribute string to a X1 structured comment:
268 static wxString& makeStringCompatX1( wxString& aText, bool aUseX1CompatibilityMode )
269 {
270  if( aUseX1CompatibilityMode )
271  {
272  aText.Replace( "%", "" );
273  aText.Prepend( "G04 #@! " );
274  }
275 
276  return aText;
277 }
278 
279 
280 void AddGerberX2Header( PLOTTER * aPlotter,
281  const BOARD *aBoard, bool aUseX1CompatibilityMode )
282 {
283  wxString text;
284 
285  // Creates the TF,.GenerationSoftware. Format is:
286  // %TF,.GenerationSoftware,<vendor>,<application name>[,<application version>]*%
287  text.Printf( wxT( "%%TF.GenerationSoftware,KiCad,Pcbnew,%s*%%" ), GetBuildVersion() );
288  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
289 
290  // creates the TF.CreationDate attribute:
291  text = GbrMakeCreationDateAttributeString( aUseX1CompatibilityMode ?
294  aPlotter->AddLineToHeader( text );
295 
296  // Creates the TF,.ProjectId. Format is (from Gerber file format doc):
297  // %TF.ProjectId,<project id>,<project GUID>,<revision id>*%
298  // <project id> is the name of the project, restricted to basic ASCII symbols only,
299  // Rem: <project id> accepts only ASCII 7 code (only basic ASCII codes are allowed in gerber files).
300  // and comma not accepted
301  // All illegal chars will be replaced by underscore
302  //
303  // <project GUID> is a string which is an unique id of a project.
304  // However Kicad does not handle such a project GUID, so it is built from the board name
305  wxFileName fn = aBoard->GetFileName();
306  wxString msg = fn.GetFullName();
307 
308  // Build a <project GUID>, from the board name
309  wxString guid = GbrMakeProjectGUIDfromString( msg );
310 
311  // build the <project id> string: this is the board short filename (without ext)
312  // and all non ASCII chars and comma are replaced by '_'
313  msg = fn.GetName();
314  msg.Replace( wxT( "," ), wxT( "_" ) );
315 
316  // build the <rec> string. All non ASCII chars and comma are replaced by '_'
317  wxString rev = ((BOARD*)aBoard)->GetTitleBlock().GetRevision();
318  rev.Replace( wxT( "," ), wxT( "_" ) );
319 
320  if( rev.IsEmpty() )
321  rev = wxT( "rev?" );
322 
323  text.Printf( wxT( "%%TF.ProjectId,%s,%s,%s*%%" ), msg.ToAscii(), GetChars( guid ), rev.ToAscii() );
324  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
325 
326  // Add the TF.SameCoordinates, that specify all gerber files uses the same
327  // origin and orientation, and the registration between files is OK.
328  // The parameter of TF.SameCoordinates is a string that is common
329  // to all files using the same registration and has no special meaning:
330  // this is just a key
331  // Because there is no mirroring/rotation in Kicad, only the plot offset origin
332  // can create incorrect registration.
333  // So we create a key from plot offset options.
334  // and therefore for a given board, all Gerber files having the same key have the same
335  // plot origin and use the same registration
336  //
337  // Currently the key is "Original" when using absolute Pcbnew coordinates,
338  // and te PY ans PY position od auxiliary axis, when using it.
339  // Please, if absolute Pcbnew coordinates, one day, are set by user, change the way
340  // the key is built to ensure file only using the *same* axis have the same key.
341  wxString registration_id = "Original";
342  wxPoint auxOrigin = aBoard->GetAuxOrigin();
343 
344  if( aBoard->GetPlotOptions().GetUseAuxOrigin() && auxOrigin.x && auxOrigin.y )
345  registration_id.Printf( "PX%xPY%x", auxOrigin.x, auxOrigin.y );
346 
347  text.Printf( "%%TF.SameCoordinates,%s*%%", registration_id.GetData() );
348  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
349 }
350 
351 
352 void AddGerberX2Attribute( PLOTTER * aPlotter,
353  const BOARD *aBoard, LAYER_NUM aLayer, bool aUseX1CompatibilityMode )
354 {
355  AddGerberX2Header( aPlotter, aBoard, aUseX1CompatibilityMode );
356 
357  wxString text;
358 
359  // Add the TF.FileFunction
360  text = GetGerberFileFunctionAttribute( aBoard, aLayer );
361  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
362 
363  // Add the TF.FilePolarity (for layers which support that)
364  text = GetGerberFilePolarityAttribute( aLayer );
365 
366  if( !text.IsEmpty() )
367  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
368 }
369 
370 
371 void BuildPlotFileName( wxFileName* aFilename, const wxString& aOutputDir,
372  const wxString& aSuffix, const wxString& aExtension )
373 {
374  // aFilename contains the base filename only (without path and extension)
375  // when calling this function.
376  // It is expected to be a valid filename (this is usually the board filename)
377  aFilename->SetPath( aOutputDir );
378 
379  // Set the file extension
380  aFilename->SetExt( aExtension );
381 
382  // remove leading and trailing spaces if any from the suffix, if
383  // something survives add it to the name;
384  // also the suffix can contain some not allowed chars in filename (/ \ . : and some others),
385  // so change them to underscore
386  // Remember it can be called from a python script, so the illegal chars
387  // have to be filtered here.
388  wxString suffix = aSuffix;
389  suffix.Trim( true );
390  suffix.Trim( false );
391 
392  wxString badchars = wxFileName::GetForbiddenChars(wxPATH_DOS);
393  badchars.Append( "%." );
394 
395  for( unsigned ii = 0; ii < badchars.Len(); ii++ )
396  suffix.Replace( badchars[ii], wxT("_") );
397 
398  if( !suffix.IsEmpty() )
399  aFilename->SetName( aFilename->GetName() + wxT( "-" ) + suffix );
400 }
401 
402 
404 {
405  m_plotter = NULL;
406  m_board = aBoard;
408 }
409 
410 
412 {
413  ClosePlot();
414 }
415 
416 
417 /* IMPORTANT THING TO KNOW: the locale during plots *MUST* be kept as
418  * C/POSIX using a LOCALE_IO object on the stack. This even when
419  * opening/closing the plotfile, since some drivers do I/O even then */
420 
422 {
423  LOCALE_IO toggle;
424 
425  if( m_plotter )
426  {
427  m_plotter->EndPlot();
428  delete m_plotter;
429  m_plotter = NULL;
430  }
431 }
432 
433 
434 bool PLOT_CONTROLLER::OpenPlotfile( const wxString &aSuffix,
435  PlotFormat aFormat,
436  const wxString &aSheetDesc )
437 {
438  LOCALE_IO toggle;
439 
440  /* Save the current format: sadly some plot routines depends on this
441  but the main reason is that the StartPlot method uses it to
442  dispatch the plotter creation */
443  GetPlotOptions().SetFormat( aFormat );
444 
445  // Ensure that the previous plot is closed
446  ClosePlot();
447 
448  // Now compute the full filename for the output and start the plot
449  // (after ensuring the output directory is OK)
450  wxString outputDirName = GetPlotOptions().GetOutputDirectory() ;
451  wxFileName outputDir = wxFileName::DirName( outputDirName );
452  wxString boardFilename = m_board->GetFileName();
453 
454  if( EnsureFileDirectoryExists( &outputDir, boardFilename ) )
455  {
456  // outputDir contains now the full path of plot files
457  m_plotFile = boardFilename;
458  m_plotFile.SetPath( outputDir.GetPath() );
459  wxString fileExt = GetDefaultPlotExtension( aFormat );
460 
461  // Gerber format can use specific file ext, depending on layers
462  // (now not a good practice, because the official file ext is .gbr)
463  if( GetPlotOptions().GetFormat() == PLOT_FORMAT_GERBER &&
464  GetPlotOptions().GetUseGerberProtelExtensions() )
465  fileExt = GetGerberProtelExtension( GetLayer() );
466 
467  // Build plot filenames from the board name and layer names:
468  BuildPlotFileName( &m_plotFile, outputDir.GetPath(), aSuffix, fileExt );
469 
471  m_plotFile.GetFullPath(), aSheetDesc );
472  }
473 
474  return( m_plotter != NULL );
475 }
476 
477 
479 {
480  LOCALE_IO toggle;
481 
482  // No plot open, nothing to do...
483  if( !m_plotter )
484  return false;
485 
486  // Fully delegated to the parent
488 
489  return true;
490 }
491 
492 
493 void PLOT_CONTROLLER::SetColorMode( bool aColorMode )
494 {
495  if( !m_plotter )
496  return;
497 
498  m_plotter->SetColorMode( aColorMode );
499 }
500 
501 
503 {
504  if( !m_plotter )
505  return false;
506 
507  return m_plotter->GetColorMode();
508 }
PCB_PLOT_PARAMS & GetPlotOptions()
Accessor to the plot parameters and options.
LAYER_NUM GetLayer()
a class to handle special data (items attributes) during plot.
~PLOT_CONTROLLER()
Batch plotter destructor, ensures that the last plot is closed.
Definition: pcbplot.cpp:411
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: class_board.h:552
void ClosePlot()
Close the current plot, nothing happens if it isn't open.
Definition: pcbplot.cpp:421
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:177
PLOTTER * m_plotter
This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.
Implementation of conversion functions that require both schematic and board internal units.
This file is part of the common library.
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.
Class BOARD to handle a board.
virtual void SetColorMode(bool aColorMode)
Plot in B/W or color.
Definition: plotter.h:126
void SetFormat(PlotFormat aFormat)
bool GetColorMode()
Definition: pcbplot.cpp:502
wxString GetDefaultPlotExtension(PlotFormat aFormat)
Returns the default plot extension for a format.
const wxString GetGerberProtelExtension(LAYER_NUM aLayer)
Function GetGerberProtelExtension.
Definition: pcbplot.cpp:48
void AddGerberX2Header(PLOTTER *aPlotter, const BOARD *aBoard, bool aUseX1CompatibilityMode)
Calculates some X2 attributes, as defined in the Gerber file format specification J4 (chapter 5) and ...
Definition: pcbplot.cpp:280
wxFileName m_plotFile
The current plot filename, set by OpenPlotfile.
PlotFormat
Enum PlotFormat is the set of supported output plot formats.
Definition: plotter.h:50
wxString GbrMakeCreationDateAttributeString(GBR_NC_STRING_FORMAT aFormat)
void AddGerberX2Attribute(PLOTTER *aPlotter, const BOARD *aBoard, LAYER_NUM aLayer, bool aUseX1CompatibilityMode)
Calculates some X2 attributes, as defined in the Gerber file format specification and add them to the...
Definition: pcbplot.cpp:352
void AddLineToHeader(const wxString &aExtraString)
Function AddLineToHeader Add a line to the list of free lines to print at the beginning of the file.
Definition: plotter.h:176
const wxString & GetFileName() const
Definition: class_board.h:237
BOARD * m_board
The board we're plotting.
This file contains miscellaneous commonly used macros and functions.
PLOT_CONTROLLER(BOARD *aBoard)
Batch plotter constructor, nothing interesting here.
Definition: pcbplot.cpp:403
Board plot function definition file.
virtual bool EndPlot()=0
wxString GetBuildVersion()
Function GetBuildVersion Return the build version string.
wxString GbrMakeProjectGUIDfromString(wxString &aText)
A helper function to build a project GUID using format RFC4122 Version 1 or 4 from the project name,...
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:485
LAYER_T
Enum LAYER_T gives the allowed types of layers, same as Specctra DSN spec.
Definition: class_board.h:72
const wxPoint & GetAuxOrigin() const
Definition: class_board.h:345
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
wxString GetOutputDirectory() const
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:371
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Function GetLayerType returns the type of the copper layer given by aLayer.
static const wxString GetGerberFilePolarityAttribute(LAYER_NUM aLayer)
Definition: pcbplot.cpp:209
Base plotter engine class.
Definition: plotter.h:97
void SetColorMode(bool)
Plotters can plot in Black and White mode or Color mode SetColorMode activate/de-actiavte the Color m...
Definition: pcbplot.cpp:493
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
static wxString & makeStringCompatX1(wxString &aText, bool aUseX1CompatibilityMode)
Definition: pcbplot.cpp:268
bool OpenPlotfile(const wxString &aSuffix, PlotFormat aFormat, const wxString &aSheetDesc)
Open a new plotfile; works as a factory for plotter objects.
Definition: pcbplot.cpp:434
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
int GetCopperLayerCount() const
Function GetCopperLayerCount.
const wxString GetGerberFileFunctionAttribute(const BOARD *aBoard, LAYER_NUM aLayer)
Function GetGerberFileFunctionAttribute Returns the "file function" attribute for aLayer,...
Definition: pcbplot.cpp:89
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
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...
bool GetUseAuxOrigin() const
bool PlotLayer()
Plot a single layer on the current plotfile m_plotLayer is the layer to plot.
Definition: pcbplot.cpp:478
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:813
LAYER_NUM m_plotLayer
the layer to plot
bool GetColorMode() const
Definition: plotter.h:131