pcbnew_scripting_helpers.cpp File Reference

Scripting helper functions for pcbnew functionality. More...

#include <Python.h>
#include <action_plugin.h>
#include <board.h>
#include <pcb_marker.h>
#include <cstdlib>
#include <drc/drc_engine.h>
#include <drc/drc_item.h>
#include <fp_lib_table.h>
#include <io_mgr.h>
#include <kicad_string.h>
#include <pcbnew_scripting_helpers.h>
#include <project.h>
#include <settings/settings_manager.h>
#include <project/project_local_settings.h>
#include <wildcards_and_files_ext.h>

Go to the source code of this file.

Functions
wxApp *	GetApp ()
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 *	CreateEmptyBoard ()
	Constructs a default BOARD with a tempoary (no filename) project. More...
bool	SaveBoard (wxString &aFileName, BOARD *aBoard, IO_MGR::PCB_FILE_T aFormat)
bool	SaveBoard (wxString &aFileName, BOARD *aBoard)
FP_LIB_TABLE *	GetFootprintLibraryTable ()
wxArrayString	GetFootprintLibraries ()
	will 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)
	will 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	ExportVRML (const wxString &aFullFileName, double aMMtoWRMLunit, bool aExport3DFiles, bool aUseRelativePaths, bool aUsePlainPCB, const wxString &a3D_Subdir, double aXRef, double aYRef)
	will export the current BOARD to a VRML (wrl) file. More...
bool	ImportSpecctraSES (wxString &aFullFilename)
	will 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)
	Function ExportFootprintsToLibrary 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 ()
	Returns 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)
	Runs the DRC check on the given board and writes the results to a report file. More...

Variables
static PCB_EDIT_FRAME *	s_PcbEditFrame = NULL
static SETTINGS_MANAGER *	s_SettingsManager = nullptr
static wxApp *	s_WxApp = nullptr
	A valid app is needed for preventing some asserts when opening the settings manager. More...

Detailed Description

Scripting helper functions for pcbnew functionality.

Definition in file pcbnew_scripting_helpers.cpp.

Function Documentation

CreateEmptyBoard()

BOARD* CreateEmptyBoard

(

)

Constructs a default BOARD with a tempoary (no filename) project.

Returns

the created board

Definition at line 177 of file pcbnew_scripting_helpers.cpp.

{
    BOARD* brd = new BOARD();

    brd->SetProject( GetDefaultProject() );

    return brd;
}

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

ExportFootprintsToLibrary()

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

Function ExportFootprintsToLibrary Save footprints in a library:

Parameters

aStoreInNewLib	true : 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 false: save footprints in a new lib. It it is an existing lib, previous footprints will be removed
aLibName	optional library name to create, stops dialog call. must be called with aStoreInNewLib as true

Definition at line 303 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()

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 258 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,
		bool	aUsePlainPCB,
		const wxString &	a3D_Subdir,
		double	aXRef,
		double	aYRef
	)

will 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 271 of file pcbnew_scripting_helpers.cpp.

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

References PCB_EDIT_FRAME::ExportVRML_File(), and s_PcbEditFrame.

Referenced by VRML_WRITER::ExportVRML_File().

GetApp()

wxApp* GetApp

(

)

Definition at line 56 of file pcbnew_scripting_helpers.cpp.

{
    if( !s_WxApp )
        s_WxApp = new wxApp();

    return s_WxApp;
}

References s_WxApp.

Referenced by GetSettingsManager().

GetBoard()

BOARD* GetBoard

(

)

Definition at line 65 of file pcbnew_scripting_helpers.cpp.

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

References PCB_BASE_FRAME::GetBoard(), NULL, and s_PcbEditFrame.

Referenced by PCB_EDIT_FRAME::canCloseWindow(), ZONE_FILLER_TOOL::CheckAllZones(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), PCB_EDIT_FRAME::doCloseWindow(), EVT_GRID_CMD_CELL_CHANGED(), EVT_TOOL_RANGE(), PCB_EDIT_FRAME::ExportSpecctraFile(), PCB_EDIT_FRAME::ExportSVG(), EDIT_TOOL::FilletTracks(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PCB_EDIT_FRAME::GetCurrentFileName(), PCB_BASE_FRAME::GetFootprintFromBoardByReference(), GetFootprintLibraryTable(), PCB_EDIT_FRAME::GetLastPath(), PCB_EDIT_FRAME::ImportSpecctraSession(), PCB_EDIT_FRAME::IsElementVisible(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::onBoardLoaded(), PCB_EDIT_FRAME::OnExportHyperlynx(), PCB_EDIT_FRAME::OnNetlistChanged(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RecordDRCExclusions(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), PCB_EDIT_FRAME::ResolveDRCExclusions(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_EDIT_FRAME::SetElementVisibility(), PCB_EDIT_FRAME::SetLastPath(), PCB_EDIT_FRAME::SetPageSettings(), PCB_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_EDIT_FRAME::UpdateTitle(), PCB_EDIT_FRAME::UpdateUserInterface(), and PCB_EDIT_FRAME::~PCB_EDIT_FRAME().

GetDefaultProject()

PROJECT* GetDefaultProject

(

)

Definition at line 105 of file pcbnew_scripting_helpers.cpp.

{
    PROJECT* project = GetSettingsManager()->GetProject( "" );

    if( !project )
    {
        GetSettingsManager()->LoadProject( "" );
        project = GetSettingsManager()->GetProject( "" );
    }

    return project;
}

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

Referenced by CreateEmptyBoard(), and LoadBoard().

GetFootprintLibraries()

wxArrayString GetFootprintLibraries

(

)

will 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 227 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 211 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::PcbFootprintLibs().

Referenced by GetFootprintLibraries(), and GetFootprints().

GetFootprints()

wxArrayString GetFootprints

(

const wxString &

aNickName

)

will 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 243 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 92 of file pcbnew_scripting_helpers.cpp.

{
    if( !s_SettingsManager )
    {
        // Ensure wx system settings stuff is available
        GetApp();
        s_SettingsManager = new SETTINGS_MANAGER( true );
    }

    return s_SettingsManager;
}

References GetApp(), and s_SettingsManager.

Referenced by PANEL_COLOR_SETTINGS::createThemeList(), EDA_3D_CANVAS::EDA_3D_CANVAS(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GetDefaultProject(), DIALOG_PLOT_SCHEMATIC::initDlg(), LoadBoard(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), PGM_SINGLE_TOP::OnPgmInit(), EDA_3D_CANVAS::ReloadRequest(), SaveBoard(), PCB_EDIT_FRAME::SaveSettings(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), and DIALOG_PRINT_PCBNEW::TransferDataToWindow().

GetUserUnits()

int GetUserUnits

(

)

Returns the currently selected user unit value for the interface.

Returns

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

Definition at line 337 of file pcbnew_scripting_helpers.cpp.

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

    return -1;
}

References EDA_BASE_FRAME::GetUserUnits(), and s_PcbEditFrame.

Referenced by DRAWING_TOOL::drawArc(), and PCB_CONTROL::placeBoardItems().

ImportSpecctraSES()

bool ImportSpecctraSES

(

wxString &

aFullFilename

)

will 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 289 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 346 of file pcbnew_scripting_helpers.cpp.

{
    return ACTION_PLUGINS::IsActionRunning();
}

References ACTION_PLUGINS::IsActionRunning().

LoadBoard() [1/2]

BOARD* LoadBoard

(

wxString &

aFileName

)

Definition at line 80 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 LoadBoard().

LoadBoard() [2/2]

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

Definition at line 119 of file pcbnew_scripting_helpers.cpp.

{
    wxFileName pro = aFileName;
    pro.SetExt( ProjectFileExtension );
    pro.MakeAbsolute();
    wxString projectPath = pro.GetFullPath();

    PROJECT* project = GetSettingsManager()->GetProject( projectPath );

    if( !project )
    {
        GetSettingsManager()->LoadProject( projectPath );
        project = GetSettingsManager()->GetProject( projectPath );
    }

    // 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, GAL_LAYER_ID_BITMASK_END, GAL_LAYER_INDEX, GetDefaultProject(), BOARD::GetDesignSettings(), PROJECT::GetLocalSettings(), SETTINGS_MANAGER::GetProject(), GetSettingsManager(), IO_MGR::Load(), SETTINGS_MANAGER::LoadProject(), BOARD_DESIGN_SETTINGS::m_DRCEngine, BOARD::m_LegacyVisibleItems, BOARD::m_LegacyVisibleLayers, PROJECT_LOCAL_SETTINGS::m_VisibleItems, PROJECT_LOCAL_SETTINGS::m_VisibleLayers, ProjectFileExtension, Rescue, BOARD::ResolveDRCExclusions(), BOARD::SetProject(), and BOARD::SynchronizeNetsAndNetClasses().

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 316 of file pcbnew_scripting_helpers.cpp.

{
    if( s_PcbEditFrame )
    {
        auto board = s_PcbEditFrame->GetBoard();
        board->BuildConnectivity();

        // Re-init everything: this is the easy way to do that
        s_PcbEditFrame->ActivateGalCanvas();
        s_PcbEditFrame->GetCanvas()->Refresh();
    }
}

References PCB_EDIT_FRAME::ActivateGalCanvas(), BOARD::BuildConnectivity(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::Refresh(), and s_PcbEditFrame.

Referenced by EDA_MSG_PANEL::AppendMessage(), BITMAP_BUTTON::Check(), C3D_MODEL_VIEWER::Clear3DModel(), ACTION_TOOLBAR::doSelectAction(), SYMBOL_EDIT_FRAME::emptyScreen(), SPLIT_BUTTON::Enable(), BITMAP_BUTTON::Enable(), EDA_MSG_PANEL::EraseMsgBox(), PCB_EDIT_FRAME::ImportSpecctraSession(), ACTION_TOOLBAR::KiRealize(), SYMBOL_EDIT_FRAME::LoadOneLibraryPartAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PCB_CALCULATOR_FRAME::OnAttenuatorSelection(), APPEARANCE_CONTROLS::OnBoardChanged(), PCB_EDIT_FRAME::onBoardLoaded(), BITMAP_BUTTON::OnEnter(), WX_COLLAPSIBLE_PANE_HEADER::onEnterWindow(), EDA_3D_CANVAS::OnEvent(), WX_COLLAPSIBLE_PANE_HEADER::onFocus(), SPLIT_BUTTON::OnKillFocus(), APPEARANCE_CONTROLS::OnLayerChanged(), PANEL_SETUP_BOARD_STACKUP::OnLayersOptionsChanged(), BITMAP_BUTTON::OnLeave(), WX_COLLAPSIBLE_PANE_HEADER::onLeaveWindow(), SPLIT_BUTTON::OnLeftButtonDown(), BITMAP_BUTTON::OnLeftButtonDown(), SPLIT_BUTTON::OnLeftButtonUp(), BITMAP_BUTTON::OnLeftButtonUp(), BM2CMP_FRAME::OnLoadFile(), SPLIT_BUTTON::OnMouseEnter(), SPLIT_BUTTON::OnMouseLeave(), C3D_MODEL_VIEWER::OnMouseMove(), C3D_MODEL_VIEWER::OnMouseWheel(), BM2CMP_FRAME::OnNegativeClicked(), BM2CMP_FRAME::OnThresholdChange(), DIALOG_JUNCTION_PROPS::resetDefaults(), DIALOG_EDIT_LINE_STYLE::resetDefaults(), TEMPLATE_WIDGET::Select(), C3D_MODEL_VIEWER::Set3DModel(), WX_COLLAPSIBLE_PANE_HEADER::SetCollapsed(), EDA_MSG_PANEL::SetMessage(), FOOTPRINTS_LISTBOX::SetSelection(), LIBRARY_LISTBOX::SetSelection(), TEMPLATE_WIDGET::Unselect(), mpWindow::UpdateAll(), KIGFX::OPENGL_GAL::updatedGalDisplayOptions(), KIGFX::CAIRO_GAL::updatedGalDisplayOptions(), NUMBER_BADGE::UpdateNumber(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

SaveBoard() [1/2]

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

Definition at line 187 of file pcbnew_scripting_helpers.cpp.

{
    aBoard->BuildConnectivity();
    aBoard->SynchronizeNetsAndNetClasses();

    IO_MGR::Save( aFormat, aFileName, aBoard, NULL );

    wxFileName pro = aFileName;
    pro.SetExt( ProjectFileExtension );
    pro.MakeAbsolute();
    wxString projectPath = pro.GetFullPath();

    GetSettingsManager()->SaveProject( pro.GetFullPath() );

    return true;
}

References BOARD::BuildConnectivity(), GetSettingsManager(), NULL, ProjectFileExtension, IO_MGR::Save(), SETTINGS_MANAGER::SaveProject(), and BOARD::SynchronizeNetsAndNetClasses().

Referenced by SaveBoard().

SaveBoard() [2/2]

bool SaveBoard	(	wxString &	aFileName,
		BOARD *	aBoard
	)

Definition at line 205 of file pcbnew_scripting_helpers.cpp.

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

References IO_MGR::KICAD_SEXP, and SaveBoard().

ScriptingSetPcbEditFrame()

void ScriptingSetPcbEditFrame

(

PCB_EDIT_FRAME *

aPcbEditFrame

)

Definition at line 74 of file pcbnew_scripting_helpers.cpp.

{
    s_PcbEditFrame = aPcbEditFrame;
}

References s_PcbEditFrame.

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

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 330 of file pcbnew_scripting_helpers.cpp.

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

References s_PcbEditFrame, and PCB_EDIT_FRAME::UpdateUserInterface().

Referenced by PCB_EDIT_FRAME::ShowBoardSetupDialog().

WriteDRCReport()

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

Runs 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 352 of file pcbnew_scripting_helpers.cpp.

{
    wxCHECK( aBoard, false );

    BOARD_DESIGN_SETTINGS& bds = aBoard->GetDesignSettings();
    std::shared_ptr<DRC_ENGINE> engine = bds.m_DRCEngine;

    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 );
    wxString drcRulesPath = s_SettingsManager->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, wxPoint aPos )
            {
                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 = bds.GetSeverity( item->GetErrorCode() );
        fprintf( fp, "%s", TO_UTF8( item->ShowReport( aUnits, 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( aUnits, 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( aUnits, 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_DESIGN_SETTINGS::GetSeverity(), BOARD_DESIGN_SETTINGS::m_DRCEngine, SETTINGS_MANAGER::Prj(), s_SettingsManager, and TO_UTF8.

Variable Documentation

s_PcbEditFrame

PCB_EDIT_FRAME* s_PcbEditFrame = NULL

static

Definition at line 48 of file pcbnew_scripting_helpers.cpp.

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

s_SettingsManager

SETTINGS_MANAGER* s_SettingsManager = nullptr

static

Definition at line 50 of file pcbnew_scripting_helpers.cpp.

Referenced by GetSettingsManager(), and WriteDRCReport().

s_WxApp

wxApp* s_WxApp = nullptr

static

A valid app is needed for preventing some asserts when opening the settings manager.

Definition at line 53 of file pcbnew_scripting_helpers.cpp.

Referenced by GetApp().