gen_footprints_placefile.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015-2021 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
 */

/*
 * 1 - create ASCII files for automatic placement of smd components
 * 2 - create a footprint report (pos and footprint descr) (ascii file)
 */

#include <confirm.h>
#include <string_utils.h>
#include <gestfich.h>
#include <pcb_edit_frame.h>
#include <pcbnew_settings.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_base.h>
#include <wx_html_report_panel.h>
#include <dialog_gen_footprint_position_file_base.h>
#include <export_footprints_placefile.h>
#include "gerber_placefile_writer.h"

#include <wx/dirdlg.h>


class DIALOG_GEN_FOOTPRINT_POSITION : public DIALOG_GEN_FOOTPRINT_POSITION_BASE
{
public:
 DIALOG_GEN_FOOTPRINT_POSITION( PCB_EDIT_FRAME * aParent ):
 DIALOG_GEN_FOOTPRINT_POSITION_BASE( aParent ),
 m_parent( aParent ),
 m_plotOpts( aParent->GetPlotSettings() )
 {
 m_messagesPanel->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
 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:
 void initDialog();
 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 onUpdateUIOnlySMD( wxUpdateUIEvent& event ) override
 {
 if( m_rbFormat->GetSelection() == 2 )
 {
 m_onlySMD->SetValue( false );
 m_onlySMD->Enable( false );
 }
 else
 {
 m_onlySMD->Enable( true );
 }
 }

 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 );
 }

 bool CreateAsciiFiles();

 bool CreateGerberFiles();

 // accessors to options:
 bool UnitsMM()
 {
 return m_radioBoxUnits->GetSelection() == 1;
 }

 bool OneFileOnly()
 {
 return m_radioBoxFilesCount->GetSelection() == 1;
 }

 bool OnlySMD()
 {
 return m_onlySMD->GetValue();
 }

 bool ExcludeAllTH()
 {
 return m_excludeTH->GetValue();
 }

 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;
 static bool m_excludeTHOpt;
 static bool m_onlySMDOpt;
};


// Static members to remember choices
int DIALOG_GEN_FOOTPRINT_POSITION::m_fileOpt = 0;
int DIALOG_GEN_FOOTPRINT_POSITION::m_fileFormat = 0;
bool DIALOG_GEN_FOOTPRINT_POSITION::m_includeBoardEdge = false;
bool DIALOG_GEN_FOOTPRINT_POSITION::m_excludeTHOpt = false;
bool DIALOG_GEN_FOOTPRINT_POSITION::m_onlySMDOpt = false;


void DIALOG_GEN_FOOTPRINT_POSITION::initDialog()
{
 m_browseButton->SetBitmap( KiBitmap( BITMAPS::small_folder ) );

 PCBNEW_SETTINGS* 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 );
 m_useDrillPlaceOrigin->SetValue( cfg->m_PlaceFile.use_aux_origin );
 m_onlySMD->SetValue( m_onlySMDOpt );
 m_excludeTH->SetValue( m_excludeTHOpt );

 // Update sizes and sizers:
 m_messagesPanel->MsgPanelSetMinSize( wxSize( -1, 160 ) );
 GetSizer()->SetSizeHints( this );
}

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();
 m_onlySMDOpt = m_onlySMD->GetValue();
 m_excludeTHOpt = m_excludeTH->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;
 cfg->m_PlaceFile.use_aux_origin = m_useDrillPlaceOrigin->GetValue();

 // 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 form).
 // Bail if it fails.

 std::function<bool( wxString* )> textResolver =
 [&]( wxString* token ) -> bool
 {
 // Handles board->GetTitleBlock() *and* board->GetProject()
 return m_parent->GetBoard()->ResolveTextVar( token, 0 );
 };

 wxString path = m_plotOpts.GetOutputDirectory();
 path = ExpandTextVars( path, &textResolver, nullptr, nullptr );
 path = ExpandEnvVarSubstitutions( path, nullptr );

 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 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( _( "Failed to create file '%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( _( "Failed 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." ), fullcount );
 m_reporter->Report( msg, RPT_SEVERITY_INFO );

 m_reporter->Report( _( "File generation successful." ), RPT_SEVERITY_INFO );

 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;
 bool useAuxOrigin = m_useDrillPlaceOrigin->GetValue();
 int fullcount = 0;
 int topSide = true;
 int bottomSide = true;

 // Test for any footprint candidate in list.
 {
 PLACE_FILE_EXPORTER exporter( brd, UnitsMM(), OnlySMD(), ExcludeAllTH(), topSide,
 bottomSide, useCSVfmt, useAuxOrigin );
 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 form).
 // Bail if it fails.

 std::function<bool( wxString* )> textResolver =
 [&]( wxString* token ) -> bool
 {
 // Handles board->GetTitleBlock() *and* board->GetProject()
 return m_parent->GetBoard()->ResolveTextVar( token, 0 );
 };

 wxString path = m_plotOpts.GetOutputDirectory();
 path = ExpandTextVars( path, &textResolver, nullptr, nullptr );
 path = ExpandEnvVarSubstitutions( path, nullptr );

 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 Front or Top side placement file, or a single file
 topSide = true;
 bottomSide = false;

 if( singleFile )
 {
 bottomSide = 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(), OnlySMD(),
 ExcludeAllTH(), topSide, bottomSide,
 useCSVfmt, useAuxOrigin );
 if( fpcount < 0 )
 {
 msg.Printf( _( "Failed to create file '%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_INFO );
 return true;
 }

 // Create the Back or Bottom side placement file
 fullcount = fpcount;
 topSide = false;
 bottomSide = true;
 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(), OnlySMD(),
 ExcludeAllTH(), topSide, bottomSide, useCSVfmt,
  useAuxOrigin );

 if( fpcount < 0 )
 {
 msg.Printf( _( "Failed 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." ), fullcount );
 m_reporter->Report( msg, RPT_SEVERITY_INFO );
 }

 m_reporter->Report( _( "File generation successful." ), RPT_SEVERITY_INFO );

 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();
 return 0;
}


int PCB_EDIT_FRAME::DoGenFootprintsPositionFile( const wxString& aFullFileName, bool aUnitsMM,
 bool aOnlySMD, bool aNoTHItems, bool aTopSide,
 bool aBottomSide, bool aFormatCSV,
 bool aUseAuxOrigin )
{
 FILE * file = nullptr;

 if( !aFullFileName.IsEmpty() )
 {
 file = wxFopen( aFullFileName, wxT( "wt" ) );

 if( file == nullptr )
 return -1;
 }

 std::string data;
 PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, aOnlySMD, aNoTHItems, aTopSide, aBottomSide,
 aFormatCSV, aUseAuxOrigin );
 data = exporter.GenPositionData();

 // 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 );
 }

 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;

 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( _( "Failed to create file '%s'." ), fn.GetFullPath() );
 DisplayError( this, msg );
 }
}


bool PCB_EDIT_FRAME::DoGenFootprintsReport( const wxString& aFullFilename, bool aUnitsMM )
{
 FILE* rptfile = wxFopen( aFullFilename, wxT( "wt" ) );

 if( rptfile == nullptr )
 return false;

 std::string data;
 PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, false, false, true, true, false, true );
 data = exporter.GenReportData();

 fputs( data.c_str(), rptfile );
 fclose( rptfile );

 return true;
}