pcbplot.cpp File Reference

#include <plotters/plotter.h>
#include <pcbplot.h>
#include <base_units.h>
#include <locale_io.h>
#include <reporter.h>
#include <board.h>
#include <board_design_settings.h>
#include <plotcontroller.h>
#include <pcb_plot_params.h>
#include <wx/ffile.h>
#include <dialog_plot.h>
#include <build_version.h>
#include <gbr_metadata.h>
#include <render_settings.h>

Go to the source code of this file.

Functions
const wxString	GetGerberProtelExtension (LAYER_NUM aLayer)
const wxString	GetGerberFileFunctionAttribute (const BOARD *aBoard, LAYER_NUM aLayer)
	Return the "file function" attribute for aLayer, as defined in the Gerber file format specification J1 (chapter 5). More...
static const wxString	GetGerberFilePolarityAttribute (LAYER_NUM aLayer)
static wxString &	makeStringCompatX1 (wxString &aText, bool aUseX1CompatibilityMode)
void	AddGerberX2Header (PLOTTER *aPlotter, const BOARD *aBoard, bool aUseX1CompatibilityMode)
	Calculate some X2 attributes as defined in the Gerber file format specification J4 (chapter 5) and add them the to the gerber file header. More...
void	AddGerberX2Attribute (PLOTTER *aPlotter, const BOARD *aBoard, LAYER_NUM aLayer, bool aUseX1CompatibilityMode)
	Calculate some X2 attributes as defined in the Gerber file format specification and add them to the gerber file header. More...
void	BuildPlotFileName (wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
	Complete a plot filename. More...

Function Documentation

AddGerberX2Attribute()

void AddGerberX2Attribute	(	PLOTTER *	aPlotter,
		const BOARD *	aBoard,
		LAYER_NUM	aLayer,
		bool	aUseX1CompatibilityMode
	)

Calculate some X2 attributes as defined in the Gerber file format specification and add them to the gerber file header.

TF.GenerationSoftware TF.CreationDate TF.ProjectId TF.FileFunction TF.FilePolarity

Parameters

aPlotter	is the current plotter.
aBoard	is the board, needed to extract some info.
aLayer	is the layer number to create the attribute for.
aUseX1CompatibilityMode	set to false to generate X2 attributes, true to use X1 compatibility (X2 attributes added as structured comments, starting by "G04 #@! " followed by the X2 attribute.

Definition at line 353 of file pcbplot.cpp.

{
 AddGerberX2Header( aPlotter, aBoard, aUseX1CompatibilityMode );

 wxString text;

 // Add the TF.FileFunction
 text = GetGerberFileFunctionAttribute( aBoard, aLayer );
 aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );

 // Add the TF.FilePolarity (for layers which support that)
 text = GetGerberFilePolarityAttribute( aLayer );

 if( !text.IsEmpty() )
 aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
}

References AddGerberX2Header(), PLOTTER::AddLineToHeader(), GetGerberFileFunctionAttribute(), GetGerberFilePolarityAttribute(), makeStringCompatX1(), and text.

Referenced by StartPlotBoard().

AddGerberX2Header()

void AddGerberX2Header	(	PLOTTER *	aPlotter,
		const BOARD *	aBoard,
		bool	aUseX1CompatibilityMode = false
	)

Calculate some X2 attributes as defined in the Gerber file format specification J4 (chapter 5) and add them the to the gerber file header.

TF.GenerationSoftware TF.CreationDate TF.ProjectId file format attribute is not added

Parameters

aPlotter	is the current plotter.
aBoard	is the board, needed to extract some info.
aUseX1CompatibilityMode	set to false to generate X2 attributes, true to use X1 compatibility (X2 attributes added as structured comments, starting by "G04 #@! " followed by the X2 attribute

Definition at line 282 of file pcbplot.cpp.

{
 wxString text;

 // Creates the TF,.GenerationSoftware. Format is:
 // %TF,.GenerationSoftware,<vendor>,<application name>[,<application version>]*%
 text.Printf( wxT( "%%TF.GenerationSoftware,KiCad,Pcbnew,%s*%%" ), GetBuildVersion() );
 aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );

 // creates the TF.CreationDate attribute:
 text = GbrMakeCreationDateAttributeString( aUseX1CompatibilityMode ?
 GBR_NC_STRING_FORMAT_X1 :
 GBR_NC_STRING_FORMAT_X2 );
 aPlotter->AddLineToHeader( text );

 // Creates the TF,.ProjectId. Format is (from Gerber file format doc):
 // %TF.ProjectId,<project id>,<project GUID>,<revision id>*%
 // <project id> is the name of the project, restricted to basic ASCII symbols only,
 // Rem: <project id> accepts only ASCII 7 code (only basic ASCII codes are allowed in
 // gerber files) and comma not accepted.
 // All illegal chars will be replaced by underscore.
 //
 // <project GUID> is a string which is an unique id of a project.
 // However Kicad does not handle such a project GUID, so it is built from the board name
 wxFileName fn = aBoard->GetFileName();
 wxString msg = fn.GetFullName();

 // Build a <project GUID>, from the board name
 wxString guid = GbrMakeProjectGUIDfromString( msg );

 // build the <project id> string: this is the board short filename (without ext)
 // and all non ASCII chars and comma are replaced by '_'
 msg = fn.GetName();
 msg.Replace( wxT( "," ), wxT( "_" ) );

 // build the <revision id> string. All non ASCII chars and comma are replaced by '_'
 wxString rev = ExpandTextVars( aBoard->GetTitleBlock().GetRevision(), aBoard->GetProject() );
 rev.Replace( wxT( "," ), wxT( "_" ) );

 if( rev.IsEmpty() )
 rev = wxT( "rev?" );

 text.Printf( wxT( "%%TF.ProjectId,%s,%s,%s*%%" ), msg.ToAscii(), guid, rev.ToAscii() );
 aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );

 // Add the TF.SameCoordinates, that specify all gerber files uses the same
 // origin and orientation, and the registration between files is OK.
 // The parameter of TF.SameCoordinates is a string that is common
 // to all files using the same registration and has no special meaning:
 // this is just a key
 // Because there is no mirroring/rotation in Kicad, only the plot offset origin
 // can create incorrect registration.
 // So we create a key from plot offset options.
 // and therefore for a given board, all Gerber files having the same key have the same
 // plot origin and use the same registration
 //
 // Currently the key is "Original" when using absolute Pcbnew coordinates,
 // and the PY and PY position of auxiliary axis, when using it.
 // Please, if absolute Pcbnew coordinates, one day, are set by user, change the way
 // the key is built to ensure file only using the *same* axis have the same key.
 wxString registration_id = wxT( "Original" );
 wxPoint auxOrigin = aBoard->GetDesignSettings().GetAuxOrigin();

 if( aBoard->GetPlotOptions().GetUseAuxOrigin() && auxOrigin.x && auxOrigin.y )
 registration_id.Printf( wxT( "PX%xPY%x" ), auxOrigin.x, auxOrigin.y );

 text.Printf( wxT( "%%TF.SameCoordinates,%s*%%" ), registration_id.GetData() );
 aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
}

References PLOTTER::AddLineToHeader(), ExpandTextVars(), GBR_NC_STRING_FORMAT_X1, GBR_NC_STRING_FORMAT_X2, GbrMakeCreationDateAttributeString(), GbrMakeProjectGUIDfromString(), BOARD_DESIGN_SETTINGS::GetAuxOrigin(), GetBuildVersion(), BOARD::GetDesignSettings(), BOARD::GetFileName(), BOARD::GetPlotOptions(), BOARD::GetProject(), TITLE_BLOCK::GetRevision(), BOARD::GetTitleBlock(), PCB_PLOT_PARAMS::GetUseAuxOrigin(), makeStringCompatX1(), and text.

Referenced by AddGerberX2Attribute(), GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), and GENDRILL_WRITER_BASE::genDrillMapFile().

BuildPlotFileName()

void BuildPlotFileName	(	wxFileName *	aFilename,
		const wxString &	aOutputDir,
		const wxString &	aSuffix,
		const wxString &	aExtension
	)

Complete a plot filename.

It forces the output directory, adds a suffix to the name, and sets the specified extension. The suffix is usually the layer name and replaces illegal file name character in the suffix with an underscore character.

Parameters

aFilename	is the file name to initialize that contains the base filename.
aOutputDir	is the path.
aSuffix	is the suffix to add to the base filename.
aExtension	is the file extension.

Definition at line 372 of file pcbplot.cpp.

{
 // aFilename contains the base filename only (without path and extension)
 // when calling this function.
 // It is expected to be a valid filename (this is usually the board filename)
 aFilename->SetPath( aOutputDir );

 // Set the file extension
 aFilename->SetExt( aExtension );

 // remove leading and trailing spaces if any from the suffix, if
 // something survives add it to the name;
 // also the suffix can contain some not allowed chars in filename (/ \ . : and some others),
 // so change them to underscore
 // Remember it can be called from a python script, so the illegal chars
 // have to be filtered here.
 wxString suffix = aSuffix;
 suffix.Trim( true );
 suffix.Trim( false );

 wxString badchars = wxFileName::GetForbiddenChars(wxPATH_DOS);
 badchars.Append( "%." );

 for( unsigned ii = 0; ii < badchars.Len(); ii++ )
 suffix.Replace( badchars[ii], wxT("_") );

 if( !suffix.IsEmpty() )
 aFilename->SetName( aFilename->GetName() + wxT( "-" ) + suffix );
}

Referenced by DIALOG_EXPORT_SVG::ExportSVGFile(), PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

GetGerberFileFunctionAttribute()

const wxString GetGerberFileFunctionAttribute	(	const BOARD *	aBoard,
		LAYER_NUM	aLayer
	)

Return the "file function" attribute for aLayer, as defined in the Gerber file format specification J1 (chapter 5).

The returned string includes the "%TF.FileFunction" attribute prefix and the "*%" suffix.

Parameters

aBoard	is the board, needed to get the total count of copper layers.
aLayer	is the layer number to create the attribute for.

Returns

The attribute, as a text string

Definition at line 87 of file pcbplot.cpp.

{
 wxString attrib;

 switch( aLayer )
 {
 case F_Adhes:
 attrib = wxT( "Glue,Top" );
 break;

 case B_Adhes:
 attrib = wxT( "Glue,Bot" );
 break;

 case F_SilkS:
 attrib = wxT( "Legend,Top" );
 break;

 case B_SilkS:
 attrib = wxT( "Legend,Bot" );
 break;

 case F_Mask:
 attrib = wxT( "Soldermask,Top" );
 break;

 case B_Mask:
 attrib = wxT( "Soldermask,Bot" );
 break;

 case F_Paste:
 attrib = wxT( "Paste,Top" );
 break;

 case B_Paste:
 attrib = wxT( "Paste,Bot" );
 break;

 case Edge_Cuts:
 // Board outline.
 // Can be "Profile,NP" (Not Plated: usual) or "Profile,P"
 // This last is the exception (Plated)
 attrib = wxT( "Profile,NP" );
 break;

 case Dwgs_User:
 attrib = wxT( "OtherDrawing,Comment" );
 break;

 case Cmts_User:
 attrib = wxT( "Other,Comment" );
 break;

 case Eco1_User:
 attrib = wxT( "Other,ECO1" );
 break;

 case Eco2_User:
 attrib = wxT( "Other,ECO2" );
 break;

 case B_Fab:
 // This is actually a assembly layer
 attrib = wxT( "AssemblyDrawing,Bot" );
 break;

 case F_Fab:
 // This is actually a assembly layer
 attrib = wxT( "AssemblyDrawing,Top" );
 break;

 case B_Cu:
 attrib.Printf( wxT( "Copper,L%d,Bot" ), aBoard->GetCopperLayerCount() );
 break;

 case F_Cu:
 attrib = wxT( "Copper,L1,Top" );
 break;

 default:
 if( IsCopperLayer( aLayer ) )
 attrib.Printf( wxT( "Copper,L%d,Inr" ), aLayer+1 );
 else
 attrib.Printf( wxT( "Other,User" ), aLayer+1 );
 break;
 }

 // This code adds a optional parameter: the type of copper layers.
 // Because it is not used by Pcbnew (it can be used only by external autorouters)
 // user do not really set this parameter.
 // Therefore do not add it.
 // However, this code is left here, for perhaps a future usage.
#if 0
 // Add the signal type of the layer, if relevant
 if( IsCopperLayer( aLayer ) )
 {
 LAYER_T type = aBoard->GetLayerType( ToLAYER_ID( aLayer ) );

 switch( type )
 {
 case LT_SIGNAL:
 attrib += wxT( ",Signal" );
 break;
 case LT_POWER:
 attrib += wxT( ",Plane" );
 break;
 case LT_MIXED:
 attrib += wxT( ",Mixed" );
 break;
 default:
 break; // do nothing (but avoid a warning for unhandled LAYER_T values from GCC)
 }
 }
#endif

 wxString fileFct;
 fileFct.Printf( wxT( "%%TF.FileFunction,%s*%%" ), attrib );

 return fileFct;
}

References B_Adhes, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, BOARD::GetCopperLayerCount(), BOARD::GetLayerType(), IsCopperLayer(), LT_MIXED, LT_POWER, LT_SIGNAL, and ToLAYER_ID().

Referenced by AddGerberX2Attribute().

GetGerberFilePolarityAttribute()

static const wxString GetGerberFilePolarityAttribute ( LAYER_NUM  aLayer )

static

Definition at line 209 of file pcbplot.cpp.

{
 /* build the string %TF.FilePolarity,Positive*%
 * or %TF.FilePolarity,Negative*%
 * an emply string for layers which do not use a polarity
 *
 * The value of the .FilePolarity specifies whether the image represents the
 * presence or absence of material.
 * This attribute can only be used when the file represents a pattern in a material layer,
 * e.g. copper, solder mask, legend.
 * Together with.FileFunction it defines the role of that image in
 * the layer structure of the PCB.
 * Note that the .FilePolarity attribute does not change the image -
 * no attribute does.
 * It changes the interpretation of the image.
 * For example, in a copper layer in positive polarity a round flash generates a copper pad.
 * In a copper layer in negative polarity it generates a clearance.
 * Solder mask images usually represent solder mask openings and are then negative.
 * This may be counter-intuitive.
 */
 int polarity = 0;

 switch( aLayer )
 {
 case F_Adhes:
 case B_Adhes:
 case F_SilkS:
 case B_SilkS:
 case F_Paste:
 case B_Paste:
 polarity = 1;
 break;

 case F_Mask:
 case B_Mask:
 polarity = -1;
 break;

 default:
 if( IsCopperLayer( aLayer ) )
 polarity = 1;
 break;
 }

 wxString filePolarity;

 if( polarity == 1 )
 filePolarity = wxT( "%TF.FilePolarity,Positive*%" );
 if( polarity == -1 )
 filePolarity = wxT( "%TF.FilePolarity,Negative*%" );

 return filePolarity;
}

References B_Adhes, B_Mask, B_Paste, B_SilkS, F_Adhes, F_Mask, F_Paste, F_SilkS, and IsCopperLayer().

Referenced by AddGerberX2Attribute().

GetGerberProtelExtension()

const wxString GetGerberProtelExtension

(

LAYER_NUM

aLayer

)

Returns

the appropriate Gerber file extension for aLayer

Definition at line 46 of file pcbplot.cpp.

{
 if( IsCopperLayer( aLayer ) )
 {
 if( aLayer == F_Cu )
 return wxT( "gtl" );
 else if( aLayer == B_Cu )
 return wxT( "gbl" );
 else
 {
 return wxString::Format( wxT( "g%d" ), aLayer+1 );
 }
 }
 else
 {
 switch( aLayer )
 {
 case B_Adhes: return wxT( "gba" );
 case F_Adhes: return wxT( "gta" );

 case B_Paste: return wxT( "gbp" );
 case F_Paste: return wxT( "gtp" );

 case B_SilkS: return wxT( "gbo" );
 case F_SilkS: return wxT( "gto" );

 case B_Mask: return wxT( "gbs" );
 case F_Mask: return wxT( "gts" );

 case Edge_Cuts: return wxT( "gm1" );

 case Dwgs_User:
 case Cmts_User:
 case Eco1_User:
 case Eco2_User:
 default: return wxT( "gbr" );
 }
 }
}

References B_Adhes, B_Cu, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_Cu, F_Mask, F_Paste, F_SilkS, Format(), and IsCopperLayer().

Referenced by PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

makeStringCompatX1()

static wxString& makeStringCompatX1 ( wxString &  aText, bool  aUseX1CompatibilityMode  )

static

Definition at line 270 of file pcbplot.cpp.

{
 if( aUseX1CompatibilityMode )
 {
 aText.Replace( wxT( "%" ), wxEmptyString );
 aText.Prepend( wxT( "G04 #@! " ) );
 }

 return aText;
}

Referenced by AddGerberX2Attribute(), and AddGerberX2Header().