KiCad PCB EDA Suite
panel_sym_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) 2017 Wayne Stambaugh <stambaughw@gmail.com>
5  * Copyright (C) 2017-2020 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software: you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the
9  * Free Software Foundation, either version 3 of the License, or (at your
10  * option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #include <set>
22 #include <wx/regex.h>
23 
24 #include <project.h>
25 #include <panel_sym_lib_table.h>
26 #include <lib_id.h>
27 #include <symbol_lib_table.h>
28 #include <lib_table_lexer.h>
29 #include <grid_tricks.h>
30 #include <widgets/wx_grid.h>
31 #include <confirm.h>
32 #include <bitmaps.h>
33 #include <lib_table_grid.h>
35 #include <env_paths.h>
36 #include <eeschema_id.h>
37 #include <symbol_edit_frame.h>
38 #include <lib_view_frame.h>
39 #include <sch_edit_frame.h>
40 #include <kiway.h>
41 #include <pgm_base.h>
43 
46 
47 
48 // clang-format off
49 
54 {
55  wxString m_Description;
56  wxString m_FileFilter;
58  bool m_IsFile;
59  SCH_IO_MGR::SCH_FILE_T m_Plugin;
60 };
61 
62 
66 enum {
69 };
70 
71 
76 static const std::map<int, supportedFileType>& fileTypes()
77 {
78  static const std::map<int, supportedFileType> fileTypes =
79  {
81  {
82  "KiCad legacy symbol library file (*.lib)",
84  "",
85  true,
86  SCH_IO_MGR::SCH_LEGACY
87  }
88  },
89  {
91  {
92  "KiCad s-expression symbol library file (*.kicad_sym)",
94  "",
95  true,
96  SCH_IO_MGR::SCH_KICAD
97  }
98  }
99  };
100 
101  return fileTypes;
102 }
103 
104 
109 {
110  friend class SYMBOL_GRID_TRICKS;
111 
112 protected:
113  LIB_TABLE_ROW* at( size_t aIndex ) override { return &rows.at( aIndex ); }
114 
115  size_t size() const override { return rows.size(); }
116 
118  {
119  return dynamic_cast< LIB_TABLE_ROW* >( new SYMBOL_LIB_TABLE_ROW );
120  }
121 
122  LIB_TABLE_ROWS_ITER begin() override { return rows.begin(); }
123 
125  {
126  return rows.insert( aIterator, aRow );
127  }
128 
129  void push_back( LIB_TABLE_ROW* aRow ) override { rows.push_back( aRow ); }
130 
132  {
133  return rows.erase( aFirst, aLast );
134  }
135 
136 public:
137 
139  {
140  rows = aTableToEdit.rows;
141  }
142 };
143 
144 
146 {
147 public:
149  GRID_TRICKS( aGrid ),
150  m_dialog( aParent )
151  {
152  }
153 
154 protected:
156 
159  virtual void paste_text( const wxString& cb_text ) override
160  {
161  SYMBOL_LIB_TABLE_GRID* tbl = (SYMBOL_LIB_TABLE_GRID*) m_grid->GetTable();
162  size_t ndx = cb_text.find( "(sym_lib_table" );
163 
164  if( ndx != std::string::npos )
165  {
166  // paste the SYMBOL_LIB_TABLE_ROWs of s-expression (sym_lib_table), starting
167  // at column 0 regardless of current cursor column.
168 
169  STRING_LINE_READER slr( TO_UTF8( cb_text ), "Clipboard" );
170  LIB_TABLE_LEXER lexer( &slr );
171  SYMBOL_LIB_TABLE tmp_tbl;
172  bool parsed = true;
173 
174  try
175  {
176  tmp_tbl.Parse( &lexer );
177  }
178  catch( PARSE_ERROR& pe )
179  {
180  DisplayError( m_dialog, pe.What() );
181  parsed = false;
182  }
183 
184  if( parsed )
185  {
186  // make sure the table is big enough...
187  if( tmp_tbl.GetCount() > (unsigned) tbl->GetNumberRows() )
188  tbl->AppendRows( tmp_tbl.GetCount() - tbl->GetNumberRows() );
189 
190  for( unsigned i = 0; i < tmp_tbl.GetCount(); ++i )
191  tbl->rows.replace( i, tmp_tbl.At( i ).clone() );
192  }
193 
194  m_grid->AutoSizeColumns( false );
195  }
196  else
197  {
198  // paste spreadsheet formatted text.
199  GRID_TRICKS::paste_text( cb_text );
200 
201  m_grid->AutoSizeColumns( false );
202  }
203  }
204 };
205 
206 
208  SYMBOL_LIB_TABLE* aGlobal,
209  const wxString& aGlobalTablePath,
210  SYMBOL_LIB_TABLE* aProject,
211  const wxString& aProjectTablePath,
212  const wxString& aProjectBasePath ) :
213  PANEL_SYM_LIB_TABLE_BASE( aParent ),
214  m_globalTable( aGlobal ),
215  m_projectTable( aProject ),
216  m_projectBasePath( aProjectBasePath ),
217  m_parent( aParent )
218 {
219  // wxGrid only supports user owned tables if they exist past end of ~wxGrid(),
220  // so make it a grid owned table.
221  m_global_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aGlobal ), true );
222 
223  // For user info, shows the table filenames:
224  m_GblTableFilename->SetLabel( aGlobalTablePath );
225 
226  wxArrayString pluginChoices;
227 
228  pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_KICAD ) );
229  pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
230 
231  EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
232 
233  if( cfg->m_lastSymbolLibDir.IsEmpty() )
234  {
236  }
237 
238  auto setupGrid =
239  [&]( WX_GRID* aGrid )
240  {
241  // Give a bit more room for combobox editors
242  aGrid->SetDefaultRowSize( aGrid->GetDefaultRowSize() + 4 );
243 
244  // add Cut, Copy, and Paste to wxGrids
245  aGrid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, aGrid ) );
246 
247  aGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
248  aGrid->AutoSizeColumns( false );
249 
250  // Set special attributes
251  wxGridCellAttr* attr;
252 
253  attr = new wxGridCellAttr;
254 
255  wxString wildcards = AllSymbolLibFilesWildcard()
257  + "|" + LegacySymbolLibFileWildcard();
258  attr->SetEditor( new GRID_CELL_PATH_EDITOR( m_parent, &cfg->m_lastSymbolLibDir,
259  wildcards,
260  true, m_projectBasePath ) );
261  aGrid->SetColAttr( COL_URI, attr );
262 
263  attr = new wxGridCellAttr;
264  attr->SetEditor( new wxGridCellChoiceEditor( pluginChoices ) );
265  aGrid->SetColAttr( COL_TYPE, attr );
266 
267  attr = new wxGridCellAttr;
268  attr->SetRenderer( new wxGridCellBoolRenderer() );
269  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
270  aGrid->SetColAttr( COL_ENABLED, attr );
271 
272  // all but COL_OPTIONS, which is edited with Option Editor anyways.
273  aGrid->AutoSizeColumn( COL_NICKNAME, false );
274  aGrid->AutoSizeColumn( COL_TYPE, false );
275  aGrid->AutoSizeColumn( COL_URI, false );
276  aGrid->AutoSizeColumn( COL_DESCR, false );
277  aGrid->AutoSizeColumn( COL_ENABLED, false );
278 
279  // would set this to width of title, if it was easily known.
280  aGrid->SetColSize( COL_OPTIONS, 80 );
281 
282  // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
283  // a currentCell which is sometimes not highlighted.
284  if( aGrid->GetNumberRows() > 0 )
285  aGrid->SelectRow( 0 );
286  };
287 
288  setupGrid( m_global_grid );
289 
290  if( aProject )
291  {
292  m_PrjTableFilename->SetLabel( aProjectTablePath );
293  m_project_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aProject ), true );
294  setupGrid( m_project_grid );
295  }
296  else
297  {
298  m_pageNdx = 0;
299  m_notebook->DeletePage( 1 );
300  m_project_grid = nullptr;
301  }
302 
303  // add Cut, Copy, and Paste to wxGrids
304  m_path_subs_grid->PushEventHandler( new GRID_TRICKS( m_path_subs_grid ) );
305 
307 
308  // select the last selected page
309  m_notebook->SetSelection( m_pageNdx );
311 
312  m_path_subs_grid->SetColLabelValue( 0, _( "Name" ) );
313  m_path_subs_grid->SetColLabelValue( 1, _( "Value" ) );
314 
315  // for ALT+A handling, we want the initial focus to be on the first selected grid.
317 
318  // Configure button logos
319  m_append_button->SetBitmap( KiBitmap( small_plus_xpm ) );
320  m_delete_button->SetBitmap( KiBitmap( trash_xpm ) );
321  m_move_up_button->SetBitmap( KiBitmap( small_up_xpm ) );
322  m_move_down_button->SetBitmap( KiBitmap( small_down_xpm ) );
323  m_browse_button->SetBitmap( KiBitmap( folder_xpm ) );
324 }
325 
326 
328 {
329  // When the dialog is closed it will hide the current notebook page first, which will
330  // in turn select the other one. We then end up saving its index as the "current page".
331  // So flip them back again:
332  m_pageNdx = m_pageNdx == 1 ? 0 : 1;
333 
334  // Delete the GRID_TRICKS.
335  // Any additional event handlers should be popped before the window is deleted.
336  m_global_grid->PopEventHandler( true );
337 
338  if( m_project_grid )
339  m_project_grid->PopEventHandler( true );
340 
341  m_path_subs_grid->PopEventHandler( true );
342 }
343 
344 
346 {
347  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
348  {
349  if( !model )
350  continue;
351 
352  for( int r = 0; r < model->GetNumberRows(); )
353  {
354  wxString nick = model->GetValue( r, COL_NICKNAME ).Trim( false ).Trim();
355  wxString uri = model->GetValue( r, COL_URI ).Trim( false ).Trim();
356  unsigned illegalCh = 0;
357 
358  if( !nick || !uri )
359  {
360  // Delete the "empty" row, where empty means missing nick or uri.
361  // This also updates the UI which could be slow, but there should only be a few
362  // rows to delete, unless the user fell asleep on the Add Row
363  // button.
364  model->DeleteRows( r, 1 );
365  }
366  else if( ( illegalCh = LIB_ID::FindIllegalLibNicknameChar( nick, LIB_ID::ID_SCH ) ) )
367  {
368  wxString msg = wxString::Format( _( "Illegal character '%c' in Nickname: \"%s\"" ),
369  illegalCh,
370  nick );
371 
372  // show the tabbed panel holding the grid we have flunked:
373  if( model != cur_model() )
374  m_notebook->SetSelection( model == global_model() ? 0 : 1 );
375 
376  m_cur_grid->MakeCellVisible( r, 0 );
377  m_cur_grid->SetGridCursor( r, 1 );
378 
379  wxMessageDialog errdlg( this, msg, _( "No Colon in Nicknames" ) );
380  errdlg.ShowModal();
381  return false;
382  }
383  else
384  {
385  // set the trimmed values back into the table so they get saved to disk.
386  model->SetValue( r, COL_NICKNAME, nick );
387  model->SetValue( r, COL_URI, uri );
388  ++r; // this row was OK.
389  }
390  }
391  }
392 
393  // check for duplicate nickNames, separately in each table.
394  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
395  {
396  if( !model )
397  continue;
398 
399  for( int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
400  {
401  wxString nick1 = model->GetValue( r1, COL_NICKNAME );
402 
403  for( int r2=r1+1; r2 < model->GetNumberRows(); ++r2 )
404  {
405  wxString nick2 = model->GetValue( r2, COL_NICKNAME );
406 
407  if( nick1 == nick2 )
408  {
409  wxString msg = wxString::Format( _( "Duplicate Nickname: \"%s\"." ), nick1 );
410 
411  // show the tabbed panel holding the grid we have flunked:
412  if( model != cur_model() )
413  m_notebook->SetSelection( model == global_model() ? 0 : 1 );
414 
415  // go to the lower of the two rows, it is technically the duplicate:
416  m_cur_grid->MakeCellVisible( r2, 0 );
417  m_cur_grid->SetGridCursor( r2, 1 );
418 
419  wxMessageDialog errdlg( this, msg, _( "Please Delete or Modify One" ) );
420  errdlg.ShowModal();
421 
422  return false;
423  }
424  }
425  }
426  }
427 
428  for( SYMBOL_LIB_TABLE* table : { global_model(), project_model() } )
429  {
430  if( !table )
431  continue;
432 
433  for( unsigned int r = 0; r < table->GetCount(); ++r )
434  {
435  SYMBOL_LIB_TABLE_ROW& row = dynamic_cast<SYMBOL_LIB_TABLE_ROW&>( table->At( r ) );
436 
437  if( !row.GetIsEnabled() )
438  continue;
439 
440  try
441  {
442  if( row.Refresh() )
443  {
444  if( table == global_model() )
446  else
448  }
449  }
450  catch( const IO_ERROR& ioe )
451  {
452  wxString msg = wxString::Format( _( "Symbol library \"%s\" failed to load.\n %s" ),
453  row.GetNickName(),
454  ioe.What() );
455 
456  wxMessageDialog errdlg( this, msg, _( "Error Loading Library" ) );
457  errdlg.ShowModal();
458 
459  return false;
460  }
461  }
462  }
463 
464  return true;
465 }
466 
467 
468 void PANEL_SYM_LIB_TABLE::OnUpdateUI( wxUpdateUIEvent& event )
469 {
470  m_pageNdx = (unsigned) std::max( 0, m_notebook->GetSelection() );
472 }
473 
474 
475 void PANEL_SYM_LIB_TABLE::browseLibrariesHandler( wxCommandEvent& event )
476 {
477  wxString wildcards = AllSymbolLibFilesWildcard()
479  + "|" + LegacySymbolLibFileWildcard();
480 
481  EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
482  wxFileDialog dlg( this, _( "Select Library" ),
483  cfg->m_lastSymbolLibDir, wxEmptyString, wildcards,
484  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
485 
486  auto result = dlg.ShowModal();
487 
488  if( result == wxID_CANCEL )
489  return;
490 
491  cfg->m_lastSymbolLibDir = dlg.GetDirectory();
492 
493  const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
494  bool addDuplicates = false;
495  bool applyToAll = false;
496  wxString warning = _( "Warning: Duplicate Nickname" );
497  wxString msg = _( "A library nicknamed \"%s\" already exists." );
498  wxString detailedMsg = _( "Please change the library nickname after adding this library." );
499 
500  wxArrayString files;
501  dlg.GetFilenames( files );
502 
503  for( const auto& file : files )
504  {
505  wxString filePath = dlg.GetDirectory() + wxFileName::GetPathSeparator() + file;
506  wxFileName fn( filePath );
507  wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), LIB_ID::ID_SCH );
508  bool doAdd = true;
509 
510  if( cur_model()->ContainsNickname( nickname ) )
511  {
512  if( !applyToAll )
513  {
514  // The cancel button adds the library to the table anyway
515  addDuplicates = ( OKOrCancelDialog( this, warning,
516  wxString::Format( msg, nickname ),
517  detailedMsg, _( "Skip" ), _( "Add Anyway" ), &applyToAll ) == wxID_CANCEL );
518  }
519 
520  doAdd = addDuplicates;
521  }
522 
523  if( doAdd && m_cur_grid->AppendRows( 1 ) )
524  {
525  int last_row = m_cur_grid->GetNumberRows() - 1;
526 
527  m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
528 
529  // TODO the following code can detect only schematic types, not libs
530  // SCH_IO_MGR needs to provide file extension information for libraries too
531 
532  // auto detect the plugin type
533  for( auto pluginType : SCH_IO_MGR::SCH_FILE_T_vector )
534  {
535  if( SCH_IO_MGR::GetLibraryFileExtension( pluginType ).Lower() == fn.GetExt().Lower() )
536  {
537  m_cur_grid->SetCellValue( last_row, COL_TYPE,
538  SCH_IO_MGR::ShowType( pluginType ) );
539  break;
540  }
541  }
542 
543  // try to use path normalized to an environmental variable or project path
544  wxString path = NormalizePath( filePath, &envVars, m_projectBasePath );
545 
546  // Do not use the project path in the global library table. This will almost
547  // assuredly be wrong for a different project.
548  if( path.IsEmpty() || (m_pageNdx == 0 && path.Contains( "${KIPRJMOD}" )) )
549  path = fn.GetFullPath();
550 
551  m_cur_grid->SetCellValue( last_row, COL_URI, path );
552  }
553  }
554 
555  if( !files.IsEmpty() )
556  {
557  m_cur_grid->MakeCellVisible( m_cur_grid->GetNumberRows() - 1, 0 );
558  m_cur_grid->SetGridCursor( m_cur_grid->GetNumberRows() - 1, 1 );
559  }
560 }
561 
562 
563 void PANEL_SYM_LIB_TABLE::appendRowHandler( wxCommandEvent& event )
564 {
566  return;
567 
568  if( m_cur_grid->AppendRows( 1 ) )
569  {
570  int row = m_cur_grid->GetNumberRows() - 1;
571 
572  // wx documentation is wrong, SetGridCursor does not make visible.
573  m_cur_grid->MakeCellVisible( row, 0 );
574  m_cur_grid->SetGridCursor( row, 1 );
575  m_cur_grid->EnableCellEditControl( true );
576  m_cur_grid->ShowCellEditControl();
577  }
578 }
579 
580 
581 void PANEL_SYM_LIB_TABLE::deleteRowHandler( wxCommandEvent& event )
582 {
584  return;
585 
586  int curRow = m_cur_grid->GetGridCursorRow();
587  int curCol = m_cur_grid->GetGridCursorCol();
588 
589  // In a wxGrid, collect rows that have a selected cell, or are selected
590  // It is not so easy: it depends on the way the selection was made.
591  // Here, we collect rows selected by clicking on a row label, and rows that contain
592  // previously-selected cells.
593  // If no candidate, just delete the row with the grid cursor.
594  wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
595  wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells();
596  wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft();
597  wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight();
598 
599  // Add all row having cell selected to list:
600  for( unsigned ii = 0; ii < cells.GetCount(); ii++ )
601  selectedRows.Add( cells[ii].GetRow() );
602 
603  // Handle block selection
604  if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
605  {
606  for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
607  selectedRows.Add( i );
608  }
609 
610  // Use the row having the grid cursor only if we have no candidate:
611  if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 )
612  selectedRows.Add( m_cur_grid->GetGridCursorRow() );
613 
614  if( selectedRows.size() == 0 )
615  {
616  wxBell();
617  return;
618  }
619 
620  std::sort( selectedRows.begin(), selectedRows.end() );
621 
622  // Remove selected rows (note: a row can be stored more than once in list)
623  int last_row = -1;
624 
625  for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
626  {
627  int row = selectedRows[ii];
628 
629  if( row != last_row )
630  {
631  last_row = row;
632  m_cur_grid->DeleteRows( row, 1 );
633  }
634  }
635 
636  if( m_cur_grid->GetNumberRows() > 0 && curRow >= 0 )
637  m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol );
638 }
639 
640 
641 void PANEL_SYM_LIB_TABLE::moveUpHandler( wxCommandEvent& event )
642 {
644  return;
645 
647  int curRow = m_cur_grid->GetGridCursorRow();
648 
649  // @todo: add multiple selection moves.
650  if( curRow >= 1 )
651  {
652  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
653  tbl->rows.release( tbl->rows.begin() + curRow );
654 
655  --curRow;
656  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
657 
658  if( tbl->GetView() )
659  {
660  // Update the wxGrid
661  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
662  tbl->GetView()->ProcessTableMessage( msg );
663  }
664 
665  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
666  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
667  }
668 }
669 
670 
671 void PANEL_SYM_LIB_TABLE::moveDownHandler( wxCommandEvent& event )
672 {
674  return;
675 
677  int curRow = m_cur_grid->GetGridCursorRow();
678 
679  // @todo: add multiple selection moves.
680  if( unsigned( curRow + 1 ) < tbl->rows.size() )
681  {
682  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
683  tbl->rows.release( tbl->rows.begin() + curRow );
684 
685  ++curRow;
686  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
687 
688  if( tbl->GetView() )
689  {
690  // Update the wxGrid
691  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
692  tbl->GetView()->ProcessTableMessage( msg );
693  }
694 
695  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
696  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
697  }
698 }
699 
700 
702 {
704  return false;
705 
706  if( !verifyTables() )
707  return false;
708 
709  if( *global_model() != *m_globalTable )
710  {
712 
713  m_globalTable->Clear();
714  m_globalTable->rows.transfer( m_globalTable->rows.end(), global_model()->rows.begin(),
715  global_model()->rows.end(), global_model()->rows );
717  }
718 
719  if( project_model() && *project_model() != *m_projectTable )
720  {
722 
724  m_projectTable->rows.transfer( m_projectTable->rows.end(), project_model()->rows.begin(),
725  project_model()->rows.end(), project_model()->rows );
727  }
728 
729  return true;
730 }
731 
732 
734 {
735  wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
736  wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required.
737 
738  std::set< wxString > unique;
739 
740  // clear the table
741  m_path_subs_grid->DeleteRows( 0, m_path_subs_grid->GetNumberRows() );
742 
743  for( SYMBOL_LIB_TABLE_GRID* tbl : { global_model(), project_model() } )
744  {
745  if( !tbl )
746  continue;
747 
748  for( int row = 0; row < tbl->GetNumberRows(); ++row )
749  {
750  wxString uri = tbl->GetValue( row, COL_URI );
751 
752  while( re.Matches( uri ) )
753  {
754  wxString envvar = re.GetMatch( uri, 2 );
755 
756  // if not ${...} form then must be $(...)
757  if( envvar.IsEmpty() )
758  envvar = re.GetMatch( uri, 4 );
759 
760  // ignore duplicates
761  unique.insert( envvar );
762 
763  // delete the last match and search again
764  uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString );
765  }
766  }
767  }
768 
769  // Make sure this special environment variable shows up even if it was
770  // not used yet. It is automatically set by KiCad to the directory holding
771  // the current project.
772  unique.insert( PROJECT_VAR_NAME );
774 
775  for( const wxString& evName : unique )
776  {
777  int row = m_path_subs_grid->GetNumberRows();
778  m_path_subs_grid->AppendRows( 1 );
779 
780  m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) );
781  m_path_subs_grid->SetCellEditor( row, 0, new GRID_CELL_READONLY_TEXT_EDITOR() );
782 
783  wxString evValue;
784  wxGetEnv( evName, &evValue );
785  m_path_subs_grid->SetCellValue( row, 1, evValue );
786  m_path_subs_grid->SetCellEditor( row, 1, new GRID_CELL_READONLY_TEXT_EDITOR() );
787  }
788 
789  // No combobox editors here, but it looks better if its consistent with the other
790  // grids in the dialog.
791  m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 2 );
792 
793  adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() );
794 }
795 
796 
798 {
799  // Account for scroll bars
800  aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
801 
802  m_path_subs_grid->AutoSizeColumn( 0 );
803 
804  int remaining_width = aWidth - m_path_subs_grid->GetColSize( 0 );
805 
806  if( remaining_width < 0 )
807  m_path_subs_grid->SetColSize( 1, -1 );
808  else
809  m_path_subs_grid->SetColSize( 1, remaining_width );
810 }
811 
812 
813 void PANEL_SYM_LIB_TABLE::onSizeGrid( wxSizeEvent& event )
814 {
815  adjustPathSubsGridColumns( event.GetSize().GetX() );
816 
817  event.Skip();
818 }
819 
820 
822 {
823  return (SYMBOL_LIB_TABLE_GRID*) m_global_grid->GetTable();
824 }
825 
826 
828 {
829  return m_project_grid ? (SYMBOL_LIB_TABLE_GRID*) m_project_grid->GetTable() : nullptr;
830 }
831 
832 
834 {
835  return (SYMBOL_LIB_TABLE_GRID*) m_cur_grid->GetTable();
836 }
837 
838 
840 
841 
842 void InvokeSchEditSymbolLibTable( KIWAY* aKiway, wxWindow *aParent )
843 {
844  auto* schEditor = (SCH_EDIT_FRAME*) aKiway->Player( FRAME_SCH, false );
845  auto* symbolEditor = (SYMBOL_EDIT_FRAME*) aKiway->Player( FRAME_SCH_SYMBOL_EDITOR, false );
846  auto* symbolViewer = (LIB_VIEW_FRAME*) aKiway->Player( FRAME_SCH_VIEWER, false );
847 
849  wxString globalTablePath = SYMBOL_LIB_TABLE::GetGlobalTableFileName();
850  SYMBOL_LIB_TABLE* projectTable = nullptr;
851  wxString projectPath = aKiway->Prj().GetProjectPath();
852  wxFileName projectTableFn( projectPath, SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
853  wxString msg;
854  wxString currentLib;
855 
856  // Don't allow editing project tables if no project is open
857  if( !aKiway->Prj().IsNullProject() )
858  projectTable = aKiway->Prj().SchSymbolLibTable();
859 
860  if( symbolEditor )
861  {
862  currentLib = symbolEditor->GetCurLib();
863 
864  // This prevents an ugly crash on OSX (https://bugs.launchpad.net/kicad/+bug/1765286)
865  symbolEditor->FreezeSearchTree();
866 
867  if( symbolEditor->HasLibModifications() )
868  {
869  msg = _( "Modifications have been made to one or more symbol libraries.\n"
870  "Changes must be saved or discarded before the symbol library "
871  "table can be modified." );
872 
873  switch( UnsavedChangesDialog( aParent, msg ) )
874  {
875  case wxID_YES: symbolEditor->SaveAll(); break;
876  case wxID_NO: symbolEditor->RevertAll(); break;
877  default:
878  case wxID_CANCEL: symbolEditor->ThawSearchTree(); return;
879  }
880  }
881  }
882 
883  DIALOG_EDIT_LIBRARY_TABLES dlg( aParent, _( "Symbol Libraries" ) );
884 
885  dlg.InstallPanel( new PANEL_SYM_LIB_TABLE( &dlg, globalTable, globalTablePath,
886  projectTable, projectTableFn.GetFullPath(),
887  aKiway->Prj().GetProjectPath() ) );
888 
889  if( dlg.ShowModal() == wxID_CANCEL )
890  {
891  if( symbolEditor )
892  symbolEditor->ThawSearchTree();
893 
894  return;
895  }
896 
897  if( dlg.m_GlobalTableChanged )
898  {
899  try
900  {
901  globalTable->Save( globalTablePath );
902  }
903  catch( const IO_ERROR& ioe )
904  {
905  msg.Printf( _( "Error saving global library table:\n\n%s" ), ioe.What() );
906  wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
907  }
908  }
909 
910  if( projectTable && dlg.m_ProjectTableChanged )
911  {
912  try
913  {
914  projectTable->Save( projectTableFn.GetFullPath() );
915  }
916  catch( const IO_ERROR& ioe )
917  {
918  msg.Printf( _( "Error saving project-specific library table:\n\n%s" ), ioe.What() );
919  wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
920  }
921  }
922 
923  if( schEditor )
924  schEditor->SyncView();
925 
926  if( symbolEditor )
927  {
928  // Check if the currently selected symbol library been removed or disabled.
929  if( !currentLib.empty() && projectTable && !projectTable->HasLibrary( currentLib, true ) )
930  {
931  symbolEditor->SetCurLib( wxEmptyString );
932  symbolEditor->emptyScreen();
933  }
934 
935  symbolEditor->SyncLibraries( true );
936  symbolEditor->ThawSearchTree();
937  }
938 
939  if( symbolViewer )
940  symbolViewer->ReCreateListLib();
941 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
const BITMAP_OPAQUE trash_xpm[1]
Definition: trash.cpp:34
wxString m_FileFilter
Filter used for file pickers if m_IsFile is true.
static const wxString & GetSymbolLibTableFileName()
const BITMAP_OPAQUE folder_xpm[1]
Definition: folder.cpp:20
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
virtual void paste_text(const wxString &cb_text) override
handle specialized clipboard text, with leading "(sym_lib_table" or spreadsheet formatted text.
wxString AllSymbolLibFilesWildcard()
bool m_IsFile
Whether the library is a folder or a file.
void moveUpHandler(wxCommandEvent &event) override
SCH_IO_MGR::SCH_FILE_T m_Plugin
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
void Clear()
Delete all rows.
PANEL_SYM_LIB_TABLE(DIALOG_EDIT_LIBRARY_TABLES *aParent, SYMBOL_LIB_TABLE *aGlobal, const wxString &aGlobalTablePath, SYMBOL_LIB_TABLE *aProject, const wxString &aProjectTablePath, const wxString &m_projectBasePath)
This file is part of the common library.
void reindex()
bool ContainsNickname(const wxString &aNickname)
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:174
unsigned GetCount() const
Get the number of rows contained in the table.
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:87
LIB_TABLE_ROW * at(size_t aIndex) override
void OnUpdateUI(wxUpdateUIEvent &event) override
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:38
void InvokeSchEditSymbolLibTable(KIWAY *aKiway, wxWindow *aParent)
WX_GRID * m_cur_grid
changed based on tab choice
GRID_TRICKS is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GRID ins...
Definition: grid_tricks.h:52
static const wxString GetLibraryFileExtension(SCH_FILE_T aFileType)
Return the symbol library file extension (if any) for aFileType.
Definition: sch_io_mgr.cpp:154
static unsigned FindIllegalLibNicknameChar(const UTF8 &aNickname, LIB_ID_TYPE aType)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:403
SYMBOL_LIB_TABLE_GRID * global_model() const
static const wxString GlobalPathEnvVariableName()
Return the name of the environment variable used to hold the directory of locally installed "KiCad sp...
static size_t m_pageNdx
Remember the last notebook page selected during a session.
Schematic editor (Eeschema) main window.
LIB_TABLE_ROWS rows
Container that describes file type info for the add a library options.
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:65
int GetNumberRows() override
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:122
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:114
Symbol library viewer main window.
void adjustPathSubsGridColumns(int aWidth)
This abstract base class mixes any object derived from LIB_TABLE into wxGridTableBase so the result c...
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:59
virtual void paste_text(const wxString &cb_text)
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:95
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:82
void populateEnvironReadOnlyTable()
Populate the readonly environment variable table with names and values by examining all the full_uri ...
const wxString & GetNickName() const
LIB_TABLE_ROW * clone() const
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
bool GetIsEnabled() const
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:345
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:117
SYMBOL_LIB_TABLE_GRID * cur_model() const
wxString m_FolderSearchExtension
In case of folders it stands for extensions of files stored inside.
SYMBOL_LIB_TABLE * m_projectTable
bool Refresh()
Attempt to reload the library.
bool TransferDataFromWindow() override
const BITMAP_OPAQUE small_down_xpm[1]
Definition: small_down.cpp:24
Class PANEL_SYM_LIB_TABLE_BASE.
Definition of file extensions used in Kicad.
DIALOG_EDIT_LIBRARY_TABLES * m_dialog
KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the s...
Definition: kiway.h:273
void push_back(LIB_TABLE_ROW *aRow) override
wxString KiCadSymbolLibFileWildcard()
Editor for wxGrid cells that adds a file/folder browser to the grid input field.
Dialog to show and edit symbol library tables.
void deleteRowHandler(wxCommandEvent &event) override
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:180
bool AppendRows(size_t aNumRows=1) override
int UnsavedChangesDialog(wxWindow *parent, wxString aMessage, bool *aApplyToAll)
A specialized version of HandleUnsavedChanges which handles an apply-to-all checkbox.
Definition: confirm.cpp:149
wxString LegacySymbolLibFileWildcard()
int OKOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Displays a warning dialog with aMessage and returns the user response.
Definition: confirm.cpp:215
void appendRowHandler(wxCommandEvent &event) override
const BITMAP_OPAQUE small_up_xpm[1]
Definition: small_up.cpp:25
SYMBOL_LIB_TABLE_GRID(const SYMBOL_LIB_TABLE &aTableToEdit)
VTBL_ENTRY bool IsNullProject() const
Checks if this project is a null project (i.e.
Definition: project.cpp:134
DIALOG_EDIT_LIBRARY_TABLES * m_parent
static const std::map< int, supportedFileType > & fileTypes()
Map with event id as the key to supported file types that will be listed for the add a library option...
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
SYMBOL_LIB_TABLE_GRID * project_model() const
Struct PARSE_ERROR contains a filename or source description, a problem input line,...
Definition: ki_exception.h:123
see class PGM_BASE
LIB_TABLE_ROW & At(unsigned aIndex)
Get the 'n'th LIB_TABLE_ROW object.
#define _(s)
Definition: 3d_actions.cpp:33
LIB_TABLE_ROWS_ITER erase(LIB_TABLE_ROWS_ITER aFirst, LIB_TABLE_ROWS_ITER aLast) override
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...
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
bool verifyTables()
Trim important fields, removes blank row entries, and checks for duplicates.
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, LIB_ID_TYPE aType, bool aLib=false)
Replace illegal LIB_ID item name characters with underscores '_'.
Definition: lib_id.cpp:352
void onSizeGrid(wxSizeEvent &event) override
LIB_TABLE_ROWS_ITER insert(LIB_TABLE_ROWS_ITER aIterator, LIB_TABLE_ROW *aRow) override
SYMBOL_LIB_TABLE * m_globalTable
LIB_TABLE_ROW * makeNewRow() override
STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:255
LIB_TABLE_ROWS_ITER begin() override
wxString m_Description
Description shown in the file picker dialog.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
static wxString GetGlobalTableFileName()
Fetch the global symbol library table file name.
size_t size() const override
const BITMAP_OPAQUE small_plus_xpm[1]
Definition: small_plus.cpp:20
void moveDownHandler(wxCommandEvent &event) override
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalizes a file path to an environmental variable, if possible.
Definition: env_paths.cpp:68
SYMBOL_GRID_TRICKS(DIALOG_EDIT_LIBRARY_TABLES *aParent, WX_GRID *aGrid)
The symbol library editor main window.
void browseLibrariesHandler(wxCommandEvent &event) override