KiCad PCB EDA Suite
Loading...
Searching...
No Matches
panel_fp_lib_table.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 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
5 * Copyright (C) 2013-2021 CERN
6 * Copyright (C) 2012-2024 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26
27/* TODO:
28
29*) After any change to uri, reparse the environment variables.
30
31*/
32
33
34#include <set>
35#include <wx/dir.h>
36#include <wx/regex.h>
37#include <wx/grid.h>
38#include <wx/dirdlg.h>
39#include <wx/filedlg.h>
40#include <wx/msgdlg.h>
41
42#include <project.h>
43#include <env_vars.h>
45#include <panel_fp_lib_table.h>
46#include <lib_id.h>
47#include <fp_lib_table.h>
48#include <lib_table_lexer.h>
49#include <invoke_pcb_dialog.h>
50#include <bitmaps.h>
52#include <widgets/wx_grid.h>
54#include <confirm.h>
55#include <lib_table_grid.h>
57#include <pgm_base.h>
58#include <pcb_edit_frame.h>
59#include <env_paths.h>
65#include <kiway.h>
66#include <kiway_express.h>
69#include <pcbnew_id.h> // For ID_PCBNEW_END_LIST
71#include <paths.h>
72#include <macros.h>
73#include <project_pcb.h>
74#include <common.h>
75
76// clang-format off
77
82{
83 wxString m_Description;
84 wxString m_FileFilter;
86 bool m_IsFile;
88};
89
90// clang-format on
91
96class LIBRARY_TRAVERSER : public wxDirTraverser
97{
98public:
99 LIBRARY_TRAVERSER( std::vector<std::string> aSearchExtensions, wxString aInitialDir ) :
100 m_searchExtensions( aSearchExtensions ), m_currentDir( aInitialDir )
101 {
102 }
103
104 virtual wxDirTraverseResult OnFile( const wxString& aFileName ) override
105 {
106 wxFileName file( aFileName );
107
108 for( const std::string& ext : m_searchExtensions )
109 {
110 if( file.GetExt().IsSameAs( ext, false ) )
111 m_foundDirs.insert( { m_currentDir, 1 } );
112 }
113
114 return wxDIR_CONTINUE;
115 }
116
117 virtual wxDirTraverseResult OnOpenError( const wxString& aOpenErrorName ) override
118 {
119 m_failedDirs.insert( { aOpenErrorName, 1 } );
120 return wxDIR_IGNORE;
121 }
122
124 {
125 return m_failedDirs.size() > 0;
126 }
127
128 virtual wxDirTraverseResult OnDir( const wxString& aDirName ) override
129 {
130 m_currentDir = aDirName;
131 return wxDIR_CONTINUE;
132 }
133
134 void GetPaths( wxArrayString& aPathArray )
135 {
136 for( std::pair<const wxString, int>& foundDirsPair : m_foundDirs )
137 aPathArray.Add( foundDirsPair.first );
138 }
139
140 void GetFailedPaths( wxArrayString& aPathArray )
141 {
142 for( std::pair<const wxString, int>& failedDirsPair : m_failedDirs )
143 aPathArray.Add( failedDirsPair.first );
144 }
145
146private:
147 std::vector<std::string> m_searchExtensions;
148 wxString m_currentDir;
149 std::unordered_map<wxString, int> m_foundDirs;
150 std::unordered_map<wxString, int> m_failedDirs;
151};
152
153
158{
159 friend class PANEL_FP_LIB_TABLE;
160 friend class FP_GRID_TRICKS;
161
162protected:
163 LIB_TABLE_ROW* at( size_t aIndex ) override { return &m_rows.at( aIndex ); }
164
165 size_t size() const override { return m_rows.size(); }
166
168 {
169 return dynamic_cast< LIB_TABLE_ROW* >( new FP_LIB_TABLE_ROW );
170 }
171
172 LIB_TABLE_ROWS_ITER begin() override { return m_rows.begin(); }
173
175 {
176 return m_rows.insert( aIterator, aRow );
177 }
178
179 void push_back( LIB_TABLE_ROW* aRow ) override { m_rows.push_back( aRow ); }
180
182 {
183 return m_rows.erase( aFirst, aLast );
184 }
185
186public:
187
188 FP_LIB_TABLE_GRID( const FP_LIB_TABLE& aTableToEdit )
189 {
190 m_rows = aTableToEdit.m_rows;
191 }
192
193 void SetValue( int aRow, int aCol, const wxString &aValue ) override
194 {
195 wxCHECK( aRow < (int) size(), /* void */ );
196
197 LIB_TABLE_GRID::SetValue( aRow, aCol, aValue );
198
199 // If setting a filepath, attempt to auto-detect the format
200 if( aCol == COL_URI )
201 {
202 LIB_TABLE_ROW* row = at( (size_t) aRow );
203 wxString fullURI = row->GetFullURI( true );
204
206
207 if( pluginType == PCB_IO_MGR::FILE_TYPE_NONE )
208 pluginType = PCB_IO_MGR::KICAD_SEXP;
209
210 SetValue( aRow, COL_TYPE, PCB_IO_MGR::ShowType( pluginType ) );
211 }
212 }
213};
214
215
216
218{
219public:
221 LIB_TABLE_GRID_TRICKS( aGrid ), m_dialog( aParent )
222 { }
223
224protected:
226
227 void optionsEditor( int aRow ) override
228 {
229 FP_LIB_TABLE_GRID* tbl = (FP_LIB_TABLE_GRID*) m_grid->GetTable();
230
231 if( tbl->GetNumberRows() > aRow )
232 {
233 LIB_TABLE_ROW* row = tbl->at( (size_t) aRow );
234 const wxString& options = row->GetOptions();
235 wxString result = options;
236 STRING_UTF8_MAP choices;
237
240 pi->GetLibraryOptions( &choices );
241
242 DIALOG_PLUGIN_OPTIONS dlg( m_dialog, row->GetNickName(), choices, options, &result );
243 dlg.ShowModal();
244
245 if( options != result )
246 {
247 row->SetOptions( result );
248 m_grid->Refresh();
249 }
250 }
251 }
252
255 void paste_text( const wxString& cb_text ) override
256 {
257 FP_LIB_TABLE_GRID* tbl = (FP_LIB_TABLE_GRID*) m_grid->GetTable();
258 size_t ndx = cb_text.find( "(fp_lib_table" );
259
260 if( ndx != std::string::npos )
261 {
262 // paste the FP_LIB_TABLE_ROWs of s-expression (fp_lib_table), starting
263 // at column 0 regardless of current cursor column.
264
265 STRING_LINE_READER slr( TO_UTF8( cb_text ), wxT( "Clipboard" ) );
266 LIB_TABLE_LEXER lexer( &slr );
267 FP_LIB_TABLE tmp_tbl;
268 bool parsed = true;
269
270 try
271 {
272 tmp_tbl.Parse( &lexer );
273 }
274 catch( PARSE_ERROR& pe )
275 {
276 DisplayError( m_dialog, pe.What() );
277 parsed = false;
278 }
279
280 if( parsed )
281 {
282 // make sure the table is big enough...
283 if( tmp_tbl.GetCount() > (unsigned) tbl->GetNumberRows() )
284 tbl->AppendRows( tmp_tbl.GetCount() - tbl->GetNumberRows() );
285
286 for( unsigned i = 0; i < tmp_tbl.GetCount(); ++i )
287 tbl->m_rows.replace( i, tmp_tbl.At( i ).clone() );
288 }
289
290 m_grid->AutoSizeColumns( false );
291 }
292 else
293 {
294 // paste spreadsheet formatted text.
295 GRID_TRICKS::paste_text( cb_text );
296
297 m_grid->AutoSizeColumns( false );
298 }
299 }
300};
301
302
304{
306
307 auto autoSizeCol = [&]( WX_GRID* aLocGrid, int aCol )
308 {
309 int prevWidth = aLocGrid->GetColSize( aCol );
310
311 aLocGrid->AutoSizeColumn( aCol, false );
312 aLocGrid->SetColSize( aCol, std::max( prevWidth, aLocGrid->GetColSize( aCol ) ) );
313 };
314
315 // Give a bit more room for wxChoice editors
316 for( int ii = 0; ii < aGrid->GetNumberRows(); ++ii )
317 aGrid->SetRowSize( ii, aGrid->GetDefaultRowSize() + 4 );
318
319 // add Cut, Copy, and Paste to wxGrids
320 aGrid->PushEventHandler( new FP_GRID_TRICKS( m_parent, aGrid ) );
321
322 aGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
323
324 wxGridCellAttr* attr;
325
326 attr = new wxGridCellAttr;
327 attr->SetEditor( new GRID_CELL_PATH_EDITOR(
329 [this]( WX_GRID* grid, int row ) -> wxString
330 {
331 auto* libTable = static_cast<FP_LIB_TABLE_GRID*>( grid->GetTable() );
332 auto* tableRow = static_cast<FP_LIB_TABLE_ROW*>( libTable->at( row ) );
333 PCB_IO_MGR::PCB_FILE_T fileType = tableRow->GetFileType();
334 const IO_BASE::IO_FILE_DESC& pluginDesc = m_supportedFpFiles.at( fileType );
335
336 if( pluginDesc.m_IsFile )
337 return pluginDesc.FileFilter();
338 else
339 return wxEmptyString;
340 } ) );
341 aGrid->SetColAttr( COL_URI, attr );
342
343 attr = new wxGridCellAttr;
344 attr->SetEditor( new wxGridCellChoiceEditor( m_pluginChoices ) );
345 aGrid->SetColAttr( COL_TYPE, attr );
346
347 attr = new wxGridCellAttr;
348 attr->SetRenderer( new wxGridCellBoolRenderer() );
349 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
350 aGrid->SetColAttr( COL_ENABLED, attr );
351
352 // No visibility control for footprint libraries yet; this feature is primarily
353 // useful for database libraries and it's only implemented for schematic symbols
354 // at the moment.
355 aGrid->HideCol( COL_VISIBLE );
356
357 // all but COL_OPTIONS, which is edited with Option Editor anyways.
358 autoSizeCol( aGrid, COL_NICKNAME );
359 autoSizeCol( aGrid, COL_TYPE );
360 autoSizeCol( aGrid, COL_URI );
361 autoSizeCol( aGrid, COL_DESCR );
362
363 // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
364 // a currentCell which is sometimes not highlighted.
365 if( aGrid->GetNumberRows() > 0 )
366 aGrid->SelectRow( 0 );
367};
368
369
371 FP_LIB_TABLE* aGlobalTable, const wxString& aGlobalTblPath,
372 FP_LIB_TABLE* aProjectTable, const wxString& aProjectTblPath,
373 const wxString& aProjectBasePath ) :
374 PANEL_FP_LIB_TABLE_BASE( aParent ),
375 m_globalTable( aGlobalTable ),
376 m_projectTable( aProjectTable ),
377 m_project( aProject ),
378 m_projectBasePath( aProjectBasePath ),
379 m_parent( aParent )
380{
381 m_global_grid->SetTable( new FP_LIB_TABLE_GRID( *aGlobalTable ), true );
382
383 // add Cut, Copy, and Paste to wxGrids
384 m_path_subs_grid->PushEventHandler( new GRID_TRICKS( m_path_subs_grid ) );
385
387
388 for( auto& [fileType, desc] : m_supportedFpFiles )
390
391
393
394 if( cfg->m_lastFootprintLibDir.IsEmpty() )
396
398
400
402
403 if( aProjectTable )
404 {
405 m_project_grid->SetTable( new FP_LIB_TABLE_GRID( *aProjectTable ), true );
407 }
408 else
409 {
410 m_pageNdx = 0;
411 m_notebook->DeletePage( 1 );
412 m_project_grid = nullptr;
413 }
414
415 m_path_subs_grid->SetColLabelValue( 0, _( "Name" ) );
416 m_path_subs_grid->SetColLabelValue( 1, _( "Value" ) );
417
418 // select the last selected page
419 m_notebook->SetSelection( m_pageNdx );
421
422 // for ALT+A handling, we want the initial focus to be on the first selected grid.
424
425 // Configure button logos
426 m_append_button->SetBitmap( KiBitmapBundle( BITMAPS::small_plus ) );
427 m_delete_button->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
428 m_move_up_button->SetBitmap( KiBitmapBundle( BITMAPS::small_up ) );
429 m_move_down_button->SetBitmap( KiBitmapBundle( BITMAPS::small_down ) );
430 m_browseButton->SetBitmap( KiBitmapBundle( BITMAPS::small_folder ) );
431
432 // For aesthetic reasons, we must set the size of m_browseButton to match the other bitmaps
433 // manually (for instance m_append_button)
434 Layout(); // Needed at least on MSW to compute the actual buttons sizes, after initializing
435 // their bitmaps
436 wxSize buttonSize = m_append_button->GetSize();
437
439 m_browseButton->SetMinSize( buttonSize );
440
441 // Populate the browse library options
442 wxMenu* browseMenu = m_browseButton->GetSplitButtonMenu();
443
444 auto joinExts = []( const std::vector<std::string>& aExts )
445 {
446 wxString joined;
447 for( const std::string& ext : aExts )
448 {
449 if( !joined.empty() )
450 joined << wxS( ", " );
451
452 joined << wxS( "*." ) << ext;
453 }
454
455 return joined;
456 };
457
458 for( auto& [type, desc] : m_supportedFpFiles )
459 {
460 wxString entryStr = PCB_IO_MGR::ShowType( type );
461
462 if( desc.m_IsFile && !desc.m_FileExtensions.empty() )
463 {
464 entryStr << wxString::Format( wxS( " (%s)" ),
465 joinExts( desc.m_FileExtensions ) );
466 }
467 else if( !desc.m_IsFile && !desc.m_ExtensionsInDir.empty() )
468 {
469 wxString midPart = wxString::Format( _( "folder with %s files" ),
470 joinExts( desc.m_ExtensionsInDir ) );
471
472 entryStr << wxString::Format( wxS( " (%s)" ), midPart );
473 }
474
475 browseMenu->Append( type, entryStr );
476
477 browseMenu->Bind( wxEVT_COMMAND_MENU_SELECTED, &PANEL_FP_LIB_TABLE::browseLibrariesHandler,
478 this, type );
479 }
480
481 Layout();
482
483 // This is the button only press for the browse button instead of the menu
485}
486
487
489{
490 wxMenu* browseMenu = m_browseButton->GetSplitButtonMenu();
491 for( auto& [type, desc] : m_supportedFpFiles )
492 {
493 browseMenu->Unbind( wxEVT_COMMAND_MENU_SELECTED,
495 }
496 m_browseButton->Unbind( wxEVT_BUTTON, &PANEL_FP_LIB_TABLE::browseLibrariesHandler, this );
497
498 // Delete the GRID_TRICKS.
499 // Any additional event handlers should be popped before the window is deleted.
500 m_global_grid->PopEventHandler( true );
501
502 if( m_project_grid )
503 m_project_grid->PopEventHandler( true );
504
505 m_path_subs_grid->PopEventHandler( true );
506}
507
508
510{
511 for( const auto& plugin : PCB_IO_MGR::PLUGIN_REGISTRY::Instance()->AllPlugins() )
512 {
513 IO_RELEASER<PCB_IO> pi( plugin.m_createFunc() );
514
515 if( !pi )
516 continue;
517
518 if( const IO_BASE::IO_FILE_DESC& desc = pi->GetLibraryDesc() )
519 m_supportedFpFiles.emplace( plugin.m_type, desc );
520 }
521}
522
523
525{
526 wxString msg;
527
528 for( FP_LIB_TABLE_GRID* model : { global_model(), project_model() } )
529 {
530 if( !model )
531 continue;
532
533 for( int r = 0; r < model->GetNumberRows(); )
534 {
535 wxString nick = model->GetValue( r, COL_NICKNAME ).Trim( false ).Trim();
536 wxString uri = model->GetValue( r, COL_URI ).Trim( false ).Trim();
537 unsigned illegalCh = 0;
538
539 if( !nick || !uri )
540 {
541 if( !nick && !uri )
542 msg = _( "A library table row nickname and path cells are empty." );
543 else if( !nick )
544 msg = _( "A library table row nickname cell is empty." );
545 else
546 msg = _( "A library table row path cell is empty." );
547
548 wxWindow* topLevelParent = wxGetTopLevelParent( this );
549
550 wxMessageDialog badCellDlg( topLevelParent, msg, _( "Invalid Row Definition" ),
551 wxYES_NO | wxCENTER | wxICON_QUESTION | wxYES_DEFAULT );
552 badCellDlg.SetExtendedMessage( _( "Empty cells will result in all rows that are "
553 "invalid to be removed from the table." ) );
554 badCellDlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Remove Invalid Cells" ) ),
555 wxMessageDialog::ButtonLabel( _( "Cancel Table Update" ) ) );
556
557 if( badCellDlg.ShowModal() == wxID_NO )
558 return false;
559
560 // Delete the "empty" row, where empty means missing nick or uri.
561 // This also updates the UI which could be slow, but there should only be a few
562 // rows to delete, unless the user fell asleep on the Add Row
563 // button.
564 model->DeleteRows( r, 1 );
565 }
566 else if( ( illegalCh = LIB_ID::FindIllegalLibraryNameChar( nick ) ) )
567 {
568 msg = wxString::Format( _( "Illegal character '%c' in nickname '%s'." ),
569 illegalCh,
570 nick );
571
572 // show the tabbed panel holding the grid we have flunked:
573 if( model != cur_model() )
574 m_notebook->SetSelection( model == global_model() ? 0 : 1 );
575
576 m_cur_grid->MakeCellVisible( r, 0 );
577 m_cur_grid->SetGridCursor( r, 1 );
578
579 wxWindow* topLevelParent = wxGetTopLevelParent( this );
580
581 wxMessageDialog errdlg( topLevelParent, msg, _( "Library Nickname Error" ) );
582 errdlg.ShowModal();
583 return false;
584 }
585 else
586 {
587 // set the trimmed values back into the table so they get saved to disk.
588 model->SetValue( r, COL_NICKNAME, nick );
589 model->SetValue( r, COL_URI, uri );
590
591 // Make sure to not save a hidden flag
592 model->SetValue( r, COL_VISIBLE, wxS( "1" ) );
593
594 ++r; // this row was OK.
595 }
596 }
597 }
598
599 // check for duplicate nickNames, separately in each table.
600 for( FP_LIB_TABLE_GRID* model : { global_model(), project_model() } )
601 {
602 if( !model )
603 continue;
604
605 for( int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
606 {
607 wxString nick1 = model->GetValue( r1, COL_NICKNAME );
608
609 for( int r2 = r1 + 1; r2 < model->GetNumberRows(); ++r2 )
610 {
611 wxString nick2 = model->GetValue( r2, COL_NICKNAME );
612
613 if( nick1 == nick2 )
614 {
615 msg = wxString::Format( _( "Multiple libraries cannot share the same "
616 "nickname ('%s')." ),
617 nick1 );
618
619 // show the tabbed panel holding the grid we have flunked:
620 if( model != cur_model() )
621 m_notebook->SetSelection( model == global_model() ? 0 : 1 );
622
623 // go to the lower of the two rows, it is technically the duplicate:
624 m_cur_grid->MakeCellVisible( r2, 0 );
625 m_cur_grid->SetGridCursor( r2, 1 );
626
627 wxWindow* topLevelParent = wxGetTopLevelParent( this );
628
629 wxMessageDialog errdlg( topLevelParent, msg, _( "Library Nickname Error" ) );
630 errdlg.ShowModal();
631 return false;
632 }
633 }
634 }
635 }
636
637 return true;
638}
639
640
641void PANEL_FP_LIB_TABLE::OnUpdateUI( wxUpdateUIEvent& event )
642{
643}
644
645
646void PANEL_FP_LIB_TABLE::appendRowHandler( wxCommandEvent& event )
647{
649 return;
650
651 if( m_cur_grid->AppendRows( 1 ) )
652 {
653 int last_row = m_cur_grid->GetNumberRows() - 1;
654
655 // wx documentation is wrong, SetGridCursor does not make visible.
656 m_cur_grid->MakeCellVisible( last_row, COL_ENABLED );
657 m_cur_grid->SetGridCursor( last_row, COL_NICKNAME );
658 m_cur_grid->EnableCellEditControl( true );
659 m_cur_grid->ShowCellEditControl();
660 }
661}
662
663
664void PANEL_FP_LIB_TABLE::deleteRowHandler( wxCommandEvent& event )
665{
667 return;
668
669 int curRow = m_cur_grid->GetGridCursorRow();
670 int curCol = m_cur_grid->GetGridCursorCol();
671
672 // In a wxGrid, collect rows that have a selected cell, or are selected
673 // It is not so easy: it depends on the way the selection was made.
674 // Here, we collect rows selected by clicking on a row label, and rows that contain any
675 // previously-selected cells.
676 // If no candidate, just delete the row with the grid cursor.
677 wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
678 wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells();
679 wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft();
680 wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight();
681
682 // Add all row having cell selected to list:
683 for( unsigned ii = 0; ii < cells.GetCount(); ii++ )
684 selectedRows.Add( cells[ii].GetRow() );
685
686 // Handle block selection
687 if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
688 {
689 for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
690 selectedRows.Add( i );
691 }
692
693 // Use the row having the grid cursor only if we have no candidate:
694 if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 )
695 selectedRows.Add( m_cur_grid->GetGridCursorRow() );
696
697 if( selectedRows.size() == 0 )
698 {
699 wxBell();
700 return;
701 }
702
703 std::sort( selectedRows.begin(), selectedRows.end() );
704
705 // Remove selected rows (note: a row can be stored more than once in list)
706 int last_row = -1;
707
708 // Needed to avoid a wxWidgets alert if the row to delete is the last row
709 // at least on wxMSW 3.2
710 m_cur_grid->ClearSelection();
711
712 for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
713 {
714 int row = selectedRows[ii];
715
716 if( row != last_row )
717 {
718 last_row = row;
719 m_cur_grid->DeleteRows( row, 1 );
720 }
721 }
722
723 if( m_cur_grid->GetNumberRows() > 0 && curRow >= 0 )
724 m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol );
725}
726
727
728void PANEL_FP_LIB_TABLE::moveUpHandler( wxCommandEvent& event )
729{
731 return;
732
734 int curRow = m_cur_grid->GetGridCursorRow();
735
736 // @todo: add multiple selection moves.
737 if( curRow >= 1 )
738 {
739 boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
740 tbl->m_rows.release( tbl->m_rows.begin() + curRow );
741
742 --curRow;
743 tbl->m_rows.insert( tbl->m_rows.begin() + curRow, move_me.release() );
744
745 if( tbl->GetView() )
746 {
747 // Update the wxGrid
748 wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
749 tbl->GetView()->ProcessTableMessage( msg );
750 }
751
752 m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
753 m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
754 }
755}
756
757
758void PANEL_FP_LIB_TABLE::moveDownHandler( wxCommandEvent& event )
759{
761 return;
762
764 int curRow = m_cur_grid->GetGridCursorRow();
765
766 // @todo: add multiple selection moves.
767 if( unsigned( curRow + 1 ) < tbl->m_rows.size() )
768 {
769 boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
770 tbl->m_rows.release( tbl->m_rows.begin() + curRow );
771
772 ++curRow;
773 tbl->m_rows.insert( tbl->m_rows.begin() + curRow, move_me.release() );
774
775 if( tbl->GetView() )
776 {
777 // Update the wxGrid
778 wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
779 tbl->GetView()->ProcessTableMessage( msg );
780 }
781
782 m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
783 m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
784 }
785}
786
787
788// @todo refactor this function into single location shared with PANEL_SYM_LIB_TABLE
789void PANEL_FP_LIB_TABLE::onMigrateLibraries( wxCommandEvent& event )
790{
792 return;
793
794 wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
795
796 if( selectedRows.empty() && m_cur_grid->GetGridCursorRow() >= 0 )
797 selectedRows.push_back( m_cur_grid->GetGridCursorRow() );
798
799 wxArrayInt rowsToMigrate;
800 wxString kicadType = PCB_IO_MGR::ShowType( PCB_IO_MGR::KICAD_SEXP );
801 wxString msg;
802
803 for( int row : selectedRows )
804 {
805 if( m_cur_grid->GetCellValue( row, COL_TYPE ) != kicadType )
806 rowsToMigrate.push_back( row );
807 }
808
809 if( rowsToMigrate.size() <= 0 )
810 {
811 wxMessageBox( wxString::Format( _( "Select one or more rows containing libraries "
812 "to save as current KiCad format." ) ) );
813 return;
814 }
815 else
816 {
817 if( rowsToMigrate.size() == 1 )
818 {
819 msg.Printf( _( "Save '%s' as current KiCad format "
820 "and replace entry in table?" ),
821 m_cur_grid->GetCellValue( rowsToMigrate[0], COL_NICKNAME ) );
822 }
823 else
824 {
825 msg.Printf( _( "Save %d libraries as current KiCad format "
826 "and replace entries in table?" ),
827 (int) rowsToMigrate.size() );
828 }
829
830 if( !IsOK( m_parent, msg ) )
831 return;
832 }
833
834 for( int row : rowsToMigrate )
835 {
836 wxString libName = m_cur_grid->GetCellValue( row, COL_NICKNAME );
837 wxString relPath = m_cur_grid->GetCellValue( row, COL_URI );
838 wxString resolvedPath = ExpandEnvVarSubstitutions( relPath, m_project );
839 wxFileName legacyLib( resolvedPath );
840
841 if( !legacyLib.Exists() )
842 {
843 msg.Printf( _( "Library '%s' not found." ), relPath );
844 DisplayErrorMessage( wxGetTopLevelParent( this ), msg );
845 continue;
846 }
847
848 wxFileName newLib( resolvedPath );
849 newLib.AppendDir( newLib.GetName() + "." + FILEEXT::KiCadFootprintLibPathExtension );
850 newLib.SetName( "" );
851 newLib.ClearExt();
852
853 if( newLib.DirExists() )
854 {
855 msg.Printf( _( "Folder '%s' already exists. Do you want overwrite any existing footprints?" ),
856 newLib.GetFullPath() );
857
858 switch( wxMessageBox( msg, _( "Migrate Library" ),
859 wxYES_NO | wxCANCEL | wxICON_QUESTION, m_parent ) )
860 {
861 case wxYES: break;
862 case wxNO: continue;
863 case wxCANCEL: return;
864 }
865 }
866
867 wxString options = m_cur_grid->GetCellValue( row, COL_OPTIONS );
868 std::unique_ptr<STRING_UTF8_MAP> props( LIB_TABLE::ParseOptions( options.ToStdString() ) );
869
870 if( PCB_IO_MGR::ConvertLibrary( props.get(), legacyLib.GetFullPath(), newLib.GetFullPath() ) )
871 {
872 relPath = NormalizePath( newLib.GetFullPath(), &Pgm().GetLocalEnvVariables(),
873 m_project );
874
875 // Do not use the project path in the global library table. This will almost
876 // assuredly be wrong for a different project.
877 if( m_cur_grid == m_global_grid && relPath.Contains( "${KIPRJMOD}" ) )
878 relPath = newLib.GetFullPath();
879
880 m_cur_grid->SetCellValue( row, COL_URI, relPath );
881 m_cur_grid->SetCellValue( row, COL_TYPE, kicadType );
882 }
883 else
884 {
885 msg.Printf( _( "Failed to save footprint library file '%s'." ), newLib.GetFullPath() );
886 DisplayErrorMessage( wxGetTopLevelParent( this ), msg );
887 }
888 }
889}
890
891
893{
895 return;
896
898
899 // We are bound both to the menu and button with this one handler
900 // So we must set the file type based on it
901 if( event.GetEventType() == wxEVT_BUTTON )
902 {
903 // Let's default to adding a kicad footprint file for just the footprint
905 }
906 else
907 {
908 fileType = static_cast<PCB_IO_MGR::PCB_FILE_T>( event.GetId() );
909 }
910
912 {
913 wxLogWarning( wxT( "File type selection event received but could not find the file type "
914 "in the table" ) );
915 return;
916 }
917
918 const IO_BASE::IO_FILE_DESC& fileDesc = m_supportedFpFiles.at( fileType );
920
921 wxString title = wxString::Format( _( "Select %s Library" ), PCB_IO_MGR::ShowType( fileType ) );
922 wxString openDir = cfg->m_lastFootprintLibDir;
923
925 openDir = m_lastProjectLibDir;
926
927 wxArrayString files;
928
929 wxWindow* topLevelParent = wxGetTopLevelParent( this );
930
931 if( fileDesc.m_IsFile )
932 {
933 wxFileDialog dlg( topLevelParent, title, openDir, wxEmptyString, fileDesc.FileFilter(),
934 wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
935
936 int result = dlg.ShowModal();
937
938 if( result == wxID_CANCEL )
939 return;
940
941 dlg.GetPaths( files );
942
944 cfg->m_lastFootprintLibDir = dlg.GetDirectory();
945 else
946 m_lastProjectLibDir = dlg.GetDirectory();
947 }
948 else
949 {
950 wxDirDialog dlg( topLevelParent, title, openDir,
951 wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST | wxDD_MULTIPLE );
952
953 int result = dlg.ShowModal();
954
955 if( result == wxID_CANCEL )
956 return;
957
958 dlg.GetPaths( files );
959
960 if( !files.IsEmpty() )
961 {
962 wxFileName first( files.front() );
963
965 cfg->m_lastFootprintLibDir = first.GetPath();
966 else
967 m_lastProjectLibDir = first.GetPath();
968 }
969 }
970
971 // Drop the last directory if the path is a .pretty folder
973 cfg->m_lastFootprintLibDir = cfg->m_lastFootprintLibDir.BeforeLast( wxFileName::GetPathSeparator() );
974
975 const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
976 bool addDuplicates = false;
977 bool applyToAll = false;
978 wxString warning = _( "Warning: Duplicate Nicknames" );
979 wxString msg = _( "A library nicknamed '%s' already exists." );
980 wxString detailedMsg = _( "One of the nicknames will need to be changed after "
981 "adding this library." );
982
983 for( const wxString& filePath : files )
984 {
985 wxFileName fn( filePath );
986 wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), true );
987 bool doAdd = true;
988
991 nickname = LIB_ID::FixIllegalChars( fn.GetFullName(), true ).wx_str();
992
993 if( cur_model()->ContainsNickname( nickname ) )
994 {
995 if( !applyToAll )
996 {
997 // The cancel button adds the library to the table anyway
998 addDuplicates = OKOrCancelDialog( wxGetTopLevelParent( this ), warning,
999 wxString::Format( msg, nickname ),
1000 detailedMsg, _( "Skip" ), _( "Add Anyway" ),
1001 &applyToAll ) == wxID_CANCEL;
1002 }
1003
1004 doAdd = addDuplicates;
1005 }
1006
1007 if( doAdd && m_cur_grid->AppendRows( 1 ) )
1008 {
1009 int last_row = m_cur_grid->GetNumberRows() - 1;
1010
1011 m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
1012
1013 m_cur_grid->SetCellValue( last_row, COL_TYPE, PCB_IO_MGR::ShowType( fileType ) );
1014
1015 // try to use path normalized to an environmental variable or project path
1016 wxString path = NormalizePath( filePath, &envVars, m_projectBasePath );
1017
1018 // Do not use the project path in the global library table. This will almost
1019 // assuredly be wrong for a different project.
1020 if( m_pageNdx == 0 && path.Contains( wxT( "${KIPRJMOD}" ) ) )
1021 path = fn.GetFullPath();
1022
1023 m_cur_grid->SetCellValue( last_row, COL_URI, path );
1024 }
1025 }
1026
1027 if( !files.IsEmpty() )
1028 {
1029 int new_row = m_cur_grid->GetNumberRows() - 1;
1030 m_cur_grid->MakeCellVisible( new_row, m_cur_grid->GetGridCursorCol() );
1031 m_cur_grid->SetGridCursor( new_row, m_cur_grid->GetGridCursorCol() );
1032 }
1033}
1034
1035
1037{
1038 // Account for scroll bars
1039 aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
1040
1041 m_path_subs_grid->AutoSizeColumn( 0 );
1042 m_path_subs_grid->SetColSize( 0, std::max( 72, m_path_subs_grid->GetColSize( 0 ) ) );
1043 m_path_subs_grid->SetColSize( 1, std::max( 120, aWidth - m_path_subs_grid->GetColSize( 0 ) ) );
1044}
1045
1046
1047void PANEL_FP_LIB_TABLE::onSizeGrid( wxSizeEvent& event )
1048{
1049 adjustPathSubsGridColumns( event.GetSize().GetX() );
1050
1051 event.Skip();
1052}
1053
1054
1055void PANEL_FP_LIB_TABLE::onReset( wxCommandEvent& event )
1056{
1058 return;
1059
1060 // No need to prompt to preserve an empty table
1061 if( m_global_grid->GetNumberRows() > 0 &&
1062 !IsOK( this, wxString::Format( _( "This action will reset your global library table on "
1063 "disk and cannot be undone." ) ) ) )
1064 {
1065 return;
1066 }
1067
1069
1070 if( dlg.ShowModal() == wxID_OK )
1071 {
1072 m_global_grid->Freeze();
1073
1074 wxGridTableBase* table = m_global_grid->GetTable();
1075 m_global_grid->DestroyTable( table );
1076
1078 m_global_grid->PopEventHandler( true );
1081
1082 m_global_grid->Thaw();
1083 }
1084}
1085
1086
1087void PANEL_FP_LIB_TABLE::onPageChange( wxBookCtrlEvent& event )
1088{
1089 m_pageNdx = (unsigned) std::max( 0, m_notebook->GetSelection() );
1090
1091 if( m_pageNdx == 0 )
1092 {
1094 m_resetGlobal->Enable();
1095 }
1096 else
1097 {
1099 m_resetGlobal->Disable();
1100 }
1101}
1102
1103
1105{
1107 return false;
1108
1109 if( verifyTables() )
1110 {
1111 if( *global_model() != *m_globalTable )
1112 {
1114
1117 }
1118
1120 {
1122
1125 }
1126
1127 return true;
1128 }
1129
1130 return false;
1131}
1132
1133
1137{
1138 wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
1139 wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required.
1140
1141 std::set< wxString > unique;
1142
1143 // clear the table
1145
1146 for( FP_LIB_TABLE_GRID* tbl : { global_model(), project_model() } )
1147 {
1148 if( !tbl )
1149 continue;
1150
1151 for( int row = 0; row < tbl->GetNumberRows(); ++row )
1152 {
1153 wxString uri = tbl->GetValue( row, COL_URI );
1154
1155 while( re.Matches( uri ) )
1156 {
1157 wxString envvar = re.GetMatch( uri, 2 );
1158
1159 // if not ${...} form then must be $(...)
1160 if( envvar.IsEmpty() )
1161 envvar = re.GetMatch( uri, 4 );
1162
1163 // ignore duplicates
1164 unique.insert( envvar );
1165
1166 // delete the last match and search again
1167 uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString );
1168 }
1169 }
1170 }
1171
1172 // Make sure this special environment variable shows up even if it was
1173 // not used yet. It is automatically set by KiCad to the directory holding
1174 // the current project.
1175 unique.insert( PROJECT_VAR_NAME );
1176 unique.insert( FP_LIB_TABLE::GlobalPathEnvVariableName() );
1177
1178 // This special environment variable is used to locate 3d shapes
1179 unique.insert( ENV_VAR::GetVersionedEnvVarName( wxS( "3DMODEL_DIR" ) ) );
1180
1181 for( const wxString& evName : unique )
1182 {
1183 int row = m_path_subs_grid->GetNumberRows();
1184 m_path_subs_grid->AppendRows( 1 );
1185
1186 m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) );
1187 m_path_subs_grid->SetCellEditor( row, 0, new GRID_CELL_READONLY_TEXT_EDITOR() );
1188
1189 wxString evValue;
1190 wxGetEnv( evName, &evValue );
1191 m_path_subs_grid->SetCellValue( row, 1, evValue );
1192 m_path_subs_grid->SetCellEditor( row, 1, new GRID_CELL_READONLY_TEXT_EDITOR() );
1193 }
1194
1195 // No combobox editors here, but it looks better if its consistent with the other
1196 // grids in the dialog.
1197 m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 2 );
1198
1199 adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() );
1200}
1201
1202//-----</event handlers>---------------------------------
1203
1204
1205
1207
1208
1209void InvokePcbLibTableEditor( KIWAY* aKiway, wxWindow* aCaller )
1210{
1211 FP_LIB_TABLE* globalTable = &GFootprintTable;
1212 wxString globalTablePath = FP_LIB_TABLE::GetGlobalTableFileName();
1213 FP_LIB_TABLE* projectTable = PROJECT_PCB::PcbFootprintLibs( &aKiway->Prj() );
1214 wxString projectTablePath = aKiway->Prj().FootprintLibTblName();
1215 wxString msg;
1216
1217 DIALOG_EDIT_LIBRARY_TABLES dlg( aCaller, _( "Footprint Libraries" ) );
1218 dlg.SetKiway( &dlg, aKiway );
1219
1220 if( aKiway->Prj().IsNullProject() )
1221 projectTable = nullptr;
1222
1223 dlg.InstallPanel( new PANEL_FP_LIB_TABLE( &dlg, &aKiway->Prj(), globalTable, globalTablePath,
1224 projectTable, projectTablePath,
1225 aKiway->Prj().GetProjectPath() ) );
1226
1227 if( dlg.ShowModal() == wxID_CANCEL )
1228 return;
1229
1230 if( dlg.m_GlobalTableChanged )
1231 {
1232 try
1233 {
1234 globalTable->Save( globalTablePath );
1235 }
1236 catch( const IO_ERROR& ioe )
1237 {
1238 msg.Printf( _( "Error saving global library table:\n\n%s" ), ioe.What() );
1239 wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
1240 }
1241 }
1242
1243 if( projectTable && dlg.m_ProjectTableChanged )
1244 {
1245 try
1246 {
1247 projectTable->Save( projectTablePath );
1248 }
1249 catch( const IO_ERROR& ioe )
1250 {
1251 msg.Printf( _( "Error saving project-specific library table:\n\n%s" ), ioe.What() );
1252 wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
1253 }
1254 }
1255
1256 std::string payload = "";
1259 aKiway->ExpressMail( FRAME_CVPCB, MAIL_RELOAD_LIB, payload );
1260}
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap)
Definition: bitmap.cpp:110
DIALOG_PLUGIN_OPTIONS is an options editor in the form of a two column name/value spreadsheet like (t...
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:102
void paste_text(const wxString &cb_text) override
handle specialized clipboard text, with leading "(fp_lib_table", OR spreadsheet formatted text.
DIALOG_EDIT_LIBRARY_TABLES * m_dialog
FP_GRID_TRICKS(DIALOG_EDIT_LIBRARY_TABLES *aParent, WX_GRID *aGrid)
void optionsEditor(int aRow) override
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.
size_t size() const override
FP_LIB_TABLE_GRID(const FP_LIB_TABLE &aTableToEdit)
void SetValue(int aRow, int aCol, const wxString &aValue) override
LIB_TABLE_ROWS_ITER begin() override
LIB_TABLE_ROWS_ITER erase(LIB_TABLE_ROWS_ITER aFirst, LIB_TABLE_ROWS_ITER aLast) override
LIB_TABLE_ROW * makeNewRow() override
LIB_TABLE_ROW * at(size_t aIndex) override
void push_back(LIB_TABLE_ROW *aRow) override
LIB_TABLE_ROWS_ITER insert(LIB_TABLE_ROWS_ITER aIterator, LIB_TABLE_ROW *aRow) override
Hold a record identifying a library accessed by the appropriate footprint library #PLUGIN object in t...
Definition: fp_lib_table.h:42
static const wxString GlobalPathEnvVariableName()
Return the name of the environment variable used to hold the directory of locally installed "KiCad sp...
virtual void Parse(LIB_TABLE_LEXER *aLexer) override
Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objec...
static wxString GetGlobalTableFileName()
Editor for wxGrid cells that adds a file/folder browser to the grid input field.
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:61
virtual void paste_text(const wxString &cb_text)
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:125
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
It is only used for debugging, since "this" is not a wxWindow*.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:527
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:196
Traverser implementation that looks to find any and all "folder" libraries by looking for files with ...
void GetPaths(wxArrayString &aPathArray)
virtual wxDirTraverseResult OnOpenError(const wxString &aOpenErrorName) override
std::unordered_map< wxString, int > m_failedDirs
std::vector< std::string > m_searchExtensions
void GetFailedPaths(wxArrayString &aPathArray)
LIBRARY_TRAVERSER(std::vector< std::string > aSearchExtensions, wxString aInitialDir)
std::unordered_map< wxString, int > m_foundDirs
virtual wxDirTraverseResult OnDir(const wxString &aDirName) override
virtual wxDirTraverseResult OnFile(const wxString &aFileName) override
static unsigned FindIllegalLibraryNameChar(const UTF8 &aLibraryName)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:243
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, bool aLib)
Replace illegal LIB_ID item name characters with underscores '_'.
Definition: lib_id.cpp:191
This abstract base class mixes any object derived from LIB_TABLE into wxGridTableBase so the result c...
void SetValue(int aRow, int aCol, const wxString &aValue) override
bool AppendRows(size_t aNumRows=1) override
int GetNumberRows() override
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
virtual const wxString GetType() const =0
Return the type of library represented by this row.
const wxString & GetNickName() const
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
LIB_TABLE_ROW * clone() const
void SetOptions(const wxString &aOptions)
Change the library options strings.
LIB_TABLE_ROW & At(unsigned aIndex)
Get the 'n'th LIB_TABLE_ROW object.
void TransferRows(LIB_TABLE_ROWS &aRowsList)
Takes ownership of another list of rows; the original list will be freed.
LIB_TABLE_ROWS m_rows
Owning set of rows.
void Clear()
Delete all rows.
unsigned GetCount() const
Get the number of rows contained in the table.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
static STRING_UTF8_MAP * ParseOptions(const std::string &aOptionsList)
Parses aOptionsList and places the result into a #PROPERTIES object which is returned.
Class PANEL_FP_LIB_TABLE_BASE.
STD_BITMAP_BUTTON * m_move_up_button
STD_BITMAP_BUTTON * m_append_button
STD_BITMAP_BUTTON * m_move_down_button
STD_BITMAP_BUTTON * m_delete_button
Dialog to show and edit symbol library tables.
FP_LIB_TABLE * m_globalTable
bool verifyTables()
Trim important fields, removes blank row entries, and checks for duplicates.
std::map< PCB_IO_MGR::PCB_FILE_T, IO_BASE::IO_FILE_DESC > m_supportedFpFiles
void onSizeGrid(wxSizeEvent &event) override
void moveUpHandler(wxCommandEvent &event) override
void adjustPathSubsGridColumns(int aWidth)
FP_LIB_TABLE_GRID * cur_model() const
FP_LIB_TABLE_GRID * project_model() const
void moveDownHandler(wxCommandEvent &event) override
wxArrayString m_pluginChoices
void setupGrid(WX_GRID *aGrid)
FP_LIB_TABLE_GRID * global_model() const
void populateEnvironReadOnlyTable()
Populate the readonly environment variable table with names and values by examining all the full_uri ...
FP_LIB_TABLE * m_projectTable
void deleteRowHandler(wxCommandEvent &event) override
void onReset(wxCommandEvent &event) override
void onMigrateLibraries(wxCommandEvent &event) override
void browseLibrariesHandler(wxCommandEvent &event)
bool TransferDataFromWindow() override
PANEL_FP_LIB_TABLE(DIALOG_EDIT_LIBRARY_TABLES *aParent, PROJECT *aProject, FP_LIB_TABLE *aGlobalTable, const wxString &aGlobalTblPath, FP_LIB_TABLE *aProjectTable, const wxString &aProjectTblPath, const wxString &aProjectBasePath)
DIALOG_EDIT_LIBRARY_TABLES * m_parent
void OnUpdateUI(wxUpdateUIEvent &event) override
void onPageChange(wxBookCtrlEvent &event) override
void appendRowHandler(wxCommandEvent &event) override
static wxString GetDefaultUserFootprintsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:98
wxString m_lastFootprintLibDir
static PLUGIN_REGISTRY * Instance()
Definition: pcb_io_mgr.h:93
static PCB_IO * PluginFind(PCB_FILE_T aFileType)
Return a #PLUGIN which the caller can use to import, export, save, or load design documents.
Definition: pcb_io_mgr.cpp:65
static bool ConvertLibrary(STRING_UTF8_MAP *aOldFileProps, const wxString &aOldFilePath, const wxString &aNewFilePath)
Convert a schematic symbol library to the latest KiCad format.
Definition: pcb_io_mgr.cpp:187
static PCB_FILE_T EnumFromStr(const wxString &aFileType)
Return the PCB_FILE_T from the corresponding plugin type name: "kicad", "legacy", etc.
Definition: pcb_io_mgr.cpp:90
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
@ FILE_TYPE_NONE
Definition: pcb_io_mgr.h:76
@ KICAD_SEXP
S-expression Pcbnew file format.
Definition: pcb_io_mgr.h:58
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a footprint library's libPath.
Definition: pcb_io_mgr.cpp:132
static const wxString ShowType(PCB_FILE_T aFileType)
Return a brief name for a plugin given aFileType enum.
Definition: pcb_io_mgr.cpp:74
virtual ENV_VAR_MAP & GetLocalEnvVariables() const
Definition: pgm_base.cpp:923
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
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 GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:135
virtual const wxString FootprintLibTblName() const
Returns the path and filename of this project's footprint library table.
Definition: project.cpp:165
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Definition: project.cpp:153
T * GetAppSettings()
Returns a handle to the a given settings by type If the settings have already been loaded,...
void SetBitmap(const wxBitmapBundle &aBmp)
void SetWidthPadding(int aPadding)
wxMenu * GetSplitButtonMenu()
void SetMinSize(const wxSize &aSize) override
void SetBitmap(const wxBitmapBundle &aBmp)
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:253
A name/value tuple with unique names and optional values.
wxString wx_str() const
Definition: utf8.cpp:45
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:267
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
Definition: wx_grid.cpp:400
void ClearRows()
wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number...
Definition: wx_grid.h:165
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:594
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:334
The common library.
int OKOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Display a warning dialog with aMessage and returns the user response.
Definition: confirm.cpp:143
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:250
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:170
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:195
This file is part of the common library.
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: cvpcb.cpp:150
#define _(s)
Declaration of the eda_3d_viewer class.
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
Definition: env_paths.cpp:71
Functions related to environment variables, including help functions.
@ FRAME_FOOTPRINT_VIEWER
Definition: frame_type.h:45
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:43
@ FRAME_CVPCB
Definition: frame_type.h:52
static const std::string KiCadFootprintLibPathExtension
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
Definition: io_mgr.h:33
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
@ COL_DESCR
@ COL_NICKNAME
@ COL_OPTIONS
@ COL_ENABLED
@ COL_URI
This file contains miscellaneous commonly used macros and functions.
@ MAIL_RELOAD_LIB
Definition: mail_type.h:56
KICOMMON_API wxString GetVersionedEnvVarName(const wxString &aBaseName)
Constructs a versioned environment variable based on this KiCad major version.
Definition: env_vars.cpp:74
void InvokePcbLibTableEditor(KIWAY *aKiway, wxWindow *aCaller)
Function InvokePcbLibTableEditor shows the modal DIALOG_FP_LIB_TABLE for purposes of editing the glob...
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:39
MODEL3D_FORMAT_TYPE fileType(const char *aFileName)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:391
Container that describes file type info.
Definition: io_base.h:40
bool m_IsFile
Whether the library is a folder or a file.
Definition: io_base.h:44
wxString FileFilter() const
Definition: io_base.cpp:40
A filename or source description, a problem input line, a line number, a byte offset,...
Definition: ki_exception.h:120
Container that describes file type info for the add a library options.
bool m_IsFile
Whether the library is a folder or a file.
PCB_IO_MGR::PCB_FILE_T m_Plugin
wxString m_Description
Description shown in the file picker dialog.
wxString m_FileFilter
Filter used for file pickers if m_IsFile is true.
wxString m_FolderSearchExtension
In case of folders it stands for extensions of files stored inside.
Definition of file extensions used in Kicad.