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) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2016 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 <plot_common.h>
32 #include <confirm.h>
33 #include <wxPcbStruct.h>
34 #include <pcbplot.h>
35 #include <pcbstruct.h>
36 #include <base_units.h>
37 #include <reporter.h>
38 #include <class_board.h>
39 #include <pcbnew.h>
40 #include <plotcontroller.h>
41 #include <pcb_plot_params.h>
42 #include <wx/ffile.h>
43 #include <dialog_plot.h>
44 #include <macros.h>
45 #include <build_version.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  // Add the signal type of the layer, if relevant
175  if( IsCopperLayer( aLayer ) )
176  {
177  LAYER_T type = aBoard->GetLayerType( ToLAYER_ID( aLayer ) );
178 
179  switch( type )
180  {
181  case LT_SIGNAL:
182  attrib += ",Signal";
183  break;
184  case LT_POWER:
185  attrib += ",Plane";
186  break;
187  case LT_MIXED:
188  attrib += ",Mixed";
189  break;
190  default:
191  break; // do nothing (but avoid a warning for unhandled LAYER_T values from GCC)
192  }
193  }
194 
195  wxString fileFct;
196  fileFct.Printf( "%%TF.FileFunction,%s*%%", GetChars( attrib ) );
197 
198  return fileFct;
199 }
200 
201 
202 static const wxString GetGerberFilePolarityAttribute( LAYER_NUM aLayer )
203 {
204  /* build the string %TF.FilePolarity,Positive*%
205  * or %TF.FilePolarity,Negative*%
206  * an emply string for layers which do not use a polarity
207  *
208  * The value of the .FilePolarity specifies whether the image represents the
209  * presence or absence of material.
210  * This attribute can only be used when the file represents a pattern in a material layer,
211  * e.g. copper, solder mask, legend.
212  * Together with.FileFunction it defines the role of that image in
213  * the layer structure of the PCB.
214  * Note that the .FilePolarity attribute does not change the image -
215  * no attribute does.
216  * It changes the interpretation of the image.
217  * For example, in a copper layer in positive polarity a round flash generates a copper pad.
218  * In a copper layer in negative polarity it generates a clearance.
219  * Solder mask images usually represent solder mask openings and are then negative.
220  * This may be counter-intuitive.
221  */
222  int polarity = 0;
223 
224  switch( aLayer )
225  {
226  case F_Adhes:
227  case B_Adhes:
228  case F_SilkS:
229  case B_SilkS:
230  case F_Paste:
231  case B_Paste:
232  polarity = 1;
233  break;
234 
235  case F_Mask:
236  case B_Mask:
237  polarity = -1;
238  break;
239 
240  default:
241  if( IsCopperLayer( aLayer ) )
242  polarity = 1;
243  break;
244  }
245 
246  wxString filePolarity;
247 
248  if( polarity == 1 )
249  filePolarity = "%TF.FilePolarity,Positive*%";
250  if( polarity == -1 )
251  filePolarity = "%TF.FilePolarity,Negative*%";
252 
253  return filePolarity;
254 }
255 
256 /* Add some X2 attributes to the file header, as defined in the
257  * Gerber file format specification J4 and "Revision 2015.06"
258  */
259 
260 // A helper function to convert a X2 attribute string to a X1 structured comment:
261 static wxString& makeStringCompatX1( wxString& aText, bool aUseX1CompatibilityMode )
262 {
263  if( aUseX1CompatibilityMode )
264  {
265  aText.Replace( "%", "" );
266  aText.Prepend( "G04 #@! " );
267  }
268 
269  return aText;
270 }
271 
272 
273 void AddGerberX2Header( PLOTTER * aPlotter,
274  const BOARD *aBoard, bool aUseX1CompatibilityMode )
275 {
276  wxString text;
277 
278  // Creates the TF,.GenerationSoftware. Format is:
279  // %TF,.GenerationSoftware,<vendor>,<application name>[,<application version>]*%
280  text.Printf( wxT( "%%TF.GenerationSoftware,KiCad,Pcbnew,%s*%%" ), GetBuildVersion() );
281  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
282 
283  // creates the TF.CreationDate ext:
284  // The attribute value must conform to the full version of the ISO 8601
285  // date and time format, including time and time zone. Note that this is
286  // the date the Gerber file was effectively created,
287  // not the time the project of PCB was started
288  wxDateTime date( wxDateTime::GetTimeNow() );
289  // Date format: see http://www.cplusplus.com/reference/ctime/strftime
290  wxString msg = date.Format( wxT( "%z" ) ); // Extract the time zone offset
291  // The time zone offset format is + (or -) mm or hhmm (mm = number of minutes, hh = number of hours)
292  // we want +(or -) hh:mm
293  if( msg.Len() > 3 )
294  msg.insert( 3, ":", 1 ),
295  text.Printf( wxT( "%%TF.CreationDate,%s%s*%%" ), GetChars( date.FormatISOCombined() ), GetChars( msg ) );
296  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
297 
298  // Creates the TF,.ProjectId. Format is (from Gerber file format doc):
299  // %TF.ProjectId,<project id>,<project GUID>,<revision id>*%
300  // <project id> is the name of the project, restricted to basic ASCII symbols only,
301  // and comma not accepted
302  // All illegal chars will be replaced by underscore
303  // <project GUID> is a 32 hexadecimal digits string which is an unique id of a project.
304  // This is a random 128-bit number expressed in 32 hexadecimal digits.
305  // See en.wikipedia.org/wiki/GUID for more information
306  // However Kicad does not handle such a project GUID, so it is built from the board name
307  // Rem: <project id> accepts only ASCII 7 code (only basic ASCII codes are allowed in gerber files).
308  wxFileName fn = aBoard->GetFileName();
309  msg = fn.GetFullName();
310  wxString guid;
311 
312  // Build a 32 digits GUID from the board name:
313  for( unsigned ii = 0; ii < msg.Len(); ii++ )
314  {
315  int cc1 = int( msg[ii] ) & 0x0F;
316  int cc2 = ( int( msg[ii] ) >> 4) & 0x0F;
317  guid << wxString::Format( wxT( "%X%X" ), cc2, cc1 );
318 
319  if( guid.Len() >= 32 )
320  break;
321  }
322 
323  // guid has 32 digits, so add missing digits
324  int cnt = 32 - guid.Len();
325 
326  if( cnt > 0 )
327  guid.Append( '0', cnt );
328 
329  // build the <project id> string: this is the board short filename (without ext)
330  // and all non ASCII chars and comma are replaced by '_'
331  msg = fn.GetName();
332  msg.Replace( wxT( "," ), wxT( "_" ) );
333 
334  // build the <rec> string. All non ASCII chars and comma are replaced by '_'
335  wxString rev = ((BOARD*)aBoard)->GetTitleBlock().GetRevision();
336  rev.Replace( wxT( "," ), wxT( "_" ) );
337 
338  if( rev.IsEmpty() )
339  rev = wxT( "rev?" );
340 
341  text.Printf( wxT( "%%TF.ProjectId,%s,%s,%s*%%" ), msg.ToAscii(), GetChars( guid ), rev.ToAscii() );
342  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
343 }
344 
345 
346 void AddGerberX2Attribute( PLOTTER * aPlotter,
347  const BOARD *aBoard, LAYER_NUM aLayer, bool aUseX1CompatibilityMode )
348 {
349  AddGerberX2Header( aPlotter, aBoard, aUseX1CompatibilityMode );
350 
351  wxString text;
352 
353  // Add the TF.FileFunction
354  text = GetGerberFileFunctionAttribute( aBoard, aLayer );
355  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
356 
357  // Add the TF.FilePolarity (for layers which support that)
358  text = GetGerberFilePolarityAttribute( aLayer );
359 
360  if( !text.IsEmpty() )
361  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
362 }
363 
364 
365 void BuildPlotFileName( wxFileName* aFilename, const wxString& aOutputDir,
366  const wxString& aSuffix, const wxString& aExtension )
367 {
368  // aFilename contains the base filename only (without path and extension)
369  // when calling this function.
370  // It is expected to be a valid filename (this is usually the board filename)
371  aFilename->SetPath( aOutputDir );
372 
373  // Set the file extension
374  aFilename->SetExt( aExtension );
375 
376  // remove leading and trailing spaces if any from the suffix, if
377  // something survives add it to the name;
378  // also the suffix can contain some not allowed chars in filename (/ \ . :),
379  // so change them to underscore
380  // Remember it can be called from a python script, so the illegal chars
381  // have to be filtered here.
382  wxString suffix = aSuffix;
383  suffix.Trim( true );
384  suffix.Trim( false );
385 
386  wxString badchars = wxFileName::GetForbiddenChars(wxPATH_DOS);
387  badchars.Append( '%' );
388 
389  for( unsigned ii = 0; ii < badchars.Len(); ii++ )
390  suffix.Replace( badchars[ii], wxT("_") );
391 
392  if( !suffix.IsEmpty() )
393  aFilename->SetName( aFilename->GetName() + wxT( "-" ) + suffix );
394 }
395 
396 
398 {
399  m_plotter = NULL;
400  m_board = aBoard;
402 }
403 
404 
406 {
407  ClosePlot();
408 }
409 
410 
411 /* IMPORTANT THING TO KNOW: the locale during plots *MUST* be kept as
412  * C/POSIX using a LOCALE_IO object on the stack. This even when
413  * opening/closing the plotfile, since some drivers do I/O even then */
414 
416 {
417  LOCALE_IO toggle;
418 
419  if( m_plotter )
420  {
421  m_plotter->EndPlot();
422  delete m_plotter;
423  m_plotter = NULL;
424  }
425 }
426 
427 
428 bool PLOT_CONTROLLER::OpenPlotfile( const wxString &aSuffix,
429  PlotFormat aFormat,
430  const wxString &aSheetDesc )
431 {
432  LOCALE_IO toggle;
433 
434  /* Save the current format: sadly some plot routines depends on this
435  but the main reason is that the StartPlot method uses it to
436  dispatch the plotter creation */
437  GetPlotOptions().SetFormat( aFormat );
438 
439  // Ensure that the previous plot is closed
440  ClosePlot();
441 
442  // Now compute the full filename for the output and start the plot
443  // (after ensuring the output directory is OK)
444  wxString outputDirName = GetPlotOptions().GetOutputDirectory() ;
445  wxFileName outputDir = wxFileName::DirName( outputDirName );
446  wxString boardFilename = m_board->GetFileName();
447 
448  if( EnsureFileDirectoryExists( &outputDir, boardFilename ) )
449  {
450  // outputDir contains now the full path of plot files
451  m_plotFile = boardFilename;
452  m_plotFile.SetPath( outputDir.GetPath() );
453  wxString fileExt = GetDefaultPlotExtension( aFormat );
454 
455  // Gerber format can use specific file ext, depending on layers
456  // (now not a good practice, because the official file ext is .gbr)
457  if( GetPlotOptions().GetFormat() == PLOT_FORMAT_GERBER &&
458  GetPlotOptions().GetUseGerberProtelExtensions() )
459  fileExt = GetGerberProtelExtension( GetLayer() );
460 
461  // Build plot filenames from the board name and layer names:
462  BuildPlotFileName( &m_plotFile, outputDir.GetPath(), aSuffix, fileExt );
463 
465  m_plotFile.GetFullPath(), aSheetDesc );
466  }
467 
468  return( m_plotter != NULL );
469 }
470 
471 
473 {
474  LOCALE_IO toggle;
475 
476  // No plot open, nothing to do...
477  if( !m_plotter )
478  return false;
479 
480  // Fully delegated to the parent
482 
483  return true;
484 }
485 
486 
487 void PLOT_CONTROLLER::SetColorMode( bool aColorMode )
488 {
489  if( !m_plotter )
490  return;
491 
492  m_plotter->SetColorMode( aColorMode );
493 }
494 
495 
497 {
498  if( !m_plotter )
499  return false;
500 
501  return m_plotter->GetColorMode();
502 }
PCB_PLOT_PARAMS & GetPlotOptions()
Accessor to the plot parameters and options.
LAYER_NUM GetLayer()
~PLOT_CONTROLLER()
Batch plotter destructor, ensures that the last plot is closed.
Definition: pcbplot.cpp:405
void ClosePlot()
Close the current plot, nothing happens if it isn't open.
Definition: pcbplot.cpp:415
Class LOCALE_IO is a class that can be instantiated within a scope in which you are expecting excepti...
Definition: common.h:166
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.
PlotFormat
Enum PlotFormat is the set of supported output plot formats.
Definition: plot_common.h:49
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.
void SetFormat(PlotFormat aFormat)
bool GetColorMode()
Definition: pcbplot.cpp:496
wxString GetDefaultPlotExtension(PlotFormat aFormat)
Returns the default plot extension for a format.
int GetCopperLayerCount() const
Function GetCopperLayerCount.
const wxString GetGerberProtelExtension(LAYER_NUM aLayer)
Function GetGerberProtelExtension.
Definition: pcbplot.cpp:48
void AddGerberX2Header(PLOTTER *aPlotter, const BOARD *aBoard, bool aUseX1CompatibilityMode)
Function AddGerberX2Header Calculates some X2 attributes, as defined in the Gerber file format specif...
Definition: pcbplot.cpp:273
wxFileName m_plotFile
The current plot filename, set by OpenPlotfile.
void AddGerberX2Attribute(PLOTTER *aPlotter, const BOARD *aBoard, LAYER_NUM aLayer, bool aUseX1CompatibilityMode)
Function AddGerberX2Attribute Calculates some X2 attributes, as defined in the Gerber file format spe...
Definition: pcbplot.cpp:346
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: plot_common.h:166
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:397
Board plot function definition file.
virtual bool EndPlot()=0
wxString GetOutputDirectory() const
wxString GetBuildVersion()
Function GetBuildVersion Return the build version string.
const wxString & GetFileName() const
Definition: class_board.h:237
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Helper function EnsureFileDirectoryExists make aTargetFullFileName absolute and creates the path of t...
Definition: common.cpp:267
LAYER_T
Enum LAYER_T gives the allowed types of layers, same as Specctra DSN spec.
Definition: class_board.h:68
Classes and definitions used in Pcbnew.
Common plot library Plot settings, and plotting engines (Postscript, Gerber, HPGL and DXF) ...
bool GetColorMode() const
Definition: plot_common.h:121
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
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:365
static const wxString GetGerberFilePolarityAttribute(LAYER_NUM aLayer)
Definition: pcbplot.cpp:202
Base plotter engine class.
Definition: plot_common.h:86
void SetColorMode(bool)
Plotters can plot in Black and White mode or Color mode SetColorMode activate/de-actiavte the Color m...
Definition: pcbplot.cpp:487
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:92
static wxString & makeStringCompatX1(wxString &aText, bool aUseX1CompatibilityMode)
Definition: pcbplot.cpp:261
bool OpenPlotfile(const wxString &aSuffix, PlotFormat aFormat, const wxString &aSheetDesc)
Open a new plotfile; works as a factory for plotter objects.
Definition: pcbplot.cpp:428
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:166
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 PlotLayer()
Plot a single layer on the current plotfile m_plotLayer is the layer to plot.
Definition: pcbplot.cpp:472
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Function GetLayerType returns the type of the copper layer given by aLayer.
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:767
LAYER_NUM m_plotLayer
the layer to plot
virtual void SetColorMode(bool _color_mode)
Definition: plot_common.h:116