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 ),
222 m_dialog( aParent )
223 { }
224
225protected:
227
228 void optionsEditor( int aRow ) override
229 {
230 FP_LIB_TABLE_GRID* tbl = (FP_LIB_TABLE_GRID*) m_grid->GetTable();
231
232 if( tbl->GetNumberRows() > aRow )
233 {
234 LIB_TABLE_ROW* row = tbl->at( (size_t) aRow );
235 const wxString& options = row->GetOptions();
236 wxString result = options;
237 STRING_UTF8_MAP choices;
238
241 pi->GetLibraryOptions( &choices );
242
243 DIALOG_PLUGIN_OPTIONS dlg( m_dialog, row->GetNickName(), choices, options, &result );
244 dlg.ShowModal();
245
246 if( options != result )
247 {
248 row->SetOptions( result );
249 m_grid->Refresh();
250 }
251 }
252 }
253
256 void paste_text( const wxString& cb_text ) override
257 {
258 FP_LIB_TABLE_GRID* tbl = (FP_LIB_TABLE_GRID*) m_grid->GetTable();
259 size_t ndx = cb_text.find( "(fp_lib_table" );
260
261 if( ndx != std::string::npos )
262 {
263 // paste the FP_LIB_TABLE_ROWs of s-expression (fp_lib_table), starting
264 // at column 0 regardless of current cursor column.
265
266 STRING_LINE_READER slr( TO_UTF8( cb_text ), wxT( "Clipboard" ) );
267 LIB_TABLE_LEXER lexer( &slr );
268 FP_LIB_TABLE tmp_tbl;
269 bool parsed = true;
270
271 try
272 {
273 tmp_tbl.Parse( &lexer );
274 }
275 catch( PARSE_ERROR& pe )
276 {
277 DisplayError( m_dialog, pe.What() );
278 parsed = false;
279 }
280
281 if( parsed )
282 {
283 // make sure the table is big enough...
284 if( tmp_tbl.GetCount() > (unsigned) tbl->GetNumberRows() )
285 tbl->AppendRows( tmp_tbl.GetCount() - tbl->GetNumberRows() );
286
287 for( unsigned i = 0; i < tmp_tbl.GetCount(); ++i )
288 tbl->m_rows.replace( i, tmp_tbl.At( i ).clone() );
289 }
290
291 m_grid->AutoSizeColumns( false );
292 }
293 else
294 {
295 // paste spreadsheet formatted text.
296 GRID_TRICKS::paste_text( cb_text );
297
298 m_grid->AutoSizeColumns( false );
299 }
300 }
301
302
303 bool toggleCell( int aRow, int aCol, bool aPreserveSelection ) override
304 {
305 if( aCol == COL_VISIBLE )
306 {
307 m_dialog->ShowInfoBarError( _( "Hidden footprint libraries are not yet supported." ) );
308 return true;
309 }
310
311 return LIB_TABLE_GRID_TRICKS::toggleCell( aRow, aCol, aPreserveSelection );
312 }
313};
314
315
317{
319
320 auto autoSizeCol = [&]( WX_GRID* aLocGrid, int aCol )
321 {
322 int prevWidth = aLocGrid->GetColSize( aCol );
323
324 aLocGrid->AutoSizeColumn( aCol, false );
325 aLocGrid->SetColSize( aCol, std::max( prevWidth, aLocGrid->GetColSize( aCol ) ) );
326 };
327
328 // Give a bit more room for wxChoice editors
329 for( int ii = 0; ii < aGrid->GetNumberRows(); ++ii )
330 aGrid->SetRowSize( ii, aGrid->GetDefaultRowSize() + 4 );
331
332 // add Cut, Copy, and Paste to wxGrids
333 aGrid->PushEventHandler( new FP_GRID_TRICKS( m_parent, aGrid ) );
334
335 aGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
336
337 wxGridCellAttr* attr;
338
339 attr = new wxGridCellAttr;
340 attr->SetEditor( new GRID_CELL_PATH_EDITOR(
342 [this]( WX_GRID* grid, int row ) -> wxString
343 {
344 auto* libTable = static_cast<FP_LIB_TABLE_GRID*>( grid->GetTable() );
345 auto* tableRow = static_cast<FP_LIB_TABLE_ROW*>( libTable->at( row ) );
346 PCB_IO_MGR::PCB_FILE_T fileType = tableRow->GetFileType();
347 const IO_BASE::IO_FILE_DESC& pluginDesc = m_supportedFpFiles.at( fileType );
348
349 if( pluginDesc.m_IsFile )
350 return pluginDesc.FileFilter();
351 else
352 return wxEmptyString;
353 } ) );
354 aGrid->SetColAttr( COL_URI, attr );
355
356 attr = new wxGridCellAttr;
357 attr->SetEditor( new wxGridCellChoiceEditor( m_pluginChoices ) );
358 aGrid->SetColAttr( COL_TYPE, attr );
359
360 attr = new wxGridCellAttr;
361 attr->SetRenderer( new wxGridCellBoolRenderer() );
362 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
363 aGrid->SetColAttr( COL_ENABLED, attr );
364
365 attr = new wxGridCellAttr;
366 attr->SetRenderer( new wxGridCellBoolRenderer() );
367 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
368 aGrid->SetColAttr( COL_VISIBLE, attr );
369 // No visibility control for footprint libraries yet; this feature is primarily
370 // useful for database libraries and it's only implemented for schematic symbols
371 // at the moment.
372 aGrid->HideCol( COL_VISIBLE );
373
374 // all but COL_OPTIONS, which is edited with Option Editor anyways.
375 autoSizeCol( aGrid, COL_NICKNAME );
376 autoSizeCol( aGrid, COL_TYPE );
377 autoSizeCol( aGrid, COL_URI );
378 autoSizeCol( aGrid, COL_DESCR );
379
380 // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
381 // a currentCell which is sometimes not highlighted.
382 if( aGrid->GetNumberRows() > 0 )
383 aGrid->SelectRow( 0 );
384};
385
386
388 FP_LIB_TABLE* aGlobalTable, const wxString& aGlobalTblPath,
389 FP_LIB_TABLE* aProjectTable, const wxString& aProjectTblPath,
390 const wxString& aProjectBasePath ) :
391 PANEL_FP_LIB_TABLE_BASE( aParent ),
392 m_globalTable( aGlobalTable ),
393 m_projectTable( aProjectTable ),
394 m_project( aProject ),
395 m_projectBasePath( aProjectBasePath ),
396 m_parent( aParent )
397{
398 m_global_grid->SetTable( new FP_LIB_TABLE_GRID( *aGlobalTable ), true );
399
400 // add Cut, Copy, and Paste to wxGrids
401 m_path_subs_grid->PushEventHandler( new GRID_TRICKS( m_path_subs_grid ) );
402
404
405 for( auto& [fileType, desc] : m_supportedFpFiles )
407
408
410
411 if( cfg->m_lastFootprintLibDir.IsEmpty() )
413
415
417
419
420 if( aProjectTable )
421 {
422 m_project_grid->SetTable( new FP_LIB_TABLE_GRID( *aProjectTable ), true );
424 }
425 else
426 {
427 m_pageNdx = 0;
428 m_notebook->DeletePage( 1 );
429 m_project_grid = nullptr;
430 }
431
432 m_path_subs_grid->SetColLabelValue( 0, _( "Name" ) );
433 m_path_subs_grid->SetColLabelValue( 1, _( "Value" ) );
434
435 // select the last selected page
436 m_notebook->SetSelection( m_pageNdx );
438
439 // for ALT+A handling, we want the initial focus to be on the first selected grid.
441
442 // Configure button logos
443 m_append_button->SetBitmap( KiBitmapBundle( BITMAPS::small_plus ) );
444 m_delete_button->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
445 m_move_up_button->SetBitmap( KiBitmapBundle( BITMAPS::small_up ) );
446 m_move_down_button->SetBitmap( KiBitmapBundle( BITMAPS::small_down ) );
447 m_browseButton->SetBitmap( KiBitmapBundle( BITMAPS::small_folder ) );
448
449 // For aesthetic reasons, we must set the size of m_browseButton to match the other bitmaps
450 // manually (for instance m_append_button)
451 Layout(); // Needed at least on MSW to compute the actual buttons sizes, after initializing
452 // their bitmaps
453 wxSize buttonSize = m_append_button->GetSize();
454
456 m_browseButton->SetMinSize( buttonSize );
457
458 // Populate the browse library options
459 wxMenu* browseMenu = m_browseButton->GetSplitButtonMenu();
460
461 auto joinExts = []( const std::vector<std::string>& aExts )
462 {
463 wxString joined;
464 for( const std::string& ext : aExts )
465 {
466 if( !joined.empty() )
467 joined << wxS( ", " );
468
469 joined << wxS( "*." ) << ext;
470 }
471
472 return joined;
473 };
474
475 for( auto& [type, desc] : m_supportedFpFiles )
476 {
477 wxString entryStr = PCB_IO_MGR::ShowType( type );
478
479 if( desc.m_IsFile && !desc.m_FileExtensions.empty() )
480 {
481 entryStr << wxString::Format( wxS( " (%s)" ),
482 joinExts( desc.m_FileExtensions ) );
483 }
484 else if( !desc.m_IsFile && !desc.m_ExtensionsInDir.empty() )
485 {
486 wxString midPart = wxString::Format( _( "folder with %s files" ),
487 joinExts( desc.m_ExtensionsInDir ) );
488
489 entryStr << wxString::Format( wxS( " (%s)" ), midPart );
490 }
491
492 browseMenu->Append( type, entryStr );
493
494 browseMenu->Bind( wxEVT_COMMAND_MENU_SELECTED, &PANEL_FP_LIB_TABLE::browseLibrariesHandler,
495 this, type );
496 }
497
498 Layout();
499
500 // This is the button only press for the browse button instead of the menu
502}
503
504
506{
507 wxMenu* browseMenu = m_browseButton->GetSplitButtonMenu();
508 for( auto& [type, desc] : m_supportedFpFiles )
509 {
510 browseMenu->Unbind( wxEVT_COMMAND_MENU_SELECTED,
512 }
513 m_browseButton->Unbind( wxEVT_BUTTON, &PANEL_FP_LIB_TABLE::browseLibrariesHandler, this );
514
515 // Delete the GRID_TRICKS.
516 // Any additional event handlers should be popped before the window is deleted.
517 m_global_grid->PopEventHandler( true );
518
519 if( m_project_grid )
520 m_project_grid->PopEventHandler( true );
521
522 m_path_subs_grid->PopEventHandler( true );
523}
524
525
527{
528 for( const auto& plugin : PCB_IO_MGR::PLUGIN_REGISTRY::Instance()->AllPlugins() )
529 {
530 IO_RELEASER<PCB_IO> pi( plugin.m_createFunc() );
531
532 if( !pi )
533 continue;
534
535 if( const IO_BASE::IO_FILE_DESC& desc = pi->GetLibraryDesc() )
536 m_supportedFpFiles.emplace( plugin.m_type, desc );
537 }
538}
539
540
542{
543 wxString msg;
544
545 for( FP_LIB_TABLE_GRID* model : { global_model(), project_model() } )
546 {
547 if( !model )
548 continue;
549
550 for( int r = 0; r < model->GetNumberRows(); )
551 {
552 wxString nick = model->GetValue( r, COL_NICKNAME ).Trim( false ).Trim();
553 wxString uri = model->GetValue( r, COL_URI ).Trim( false ).Trim();
554 unsigned illegalCh = 0;
555
556 if( !nick || !uri )
557 {
558 if( !nick && !uri )
559 msg = _( "A library table row nickname and path cells are empty." );
560 else if( !nick )
561 msg = _( "A library table row nickname cell is empty." );
562 else
563 msg = _( "A library table row path cell is empty." );
564
565 wxWindow* topLevelParent = wxGetTopLevelParent( this );
566
567 wxMessageDialog badCellDlg( topLevelParent, msg, _( "Invalid Row Definition" ),
568 wxYES_NO | wxCENTER | wxICON_QUESTION | wxYES_DEFAULT );
569 badCellDlg.SetExtendedMessage( _( "Empty cells will result in all rows that are "
570 "invalid to be removed from the table." ) );
571 badCellDlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Remove Invalid Cells" ) ),
572 wxMessageDialog::ButtonLabel( _( "Cancel Table Update" ) ) );
573
574 if( badCellDlg.ShowModal() == wxID_NO )
575 return false;
576
577 // Delete the "empty" row, where empty means missing nick or uri.
578 // This also updates the UI which could be slow, but there should only be a few
579 // rows to delete, unless the user fell asleep on the Add Row
580 // button.
581 model->DeleteRows( r, 1 );
582 }
583 else if( ( illegalCh = LIB_ID::FindIllegalLibraryNameChar( nick ) ) )
584 {
585 msg = wxString::Format( _( "Illegal character '%c' in nickname '%s'." ),
586 illegalCh,
587 nick );
588
589 // show the tabbed panel holding the grid we have flunked:
590 if( model != cur_model() )
591 m_notebook->SetSelection( model == global_model() ? 0 : 1 );
592
593 m_cur_grid->MakeCellVisible( r, 0 );
594 m_cur_grid->SetGridCursor( r, 1 );
595
596 wxWindow* topLevelParent = wxGetTopLevelParent( this );
597
598 wxMessageDialog errdlg( topLevelParent, msg, _( "Library Nickname Error" ) );
599 errdlg.ShowModal();
600 return false;
601 }
602 else
603 {
604 // set the trimmed values back into the table so they get saved to disk.
605 model->SetValue( r, COL_NICKNAME, nick );
606 model->SetValue( r, COL_URI, uri );
607
608 // Make sure to not save a hidden flag
609 model->SetValue( r, COL_VISIBLE, wxS( "1" ) );
610
611 ++r; // this row was OK.
612 }
613 }
614 }
615
616 // check for duplicate nickNames, separately in each table.
617 for( FP_LIB_TABLE_GRID* model : { global_model(), project_model() } )
618 {
619 if( !model )
620 continue;
621
622 for( int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
623 {
624 wxString nick1 = model->GetValue( r1, COL_NICKNAME );
625
626 for( int r2 = r1 + 1; r2 < model->GetNumberRows(); ++r2 )
627 {
628 wxString nick2 = model->GetValue( r2, COL_NICKNAME );
629
630 if( nick1 == nick2 )
631 {
632 msg = wxString::Format( _( "Multiple libraries cannot share the same "
633 "nickname ('%s')." ),
634 nick1 );
635
636 // show the tabbed panel holding the grid we have flunked:
637 if( model != cur_model() )
638 m_notebook->SetSelection( model == global_model() ? 0 : 1 );
639
640 // go to the lower of the two rows, it is technically the duplicate:
641 m_cur_grid->MakeCellVisible( r2, 0 );
642 m_cur_grid->SetGridCursor( r2, 1 );
643
644 wxWindow* topLevelParent = wxGetTopLevelParent( this );
645
646 wxMessageDialog errdlg( topLevelParent, msg, _( "Library Nickname Error" ) );
647 errdlg.ShowModal();
648 return false;
649 }
650 }
651 }
652 }
653
654 return true;
655}
656
657
658void PANEL_FP_LIB_TABLE::OnUpdateUI( wxUpdateUIEvent& event )
659{
660}
661
662
663void PANEL_FP_LIB_TABLE::appendRowHandler( wxCommandEvent& event )
664{
666 return;
667
668 if( m_cur_grid->AppendRows( 1 ) )
669 {
670 int last_row = m_cur_grid->GetNumberRows() - 1;
671
672 // wx documentation is wrong, SetGridCursor does not make visible.
673 m_cur_grid->MakeCellVisible( last_row, COL_ENABLED );
674 m_cur_grid->SetGridCursor( last_row, COL_NICKNAME );
675 m_cur_grid->EnableCellEditControl( true );
676 m_cur_grid->ShowCellEditControl();
677 }
678}
679
680
681void PANEL_FP_LIB_TABLE::deleteRowHandler( wxCommandEvent& event )
682{
684 return;
685
686 int curRow = m_cur_grid->GetGridCursorRow();
687 int curCol = m_cur_grid->GetGridCursorCol();
688
689 // In a wxGrid, collect rows that have a selected cell, or are selected
690 // It is not so easy: it depends on the way the selection was made.
691 // Here, we collect rows selected by clicking on a row label, and rows that contain any
692 // previously-selected cells.
693 // If no candidate, just delete the row with the grid cursor.
694 wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
695 wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells();
696 wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft();
697 wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight();
698
699 // Add all row having cell selected to list:
700 for( unsigned ii = 0; ii < cells.GetCount(); ii++ )
701 selectedRows.Add( cells[ii].GetRow() );
702
703 // Handle block selection
704 if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
705 {
706 for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
707 selectedRows.Add( i );
708 }
709
710 // Use the row having the grid cursor only if we have no candidate:
711 if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 )
712 selectedRows.Add( m_cur_grid->GetGridCursorRow() );
713
714 if( selectedRows.size() == 0 )
715 {
716 wxBell();
717 return;
718 }
719
720 std::sort( selectedRows.begin(), selectedRows.end() );
721
722 // Remove selected rows (note: a row can be stored more than once in list)
723 int last_row = -1;
724
725 // Needed to avoid a wxWidgets alert if the row to delete is the last row
726 // at least on wxMSW 3.2
727 m_cur_grid->ClearSelection();
728
729 for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
730 {
731 int row = selectedRows[ii];
732
733 if( row != last_row )
734 {
735 last_row = row;
736 m_cur_grid->DeleteRows( row, 1 );
737 }
738 }
739
740 if( m_cur_grid->GetNumberRows() > 0 && curRow >= 0 )
741 m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol );
742}
743
744
745void PANEL_FP_LIB_TABLE::moveUpHandler( wxCommandEvent& event )
746{
748 return;
749
751 int curRow = m_cur_grid->GetGridCursorRow();
752
753 // @todo: add multiple selection moves.
754 if( curRow >= 1 )
755 {
756 boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
757 tbl->m_rows.release( tbl->m_rows.begin() + curRow );
758
759 --curRow;
760 tbl->m_rows.insert( tbl->m_rows.begin() + curRow, move_me.release() );
761
762 if( tbl->GetView() )
763 {
764 // Update the wxGrid
765 wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
766 tbl->GetView()->ProcessTableMessage( msg );
767 }
768
769 m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
770 m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
771 }
772}
773
774
775void PANEL_FP_LIB_TABLE::moveDownHandler( wxCommandEvent& event )
776{
778 return;
779
781 int curRow = m_cur_grid->GetGridCursorRow();
782
783 // @todo: add multiple selection moves.
784 if( unsigned( curRow + 1 ) < tbl->m_rows.size() )
785 {
786 boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
787 tbl->m_rows.release( tbl->m_rows.begin() + curRow );
788
789 ++curRow;
790 tbl->m_rows.insert( tbl->m_rows.begin() + curRow, move_me.release() );
791
792 if( tbl->GetView() )
793 {
794 // Update the wxGrid
795 wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
796 tbl->GetView()->ProcessTableMessage( msg );
797 }
798
799 m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
800 m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
801 }
802}
803
804
805// @todo refactor this function into single location shared with PANEL_SYM_LIB_TABLE
806void PANEL_FP_LIB_TABLE::onMigrateLibraries( wxCommandEvent& event )
807{
809 return;
810
811 wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
812
813 if( selectedRows.empty() && m_cur_grid->GetGridCursorRow() >= 0 )
814 selectedRows.push_back( m_cur_grid->GetGridCursorRow() );
815
816 wxArrayInt rowsToMigrate;
817 wxString kicadType = PCB_IO_MGR::ShowType( PCB_IO_MGR::KICAD_SEXP );
818 wxString msg;
819
820 for( int row : selectedRows )
821 {
822 if( m_cur_grid->GetCellValue( row, COL_TYPE ) != kicadType )
823 rowsToMigrate.push_back( row );
824 }
825
826 if( rowsToMigrate.size() <= 0 )
827 {
828 wxMessageBox( wxString::Format( _( "Select one or more rows containing libraries "
829 "to save as current KiCad format." ) ) );
830 return;
831 }
832 else
833 {
834 if( rowsToMigrate.size() == 1 )
835 {
836 msg.Printf( _( "Save '%s' as current KiCad format "
837 "and replace entry in table?" ),
838 m_cur_grid->GetCellValue( rowsToMigrate[0], COL_NICKNAME ) );
839 }
840 else
841 {
842 msg.Printf( _( "Save %d libraries as current KiCad format "
843 "and replace entries in table?" ),
844 (int) rowsToMigrate.size() );
845 }
846
847 if( !IsOK( m_parent, msg ) )
848 return;
849 }
850
851 for( int row : rowsToMigrate )
852 {
853 wxString libName = m_cur_grid->GetCellValue( row, COL_NICKNAME );
854 wxString relPath = m_cur_grid->GetCellValue( row, COL_URI );
855 wxString resolvedPath = ExpandEnvVarSubstitutions( relPath, m_project );
856 wxFileName legacyLib( resolvedPath );
857
858 if( !legacyLib.Exists() )
859 {
860 msg.Printf( _( "Library '%s' not found." ), relPath );
861 DisplayErrorMessage( wxGetTopLevelParent( this ), msg );
862 continue;
863 }
864
865 wxFileName newLib( resolvedPath );
866 newLib.AppendDir( newLib.GetName() + "." + FILEEXT::KiCadFootprintLibPathExtension );
867 newLib.SetName( "" );
868 newLib.ClearExt();
869
870 if( newLib.DirExists() )
871 {
872 msg.Printf( _( "Folder '%s' already exists. Do you want overwrite any existing footprints?" ),
873 newLib.GetFullPath() );
874
875 switch( wxMessageBox( msg, _( "Migrate Library" ),
876 wxYES_NO | wxCANCEL | wxICON_QUESTION, m_parent ) )
877 {
878 case wxYES: break;
879 case wxNO: continue;
880 case wxCANCEL: return;
881 }
882 }
883
884 wxString options = m_cur_grid->GetCellValue( row, COL_OPTIONS );
885 std::unique_ptr<STRING_UTF8_MAP> props( LIB_TABLE::ParseOptions( options.ToStdString() ) );
886
887 if( PCB_IO_MGR::ConvertLibrary( props.get(), legacyLib.GetFullPath(), newLib.GetFullPath() ) )
888 {
889 relPath = NormalizePath( newLib.GetFullPath(), &Pgm().GetLocalEnvVariables(),
890 m_project );
891
892 // Do not use the project path in the global library table. This will almost
893 // assuredly be wrong for a different project.
894 if( m_cur_grid == m_global_grid && relPath.Contains( "${KIPRJMOD}" ) )
895 relPath = newLib.GetFullPath();
896
897 m_cur_grid->SetCellValue( row, COL_URI, relPath );
898 m_cur_grid->SetCellValue( row, COL_TYPE, kicadType );
899 }
900 else
901 {
902 msg.Printf( _( "Failed to save footprint library file '%s'." ), newLib.GetFullPath() );
903 DisplayErrorMessage( wxGetTopLevelParent( this ), msg );
904 }
905 }
906}
907
908
910{
912 return;
913
915
916 // We are bound both to the menu and button with this one handler
917 // So we must set the file type based on it
918 if( event.GetEventType() == wxEVT_BUTTON )
919 {
920 // Let's default to adding a kicad footprint file for just the footprint
922 }
923 else
924 {
925 fileType = static_cast<PCB_IO_MGR::PCB_FILE_T>( event.GetId() );
926 }
927
929 {
930 wxLogWarning( wxT( "File type selection event received but could not find the file type "
931 "in the table" ) );
932 return;
933 }
934
935 const IO_BASE::IO_FILE_DESC& fileDesc = m_supportedFpFiles.at( fileType );
937
938 wxString title = wxString::Format( _( "Select %s Library" ), PCB_IO_MGR::ShowType( fileType ) );
939 wxString openDir = cfg->m_lastFootprintLibDir;
940
942 openDir = m_lastProjectLibDir;
943
944 wxArrayString files;
945
946 wxWindow* topLevelParent = wxGetTopLevelParent( this );
947
948 if( fileDesc.m_IsFile )
949 {
950 wxFileDialog dlg( topLevelParent, title, openDir, wxEmptyString, fileDesc.FileFilter(),
951 wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
952
953 int result = dlg.ShowModal();
954
955 if( result == wxID_CANCEL )
956 return;
957
958 dlg.GetPaths( files );
959
961 cfg->m_lastFootprintLibDir = dlg.GetDirectory();
962 else
963 m_lastProjectLibDir = dlg.GetDirectory();
964 }
965 else
966 {
967 wxDirDialog dlg( topLevelParent, title, openDir,
968 wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST | wxDD_MULTIPLE );
969
970 int result = dlg.ShowModal();
971
972 if( result == wxID_CANCEL )
973 return;
974
975 dlg.GetPaths( files );
976
977 if( !files.IsEmpty() )
978 {
979 wxFileName first( files.front() );
980
982 cfg->m_lastFootprintLibDir = first.GetPath();
983 else
984 m_lastProjectLibDir = first.GetPath();
985 }
986 }
987
988 // Drop the last directory if the path is a .pretty folder
990 cfg->m_lastFootprintLibDir = cfg->m_lastFootprintLibDir.BeforeLast( wxFileName::GetPathSeparator() );
991
992 const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
993 bool addDuplicates = false;
994 bool applyToAll = false;
995 wxString warning = _( "Warning: Duplicate Nicknames" );
996 wxString msg = _( "A library nicknamed '%s' already exists." );
997 wxString detailedMsg = _( "One of the nicknames will need to be changed after "
998 "adding this library." );
999
1000 for( const wxString& filePath : files )
1001 {
1002 wxFileName fn( filePath );
1003 wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), true );
1004 bool doAdd = true;
1005
1007 && fn.GetExt() != FILEEXT::KiCadFootprintLibPathExtension )
1008 nickname = LIB_ID::FixIllegalChars( fn.GetFullName(), true ).wx_str();
1009
1010 if( cur_model()->ContainsNickname( nickname ) )
1011 {
1012 if( !applyToAll )
1013 {
1014 // The cancel button adds the library to the table anyway
1015 addDuplicates = OKOrCancelDialog( wxGetTopLevelParent( this ), warning,
1016 wxString::Format( msg, nickname ),
1017 detailedMsg, _( "Skip" ), _( "Add Anyway" ),
1018 &applyToAll ) == wxID_CANCEL;
1019 }
1020
1021 doAdd = addDuplicates;
1022 }
1023
1024 if( doAdd && m_cur_grid->AppendRows( 1 ) )
1025 {
1026 int last_row = m_cur_grid->GetNumberRows() - 1;
1027
1028 m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
1029
1030 m_cur_grid->SetCellValue( last_row, COL_TYPE, PCB_IO_MGR::ShowType( fileType ) );
1031
1032 // try to use path normalized to an environmental variable or project path
1033 wxString path = NormalizePath( filePath, &envVars, m_projectBasePath );
1034
1035 // Do not use the project path in the global library table. This will almost
1036 // assuredly be wrong for a different project.
1037 if( m_pageNdx == 0 && path.Contains( wxT( "${KIPRJMOD}" ) ) )
1038 path = fn.GetFullPath();
1039
1040 m_cur_grid->SetCellValue( last_row, COL_URI, path );
1041 }
1042 }
1043
1044 if( !files.IsEmpty() )
1045 {
1046 int new_row = m_cur_grid->GetNumberRows() - 1;
1047 m_cur_grid->MakeCellVisible( new_row, m_cur_grid->GetGridCursorCol() );
1048 m_cur_grid->SetGridCursor( new_row, m_cur_grid->GetGridCursorCol() );
1049 }
1050}
1051
1052
1054{
1055 // Account for scroll bars
1056 aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
1057
1058 m_path_subs_grid->AutoSizeColumn( 0 );
1059 m_path_subs_grid->SetColSize( 0, std::max( 72, m_path_subs_grid->GetColSize( 0 ) ) );
1060 m_path_subs_grid->SetColSize( 1, std::max( 120, aWidth - m_path_subs_grid->GetColSize( 0 ) ) );
1061}
1062
1063
1064void PANEL_FP_LIB_TABLE::onSizeGrid( wxSizeEvent& event )
1065{
1066 adjustPathSubsGridColumns( event.GetSize().GetX() );
1067
1068 event.Skip();
1069}
1070
1071
1072void PANEL_FP_LIB_TABLE::onReset( wxCommandEvent& event )
1073{
1075 return;
1076
1077 // No need to prompt to preserve an empty table
1078 if( m_global_grid->GetNumberRows() > 0 &&
1079 !IsOK( this, wxString::Format( _( "This action will reset your global library table on "
1080 "disk and cannot be undone." ) ) ) )
1081 {
1082 return;
1083 }
1084
1086
1087 if( dlg.ShowModal() == wxID_OK )
1088 {
1089 m_global_grid->Freeze();
1090
1091 wxGridTableBase* table = m_global_grid->GetTable();
1092 m_global_grid->DestroyTable( table );
1093
1095 m_global_grid->PopEventHandler( true );
1098
1099 m_global_grid->Thaw();
1100 }
1101}
1102
1103
1104void PANEL_FP_LIB_TABLE::onPageChange( wxBookCtrlEvent& event )
1105{
1106 m_pageNdx = (unsigned) std::max( 0, m_notebook->GetSelection() );
1107
1108 if( m_pageNdx == 0 )
1109 {
1111 m_resetGlobal->Enable();
1112 }
1113 else
1114 {
1116 m_resetGlobal->Disable();
1117 }
1118}
1119
1120
1122{
1124 return false;
1125
1126 if( verifyTables() )
1127 {
1128 if( *global_model() != *m_globalTable )
1129 {
1131
1134 }
1135
1137 {
1139
1142 }
1143
1144 return true;
1145 }
1146
1147 return false;
1148}
1149
1150
1154{
1155 wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
1156 wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required.
1157
1158 std::set< wxString > unique;
1159
1160 // clear the table
1162
1163 for( FP_LIB_TABLE_GRID* tbl : { global_model(), project_model() } )
1164 {
1165 if( !tbl )
1166 continue;
1167
1168 for( int row = 0; row < tbl->GetNumberRows(); ++row )
1169 {
1170 wxString uri = tbl->GetValue( row, COL_URI );
1171
1172 while( re.Matches( uri ) )
1173 {
1174 wxString envvar = re.GetMatch( uri, 2 );
1175
1176 // if not ${...} form then must be $(...)
1177 if( envvar.IsEmpty() )
1178 envvar = re.GetMatch( uri, 4 );
1179
1180 // ignore duplicates
1181 unique.insert( envvar );
1182
1183 // delete the last match and search again
1184 uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString );
1185 }
1186 }
1187 }
1188
1189 // Make sure this special environment variable shows up even if it was
1190 // not used yet. It is automatically set by KiCad to the directory holding
1191 // the current project.
1192 unique.insert( PROJECT_VAR_NAME );
1193 unique.insert( FP_LIB_TABLE::GlobalPathEnvVariableName() );
1194
1195 // This special environment variable is used to locate 3d shapes
1196 unique.insert( ENV_VAR::GetVersionedEnvVarName( wxS( "3DMODEL_DIR" ) ) );
1197
1198 for( const wxString& evName : unique )
1199 {
1200 int row = m_path_subs_grid->GetNumberRows();
1201 m_path_subs_grid->AppendRows( 1 );
1202
1203 m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) );
1204 m_path_subs_grid->SetCellEditor( row, 0, new GRID_CELL_READONLY_TEXT_EDITOR() );
1205
1206 wxString evValue;
1207 wxGetEnv( evName, &evValue );
1208 m_path_subs_grid->SetCellValue( row, 1, evValue );
1209 m_path_subs_grid->SetCellEditor( row, 1, new GRID_CELL_READONLY_TEXT_EDITOR() );
1210 }
1211
1212 // No combobox editors here, but it looks better if its consistent with the other
1213 // grids in the dialog.
1214 m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 2 );
1215
1216 adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() );
1217}
1218
1219//-----</event handlers>---------------------------------
1220
1221
1222
1224
1225
1226void InvokePcbLibTableEditor( KIWAY* aKiway, wxWindow* aCaller )
1227{
1228 FP_LIB_TABLE* globalTable = &GFootprintTable;
1229 wxString globalTablePath = FP_LIB_TABLE::GetGlobalTableFileName();
1230 FP_LIB_TABLE* projectTable = PROJECT_PCB::PcbFootprintLibs( &aKiway->Prj() );
1231 wxString projectTablePath = aKiway->Prj().FootprintLibTblName();
1232 wxString msg;
1233
1234 DIALOG_EDIT_LIBRARY_TABLES dlg( aCaller, _( "Footprint Libraries" ) );
1235 dlg.SetKiway( &dlg, aKiway );
1236
1237 if( aKiway->Prj().IsNullProject() )
1238 projectTable = nullptr;
1239
1240 dlg.InstallPanel( new PANEL_FP_LIB_TABLE( &dlg, &aKiway->Prj(), globalTable, globalTablePath,
1241 projectTable, projectTablePath,
1242 aKiway->Prj().GetProjectPath() ) );
1243
1244 if( dlg.ShowModal() == wxID_CANCEL )
1245 return;
1246
1247 if( dlg.m_GlobalTableChanged )
1248 {
1249 try
1250 {
1251 globalTable->Save( globalTablePath );
1252 }
1253 catch( const IO_ERROR& ioe )
1254 {
1255 msg.Printf( _( "Error saving global library table:\n\n%s" ), ioe.What() );
1256 wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
1257 }
1258 }
1259
1260 if( projectTable && dlg.m_ProjectTableChanged )
1261 {
1262 try
1263 {
1264 projectTable->Save( projectTablePath );
1265 }
1266 catch( const IO_ERROR& ioe )
1267 {
1268 msg.Printf( _( "Error saving project-specific library table:\n\n%s" ), ioe.What() );
1269 wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
1270 }
1271 }
1272
1273 std::string payload = "";
1276 aKiway->ExpressMail( FRAME_CVPCB, MAIL_RELOAD_LIB, payload );
1277}
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap)
Definition: bitmap.cpp:110
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
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
bool toggleCell(int aRow, int aCol, bool aPreserveSelection) 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
virtual bool toggleCell(int aRow, int aCol, bool aPreserveSelection=false)
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:343
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.