pcbnew_scripting_helpers.cpp File Reference

Scripting helper functions for pcbnew functionality. More...

#include <Python.h>
#include "pcbnew_scripting_helpers.h"
#include <tool/tool_manager.h>
#include <action_plugin.h>
#include <board.h>
#include <board_design_settings.h>
#include <pcb_marker.h>
#include <cstdlib>
#include <drc/drc_engine.h>
#include <drc/drc_item.h>
#include <fp_lib_table.h>
#include <ignore.h>
#include <io_mgr.h>
#include <string_utils.h>
#include <macros.h>
#include <project.h>
#include <project/net_settings.h>
#include <project/project_file.h>
#include <settings/settings_manager.h>
#include <specctra.h>
#include <project/project_local_settings.h>
#include <wildcards_and_files_ext.h>
#include <locale_io.h>
#include <wx/app.h>

Go to the source code of this file.

Functions
BOARD *	GetBoard ()
void	ScriptingSetPcbEditFrame (PCB_EDIT_FRAME *aPcbEditFrame)
BOARD *	LoadBoard (wxString &aFileName)
SETTINGS_MANAGER *	GetSettingsManager ()
PROJECT *	GetDefaultProject ()
BOARD *	LoadBoard (wxString &aFileName, IO_MGR::PCB_FILE_T aFormat)
BOARD *	NewBoard (wxString &aFileName)
	Creates a new board and project with the given filename (will overwrite existing files!) More...
BOARD *	CreateEmptyBoard ()
	Construct a default BOARD with a temporary (no filename) project. More...
bool	SaveBoard (wxString &aFileName, BOARD *aBoard, IO_MGR::PCB_FILE_T aFormat, bool aSkipSettings)
bool	SaveBoard (wxString &aFileName, BOARD *aBoard, bool aSkipSettings)
	Saves a copy of the given board and its associated project to the given path. More...
FP_LIB_TABLE *	GetFootprintLibraryTable ()
wxArrayString	GetFootprintLibraries ()
	Get the nicknames of all of the footprint libraries configured in pcbnew in both the project and global library tables. More...
wxArrayString	GetFootprints (const wxString &aNickName)
	Get the names of all of the footprints available in a footprint library. More...
bool	ExportSpecctraDSN (wxString &aFullFilename)
	Will export the current BOARD to a specctra dsn file. More...
bool	ExportSpecctraDSN (BOARD *aBoard, wxString &aFullFilename)
	Will export the BOARD to a specctra dsn file. More...
bool	ExportVRML (const wxString &aFullFileName, double aMMtoWRMLunit, bool aExport3DFiles, bool aUseRelativePaths, const wxString &a3D_Subdir, double aXRef, double aYRef)
	Export the current BOARD to a VRML (wrl) file. More...
bool	ImportSpecctraSES (wxString &aFullFilename)
	Import a specctra *.ses file and use it to relocate MODULEs and to replace all vias and tracks in an existing and loaded BOARD. More...
bool	ExportFootprintsToLibrary (bool aStoreInNewLib, const wxString &aLibName, wxString *aLibPath)
	Save footprints in a library: More...
void	Refresh ()
	Update the board display after modifying it by a python script (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins. More...
void	UpdateUserInterface ()
	Update the layer manager and other widgets from the board setup (layer and items visibility, colors ...) (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins. More...
int	GetUserUnits ()
	Return the currently selected user unit value for the interface. More...
bool	IsActionRunning ()
	Are we currently in an action plugin? More...
bool	WriteDRCReport (BOARD *aBoard, const wxString &aFileName, EDA_UNITS aUnits, bool aReportAllTrackErrors)
	Run the DRC check on the given board and writes the results to a report file. More...

Variables
static PCB_EDIT_FRAME *	s_PcbEditFrame = nullptr
static SETTINGS_MANAGER *	s_SettingsManager = nullptr

Detailed Description

Scripting helper functions for pcbnew functionality.

Definition in file pcbnew_scripting_helpers.cpp.

Function Documentation

CreateEmptyBoard()

BOARD * CreateEmptyBoard

(

)

Construct a default BOARD with a temporary (no filename) project.

Returns

the created board.

Definition at line 227 of file pcbnew_scripting_helpers.cpp.

{
 // Creating a new board is not possible if running inside KiCad
 if( s_PcbEditFrame )
 return nullptr;
 
 BOARD* brd = new BOARD();
 
 brd->SetProject( GetDefaultProject() );
 
 return brd;
}

References GetDefaultProject(), s_PcbEditFrame, and BOARD::SetProject().

ExportFootprintsToLibrary()

bool ExportFootprintsToLibrary	(	bool	aStoreInNewLib,
		const wxString &	aLibName = wxEmptyString,
		wxString *	aLibPath = nullptr
	)

Save footprints in a library:

Parameters

aStoreInNewLib	set to true to save footprints in a existing lib. Existing footprints will be kept or updated. This lib should be in fp lib table, and is type is .pretty. Set to false to save footprints in a new lib. If it is an existing lib, previous footprints will be removed.
aLibName	is the optional library name to create, stops dialog call. Must be called with aStoreInNewLib as true.

Definition at line 384 of file pcbnew_scripting_helpers.cpp.

{
 if( s_PcbEditFrame )
 {
 s_PcbEditFrame->ExportFootprintsToLibrary( aStoreInNewLib, aLibName, aLibPath );
 return true;
 }
 else
 {
 return false;
 }
}

References PCB_EDIT_FRAME::ExportFootprintsToLibrary(), and s_PcbEditFrame.

ExportSpecctraDSN() [1/2]

bool ExportSpecctraDSN	(	BOARD *	aBoard,
		wxString &	aFullFilename
	)

Will export the BOARD to a specctra dsn file.

Unlike first overload doesn't need a valid PCB_EDIT_FRAME set and can be used in a standalone python script.

See http://www.autotraxeda.com/docs/SPECCTRA/SPECCTRA.pdf for the specification.

Returns

true if OK

Definition at line 339 of file pcbnew_scripting_helpers.cpp.

{
 try
 {
 ExportBoardToSpecctraFile( aBoard, aFullFilename );
 }
 catch( ... )
 {
 return false;
 }
 
 return true;
}

References ExportBoardToSpecctraFile().

ExportSpecctraDSN() [2/2]

bool ExportSpecctraDSN

(

wxString &

aFullFilename

)

Will export the current BOARD to a specctra dsn file.

See http://www.autotraxeda.com/docs/SPECCTRA/SPECCTRA.pdf for the specification.

Returns

true if OK

Definition at line 325 of file pcbnew_scripting_helpers.cpp.

{
 if( s_PcbEditFrame )
 {
 bool ok = s_PcbEditFrame->ExportSpecctraFile( aFullFilename );
 return ok;
 }
 else
 {
 return false;
 }
}

References PCB_EDIT_FRAME::ExportSpecctraFile(), and s_PcbEditFrame.

ExportVRML()

bool ExportVRML	(	const wxString &	aFullFileName,
		double	aMMtoWRMLunit,
		bool	aExport3DFiles,
		bool	aUseRelativePaths,
		const wxString &	a3D_Subdir,
		double	aXRef,
		double	aYRef
	)

Export the current BOARD to a VRML (wrl) file.

See ExportVRML_File in pcb_edit_frame.h for detailed documentation.

Returns

true if OK.

Definition at line 354 of file pcbnew_scripting_helpers.cpp.

{
 if( s_PcbEditFrame )
 {
 bool ok = s_PcbEditFrame->ExportVRML_File( aFullFileName, aMMtoWRMLunit,
 aExport3DFiles, aUseRelativePaths,
 a3D_Subdir, aXRef, aYRef );
 return ok;
 }
 else
 {
 return false;
 }
}

References PCB_EDIT_FRAME::ExportVRML_File(), and s_PcbEditFrame.

GetBoard()

BOARD * GetBoard

(

)

Definition at line 64 of file pcbnew_scripting_helpers.cpp.

{
 if( s_PcbEditFrame )
 return s_PcbEditFrame->GetBoard();
 else
 return nullptr;
}

References PCB_BASE_FRAME::GetBoard(), and s_PcbEditFrame.

Referenced by ZONE_FILLER_TOOL::CheckAllZones(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), PCB_LAYER_VALUE::EqualTo(), EVT_GRID_CMD_CELL_CHANGED(), EVT_TOOL_RANGE(), EDIT_TOOL::FilletTracks(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GetFootprintLibraryTable(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), ROUTER_TOOL::SelectCopperLayerPair(), GLOBAL_EDIT_TOOL::SwapLayers(), and PCB_PROPERTIES_PANEL::UpdateData().

GetDefaultProject()

PROJECT * GetDefaultProject

(

)

Definition at line 111 of file pcbnew_scripting_helpers.cpp.

{
 // For some reasons, LoadProject() needs a C locale, so ensure we have the right locale
 // This is mainly when running QA Python tests
 LOCALE_IO dummy;
 
 PROJECT* project = GetSettingsManager()->GetProject( "" );
 
 if( !project )
 {
 GetSettingsManager()->LoadProject( "" );
 project = GetSettingsManager()->GetProject( "" );
 }
 
 return project;
}

References dummy(), SETTINGS_MANAGER::GetProject(), GetSettingsManager(), SETTINGS_MANAGER::LoadProject(), and project.

Referenced by CreateEmptyBoard(), and LoadBoard().

GetFootprintLibraries()

wxArrayString GetFootprintLibraries

(

)

Get the nicknames of all of the footprint libraries configured in pcbnew in both the project and global library tables.

Returns

the list of footprint library nicknames, empty on error.

Definition at line 294 of file pcbnew_scripting_helpers.cpp.

{
 wxArrayString footprintLibraryNames;
 
 FP_LIB_TABLE* tbl = GetFootprintLibraryTable();
 
 if( !tbl )
 return footprintLibraryNames;
 
 for( const wxString& name : tbl->GetLogicalLibs() )
 footprintLibraryNames.Add( name );
 
 return footprintLibraryNames;
}

References GetFootprintLibraryTable(), LIB_TABLE::GetLogicalLibs(), and name.

GetFootprintLibraryTable()

FP_LIB_TABLE * GetFootprintLibraryTable

(

)

Definition at line 278 of file pcbnew_scripting_helpers.cpp.

{
 BOARD* board = GetBoard();
 
 if( !board )
 return nullptr;
 
 PROJECT* project = board->GetProject();
 
 if( !project )
 return nullptr;
 
 return project->PcbFootprintLibs();
}

References GetBoard(), BOARD::GetProject(), and project.

Referenced by GetFootprintLibraries(), and GetFootprints().

GetFootprints()

wxArrayString GetFootprints

(

const wxString &

aNickName

)

Get the names of all of the footprints available in a footprint library.

Parameters

aNickName

is the nickname specifying which footprint library to fetch from.

Returns

the list of footprint names, empty on error.

Definition at line 310 of file pcbnew_scripting_helpers.cpp.

{
 wxArrayString footprintNames;
 
 FP_LIB_TABLE* tbl = GetFootprintLibraryTable();
 
 if( !tbl )
 return footprintNames;
 
 tbl->FootprintEnumerate( footprintNames, aNickName, true );
 
 return footprintNames;
}

References FP_LIB_TABLE::FootprintEnumerate(), and GetFootprintLibraryTable().

GetSettingsManager()

SETTINGS_MANAGER * GetSettingsManager

(

)

Definition at line 91 of file pcbnew_scripting_helpers.cpp.

{
 if( !s_SettingsManager )
 {
 if( s_PcbEditFrame )
 {
 s_SettingsManager = s_PcbEditFrame->GetSettingsManager();
 }
 else
 {
 // Ensure wx system settings stuff is available
 ignore_unused( wxTheApp );
 s_SettingsManager = new SETTINGS_MANAGER( true );
 }
 }
 
 return s_SettingsManager;
}

References EDA_BASE_FRAME::GetSettingsManager(), ignore_unused(), s_PcbEditFrame, and s_SettingsManager.

Referenced by PANEL_COLOR_SETTINGS::createThemeList(), EDA_3D_CANVAS::EDA_3D_CANVAS(), GetDefaultProject(), LoadBoard(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), NewBoard(), PGM_SINGLE_TOP::OnPgmInit(), PROJECT::PinLibrary(), EDA_3D_CANVAS::ReloadRequest(), SaveBoard(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), and PROJECT::UnpinLibrary().

GetUserUnits()

int GetUserUnits

(

)

Return the currently selected user unit value for the interface.

Returns

0 = Inches, 1=mm, -1 if the frame isn't set

Definition at line 433 of file pcbnew_scripting_helpers.cpp.

{
 if( s_PcbEditFrame )
 return static_cast<int>( s_PcbEditFrame->GetUserUnits() );
 
 return -1;
}

References UNITS_PROVIDER::GetUserUnits(), and s_PcbEditFrame.

Referenced by DRAWING_TOOL::drawArc(), and DRAWING_TOOL::drawShape().

ImportSpecctraSES()

bool ImportSpecctraSES

(

wxString &

aFullFilename

)

Import a specctra *.ses file and use it to relocate MODULEs and to replace all vias and tracks in an existing and loaded BOARD.

See http://www.autotraxeda.com/docs/SPECCTRA/SPECCTRA.pdf for the specification.

Returns

true if OK

Definition at line 370 of file pcbnew_scripting_helpers.cpp.

{
 if( s_PcbEditFrame )
 {
 bool ok = s_PcbEditFrame->ImportSpecctraSession( aFullFilename );
 return ok;
 }
 else
 {
 return false;
 }
}

References PCB_EDIT_FRAME::ImportSpecctraSession(), and s_PcbEditFrame.

IsActionRunning()

bool IsActionRunning

(

)

Are we currently in an action plugin?

Definition at line 442 of file pcbnew_scripting_helpers.cpp.

{
 return ACTION_PLUGINS::IsActionRunning();
}

References ACTION_PLUGINS::IsActionRunning().

LoadBoard() [1/2]

BOARD * LoadBoard

(

wxString &

aFileName

)

Definition at line 79 of file pcbnew_scripting_helpers.cpp.

{
 if( aFileName.EndsWith( KiCadPcbFileExtension ) )
 return LoadBoard( aFileName, IO_MGR::KICAD_SEXP );
 else if( aFileName.EndsWith( LegacyPcbFileExtension ) )
 return LoadBoard( aFileName, IO_MGR::LEGACY );
 
 // as fall back for any other kind use the legacy format
 return LoadBoard( aFileName, IO_MGR::LEGACY );
}

References IO_MGR::KICAD_SEXP, KiCadPcbFileExtension, IO_MGR::LEGACY, LegacyPcbFileExtension, and LoadBoard().

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and LoadBoard().

LoadBoard() [2/2]

BOARD * LoadBoard	(	wxString &	aFileName,
		IO_MGR::PCB_FILE_T	aFormat
	)

Definition at line 129 of file pcbnew_scripting_helpers.cpp.

{
 wxFileName pro = aFileName;
 pro.SetExt( ProjectFileExtension );
 pro.MakeAbsolute();
 wxString projectPath = pro.GetFullPath();
 
 // Ensure the "C" locale is temporary set, before reading any file
 // It also avoid wxWidget alerts about locale issues, later, when using Python 3
 LOCALE_IO dummy;
 
 PROJECT* project = GetSettingsManager()->GetProject( projectPath );
 
 if( !project )
 {
 if( wxFileExists( projectPath ) )
 {
 GetSettingsManager()->LoadProject( projectPath, false );
 project = GetSettingsManager()->GetProject( projectPath );
 }
 }
 else if( s_PcbEditFrame && project == &GetSettingsManager()->Prj() )
 {
 // Project is already loaded? Then so is the board
 return s_PcbEditFrame->GetBoard();
 }
 
 // Board cannot be loaded without a project, so create the default project
 if( !project )
 project = GetDefaultProject();
 
 BOARD* brd = IO_MGR::Load( aFormat, aFileName );
 
 if( brd )
 {
 brd->SetProject( project );
 
 // Move legacy view settings to local project settings
 if( !brd->m_LegacyVisibleLayers.test( Rescue ) )
 project->GetLocalSettings().m_VisibleLayers = brd->m_LegacyVisibleLayers;
 
 if( !brd->m_LegacyVisibleItems.test( GAL_LAYER_INDEX( GAL_LAYER_ID_BITMASK_END ) ) )
 project->GetLocalSettings().m_VisibleItems = brd->m_LegacyVisibleItems;
 
 BOARD_DESIGN_SETTINGS& bds = brd->GetDesignSettings();
 bds.m_DRCEngine = std::make_shared<DRC_ENGINE>( brd, &bds );
 
 try
 {
 wxFileName rules = pro;
 rules.SetExt( DesignRulesFileExtension );
 bds.m_DRCEngine->InitEngine( rules );
 }
 catch( ... )
 {
 // Best efforts...
 }
 
 for( PCB_MARKER* marker : brd->ResolveDRCExclusions() )
 brd->Add( marker );
 
 brd->BuildConnectivity();
 brd->BuildListOfNets();
 brd->SynchronizeNetsAndNetClasses();
 }
 
 return brd;
}

References BOARD::Add(), BOARD::BuildConnectivity(), BOARD::BuildListOfNets(), DesignRulesFileExtension, dummy(), GAL_LAYER_ID_BITMASK_END, GAL_LAYER_INDEX, PCB_BASE_FRAME::GetBoard(), GetDefaultProject(), BOARD::GetDesignSettings(), SETTINGS_MANAGER::GetProject(), GetSettingsManager(), IO_MGR::Load(), SETTINGS_MANAGER::LoadProject(), BOARD_DESIGN_SETTINGS::m_DRCEngine, BOARD::m_LegacyVisibleItems, BOARD::m_LegacyVisibleLayers, Prj(), project, ProjectFileExtension, Rescue, BOARD::ResolveDRCExclusions(), s_PcbEditFrame, BOARD::SetProject(), and BOARD::SynchronizeNetsAndNetClasses().

NewBoard()

BOARD * NewBoard

(

wxString &

aFileName

)

Creates a new board and project with the given filename (will overwrite existing files!)

Parameters

aFileName

is the filename (including full path if desired) of the kicad_pcb to create

Returns

a pointer to the board if it was created, or None if not

Definition at line 199 of file pcbnew_scripting_helpers.cpp.

{
 wxFileName boardFn = aFileName;
 wxFileName proFn = aFileName;
 proFn.SetExt( ProjectFileExtension );
 proFn.MakeAbsolute();
 
 wxString projectPath = proFn.GetFullPath();
 
 // Ensure the "C" locale is temporary set, before reading any file
 // It also avoids wxWidgets alerts about locale issues, later, when using Python 3
 LOCALE_IO dummy;
 
 GetSettingsManager()->LoadProject( projectPath, false );
 PROJECT* project = GetSettingsManager()->GetProject( projectPath );
 
 BOARD* brd = new BOARD();
 
 brd->SetProject( project );
 BOARD_DESIGN_SETTINGS& bds = brd->GetDesignSettings();
 bds.m_DRCEngine = std::make_shared<DRC_ENGINE>( brd, &bds );
 
 SaveBoard( aFileName, brd );
 
 return brd;
}

References dummy(), BOARD::GetDesignSettings(), SETTINGS_MANAGER::GetProject(), GetSettingsManager(), SETTINGS_MANAGER::LoadProject(), BOARD_DESIGN_SETTINGS::m_DRCEngine, project, ProjectFileExtension, SaveBoard(), and BOARD::SetProject().

Refresh()

void Refresh

(

)

Update the board display after modifying it by a python script (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins.

Could be deprecated because modifying a board (especially deleting items) outside a action plugin can crash Pcbnew.

Definition at line 397 of file pcbnew_scripting_helpers.cpp.

{
 if( s_PcbEditFrame )
 {
 TOOL_MANAGER* toolMgr = s_PcbEditFrame->GetToolManager();
 BOARD* board = s_PcbEditFrame->GetBoard();
 PCB_DRAW_PANEL_GAL* canvas = s_PcbEditFrame->GetCanvas();
 
 canvas->SyncLayersVisibility( board );
 
 canvas->GetView()->Clear();
 canvas->GetView()->InitPreview();
 canvas->GetGAL()->SetGridOrigin( VECTOR2D( board->GetDesignSettings().GetGridOrigin() ) );
 canvas->DisplayBoard( board );
 
 // allow tools to re-add their view items (selection previews, grids, etc.)
 if( toolMgr )
 toolMgr->ResetTools( TOOL_BASE::GAL_SWITCH );
 
 // reload the drawing-sheet
 s_PcbEditFrame->SetPageSettings( board->GetPageSettings() );
 
 board->BuildConnectivity();
 
 canvas->Refresh();
 }
}

References BOARD::BuildConnectivity(), KIGFX::VIEW::Clear(), PCB_DRAW_PANEL_GAL::DisplayBoard(), TOOL_BASE::GAL_SWITCH, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetDesignSettings(), EDA_DRAW_PANEL_GAL::GetGAL(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), BOARD::GetPageSettings(), TOOLS_HOLDER::GetToolManager(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::InitPreview(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::ResetTools(), s_PcbEditFrame, KIGFX::GAL::SetGridOrigin(), PCB_EDIT_FRAME::SetPageSettings(), and PCB_DRAW_PANEL_GAL::SyncLayersVisibility().

Referenced by EDA_MSG_PANEL::AppendMessage(), BITMAP_BUTTON::Check(), EDA_3D_MODEL_VIEWER::Clear3DModel(), ACTION_TOOLBAR::doSelectAction(), SYMBOL_EDIT_FRAME::emptyScreen(), BITMAP_BUTTON::Enable(), SPLIT_BUTTON::Enable(), EDA_MSG_PANEL::EraseMsgBox(), PANEL_CORROSION::FillTable(), PCB_EDIT_FRAME::ImportSpecctraSession(), ACTION_TOOLBAR::KiRealize(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PANEL_ATTENUATORS::OnAttenuatorSelection(), APPEARANCE_CONTROLS::OnBoardChanged(), PCB_EDIT_FRAME::onBoardLoaded(), WX_COLLAPSIBLE_PANE_HEADER::onEnterWindow(), EDA_3D_CANVAS::OnEvent(), WX_COLLAPSIBLE_PANE_HEADER::onFocus(), BITMAP_BUTTON::OnKillFocus(), SPLIT_BUTTON::OnKillFocus(), APPEARANCE_CONTROLS::OnLanguageChanged(), APPEARANCE_CONTROLS::OnLayerChanged(), PANEL_SETUP_BOARD_STACKUP::OnLayersOptionsChanged(), WX_COLLAPSIBLE_PANE_HEADER::onLeaveWindow(), BITMAP_BUTTON::OnLeftButtonDown(), SPLIT_BUTTON::OnLeftButtonDown(), BITMAP_BUTTON::OnLeftButtonUp(), SPLIT_BUTTON::OnLeftButtonUp(), BM2CMP_FRAME::OnLoadFile(), BITMAP_BUTTON::OnMouseEnter(), SPLIT_BUTTON::OnMouseEnter(), BITMAP_BUTTON::OnMouseLeave(), SPLIT_BUTTON::OnMouseLeave(), EDA_3D_MODEL_VIEWER::OnMouseMove(), EDA_3D_MODEL_VIEWER::OnMouseWheel(), BM2CMP_FRAME::OnNegativeClicked(), DIALOG_TEMPLATE_SELECTOR::onNotebookResize(), LAYERS_MAP_DIALOG::OnResetClick(), LAYERS_MAP_DIALOG::OnSelectLayer(), BITMAP_BUTTON::OnSetFocus(), PANEL_PACKAGES_VIEW::OnSizeInfoBox(), SPLIT_BUTTON::onThemeChanged(), BM2CMP_FRAME::OnThresholdChange(), PANEL_TRANSLINE::OnTransLineResetButtonClick(), PANEL_TRANSLINE::OnTranslineSelection(), ACTION_TOOLBAR::RefreshBitmaps(), PANEL_REGULATOR::RegulatorPageUpdate(), DIALOG_JUNCTION_PROPS::resetDefaults(), DIALOG_LINE_PROPERTIES::resetDefaults(), DIALOG_WIRE_BUS_PROPERTIES::resetDefaults(), TEMPLATE_WIDGET::Select(), EDA_3D_MODEL_VIEWER::Set3DModel(), WX_COLLAPSIBLE_PANE_HEADER::SetCollapsed(), SPLIT_BUTTON::SetLabel(), EDA_MSG_PANEL::SetMessage(), PANEL_PACKAGE::SetSelected(), FOOTPRINTS_LISTBOX::SetSelection(), LIBRARY_LISTBOX::SetSelection(), PANEL_ATTENUATORS::ThemeChanged(), PANEL_COLOR_CODE::ThemeChanged(), PANEL_COLOR_CODE::ToleranceSelection(), TEMPLATE_WIDGET::Unselect(), mpWindow::UpdateAll(), KIGFX::CAIRO_GAL::updatedGalDisplayOptions(), KIGFX::OPENGL_GAL::updatedGalDisplayOptions(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), and NUMBER_BADGE::UpdateNumber().

SaveBoard() [1/2]

bool SaveBoard	(	wxString &	aFileName,
		BOARD *	aBoard,
		bool	aSkipSettings = false
	)

Saves a copy of the given board and its associated project to the given path.

Boards can only be saved in KiCad native format.

Parameters

aFileName	is the full path to save a copy to.
aBoard	is a pointer to a loaded BOARD to save.
aSkipSettings	if true, only save the board file. This will lose settings changes that are saved in the project file

Returns

true if the save was completed.

Definition at line 272 of file pcbnew_scripting_helpers.cpp.

{
 return SaveBoard( aFileName, aBoard, IO_MGR::KICAD_SEXP, aSkipSettings );
}

References IO_MGR::KICAD_SEXP, and SaveBoard().

SaveBoard() [2/2]

bool SaveBoard	(	wxString &	aFileName,
		BOARD *	aBoard,
		IO_MGR::PCB_FILE_T	aFormat,
		bool	aSkipSettings
	)

Definition at line 241 of file pcbnew_scripting_helpers.cpp.

{
 aBoard->BuildConnectivity();
 aBoard->SynchronizeNetsAndNetClasses();
 
 // Ensure the "C" locale is temporary set, before saving any file
 // It also avoid wxWidget alerts about locale issues, later, when using Python 3
 LOCALE_IO dummy;
 
 try
 {
 IO_MGR::Save( aFormat, aFileName, aBoard, nullptr );
 }
 catch( ... )
 {
 return false;
 }
 
 if( !aSkipSettings )
 {
 wxFileName pro = aFileName;
 pro.SetExt( ProjectFileExtension );
 pro.MakeAbsolute();
 
 GetSettingsManager()->SaveProjectAs( pro.GetFullPath(), aBoard->GetProject() );
 }
 
 return true;
}

References BOARD::BuildConnectivity(), dummy(), BOARD::GetProject(), GetSettingsManager(), ProjectFileExtension, IO_MGR::Save(), SETTINGS_MANAGER::SaveProjectAs(), and BOARD::SynchronizeNetsAndNetClasses().

Referenced by NewBoard(), and SaveBoard().

ScriptingSetPcbEditFrame()

void ScriptingSetPcbEditFrame

(

PCB_EDIT_FRAME *

aPcbEditFrame

)

Definition at line 73 of file pcbnew_scripting_helpers.cpp.

{
 s_PcbEditFrame = aPcbEditFrame;
}

References s_PcbEditFrame.

Referenced by PCB::IFACE::CreateKiWindow().

UpdateUserInterface()

void UpdateUserInterface

(

)

Update the layer manager and other widgets from the board setup (layer and items visibility, colors ...) (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins.

Definition at line 426 of file pcbnew_scripting_helpers.cpp.

{
 if( s_PcbEditFrame )
 s_PcbEditFrame->UpdateUserInterface();
}

References s_PcbEditFrame, and PCB_EDIT_FRAME::UpdateUserInterface().

WriteDRCReport()

bool WriteDRCReport	(	BOARD *	aBoard,
		const wxString &	aFileName,
		EDA_UNITS	aUnits,
		bool	aReportAllTrackErrors
	)

Run the DRC check on the given board and writes the results to a report file.

Requires that the project for the board be loaded, and note that unlike the DRC dialog this does not attempt to fill zones, so zones must be valid before calling.

Parameters

aBoard	is a valid loaded board.
aFileName	is the full path and name of the report file to write.
aUnits	is the units to use in the report.
aReportAllTrackErrors	controls whether all errors or just the first error is reported for each track.

Returns

true if successful, false if not.

Definition at line 448 of file pcbnew_scripting_helpers.cpp.

{
 wxCHECK( aBoard, false );
 
 BOARD_DESIGN_SETTINGS& bds = aBoard->GetDesignSettings();
 std::shared_ptr<DRC_ENGINE> engine = bds.m_DRCEngine;
 UNITS_PROVIDER unitsProvider( pcbIUScale, aUnits );
 
 if( !engine )
 {
 bds.m_DRCEngine = std::make_shared<DRC_ENGINE>( aBoard, &bds );
 engine = bds.m_DRCEngine;
 }
 
 wxCHECK( engine, false );
 
 wxFileName fn = aBoard->GetFileName();
 fn.SetExt( DesignRulesFileExtension );
 PROJECT* prj = nullptr;
 
 if( aBoard->GetProject() )
 prj = aBoard->GetProject();
 else if( s_SettingsManager )
 prj = &s_SettingsManager->Prj();
 
 wxCHECK( prj, false );
 
 wxString drcRulesPath = prj->AbsolutePath( fn.GetFullName() );
 
 try
 {
 engine->InitEngine( drcRulesPath );
 }
 catch( PARSE_ERROR& )
 {
 return false;
 }
 
 std::vector<std::shared_ptr<DRC_ITEM>> footprints;
 std::vector<std::shared_ptr<DRC_ITEM>> unconnected;
 std::vector<std::shared_ptr<DRC_ITEM>> violations;
 
 engine->SetProgressReporter( nullptr );
 
 engine->SetViolationHandler(
 [&]( const std::shared_ptr<DRC_ITEM>& aItem, VECTOR2D aPos, int aLayer )
 {
 if( aItem->GetErrorCode() == DRCE_MISSING_FOOTPRINT
 || aItem->GetErrorCode() == DRCE_DUPLICATE_FOOTPRINT
 || aItem->GetErrorCode() == DRCE_EXTRA_FOOTPRINT
 || aItem->GetErrorCode() == DRCE_NET_CONFLICT )
 {
 footprints.push_back( aItem );
 }
 else if( aItem->GetErrorCode() == DRCE_UNCONNECTED_ITEMS )
 {
 unconnected.push_back( aItem );
 }
 else
 {
 violations.push_back( aItem );
 }
 } );
 
 engine->RunTests( aUnits, aReportAllTrackErrors, false );
 engine->ClearViolationHandler();
 
 // TODO: Unify this with DIALOG_DRC::writeReport
 
 FILE* fp = wxFopen( aFileName, wxT( "w" ) );
 
 if( fp == nullptr )
 return false;
 
 std::map<KIID, EDA_ITEM*> itemMap;
 aBoard->FillItemMap( itemMap );
 
 fprintf( fp, "** Drc report for %s **\n", TO_UTF8( aBoard->GetFileName() ) );
 
 wxDateTime now = wxDateTime::Now();
 
 fprintf( fp, "** Created on %s **\n", TO_UTF8( now.Format( wxT( "%F %T" ) ) ) );
 
 fprintf( fp, "\n** Found %d DRC violations **\n", static_cast<int>( violations.size() ) );
 
 for( const std::shared_ptr<DRC_ITEM>& item : violations )
 {
 SEVERITY severity = item->GetParent()->GetSeverity();
 fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
 }
 
 fprintf( fp, "\n** Found %d unconnected pads **\n", static_cast<int>( unconnected.size() ) );
 
 for( const std::shared_ptr<DRC_ITEM>& item : unconnected )
 {
 SEVERITY severity = bds.GetSeverity( item->GetErrorCode() );
 fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
 }
 
 fprintf( fp, "\n** Found %d Footprint errors **\n", static_cast<int>( footprints.size() ) );
 
 for( const std::shared_ptr<DRC_ITEM>& item : footprints )
 {
 SEVERITY severity = bds.GetSeverity( item->GetErrorCode() );
 fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
 }
 
 fprintf( fp, "\n** End of Report **\n" );
 fclose( fp );
 
 return true;
}

References PROJECT::AbsolutePath(), DesignRulesFileExtension, DRCE_DUPLICATE_FOOTPRINT, DRCE_EXTRA_FOOTPRINT, DRCE_MISSING_FOOTPRINT, DRCE_NET_CONFLICT, DRCE_UNCONNECTED_ITEMS, BOARD::FillItemMap(), BOARD::GetDesignSettings(), BOARD::GetFileName(), BOARD::GetProject(), BOARD_DESIGN_SETTINGS::GetSeverity(), BOARD_DESIGN_SETTINGS::m_DRCEngine, pcbIUScale, SETTINGS_MANAGER::Prj(), s_SettingsManager, and TO_UTF8.

Variable Documentation

s_PcbEditFrame

PCB_EDIT_FRAME* s_PcbEditFrame = nullptr

static

Definition at line 60 of file pcbnew_scripting_helpers.cpp.

Referenced by CreateEmptyBoard(), ExportFootprintsToLibrary(), ExportSpecctraDSN(), ExportVRML(), GetBoard(), GetSettingsManager(), GetUserUnits(), ImportSpecctraSES(), LoadBoard(), Refresh(), ScriptingSetPcbEditFrame(), and UpdateUserInterface().

s_SettingsManager

SETTINGS_MANAGER* s_SettingsManager = nullptr

static

Definition at line 61 of file pcbnew_scripting_helpers.cpp.

Referenced by GetSettingsManager(), and WriteDRCReport().