KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcbnew_scripting_helpers.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2012 NBEE Embedded Systems, Miguel Angel Ajo <[email protected]>
5 * Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
30#include <Python.h>
31#undef HAVE_CLOCK_GETTIME // macro is defined in Python.h and causes redefine warning
32
34
35#include <action_plugin.h>
36#include <board.h>
38#include <pcb_marker.h>
39#include <cstdlib>
41#include <drc/drc_engine.h>
42#include <drc/drc_item.h>
43#include <fp_lib_table.h>
44#include <core/ignore.h>
45#include <pcb_io/pcb_io_mgr.h>
46#include <string_utils.h>
47#include <filename_resolver.h>
48#include <macros.h>
50#include <pgm_base.h>
51#include <project.h>
52#include <project_pcb.h>
56#include <specctra.h>
59#include <locale_io.h>
60#include <wx/app.h>
61#include <wx/crt.h>
62
63
66
67
69{
70 if( s_PcbEditFrame )
71 return s_PcbEditFrame->GetBoard();
72 else
73 return nullptr;
74}
75
76
78{
79 s_PcbEditFrame = aPcbEditFrame;
80}
81
82
84{
85 if( s_PcbEditFrame == aPcbEditFrame )
86 s_PcbEditFrame = nullptr;
87}
88
89
90BOARD* LoadBoard( wxString& aFileName, bool aSetActive )
91{
92 if( aFileName.EndsWith( FILEEXT::KiCadPcbFileExtension ) )
93 return LoadBoard( aFileName, PCB_IO_MGR::KICAD_SEXP, aSetActive );
94 else if( aFileName.EndsWith( FILEEXT::LegacyPcbFileExtension ) )
95 return LoadBoard( aFileName, PCB_IO_MGR::LEGACY, aSetActive );
96
97 // as fall back for any other kind use the legacy format
98 return LoadBoard( aFileName, PCB_IO_MGR::LEGACY, aSetActive );
99}
100
101
102BOARD* LoadBoard( wxString& aFileName )
103{
104 return LoadBoard( aFileName, false );
105}
106
107
109{
110 if( !s_SettingsManager )
111 {
112 if( s_PcbEditFrame )
113 {
115 }
116 else
117 {
118 // Ensure wx system settings stuff is available
119 ignore_unused( wxTheApp );
121 }
122 }
123
124 return s_SettingsManager;
125}
126
127
129{
130 // For some reasons, LoadProject() needs a C locale, so ensure we have the right locale
131 // This is mainly when running QA Python tests
133
135
136 if( !project )
137 {
140 }
141
142 return project;
143}
144
145BOARD* LoadBoard( wxString& aFileName, PCB_IO_MGR::PCB_FILE_T aFormat )
146{
147 return LoadBoard( aFileName, aFormat, false );
148}
149
150BOARD* LoadBoard( wxString& aFileName, PCB_IO_MGR::PCB_FILE_T aFormat, bool aSetActive )
151{
152 wxFileName pro = aFileName;
153 pro.SetExt( FILEEXT::ProjectFileExtension );
154 pro.MakeAbsolute();
155 wxString projectPath = pro.GetFullPath();
156
157 // Ensure the "C" locale is temporary set, before reading any file
158 // It also avoid wxWidget alerts about locale issues, later, when using Python 3
160
161 PROJECT* project = GetSettingsManager()->GetProject( projectPath );
162
163 if( !project )
164 {
165 if( wxFileExists( projectPath ) )
166 {
167 // cli
168 GetSettingsManager()->LoadProject( projectPath, aSetActive );
169 project = GetSettingsManager()->GetProject( projectPath );
170 }
171 }
172 else if( s_PcbEditFrame && project == &GetSettingsManager()->Prj() )
173 {
174 // Project is already loaded? Then so is the board
175 return s_PcbEditFrame->GetBoard();
176 }
177
178 // Board cannot be loaded without a project, so create the default project
179 if( !project )
181
182 BASE_SCREEN::m_DrawingSheetFileName = project->GetProjectFile().m_BoardDrawingSheetFile;
183
184 BOARD* brd = PCB_IO_MGR::Load( aFormat, aFileName );
185
186 if( brd )
187 {
188 // Load the drawing sheet from the filename stored in BASE_SCREEN::m_DrawingSheetFileName.
189 // If empty, or not existing, the default drawing sheet is loaded.
193
195 project->GetProjectPath(),
196 brd->GetEmbeddedFiles() );
197
198 wxString msg;
199
200 if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, &msg ) )
201 {
202 wxFprintf( stderr, _( "Error loading drawing sheet '%s': %s" ),
204 }
205
206 // JEY TODO: move this global to the board
208
209 layerEnum.Choices().Clear();
210 layerEnum.Undefined( UNDEFINED_LAYER );
211
212 for( PCB_LAYER_ID layer : LSET::AllLayersMask().Seq() )
213 {
214 // Canonical name
215 layerEnum.Map( layer, LSET::Name( layer ) );
216
217 // User name
218 layerEnum.Map( layer, brd->GetLayerName( layer ) );
219 }
220
221 brd->SetProject( project );
222
223 // Move legacy view settings to local project settings
224 if( !brd->m_LegacyVisibleLayers.test( Rescue ) )
225 project->GetLocalSettings().m_VisibleLayers = brd->m_LegacyVisibleLayers;
226
228 project->GetLocalSettings().m_VisibleItems = brd->m_LegacyVisibleItems;
229
231 bds.m_DRCEngine = std::make_shared<DRC_ENGINE>( brd, &bds );
232
233 try
234 {
235 wxFileName rules = pro;
236 rules.SetExt( FILEEXT::DesignRulesFileExtension );
237 bds.m_DRCEngine->InitEngine( rules );
238 }
239 catch( ... )
240 {
241 // Best efforts...
242 }
243
244 for( PCB_MARKER* marker : brd->ResolveDRCExclusions( true ) )
245 brd->Add( marker );
246
247 brd->BuildConnectivity();
248 brd->BuildListOfNets();
249 brd->SynchronizeNetsAndNetClasses( false );
250 brd->UpdateUserUnits( brd, nullptr );
251 }
252
253 return brd;
254}
255
256
257BOARD* NewBoard( wxString& aFileName )
258{
259 wxFileName boardFn = aFileName;
260 wxFileName proFn = aFileName;
261 proFn.SetExt( FILEEXT::ProjectFileExtension );
262 proFn.MakeAbsolute();
263
264 wxString projectPath = proFn.GetFullPath();
265
266 // Ensure the "C" locale is temporary set, before reading any file
267 // It also avoids wxWidgets alerts about locale issues, later, when using Python 3
269
270 GetSettingsManager()->LoadProject( projectPath, false );
271 PROJECT* project = GetSettingsManager()->GetProject( projectPath );
272
273 BOARD* brd = new BOARD();
274
275 brd->SetProject( project );
277 bds.m_DRCEngine = std::make_shared<DRC_ENGINE>( brd, &bds );
278
279 SaveBoard( aFileName, brd );
280
281 return brd;
282}
283
284
286{
287 // Creating a new board is not possible if running inside KiCad
288 if( s_PcbEditFrame )
289 return nullptr;
290
291 BOARD* brd = new BOARD();
292
294
295 return brd;
296}
297
298
299bool SaveBoard( wxString& aFileName, BOARD* aBoard, PCB_IO_MGR::PCB_FILE_T aFormat, bool aSkipSettings )
300{
301 aBoard->BuildConnectivity();
302 aBoard->SynchronizeNetsAndNetClasses( false );
303
304 // Ensure the "C" locale is temporary set, before saving any file
305 // It also avoid wxWidget alerts about locale issues, later, when using Python 3
307
308 try
309 {
310 PCB_IO_MGR::Save( aFormat, aFileName, aBoard, nullptr );
311 }
312 catch( ... )
313 {
314 return false;
315 }
316
317 if( !aSkipSettings )
318 {
319 wxFileName pro = aFileName;
320 pro.SetExt( FILEEXT::ProjectFileExtension );
321 pro.MakeAbsolute();
322
323 GetSettingsManager()->SaveProjectAs( pro.GetFullPath(), aBoard->GetProject() );
324 }
325
326 return true;
327}
328
329
330bool SaveBoard( wxString& aFileName, BOARD* aBoard, bool aSkipSettings )
331{
332 return SaveBoard( aFileName, aBoard, PCB_IO_MGR::KICAD_SEXP, aSkipSettings );
333}
334
335
337{
338 BOARD* board = GetBoard();
339
340 if( !board )
341 return nullptr;
342
343 PROJECT* project = board->GetProject();
344
345 if( !project )
346 return nullptr;
347
349}
350
351
353{
354 wxArrayString footprintLibraryNames;
355
357
358 if( !tbl )
359 return footprintLibraryNames;
360
361 for( const wxString& name : tbl->GetLogicalLibs() )
362 footprintLibraryNames.Add( name );
363
364 return footprintLibraryNames;
365}
366
367
368wxArrayString GetFootprints( const wxString& aNickName )
369{
370 wxArrayString footprintNames;
371
373
374 if( !tbl )
375 return footprintNames;
376
377 tbl->FootprintEnumerate( footprintNames, aNickName, true );
378
379 return footprintNames;
380}
381
382
383bool ExportSpecctraDSN( wxString& aFullFilename )
384{
385 if( s_PcbEditFrame )
386 {
387 bool ok = s_PcbEditFrame->ExportSpecctraFile( aFullFilename );
388 return ok;
389 }
390 else
391 {
392 return false;
393 }
394}
395
396
397bool ExportSpecctraDSN( BOARD* aBoard, wxString& aFullFilename )
398{
399 try
400 {
401 DSN::ExportBoardToSpecctraFile( aBoard, aFullFilename );
402 }
403 catch( ... )
404 {
405 return false;
406 }
407
408 return true;
409}
410
411
412bool ExportVRML( const wxString& aFullFileName, double aMMtoWRMLunit, bool aIncludeUnspecified,
413 bool aIncludeDNP, bool aExport3DFiles,
414 bool aUseRelativePaths, const wxString& a3D_Subdir, double aXRef, double aYRef )
415{
416 if( s_PcbEditFrame )
417 {
418 bool ok = s_PcbEditFrame->ExportVRML_File( aFullFileName, aMMtoWRMLunit,
419 aIncludeUnspecified, aIncludeDNP,
420 aExport3DFiles, aUseRelativePaths,
421 a3D_Subdir, aXRef, aYRef );
422 return ok;
423 }
424 else
425 {
426 return false;
427 }
428}
429
430bool ImportSpecctraSES( wxString& aFullFilename )
431{
432 if( s_PcbEditFrame )
433 {
434 bool ok = s_PcbEditFrame->ImportSpecctraSession( aFullFilename );
435 return ok;
436 }
437 else
438 {
439 return false;
440 }
441}
442
443bool ImportSpecctraSES( BOARD* aBoard, wxString& aFullFilename )
444{
445 try
446 {
447 DSN::ImportSpecctraSession( aBoard, aFullFilename );
448 }
449 catch( ... )
450 {
451 return false;
452 }
453
454 return true;
455}
456
457
458bool ExportFootprintsToLibrary( bool aStoreInNewLib, const wxString& aLibName, wxString* aLibPath )
459{
460 if( s_PcbEditFrame )
461 {
462 s_PcbEditFrame->ExportFootprintsToLibrary( aStoreInNewLib, aLibName, aLibPath );
463 return true;
464 }
465 else
466 {
467 return false;
468 }
469}
470
472{
473 if( s_PcbEditFrame )
474 {
476 }
477}
478
479
481{
482 if( s_PcbEditFrame )
484}
485
486
488{
489 if( s_PcbEditFrame )
490 return static_cast<int>( s_PcbEditFrame->GetUserUnits() );
491
492 return -1;
493}
494
495
496std::deque<BOARD_ITEM*> GetCurrentSelection()
497{
498 std::deque<BOARD_ITEM*> items;
499
500 if( s_PcbEditFrame )
501 {
503
504 std::for_each( selection.begin(), selection.end(),
505 [&items]( EDA_ITEM* item )
506 {
507 items.push_back( static_cast<BOARD_ITEM*>( item ) );
508 } );
509 }
510
511 return items;
512}
513
514void FocusOnItem( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer )
515{
516 if( s_PcbEditFrame )
517 {
518 s_PcbEditFrame->FocusOnItem( aItem, aLayer );
519 }
520}
521
522
524{
526}
527
528
529bool WriteDRCReport( BOARD* aBoard, const wxString& aFileName, EDA_UNITS aUnits,
530 bool aReportAllTrackErrors )
531{
532 wxCHECK( aBoard, false );
533
535 std::shared_ptr<DRC_ENGINE> engine = bds.m_DRCEngine;
536 UNITS_PROVIDER unitsProvider( pcbIUScale, aUnits );
537
538 if( !engine )
539 {
540 bds.m_DRCEngine = std::make_shared<DRC_ENGINE>( aBoard, &bds );
541 engine = bds.m_DRCEngine;
542 }
543
544 wxCHECK( engine, false );
545
546 wxFileName fn = aBoard->GetFileName();
548 PROJECT* prj = nullptr;
549
550 if( aBoard->GetProject() )
551 prj = aBoard->GetProject();
552 else if( s_SettingsManager )
553 prj = &s_SettingsManager->Prj();
554
555 wxCHECK( prj, false );
556
557 // Load the global fp-lib-table otherwise we can't check the libs parity
558 wxFileName fn_flp = FP_LIB_TABLE::GetGlobalTableFileName();
559 if( fn_flp.FileExists() ) {
561 GFootprintTable.Load( fn_flp.GetFullPath() );
562 }
563
564 wxString drcRulesPath = prj->AbsolutePath( fn.GetFullName() );
565
566 // Rebuild The Instance of ENUM_MAP<PCB_LAYER_ID> (layer names list), because the DRC
567 // engine can use layer names (canonical and/or user names)
569 layerEnum.Choices().Clear();
570 layerEnum.Undefined( UNDEFINED_LAYER );
571
572 for( PCB_LAYER_ID layer : LSET::AllLayersMask().Seq() )
573 {
574 layerEnum.Map( layer, LSET::Name( layer ) ); // Add Canonical name
575 layerEnum.Map( layer, aBoard->GetLayerName( layer ) ); // Add User name
576 }
577
578 try
579 {
580 engine->InitEngine( drcRulesPath );
581 }
582 catch( PARSE_ERROR& err )
583 {
584 fprintf( stderr, "Init DRC engine: err <%s>\n", TO_UTF8( err.What() ) ); fflush( stderr);
585 return false;
586 }
587
588 std::vector<std::shared_ptr<DRC_ITEM>> footprints;
589 std::vector<std::shared_ptr<DRC_ITEM>> unconnected;
590 std::vector<std::shared_ptr<DRC_ITEM>> violations;
591
592 engine->SetProgressReporter( nullptr );
593
594 engine->SetViolationHandler(
595 [&]( const std::shared_ptr<DRC_ITEM>& aItem, VECTOR2D aPos, int aLayer )
596 {
597 if( aItem->GetErrorCode() == DRCE_MISSING_FOOTPRINT
598 || aItem->GetErrorCode() == DRCE_DUPLICATE_FOOTPRINT
599 || aItem->GetErrorCode() == DRCE_EXTRA_FOOTPRINT
600 || aItem->GetErrorCode() == DRCE_NET_CONFLICT
601 || aItem->GetErrorCode() == DRCE_SCHEMATIC_PARITY_ISSUES )
602 {
603 footprints.push_back( aItem );
604 }
605 else if( aItem->GetErrorCode() == DRCE_UNCONNECTED_ITEMS )
606 {
607 unconnected.push_back( aItem );
608 }
609 else
610 {
611 violations.push_back( aItem );
612 }
613 } );
614
615 aBoard->RecordDRCExclusions();
616 aBoard->DeleteMARKERs( true, true );
617 engine->RunTests( aUnits, aReportAllTrackErrors, false );
618 engine->ClearViolationHandler();
619
620 // Update the exclusion status on any excluded markers that still exist.
621 aBoard->ResolveDRCExclusions( false );
622
623 // TODO: Unify this with DIALOG_DRC::writeReport
624
625 FILE* fp = wxFopen( aFileName, wxT( "w" ) );
626
627 if( fp == nullptr )
628 return false;
629
630 std::map<KIID, EDA_ITEM*> itemMap;
631 aBoard->FillItemMap( itemMap );
632
633 fprintf( fp, "** Drc report for %s **\n", TO_UTF8( aBoard->GetFileName() ) );
634
635 wxDateTime now = wxDateTime::Now();
636
637 fprintf( fp, "** Created on %s **\n", TO_UTF8( now.Format( wxT( "%F %T" ) ) ) );
638
639 fprintf( fp, "\n** Found %d DRC violations **\n", static_cast<int>( violations.size() ) );
640
641 for( const std::shared_ptr<DRC_ITEM>& item : violations )
642 {
643 SEVERITY severity = item->GetParent() ? item->GetParent()->GetSeverity()
644 : bds.GetSeverity( item->GetErrorCode() );
645 fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
646 }
647
648 fprintf( fp, "\n** Found %d unconnected pads **\n", static_cast<int>( unconnected.size() ) );
649
650 for( const std::shared_ptr<DRC_ITEM>& item : unconnected )
651 {
652 SEVERITY severity = bds.GetSeverity( item->GetErrorCode() );
653 fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
654 }
655
656 fprintf( fp, "\n** Found %d Footprint errors **\n", static_cast<int>( footprints.size() ) );
657
658 for( const std::shared_ptr<DRC_ITEM>& item : footprints )
659 {
660 SEVERITY severity = bds.GetSeverity( item->GetErrorCode() );
661 fprintf( fp, "%s", TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
662 }
663
664 fprintf( fp, "\n** End of Report **\n" );
665 fclose( fp );
666
667 return true;
668}
669
670wxString GetLanguage()
671{
672 if( s_PcbEditFrame )
674 else
675 return "";
676}
const char * name
Definition: DXF_plotter.cpp:57
Class PCBNEW_ACTION_PLUGINS.
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
static bool IsActionRunning()
static wxString m_DrawingSheetFileName
the name of the drawing sheet file, or empty to use the default drawing sheet
Definition: base_screen.h:85
bool test(size_t pos) const
Definition: base_set.h:47
Container for design settings for a BOARD object.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
SEVERITY GetSeverity(int aDRCErrorCode)
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:289
EMBEDDED_FILES * GetEmbeddedFiles() override
Definition: board.cpp:2523
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition: board.cpp:982
GAL_SET m_LegacyVisibleItems
Definition: board.h:369
void BuildListOfNets()
Definition: board.h:827
void UpdateUserUnits(BOARD_ITEM *aItem, KIGFX::VIEW *aView)
Update any references within aItem (or its descendants) to the user units.
Definition: board.cpp:1313
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
Definition: board.cpp:186
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
Definition: board.cpp:327
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition: board.cpp:2033
LSET m_LegacyVisibleLayers
Visibility settings stored in board prior to 6.0, only used for loading legacy files.
Definition: board.h:368
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
Definition: board.cpp:196
const wxString & GetFileName() const
Definition: board.h:326
std::vector< PCB_MARKER * > ResolveDRCExclusions(bool aCreateMarkers)
Rebuild DRC markers from the serialized data in BOARD_DESIGN_SETTINGS.
Definition: board.cpp:344
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
Definition: board.cpp:1494
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:575
PROJECT * GetProject() const
Definition: board.h:490
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:874
void DeleteMARKERs()
Delete all MARKERS from the board.
Definition: board.cpp:1339
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
SETTINGS_MANAGER * GetSettingsManager() const
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
ENUM_MAP & Map(T aValue, const wxString &aName)
Definition: property.h:669
static ENUM_MAP< T > & Instance()
Definition: property.h:663
ENUM_MAP & Undefined(T aValue)
Definition: property.h:676
wxPGChoices & Choices()
Definition: property.h:712
Provide an extensible class to resolve 3D model paths.
bool SetProject(PROJECT *aProject, bool *flgChanged=nullptr)
Set the current KiCad project directory as the first entry in the model path list.
void SetProgramBase(PGM_BASE *aBase)
Set a pointer to the application's PGM_BASE instance used to extract the local env vars.
wxString ResolvePath(const wxString &aFileName, const wxString &aWorkingPath, const EMBEDDED_FILES *aFiles)
Determines the full path of the given file name.
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aNickname, bool aBestEfforts)
Return a list of footprint names contained within the library given by aNickname.
static wxString GetGlobalTableFileName()
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
void Clear()
Delete all rows.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:49
static LSET AllLayersMask()
Definition: lset.cpp:767
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:63
BOARD * GetBoard() const
void FocusOnItem(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
The main frame for Pcbnew.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
void ExportFootprintsToLibrary(bool aStoreInNewLib, const wxString &aLibName=wxEmptyString, wxString *aLibPath=nullptr)
Save footprints in a library:
bool ImportSpecctraSession(const wxString &aFullFilename)
Import a specctra *.ses file and use it to relocate MODULEs and to replace all vias and tracks in an ...
void RebuildAndRefresh()
Rebuilds board connectivity, refreshes canvas.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
bool ExportVRML_File(const wxString &aFullFileName, double aMMtoWRMLunit, bool aIncludeUnspecified, bool aIncludeDNP, bool aExport3DFiles, bool aUseRelativePaths, const wxString &a3D_Subdir, double aXRef, double aYRef)
Create the file(s) exporting current BOARD to a VRML file.
bool ExportSpecctraFile(const wxString &aFullFilename)
Export the current BOARD to a specctra dsn file.
static void Save(PCB_FILE_T aFileType, const wxString &aFileName, BOARD *aBoard, const STRING_UTF8_MAP *aProperties=nullptr)
Write either a full aBoard to a storage file in a format that this implementation knows about,...
Definition: pcb_io_mgr.cpp:172
PCB_FILE_T
The set of file types that the PCB_IO_MGR knows about, and for which there has been a plugin written,...
Definition: pcb_io_mgr.h:56
@ KICAD_SEXP
S-expression Pcbnew file format.
Definition: pcb_io_mgr.h:58
@ LEGACY
Legacy Pcbnew file formats prior to s-expression.
Definition: pcb_io_mgr.h:59
static BOARD * Load(PCB_FILE_T aFileType, const wxString &aFileName, BOARD *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr, PROJECT *aProject=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr)
Find the requested #PLUGIN and if found, calls the #PLUGIN::LoadBoard() function on it using the argu...
Definition: pcb_io_mgr.cpp:156
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
Definition: project_pcb.cpp:37
Container for project specific data.
Definition: project.h:62
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Definition: project.cpp:320
ITER end()
Definition: selection.h:75
ITER begin()
Definition: selection.h:74
void SaveProjectAs(const wxString &aFullPath, PROJECT *aProject=nullptr)
Sets the currently loaded project path and saves it (pointers remain valid) Note that this will not m...
COMMON_SETTINGS * GetCommonSettings() const
Retrieves the common settings shared by all applications.
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
PROJECT * GetProject(const wxString &aFullPath) const
Retrieves a loaded project by name.
PROJECT & Prj() const
A helper while we are not MDI-capable – return the one and only project.
EDA_UNITS GetUserUnits() const
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: cvpcb.cpp:150
@ DRCE_UNCONNECTED_ITEMS
Definition: drc_item.h:39
@ DRCE_DUPLICATE_FOOTPRINT
Definition: drc_item.h:72
@ DRCE_EXTRA_FOOTPRINT
Definition: drc_item.h:73
@ DRCE_NET_CONFLICT
Definition: drc_item.h:74
@ DRCE_MISSING_FOOTPRINT
Definition: drc_item.h:71
@ DRCE_SCHEMATIC_PARITY_ISSUES
Definition: drc_item.h:75
#define _(s)
EDA_UNITS
Definition: eda_units.h:46
static FILENAME_RESOLVER * resolver
Definition: export_idf.cpp:53
static const std::string ProjectFileExtension
static const std::string LegacyPcbFileExtension
static const std::string DesignRulesFileExtension
static const std::string KiCadPcbFileExtension
void ignore_unused(const T &)
Definition: ignore.h:24
PROJECT & Prj()
Definition: kicad.cpp:595
@ GAL_LAYER_ID_BITMASK_END
This is the end of the layers used for visibility bit masks in legacy board files.
Definition: layer_ids.h:230
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
@ Rescue
Definition: layer_ids.h:133
#define GAL_LAYER_INDEX(x)
Use this macro to convert a GAL layer to a 0-indexed offset from LAYER_VIAS.
Definition: layer_ids.h:273
This file contains miscellaneous commonly used macros and functions.
void ExportBoardToSpecctraFile(BOARD *aBoard, const wxString &aFullFilename)
Helper method to export board to DSN file.
bool ImportSpecctraSession(BOARD *aBoard, const wxString &fullFileName)
Helper method to import SES file to a board.
bool ImportSpecctraSES(wxString &aFullFilename)
Import a specctra *.ses file and use it to relocate MODULEs and to replace all vias and tracks in an ...
BOARD * LoadBoard(wxString &aFileName, bool aSetActive)
Loads a board from file This function identifies the file type by extension and determines the correc...
SETTINGS_MANAGER * GetSettingsManager()
void ScriptingOnDestructPcbEditFrame(PCB_EDIT_FRAME *aPcbEditFrame)
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.
BOARD * CreateEmptyBoard()
Construct a default BOARD with a temporary (no filename) project.
bool ExportVRML(const wxString &aFullFileName, double aMMtoWRMLunit, bool aIncludeUnspecified, bool aIncludeDNP, bool aExport3DFiles, bool aUseRelativePaths, const wxString &a3D_Subdir, double aXRef, double aYRef)
Export the current BOARD to a VRML (wrl) file.
wxArrayString GetFootprintLibraries()
Get the nicknames of all of the footprint libraries configured in pcbnew in both the project and glob...
FP_LIB_TABLE * GetFootprintLibraryTable()
int GetUserUnits()
Return the currently selected user unit value for the interface.
wxArrayString GetFootprints(const wxString &aNickName)
Get the names of all of the footprints available in a footprint library.
void ScriptingSetPcbEditFrame(PCB_EDIT_FRAME *aPcbEditFrame)
static PCB_EDIT_FRAME * s_PcbEditFrame
bool IsActionRunning()
Are we currently in an action plugin?
bool SaveBoard(wxString &aFileName, BOARD *aBoard, PCB_IO_MGR::PCB_FILE_T aFormat, bool aSkipSettings)
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
bool ExportSpecctraDSN(wxString &aFullFilename)
Will export the current BOARD to a specctra dsn file.
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
std::deque< BOARD_ITEM * > GetCurrentSelection()
Get the list of selected objects.
wxString GetLanguage()
Get the language string from COMMON_SETTINGS.
void FocusOnItem(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer)
Focus the view on the target item.
static SETTINGS_MANAGER * s_SettingsManager
BOARD * GetBoard()
bool ExportFootprintsToLibrary(bool aStoreInNewLib, const wxString &aLibName, wxString *aLibPath)
Save footprints in a library:
PROJECT * GetDefaultProject()
BOARD * NewBoard(wxString &aFileName)
Creates a new board and project with the given filename (will overwrite existing files!...
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE
SEVERITY
std::vector< FAB_LAYER_COLOR > dummy
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:391
A filename or source description, a problem input line, a line number, a byte offset,...
Definition: ki_exception.h:120
Definition of file extensions used in Kicad.