kicad/pcbnew/exporters/gen_footprints_placefile.cpp

549 lines
17 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
/*
2007-08-23 04:28:46 +00:00
* 1 - create ascii files for automatic placement of smd components
2020-11-13 11:17:15 +00:00
* 2 - create a footprint report (pos and footprint descr) (ascii file)
2007-08-23 04:28:46 +00:00
*/
#include <confirm.h>
#include <kicad_string.h>
#include <gestfich.h>
2018-01-29 20:58:58 +00:00
#include <pcb_edit_frame.h>
#include <pcbnew_settings.h>
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
#include <pgm_base.h>
#include <bitmaps.h>
#include <reporter.h>
#include <tools/board_editor_control.h>
#include <board.h>
#include <footprint.h>
#include <wildcards_and_files_ext.h>
#include <kiface_i.h>
#include <wx_html_report_panel.h>
2018-02-16 16:52:19 +00:00
#include <dialog_gen_footprint_position_file_base.h>
#include <export_footprints_placefile.h>
#include "gerber_placefile_writer.h"
2019-06-04 20:59:59 +00:00
/**
* The dialog to create footprint position files and choose options (one or 2 files, units
* and force all SMD footprints in list)
*/
2018-02-16 19:26:55 +00:00
class DIALOG_GEN_FOOTPRINT_POSITION : public DIALOG_GEN_FOOTPRINT_POSITION_BASE
{
public:
2018-02-16 19:26:55 +00:00
DIALOG_GEN_FOOTPRINT_POSITION( PCB_EDIT_FRAME * aParent ):
DIALOG_GEN_FOOTPRINT_POSITION_BASE( aParent ),
m_parent( aParent ),
m_plotOpts( aParent->GetPlotSettings() )
{
m_reporter = &m_messagesPanel->Reporter();
initDialog();
// We use a sdbSizer to get platform-dependent ordering of the action buttons, but
// that requires us to correct the button labels here.
m_sdbSizerOK->SetLabel( _( "Generate Position File" ) );
m_sdbSizerCancel->SetLabel( _( "Close" ) );
m_sdbSizer->Layout();
m_sdbSizerOK->SetDefault();
GetSizer()->SetSizeHints(this);
Centre();
}
private:
PCB_EDIT_FRAME* m_parent;
PCB_PLOT_PARAMS m_plotOpts;
REPORTER* m_reporter;
static int m_unitsOpt;
static int m_fileOpt;
static int m_fileFormat;
static bool m_includeBoardEdge;
void initDialog();
2016-09-24 18:53:15 +00:00
void OnOutputDirectoryBrowseClicked( wxCommandEvent& event ) override;
void OnGenerate( wxCommandEvent& event ) override;
void onUpdateUIUnits( wxUpdateUIEvent& event ) override
{
m_radioBoxUnits->Enable( m_rbFormat->GetSelection() != 2 );
}
void onUpdateUIFileOpt( wxUpdateUIEvent& event ) override
{
m_radioBoxFilesCount->Enable( m_rbFormat->GetSelection() != 2 );
}
void onUpdateUIExcludeTH( wxUpdateUIEvent& event ) override
{
if( m_rbFormat->GetSelection() == 2 )
{
m_excludeTH->SetValue( false );
m_excludeTH->Enable( false );
}
else
{
m_excludeTH->Enable( true );
}
}
void onUpdateUIincludeBoardEdge( wxUpdateUIEvent& event ) override
{
m_cbIncludeBoardEdge->Enable( m_rbFormat->GetSelection() == 2 );
}
/** Creates files in text or csv format
*/
bool CreateAsciiFiles();
/** Creates placement files in gerber format
*/
bool CreateGerberFiles();
// accessors to options:
bool UnitsMM()
{
return m_radioBoxUnits->GetSelection() == 1;
}
bool OneFileOnly()
{
return m_radioBoxFilesCount->GetSelection() == 1;
}
bool ExcludeAllTH()
{
return m_excludeTH->GetValue();
}
};
// Static members to remember choices
2018-02-16 19:26:55 +00:00
int DIALOG_GEN_FOOTPRINT_POSITION::m_fileOpt = 0;
int DIALOG_GEN_FOOTPRINT_POSITION::m_fileFormat = 0;
bool DIALOG_GEN_FOOTPRINT_POSITION::m_includeBoardEdge = false;
2018-02-16 19:26:55 +00:00
void DIALOG_GEN_FOOTPRINT_POSITION::initDialog()
{
m_browseButton->SetBitmap( KiBitmap( small_folder_xpm ) );
auto cfg = m_parent->GetPcbNewSettings();
m_units = cfg->m_PlaceFile.units == 0 ? EDA_UNITS::INCHES : EDA_UNITS::MILLIMETRES;
m_fileOpt = cfg->m_PlaceFile.file_options;
m_fileFormat = cfg->m_PlaceFile.file_format;
m_includeBoardEdge = cfg->m_PlaceFile.include_board_edge;
// Output directory
m_outputDirectoryName->SetValue( m_plotOpts.GetOutputDirectory() );
// Update Options
m_radioBoxUnits->SetSelection( cfg->m_PlaceFile.units );
m_radioBoxFilesCount->SetSelection( m_fileOpt );
m_rbFormat->SetSelection( m_fileFormat );
m_cbIncludeBoardEdge->SetValue( m_includeBoardEdge );
// Update sizes and sizers:
m_messagesPanel->MsgPanelSetMinSize( wxSize( -1, 160 ) );
GetSizer()->SetSizeHints( this );
}
2018-02-16 19:26:55 +00:00
void DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked( wxCommandEvent& event )
{
// Build the absolute path of current output directory to preselect it in the file browser.
wxString path = ExpandEnvVarSubstitutions( m_outputDirectoryName->GetValue(), &Prj() );
path = Prj().AbsolutePath( path );
wxDirDialog dirDialog( this, _( "Select Output Directory" ), path );
if( dirDialog.ShowModal() == wxID_CANCEL )
return;
wxFileName dirName = wxFileName::DirName( dirDialog.GetPath() );
wxMessageDialog dialog( this, _( "Use a relative path?"),
_( "Plot Output Directory" ),
wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
if( dialog.ShowModal() == wxID_YES )
{
wxString boardFilePath = ( (wxFileName) m_parent->GetBoard()->GetFileName() ).GetPath();
if( !dirName.MakeRelativeTo( boardFilePath ) )
wxMessageBox( _( "Cannot make path relative (target volume different from board file volume)!" ),
_( "Plot Output Directory" ), wxOK | wxICON_ERROR );
}
m_outputDirectoryName->SetValue( dirName.GetFullPath() );
}
void DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate( wxCommandEvent& event )
{
m_fileOpt = m_radioBoxFilesCount->GetSelection();
m_fileFormat = m_rbFormat->GetSelection();
m_includeBoardEdge = m_cbIncludeBoardEdge->GetValue();
auto cfg = m_parent->GetPcbNewSettings();
m_units = m_radioBoxUnits->GetSelection() == 0 ? EDA_UNITS::INCHES : EDA_UNITS::MILLIMETRES;
cfg->m_PlaceFile.units = m_units == EDA_UNITS::INCHES ? 0 : 1;
cfg->m_PlaceFile.file_options = m_fileOpt;
cfg->m_PlaceFile.file_format = m_fileFormat;
cfg->m_PlaceFile.include_board_edge = m_includeBoardEdge;
// Set output directory and replace backslashes with forward ones
// (Keep unix convention in cfg files)
wxString dirStr;
dirStr = m_outputDirectoryName->GetValue();
dirStr.Replace( wxT( "\\" ), wxT( "/" ) );
m_plotOpts.SetOutputDirectory( dirStr );
m_parent->SetPlotSettings( m_plotOpts );
if( m_fileFormat == 2 )
CreateGerberFiles();
else
CreateAsciiFiles();
}
bool DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles()
{
BOARD* brd = m_parent->GetBoard();
wxFileName fn;
wxString msg;
int fullcount = 0;
// Create output directory if it does not exist. Also transform it in absolute path.
// Bail if it fails
wxString path = ExpandEnvVarSubstitutions( m_plotOpts.GetOutputDirectory(), &Prj() );
wxFileName outputDir = wxFileName::DirName( path );
wxString boardFilename = m_parent->GetBoard()->GetFileName();
m_reporter = &m_messagesPanel->Reporter();
if( !EnsureFileDirectoryExists( &outputDir, boardFilename, m_reporter ) )
{
msg.Printf( _( "Could not write plot files to folder \"%s\"." ),
outputDir.GetPath() );
DisplayError( this, msg );
return false;
}
fn = m_parent->GetBoard()->GetFileName();
fn.SetPath( outputDir.GetPath() );
// Create the the Front and Top side placement files. Gerber P&P files are always separated.
// Not also they include all footprints
PLACEFILE_GERBER_WRITER exporter( brd );
wxString filename = exporter.GetPlaceFileName( fn.GetFullPath(), F_Cu );
int fpcount = exporter.CreatePlaceFile( filename, F_Cu, m_includeBoardEdge );
if( fpcount < 0 )
{
msg.Printf( _( "Unable to create \"%s\"." ), fn.GetFullPath() );
wxMessageBox( msg );
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
return false;
}
msg.Printf( _( "Front (top side) placement file: \"%s\"." ), filename );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
msg.Printf( _( "Component count: %d." ), fpcount );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
// Create the Back or Bottom side placement file
fullcount = fpcount;
filename = exporter.GetPlaceFileName( fn.GetFullPath(), B_Cu );
fpcount = exporter.CreatePlaceFile( filename, B_Cu, m_includeBoardEdge );
if( fpcount < 0 )
{
msg.Printf( _( "Unable to create file \"%s\"." ), filename );
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
wxMessageBox( msg );
return false;
}
// Display results
msg.Printf( _( "Back (bottom side) placement file: \"%s\"." ), filename );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
msg.Printf( _( "Component count: %d." ), fpcount );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
fullcount += fpcount;
msg.Printf( _( "Full component count: %d\n" ), fullcount );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
m_reporter->Report( _( "File generation successful." ), RPT_SEVERITY_ACTION );
return true;
}
bool DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles()
{
BOARD * brd = m_parent->GetBoard();
wxFileName fn;
wxString msg;
bool singleFile = OneFileOnly();
bool useCSVfmt = m_fileFormat == 1;
int fullcount = 0;
int top_side = true;
int bottom_side = true;
// Test for any footprint candidate in list.
{
PLACE_FILE_EXPORTER exporter( brd, UnitsMM(), ExcludeAllTH(), top_side, bottom_side,
useCSVfmt );
exporter.GenPositionData();
if( exporter.GetFootprintCount() == 0 )
{
wxMessageBox( _( "No footprint for automated placement." ) );
return false;
}
}
// Create output directory if it does not exist.
// Also transform it in absolute path.
// Bail if it fails
wxFileName outputDir = wxFileName::DirName( m_plotOpts.GetOutputDirectory() );
wxString boardFilename = m_parent->GetBoard()->GetFileName();
m_reporter = &m_messagesPanel->Reporter();
if( !EnsureFileDirectoryExists( &outputDir, boardFilename, m_reporter ) )
{
msg.Printf( _( "Could not write plot files to folder \"%s\"." ), outputDir.GetPath() );
DisplayError( this, msg );
return false;
}
2012-08-29 16:59:50 +00:00
fn = m_parent->GetBoard()->GetFileName();
fn.SetPath( outputDir.GetPath() );
// Create the the Front or Top side placement file, or a single file
top_side = true;
bottom_side = false;
if( singleFile )
{
bottom_side = true;
fn.SetName( fn.GetName() + wxT( "-" ) + wxT("all") );
}
else
fn.SetName( fn.GetName() + wxT( "-" ) + PLACE_FILE_EXPORTER::GetFrontSideName().c_str() );
if( useCSVfmt )
{
fn.SetName( fn.GetName() + wxT( "-" ) + FootprintPlaceFileExtension );
fn.SetExt( wxT( "csv" ) );
}
else
fn.SetExt( FootprintPlaceFileExtension );
int fpcount = m_parent->DoGenFootprintsPositionFile( fn.GetFullPath(), UnitsMM(),
ExcludeAllTH(), top_side, bottom_side,
useCSVfmt );
if( fpcount < 0 )
{
msg.Printf( _( "Unable to create \"%s\"." ), fn.GetFullPath() );
wxMessageBox( msg );
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
return false;
}
if( singleFile )
msg.Printf( _( "Placement file: \"%s\"." ), fn.GetFullPath() );
else
msg.Printf( _( "Front (top side) placement file: \"%s\"." ),
fn.GetFullPath() );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
msg.Printf( _( "Component count: %d." ), fpcount );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
if( singleFile )
{
m_reporter->Report( _( "File generation successful." ), RPT_SEVERITY_ACTION );
return true;
}
// Create the Back or Bottom side placement file
fullcount = fpcount;
top_side = false;
bottom_side = true;
2012-08-29 16:59:50 +00:00
fn = brd->GetFileName();
fn.SetPath( outputDir.GetPath() );
fn.SetName( fn.GetName() + wxT( "-" ) + PLACE_FILE_EXPORTER::GetBackSideName().c_str() );
if( useCSVfmt )
{
fn.SetName( fn.GetName() + wxT( "-" ) + FootprintPlaceFileExtension );
fn.SetExt( wxT( "csv" ) );
}
else
fn.SetExt( FootprintPlaceFileExtension );
fpcount = m_parent->DoGenFootprintsPositionFile( fn.GetFullPath(), UnitsMM(), ExcludeAllTH(),
top_side, bottom_side, useCSVfmt );
if( fpcount < 0 )
{
msg.Printf( _( "Unable to create file \"%s\"." ), fn.GetFullPath() );
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
wxMessageBox( msg );
return false;
}
// Display results
if( !singleFile )
{
msg.Printf( _( "Back (bottom side) placement file: \"%s\"." ), fn.GetFullPath() );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
msg.Printf( _( "Component count: %d." ), fpcount );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
}
if( !singleFile )
{
fullcount += fpcount;
msg.Printf( _( "Full component count: %d\n" ), fullcount );
m_reporter->Report( msg, RPT_SEVERITY_INFO );
}
m_reporter->Report( _( "File generation successful." ), RPT_SEVERITY_ACTION );
return true;
}
int BOARD_EDITOR_CONTROL::GeneratePosFile( const TOOL_EVENT& aEvent )
{
PCB_EDIT_FRAME* editFrame = getEditFrame<PCB_EDIT_FRAME>();
DIALOG_GEN_FOOTPRINT_POSITION dlg( editFrame );
dlg.ShowModal();
2019-06-04 20:59:59 +00:00
return 0;
}
2019-06-04 20:59:59 +00:00
int PCB_EDIT_FRAME::DoGenFootprintsPositionFile( const wxString& aFullFileName, bool aUnitsMM,
bool aForceSmdItems, bool aTopSide,
bool aBottomSide, bool aFormatCSV )
{
FILE * file = NULL;
if( !aFullFileName.IsEmpty() )
2007-08-23 04:28:46 +00:00
{
file = wxFopen( aFullFileName, wxT( "wt" ) );
if( file == NULL )
return -1;
2007-08-23 04:28:46 +00:00
}
std::string data;
PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, aForceSmdItems, aTopSide, aBottomSide,
aFormatCSV );
data = exporter.GenPositionData();
2007-08-23 04:28:46 +00:00
// if aFullFileName is empty, the file is not created, only the
// count of footprints to place is returned
if( file )
{
// Creates a footprint position file
// aSide = 0 -> Back (bottom) side)
// aSide = 1 -> Front (top) side)
// aSide = 2 -> both sides
fputs( data.c_str(), file );
fclose( file );
}
2007-08-23 04:28:46 +00:00
return exporter.GetFootprintCount();
}
void PCB_EDIT_FRAME::GenFootprintsReport( wxCommandEvent& event )
{
wxFileName fn;
wxString boardFilePath = ( (wxFileName) GetBoard()->GetFileName() ).GetPath();
wxDirDialog dirDialog( this, _( "Select Output Directory" ), boardFilePath );
if( dirDialog.ShowModal() == wxID_CANCEL )
return;
2012-08-29 16:59:50 +00:00
fn = GetBoard()->GetFileName();
fn.SetPath( dirDialog.GetPath() );
fn.SetExt( wxT( "rpt" ) );
bool unitMM = GetUserUnits() == EDA_UNITS::MILLIMETRES;
bool success = DoGenFootprintsReport( fn.GetFullPath(), unitMM );
wxString msg;
if( success )
{
msg.Printf( _( "Footprint report file created:\n\"%s\"" ), fn.GetFullPath() );
wxMessageBox( msg, _( "Footprint Report" ), wxICON_INFORMATION );
}
else
{
msg.Printf( _( "Unable to create \"%s\"" ), fn.GetFullPath() );
DisplayError( this, msg );
}
}
2020-11-13 11:17:15 +00:00
/* Print a footprint report.
2007-08-23 04:28:46 +00:00
*/
bool PCB_EDIT_FRAME::DoGenFootprintsReport( const wxString& aFullFilename, bool aUnitsMM )
{
FILE* rptfile = wxFopen( aFullFilename, wxT( "wt" ) );
2007-08-23 04:28:46 +00:00
if( rptfile == NULL )
return false;
std::string data;
PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, false, true, true, false );
data = exporter.GenReportData();
2007-08-23 04:28:46 +00:00
fputs( data.c_str(), rptfile );
2007-08-23 04:28:46 +00:00
fclose( rptfile );
return true;
}