520 lines
17 KiB
C++
520 lines
17 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 1992-2022 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
|
|
*/
|
|
|
|
#include <pcbnew_scripting_helpers.h>
|
|
#include <pgm_base.h>
|
|
#include <kiface_base.h>
|
|
#include <kiface_ids.h>
|
|
#include <confirm.h>
|
|
#include <pcb_edit_frame.h>
|
|
#include <eda_dde.h>
|
|
#include <macros.h>
|
|
#include <wx/snglinst.h>
|
|
#include <gestfich.h>
|
|
#include <paths.h>
|
|
#include <pcbnew_settings.h>
|
|
#include <footprint_editor_settings.h>
|
|
#include <settings/settings_manager.h>
|
|
#include <settings/cvpcb_settings.h>
|
|
#include <fp_lib_table.h>
|
|
#include <footprint_edit_frame.h>
|
|
#include <footprint_viewer_frame.h>
|
|
#include <footprint_wizard_frame.h>
|
|
#include <footprint_preview_panel.h>
|
|
#include <footprint_info_impl.h>
|
|
#include <dialogs/dialog_configure_paths.h>
|
|
#include <dialog_global_fp_lib_table_config.h>
|
|
#include <panel_display_options.h>
|
|
#include <panel_edit_options.h>
|
|
#include <panel_fp_editor_defaults.h>
|
|
#include <panel_fp_editor_color_settings.h>
|
|
#include <panel_pcbnew_color_settings.h>
|
|
#include <panel_pcbnew_action_plugins.h>
|
|
#include <panel_pcbnew_display_origin.h>
|
|
#include <panel_3D_display_options.h>
|
|
#include <panel_3D_opengl_options.h>
|
|
#include <panel_3D_raytracing_options.h>
|
|
#include <panel_3D_colors.h>
|
|
#include <python_scripting.h>
|
|
|
|
#include "invoke_pcb_dialog.h"
|
|
#include <wildcards_and_files_ext.h>
|
|
#include "pcbnew_jobs_handler.h"
|
|
|
|
#include <wx/crt.h>
|
|
|
|
/* init functions defined by swig */
|
|
|
|
extern "C" PyObject* PyInit__pcbnew( void );
|
|
|
|
namespace PCB {
|
|
|
|
static struct IFACE : public KIFACE_BASE, public UNITS_PROVIDER
|
|
{
|
|
// Of course all are virtual overloads, implementations of the KIFACE.
|
|
|
|
IFACE( const char* aName, KIWAY::FACE_T aType ) :
|
|
KIFACE_BASE( aName, aType ),
|
|
UNITS_PROVIDER( pcbIUScale, EDA_UNITS::MILLIMETRES )
|
|
{}
|
|
|
|
bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits ) override;
|
|
|
|
void Reset() override;
|
|
|
|
void OnKifaceEnd() override;
|
|
|
|
wxWindow* CreateKiWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway,
|
|
int aCtlBits = 0 ) override
|
|
{
|
|
switch( aClassId )
|
|
{
|
|
case FRAME_PCB_EDITOR:
|
|
{
|
|
auto frame = new PCB_EDIT_FRAME( aKiway, aParent );
|
|
|
|
// give the scripting helpers access to our frame
|
|
ScriptingSetPcbEditFrame( frame );
|
|
|
|
if( Kiface().IsSingle() )
|
|
{
|
|
// only run this under single_top, not under a project manager.
|
|
frame->CreateServer( KICAD_PCB_PORT_SERVICE_NUMBER );
|
|
}
|
|
|
|
return frame;
|
|
}
|
|
|
|
case FRAME_FOOTPRINT_EDITOR:
|
|
return new FOOTPRINT_EDIT_FRAME( aKiway, aParent );
|
|
|
|
case FRAME_FOOTPRINT_VIEWER:
|
|
case FRAME_FOOTPRINT_VIEWER_MODAL:
|
|
return new FOOTPRINT_VIEWER_FRAME( aKiway, aParent, FRAME_T( aClassId ) );
|
|
|
|
case FRAME_FOOTPRINT_WIZARD:
|
|
return new FOOTPRINT_WIZARD_FRAME( aKiway, aParent, FRAME_T( aClassId ) );
|
|
|
|
case FRAME_FOOTPRINT_PREVIEW:
|
|
return dynamic_cast< wxWindow* >( FOOTPRINT_PREVIEW_PANEL::New( aKiway, aParent ) );
|
|
|
|
case DIALOG_CONFIGUREPATHS:
|
|
{
|
|
DIALOG_CONFIGURE_PATHS dlg( aParent );
|
|
|
|
// The dialog's constructor probably failed to set its Kiway because the
|
|
// dynamic_cast fails when aParent was allocated by a separate compilation
|
|
// module. So set it directly.
|
|
dlg.SetKiway( &dlg, aKiway );
|
|
|
|
// Use QuasiModal so that HTML help window will work
|
|
if( dlg.ShowQuasiModal() == wxID_OK )
|
|
aKiway->CommonSettingsChanged( true, false );
|
|
|
|
// Dialog has completed; nothing to return.
|
|
return nullptr;
|
|
}
|
|
|
|
case DIALOG_PCB_LIBRARY_TABLE:
|
|
InvokePcbLibTableEditor( aKiway, aParent );
|
|
// Dialog has completed; nothing to return.
|
|
return nullptr;
|
|
|
|
case PANEL_FP_DISPLAY_OPTIONS:
|
|
{
|
|
SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
|
|
APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
|
|
|
|
return new PANEL_DISPLAY_OPTIONS( aParent, cfg );
|
|
}
|
|
|
|
case PANEL_FP_EDIT_OPTIONS:
|
|
{
|
|
EDA_BASE_FRAME* frame = aKiway->Player( FRAME_FOOTPRINT_EDITOR, false );
|
|
|
|
if( !frame )
|
|
frame = aKiway->Player( FRAME_FOOTPRINT_VIEWER, false );
|
|
|
|
if( !frame )
|
|
frame = aKiway->Player( FRAME_PCB_EDITOR, false );
|
|
|
|
if( frame )
|
|
SetUserUnits( frame->GetUserUnits() );
|
|
|
|
return new PANEL_EDIT_OPTIONS( aParent, this, frame, true );
|
|
}
|
|
|
|
case PANEL_FP_DEFAULT_VALUES:
|
|
{
|
|
EDA_BASE_FRAME* frame = aKiway->Player( FRAME_FOOTPRINT_EDITOR, false );
|
|
|
|
if( !frame )
|
|
frame = aKiway->Player( FRAME_FOOTPRINT_VIEWER, false );
|
|
|
|
if( !frame )
|
|
frame = aKiway->Player( FRAME_PCB_EDITOR, false );
|
|
|
|
if( frame )
|
|
SetUserUnits( frame->GetUserUnits() );
|
|
|
|
return new PANEL_FP_EDITOR_DEFAULTS( aParent, this );
|
|
}
|
|
|
|
case PANEL_FP_COLORS:
|
|
return new PANEL_FP_EDITOR_COLOR_SETTINGS( aParent );
|
|
|
|
case PANEL_PCB_DISPLAY_OPTIONS:
|
|
{
|
|
SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
|
|
APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<PCBNEW_SETTINGS>();
|
|
|
|
return new PANEL_DISPLAY_OPTIONS( aParent, cfg );
|
|
}
|
|
|
|
case PANEL_PCB_EDIT_OPTIONS:
|
|
{
|
|
EDA_BASE_FRAME* frame = aKiway->Player( FRAME_PCB_EDITOR, false );
|
|
|
|
if( !frame )
|
|
frame = aKiway->Player( FRAME_FOOTPRINT_EDITOR, false );
|
|
|
|
if( !frame )
|
|
frame = aKiway->Player( FRAME_FOOTPRINT_VIEWER, false );
|
|
|
|
if( frame )
|
|
SetUserUnits( frame->GetUserUnits() );
|
|
|
|
return new PANEL_EDIT_OPTIONS( aParent, this, frame, false );
|
|
}
|
|
|
|
case PANEL_PCB_COLORS:
|
|
{
|
|
BOARD* board = nullptr;
|
|
EDA_BASE_FRAME* boardProvider = aKiway->Player( FRAME_PCB_EDITOR, false );
|
|
|
|
if( boardProvider )
|
|
board = static_cast<PCB_EDIT_FRAME*>( boardProvider )->GetBoard();
|
|
|
|
return new PANEL_PCBNEW_COLOR_SETTINGS( aParent, board );
|
|
}
|
|
|
|
case PANEL_PCB_ACTION_PLUGINS:
|
|
return new PANEL_PCBNEW_ACTION_PLUGINS( aParent );
|
|
|
|
case PANEL_PCB_ORIGINS_AXES:
|
|
return new PANEL_PCBNEW_DISPLAY_ORIGIN( aParent );
|
|
|
|
case PANEL_3DV_DISPLAY_OPTIONS:
|
|
return new PANEL_3D_DISPLAY_OPTIONS( aParent );
|
|
|
|
case PANEL_3DV_OPENGL:
|
|
return new PANEL_3D_OPENGL_OPTIONS( aParent );
|
|
|
|
case PANEL_3DV_RAYTRACING:
|
|
return new PANEL_3D_RAYTRACING_OPTIONS( aParent );
|
|
|
|
case PANEL_3DV_COLORS:
|
|
return new PANEL_3D_COLORS( aParent );
|
|
|
|
default:
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return a pointer to the requested object.
|
|
*
|
|
* The safest way to use this is to retrieve a pointer to a static instance of an interface,
|
|
* similar to how the KIFACE interface is exported. But if you know what you are doing use
|
|
* it to retrieve anything you want.
|
|
*
|
|
* @param aDataId identifies which object you want the address of.
|
|
* @return the object which must be cast into the know type.
|
|
*/
|
|
void* IfaceOrAddress( int aDataId ) override
|
|
{
|
|
switch( aDataId )
|
|
{
|
|
// Return a pointer to the global instance of the footprint list.
|
|
case KIFACE_FOOTPRINT_LIST:
|
|
return (void*) &GFootprintList;
|
|
|
|
// Return a new FP_LIB_TABLE with the global table installed as a fallback.
|
|
case KIFACE_NEW_FOOTPRINT_TABLE:
|
|
return (void*) new FP_LIB_TABLE( &GFootprintTable );
|
|
|
|
// Return a pointer to the global instance of the global footprint table.
|
|
case KIFACE_GLOBAL_FOOTPRINT_TABLE:
|
|
return (void*) &GFootprintTable;
|
|
|
|
case KIFACE_SCRIPTING_LEGACY:
|
|
return reinterpret_cast<void*>( PyInit__pcbnew );
|
|
|
|
default:
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Saving a file under a different name is delegated to the various KIFACEs because
|
|
* the project doesn't know the internal format of the various files (which may have
|
|
* paths in them that need updating).
|
|
*/
|
|
void SaveFileAs( const wxString& aProjectBasePath, const wxString& aSrcProjectName,
|
|
const wxString& aNewProjectBasePath, const wxString& aNewProjectName,
|
|
const wxString& aSrcFilePath, wxString& aErrors ) override;
|
|
|
|
int HandleJob( JOB* aJob ) override;
|
|
|
|
private:
|
|
bool loadGlobalLibTable();
|
|
|
|
std::unique_ptr<PCBNEW_JOBS_HANDLER> m_jobHandler;
|
|
|
|
} kiface( "pcbnew", KIWAY::FACE_PCB );
|
|
|
|
} // namespace
|
|
|
|
|
|
using namespace PCB;
|
|
|
|
|
|
static PGM_BASE* process;
|
|
|
|
|
|
KIFACE_BASE& Kiface() { return kiface; }
|
|
|
|
|
|
// KIFACE_GETTER's actual spelling is a substitution macro found in kiway.h.
|
|
// KIFACE_GETTER will not have name mangling due to declaration in kiway.h.
|
|
MY_API( KIFACE* ) KIFACE_GETTER( int* aKIFACEversion, int aKiwayVersion, PGM_BASE* aProgram )
|
|
{
|
|
process = aProgram;
|
|
return &kiface;
|
|
}
|
|
|
|
|
|
#if defined( BUILD_KIWAY_DLL )
|
|
PGM_BASE& Pgm()
|
|
{
|
|
wxASSERT( process ); // KIFACE_GETTER has already been called.
|
|
return *process;
|
|
}
|
|
|
|
|
|
// Similar to PGM_BASE& Pgm(), but return nullptr when a *.ki_face is run from a python script.
|
|
PGM_BASE* PgmOrNull()
|
|
{
|
|
return process;
|
|
}
|
|
#endif
|
|
|
|
|
|
/// The global footprint library table. This is not dynamically allocated because
|
|
/// in a multiple project environment we must keep its address constant (since it is
|
|
/// the fallback table for multiple projects).
|
|
FP_LIB_TABLE GFootprintTable;
|
|
|
|
/// The global footprint info table. This is performance-intensive to build so we
|
|
/// keep a hash-stamped global version. Any deviation from the request vs. stored
|
|
/// hash will result in it being rebuilt.
|
|
FOOTPRINT_LIST_IMPL GFootprintList;
|
|
|
|
|
|
bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits )
|
|
{
|
|
// This is process-level-initialization, not project-level-initialization of the DSO.
|
|
// Do nothing in here pertinent to a project!
|
|
InitSettings( new PCBNEW_SETTINGS );
|
|
aProgram->GetSettingsManager().RegisterSettings( new FOOTPRINT_EDITOR_SETTINGS );
|
|
aProgram->GetSettingsManager().RegisterSettings( new EDA_3D_VIEWER_SETTINGS );
|
|
|
|
// We intentionally register KifaceSettings after FOOTPRINT_EDITOR_SETTINGS and EDA_3D_VIEWER_SETTINGS
|
|
// In legacy configs, many settings were in a single editor config and the migration routine
|
|
// for the main editor file will try and call into the now separate settings stores
|
|
// to move the settings into them
|
|
aProgram->GetSettingsManager().RegisterSettings( KifaceSettings() );
|
|
|
|
// Register the footprint editor settings as well because they share a KiFACE and need to be
|
|
// loaded prior to use to avoid threading deadlocks
|
|
aProgram->GetSettingsManager().RegisterSettings( new CVPCB_SETTINGS );
|
|
|
|
start_common( aCtlBits );
|
|
|
|
if( !loadGlobalLibTable() )
|
|
return false;
|
|
|
|
m_jobHandler = std::make_unique<PCBNEW_JOBS_HANDLER>();
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void IFACE::Reset()
|
|
{
|
|
loadGlobalLibTable();
|
|
}
|
|
|
|
|
|
bool IFACE::loadGlobalLibTable()
|
|
{
|
|
wxFileName fn = FP_LIB_TABLE::GetGlobalTableFileName();
|
|
|
|
if( !fn.FileExists() )
|
|
{
|
|
if( !( m_start_flags & KFCTL_CLI ) )
|
|
{
|
|
DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG fpDialog( nullptr );
|
|
|
|
fpDialog.ShowModal();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
try
|
|
{
|
|
// The global table is not related to a specific project. All projects
|
|
// will use the same global table. So the KIFACE::OnKifaceStart() contract
|
|
// of avoiding anything project specific is not violated here.
|
|
if( !FP_LIB_TABLE::LoadGlobalTable( GFootprintTable ) )
|
|
return false;
|
|
}
|
|
catch( const IO_ERROR& ioe )
|
|
{
|
|
// if we are here, a incorrect global footprint library table was found.
|
|
// Incorrect global symbol library table is not a fatal error:
|
|
// the user just has to edit the (partially) loaded table.
|
|
wxString msg = _( "An error occurred attempting to load the global footprint library "
|
|
"table.\n"
|
|
"Please edit this global footprint library table in Preferences "
|
|
"menu." );
|
|
|
|
DisplayErrorMessage( nullptr, msg, ioe.What() );
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void IFACE::OnKifaceEnd()
|
|
{
|
|
end_common();
|
|
}
|
|
|
|
|
|
void IFACE::SaveFileAs( const wxString& aProjectBasePath, const wxString& aSrcProjectName,
|
|
const wxString& aNewProjectBasePath, const wxString& aNewProjectName,
|
|
const wxString& aSrcFilePath, wxString& aErrors )
|
|
{
|
|
wxFileName destFile( aSrcFilePath );
|
|
wxString destPath = destFile.GetPathWithSep();
|
|
wxUniChar pathSep = wxFileName::GetPathSeparator();
|
|
wxString ext = destFile.GetExt();
|
|
|
|
if( destPath.StartsWith( aProjectBasePath + pathSep ) )
|
|
destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
|
|
|
|
wxString srcProjectFootprintLib = pathSep + aSrcProjectName + wxT( ".pretty" ) + pathSep;
|
|
wxString newProjectFootprintLib = pathSep + aNewProjectName + wxT( ".pretty" ) + pathSep;
|
|
|
|
destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib, true );
|
|
|
|
destFile.SetPath( destPath );
|
|
|
|
if( ext == KiCadPcbFileExtension || ext == KiCadPcbFileExtension + BackupFileSuffix )
|
|
{
|
|
if( destFile.GetName() == aSrcProjectName )
|
|
destFile.SetName( aNewProjectName );
|
|
|
|
KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
|
|
}
|
|
else if( ext == LegacyPcbFileExtension )
|
|
{
|
|
if( destFile.GetName() == aSrcProjectName )
|
|
destFile.SetName( aNewProjectName );
|
|
|
|
KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
|
|
}
|
|
else if( ext == LegacyFootprintLibPathExtension || ext == KiCadFootprintFileExtension )
|
|
{
|
|
// Footprints are not project-specific. Keep their source names.
|
|
KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
|
|
}
|
|
else if( ext == FootprintAssignmentFileExtension )
|
|
{
|
|
// TODO
|
|
}
|
|
else if( ext == wxT( "rpt" ) )
|
|
{
|
|
// DRC must be the "gold standard". Since we can't guarantee that there aren't
|
|
// any non-deterministic cases in the save-as algorithm, we don't want to certify
|
|
// the result with the source's DRC report. Therefore copy it under the old
|
|
// name.
|
|
KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
|
|
}
|
|
else if( destFile.GetName() == wxT( "fp-lib-table" ) )
|
|
{
|
|
try
|
|
{
|
|
FP_LIB_TABLE fpLibTable;
|
|
fpLibTable.Load( aSrcFilePath );
|
|
|
|
for( unsigned i = 0; i < fpLibTable.GetCount(); i++ )
|
|
{
|
|
LIB_TABLE_ROW& row = fpLibTable.At( i );
|
|
wxString uri = row.GetFullURI();
|
|
|
|
uri.Replace( wxT( "/" ) + aSrcProjectName + wxT( ".pretty" ),
|
|
wxT( "/" ) + aNewProjectName + wxT( ".pretty" ) );
|
|
|
|
row.SetFullURI( uri );
|
|
}
|
|
|
|
fpLibTable.Save( destFile.GetFullPath() );
|
|
}
|
|
catch( ... )
|
|
{
|
|
wxString msg;
|
|
|
|
if( !aErrors.empty() )
|
|
aErrors += wxT( "\n" );
|
|
|
|
msg.Printf( _( "Cannot copy file '%s'." ), destFile.GetFullPath() );
|
|
aErrors += msg;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
wxFAIL_MSG( wxT( "Unexpected filetype for Pcbnew::SaveFileAs()" ) );
|
|
}
|
|
}
|
|
|
|
|
|
int IFACE::HandleJob( JOB* aJob )
|
|
{
|
|
return m_jobHandler->RunJob( aJob );
|
|
}
|