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-2018 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 <fctsys.h>
25 #include <project.h>
26 #include <panel_sym_lib_table.h>
27 #include <lib_id.h>
28 #include <symbol_lib_table.h>
29 #include <lib_table_lexer.h>
30 #include <grid_tricks.h>
31 #include <widgets/wx_grid.h>
32 #include <confirm.h>
33 #include <bitmaps.h>
34 #include <lib_table_grid.h>
36 #include <env_paths.h>
37 #include <lib_edit_frame.h>
38 #include <viewlib_frame.h>
39 #include <kiway.h>
41 
46 {
47  friend class SYMBOL_GRID_TRICKS;
48 
49 protected:
50  LIB_TABLE_ROW* at( size_t aIndex ) override { return &rows.at( aIndex ); }
51 
52  size_t size() const override { return rows.size(); }
53 
55  {
56  return dynamic_cast< LIB_TABLE_ROW* >( new SYMBOL_LIB_TABLE_ROW );
57  }
58 
59  LIB_TABLE_ROWS_ITER begin() override { return rows.begin(); }
60 
62  {
63  return rows.insert( aIterator, aRow );
64  }
65 
66  void push_back( LIB_TABLE_ROW* aRow ) override { rows.push_back( aRow ); }
67 
69  {
70  return rows.erase( aFirst, aLast );
71  }
72 
73 public:
74 
75  SYMBOL_LIB_TABLE_GRID( const SYMBOL_LIB_TABLE& aTableToEdit )
76  {
77  rows = aTableToEdit.rows;
78  }
79 };
80 
81 
83 {
84 public:
85  SYMBOL_GRID_TRICKS( DIALOG_EDIT_LIBRARY_TABLES* aParent, wxGrid* aGrid ) :
86  GRID_TRICKS( aGrid ),
87  m_dialog( aParent )
88  {
89  }
90 
91 protected:
93 
96  virtual void paste_text( const wxString& cb_text ) override
97  {
98  SYMBOL_LIB_TABLE_GRID* tbl = (SYMBOL_LIB_TABLE_GRID*) m_grid->GetTable();
99  size_t ndx = cb_text.find( "(sym_lib_table" );
100 
101  if( ndx != std::string::npos )
102  {
103  // paste the SYMBOL_LIB_TABLE_ROWs of s-expression (sym_lib_table), starting
104  // at column 0 regardless of current cursor column.
105 
106  STRING_LINE_READER slr( TO_UTF8( cb_text ), "Clipboard" );
107  LIB_TABLE_LEXER lexer( &slr );
108  SYMBOL_LIB_TABLE tmp_tbl;
109  bool parsed = true;
110 
111  try
112  {
113  tmp_tbl.Parse( &lexer );
114  }
115  catch( PARSE_ERROR& pe )
116  {
117  DisplayError( m_dialog, pe.What() );
118  parsed = false;
119  }
120 
121  if( parsed )
122  {
123  // make sure the table is big enough...
124  if( tmp_tbl.GetCount() > tbl->GetNumberRows() )
125  tbl->AppendRows( tmp_tbl.GetCount() - tbl->GetNumberRows() );
126 
127  for( int i = 0; i < tmp_tbl.GetCount(); ++i )
128  tbl->rows.replace( i, tmp_tbl.At( i ) );
129  }
130 
131  m_grid->AutoSizeColumns( false );
132  }
133  else
134  {
135  // paste spreadsheet formatted text.
136  GRID_TRICKS::paste_text( cb_text );
137 
138  m_grid->AutoSizeColumns( false );
139  }
140  }
141 };
142 
143 
145  SYMBOL_LIB_TABLE* aGlobal,
146  const wxString& aGlobalTablePath,
147  SYMBOL_LIB_TABLE* aProject,
148  const wxString& aProjectTablePath,
149  const wxString& aProjectBasePath ) :
150  PANEL_SYM_LIB_TABLE_BASE( aParent ),
151  m_globalTable( aGlobal ),
152  m_projectTable( aProject ),
153  m_projectBasePath( aProjectBasePath ),
154  m_parent( aParent )
155 {
156  // For user info, shows the table filenames:
157  m_GblTableFilename->SetLabel( aGlobalTablePath );
158  m_PrjTableFilename->SetLabel( aProjectTablePath );
159 
160  // wxGrid only supports user owned tables if they exist past end of ~wxGrid(),
161  // so make it a grid owned table.
162  m_global_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aGlobal ), true );
163  m_project_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aProject ), true );
164 
165  // Give a bit more room for combobox editors
166  m_global_grid->SetDefaultRowSize( m_global_grid->GetDefaultRowSize() + 2 );
167  m_project_grid->SetDefaultRowSize( m_project_grid->GetDefaultRowSize() + 2 );
168 
169  // add Cut, Copy, and Paste to wxGrids
170  m_global_grid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, m_global_grid ) );
171  m_project_grid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, m_project_grid ) );
172  m_path_subs_grid->PushEventHandler( new GRID_TRICKS( m_path_subs_grid ) );
173 
174  m_global_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
175  m_project_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
176 
177  m_global_grid->AutoSizeColumns( false );
178  m_project_grid->AutoSizeColumns( false );
179 
180  wxArrayString pluginChoices;
181 
182 // pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_KICAD ) );
183  pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
184 
186 
187  for( wxGrid* g : { m_global_grid, m_project_grid } )
188  {
189  // Set special attributes
190  wxGridCellAttr* attr;
191 
192  attr = new wxGridCellAttr;
193  attr->SetEditor( new wxGridCellChoiceEditor( pluginChoices ) );
194  g->SetColAttr( COL_TYPE, attr );
195 
196  attr = new wxGridCellAttr;
197  attr->SetRenderer( new wxGridCellBoolRenderer() );
198  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
199  g->SetColAttr( COL_ENABLED, attr );
200 
201  // all but COL_OPTIONS, which is edited with Option Editor anyways.
202  g->AutoSizeColumn( COL_NICKNAME, false );
203  g->AutoSizeColumn( COL_TYPE, false );
204  g->AutoSizeColumn( COL_URI, false );
205  g->AutoSizeColumn( COL_DESCR, false );
206  g->AutoSizeColumn( COL_ENABLED, false );
207 
208  // would set this to width of title, if it was easily known.
209  g->SetColSize( COL_OPTIONS, 80 );
210  }
211 
212  // select the last selected page
213  m_auinotebook->SetSelection( m_pageNdx );
215 
216  // for ALT+A handling, we want the initial focus to be on the first selected grid.
218 
219  // Configure button logos
220  m_append_button->SetBitmap( KiBitmap( small_plus_xpm ) );
221  m_delete_button->SetBitmap( KiBitmap( trash_xpm ) );
222  m_move_up_button->SetBitmap( KiBitmap( small_up_xpm ) );
223  m_move_down_button->SetBitmap( KiBitmap( small_down_xpm ) );
224  m_browse_button->SetBitmap( KiBitmap( folder_xpm ) );
225 
226  // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
227  // a currentCell which is sometimes not highlighted.
228  if( m_global_grid->GetNumberRows() > 0 )
229  m_global_grid->SelectRow( 0 );
230 
231  if( m_project_grid->GetNumberRows() > 0 )
232  m_project_grid->SelectRow( 0 );
233 }
234 
235 
237 {
238  // When the dialog is closed it will hide the current notebook page first, which will
239  // in turn select the other one. We then end up saving its index as the "current page".
240  // So flip them back again:
241  m_pageNdx = m_pageNdx == 1 ? 0 : 1;
242 
243  // Delete the GRID_TRICKS.
244  // Any additional event handlers should be popped before the window is deleted.
245  m_global_grid->PopEventHandler( true );
246  m_project_grid->PopEventHandler( true );
247  m_path_subs_grid->PopEventHandler( true );
248 }
249 
250 
252 {
253  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
254  {
255  for( int r = 0; r < model->GetNumberRows(); )
256  {
257  wxString nick = model->GetValue( r, COL_NICKNAME ).Trim( false ).Trim();
258  wxString uri = model->GetValue( r, COL_URI ).Trim( false ).Trim();
259  unsigned illegalCh = 0;
260 
261  if( !nick || !uri )
262  {
263  // Delete the "empty" row, where empty means missing nick or uri.
264  // This also updates the UI which could be slow, but there should only be a few
265  // rows to delete, unless the user fell asleep on the Add Row
266  // button.
267  model->DeleteRows( r, 1 );
268  }
269  else if( ( illegalCh = LIB_ID::FindIllegalLibNicknameChar( nick, LIB_ID::ID_SCH ) ) )
270  {
271  wxString msg = wxString::Format( _( "Illegal character '%c' in Nickname: \"%s\"" ),
272  illegalCh,
273  nick );
274 
275  // show the tabbed panel holding the grid we have flunked:
276  if( model != cur_model() )
277  m_auinotebook->SetSelection( model == global_model() ? 0 : 1 );
278 
279  m_cur_grid->MakeCellVisible( r, 0 );
280  m_cur_grid->SetGridCursor( r, 1 );
281 
282  wxMessageDialog errdlg( this, msg, _( "No Colon in Nicknames" ) );
283  errdlg.ShowModal();
284  return false;
285  }
286  else
287  {
288  // set the trimmed values back into the table so they get saved to disk.
289  model->SetValue( r, COL_NICKNAME, nick );
290  model->SetValue( r, COL_URI, uri );
291  ++r; // this row was OK.
292  }
293  }
294  }
295 
296  // check for duplicate nickNames, separately in each table.
297  for( SYMBOL_LIB_TABLE_GRID* model : { global_model(), project_model() } )
298  {
299  for( int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
300  {
301  wxString nick1 = model->GetValue( r1, COL_NICKNAME );
302 
303  for( int r2=r1+1; r2 < model->GetNumberRows(); ++r2 )
304  {
305  wxString nick2 = model->GetValue( r2, COL_NICKNAME );
306 
307  if( nick1 == nick2 )
308  {
309  wxString msg = wxString::Format( _( "Duplicate Nickname: \"%s\"." ), nick1 );
310 
311  // show the tabbed panel holding the grid we have flunked:
312  if( model != cur_model() )
313  m_auinotebook->SetSelection( model == global_model() ? 0 : 1 );
314 
315  // go to the lower of the two rows, it is technically the duplicate:
316  m_cur_grid->MakeCellVisible( r2, 0 );
317  m_cur_grid->SetGridCursor( r2, 1 );
318 
319  wxMessageDialog errdlg( this, msg, _( "Please Delete or Modify One" ) );
320  errdlg.ShowModal();
321 
322  return false;
323  }
324  }
325  }
326  }
327 
328  return true;
329 }
330 
331 
332 void PANEL_SYM_LIB_TABLE::pageChangedHandler( wxAuiNotebookEvent& event )
333 {
334  m_pageNdx = (unsigned) std::max( 0, m_auinotebook->GetSelection() );
336 }
337 
338 
339 void PANEL_SYM_LIB_TABLE::browseLibrariesHandler( wxCommandEvent& event )
340 {
341  if( m_lastBrowseDir.IsEmpty() )
343 
344  wxFileDialog dlg( this, _( "Select Library" ), m_lastBrowseDir,
345  wxEmptyString, SchematicLibraryFileWildcard(),
346  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
347 
348  auto result = dlg.ShowModal();
349 
350  if( result == wxID_CANCEL )
351  return;
352 
353  m_lastBrowseDir = dlg.GetDirectory();
354 
355  const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
356  bool addDuplicates = false;
357  bool applyToAll = false;
358  wxString warning = _( "Warning: Duplicate Nickname" );
359  wxString msg = _( "A library nicknamed \"%s\" already exists." );
360  wxArrayString files;
361  dlg.GetFilenames( files );
362 
363  for( const auto& file : files )
364  {
365  wxString filePath = dlg.GetDirectory() + wxFileName::GetPathSeparator() + file;
366  wxFileName fn( filePath );
367  wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), LIB_ID::ID_SCH );
368  bool doAdd = true;
369 
370  if( cur_model()->ContainsNickname( nickname ) )
371  {
372  if( !applyToAll )
373  {
374  int ret = YesOrCancelDialog( this, warning, wxString::Format( msg, nickname ),
375  _( "Skip" ), _( "Add Anyway" ), &applyToAll );
376  addDuplicates = (ret == wxID_CANCEL );
377  }
378 
379  doAdd = addDuplicates;
380  }
381 
382  if( doAdd && m_cur_grid->AppendRows( 1 ) )
383  {
384  int last_row = m_cur_grid->GetNumberRows() - 1;
385 
386  m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
387 
388  // TODO the following code can detect only schematic types, not libs
389  // SCH_IO_MGR needs to provide file extension information for libraries too
390 
391  // auto detect the plugin type
392  /*for( auto pluginType : SCH_IO_MGR::SCH_FILE_T_vector )
393  {
394  if( SCH_IO_MGR::GetFileExtension( pluginType ).Lower() == fn.GetExt().Lower() )
395  {
396  m_cur_grid->SetCellValue( last_row, COL_TYPE,
397  SCH_IO_MGR::ShowType( pluginType ) );
398  break;
399  }
400  }*/
401  m_cur_grid->SetCellValue( last_row, COL_TYPE,
402  SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
403 
404  // try to use path normalized to an environmental variable or project path
405  wxString path = NormalizePath( filePath, &envVars, m_projectBasePath );
406 
407  if( path.IsEmpty() )
408  path = fn.GetFullPath();
409 
410  m_cur_grid->SetCellValue( last_row, COL_URI, path );
411  }
412  }
413 
414  if( !files.IsEmpty() )
415  {
416  m_cur_grid->MakeCellVisible( m_cur_grid->GetNumberRows() - 1, 0 );
417  m_cur_grid->SetGridCursor( m_cur_grid->GetNumberRows() - 1, 1 );
418  }
419 }
420 
421 
422 void PANEL_SYM_LIB_TABLE::appendRowHandler( wxCommandEvent& event )
423 {
425  return;
426 
427  if( m_cur_grid->AppendRows( 1 ) )
428  {
429  int row = m_cur_grid->GetNumberRows() - 1;
430  // Gives a default type (currently, only one type exists):
431  m_cur_grid->SetCellValue( row, COL_TYPE, SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) );
432 
433  // wx documentation is wrong, SetGridCursor does not make visible.
434  m_cur_grid->MakeCellVisible( row, 0 );
435  m_cur_grid->SetGridCursor( row, 1 );
436 
437  m_cur_grid->EnableCellEditControl( true );
438  m_cur_grid->ShowCellEditControl();
439  }
440 }
441 
442 
443 void PANEL_SYM_LIB_TABLE::deleteRowHandler( wxCommandEvent& event )
444 {
446  return;
447 
448  int curRow = m_cur_grid->GetGridCursorRow();
449  int curCol = m_cur_grid->GetGridCursorCol();
450 
451  // In a wxGrid, collect rows that have a selected cell, or are selected
452  // is not so easy: it depend on the way the selection was made.
453  // Here, we collect row selected by clicking on a row label, and
454  // row that contain a cell previously selected.
455  // If no candidate, just delete the row with the grid cursor.
456  wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
457  wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells();
458  wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft();
459  wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight();
460 
461  // Add all row having cell selected to list:
462  for( unsigned ii = 0; ii < cells.GetCount(); ii++ )
463  selectedRows.Add( cells[ii].GetRow() );
464 
465  // Handle block selection
466  if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
467  {
468  for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
469  selectedRows.Add( i );
470  }
471 
472  // Use the row having the grid cursor only if we have no candidate:
473  if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 )
474  selectedRows.Add( m_cur_grid->GetGridCursorRow() );
475 
476  if( selectedRows.size() == 0 )
477  {
478  wxBell();
479  return;
480  }
481 
482  std::sort( selectedRows.begin(), selectedRows.end() );
483 
484  // Remove selected rows (note: a row can be stored more than once in list)
485  int last_row = -1;
486 
487  for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
488  {
489  int row = selectedRows[ii];
490 
491  if( row != last_row )
492  {
493  last_row = row;
494  m_cur_grid->DeleteRows( row, 1 );
495  }
496  }
497 
498  m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol );
499 }
500 
501 
502 void PANEL_SYM_LIB_TABLE::moveUpHandler( wxCommandEvent& event )
503 {
505  return;
506 
508  int curRow = m_cur_grid->GetGridCursorRow();
509 
510  // @todo: add multiple selection moves.
511  if( curRow >= 1 )
512  {
513  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
514  tbl->rows.release( tbl->rows.begin() + curRow );
515 
516  --curRow;
517  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
518 
519  if( tbl->GetView() )
520  {
521  // Update the wxGrid
522  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
523  tbl->GetView()->ProcessTableMessage( msg );
524  }
525 
526  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
527  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
528  }
529 }
530 
531 
532 void PANEL_SYM_LIB_TABLE::moveDownHandler( wxCommandEvent& event )
533 {
535  return;
536 
538  int curRow = m_cur_grid->GetGridCursorRow();
539 
540  // @todo: add multiple selection moves.
541  if( unsigned( curRow + 1 ) < tbl->rows.size() )
542  {
543  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
544  tbl->rows.release( tbl->rows.begin() + curRow );
545 
546  ++curRow;
547  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
548 
549  if( tbl->GetView() )
550  {
551  // Update the wxGrid
552  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
553  tbl->GetView()->ProcessTableMessage( msg );
554  }
555 
556  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
557  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
558  }
559 }
560 
561 
563 {
565  return false;
566 
567  if( !verifyTables() )
568  return false;
569 
570  if( *global_model() != *m_globalTable )
571  {
573 
574  m_globalTable->Clear();
575  m_globalTable->rows.transfer( m_globalTable->rows.end(), global_model()->rows.begin(),
576  global_model()->rows.end(), global_model()->rows );
578  }
579 
580  if( *project_model() != *m_projectTable )
581  {
583 
585  m_projectTable->rows.transfer( m_projectTable->rows.end(), project_model()->rows.begin(),
586  project_model()->rows.end(), project_model()->rows );
588  }
589 
590  return true;
591 }
592 
593 
595 {
596  wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
597  wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required.
598 
599  std::set< wxString > unique;
600 
601  // clear the table
602  m_path_subs_grid->DeleteRows( 0, m_path_subs_grid->GetNumberRows() );
603 
604  for( SYMBOL_LIB_TABLE_GRID* tbl : { global_model(), project_model() } )
605  {
606  for( int row = 0; row < tbl->GetNumberRows(); ++row )
607  {
608  wxString uri = tbl->GetValue( row, COL_URI );
609 
610  while( re.Matches( uri ) )
611  {
612  wxString envvar = re.GetMatch( uri, 2 );
613 
614  // if not ${...} form then must be $(...)
615  if( envvar.IsEmpty() )
616  envvar = re.GetMatch( uri, 4 );
617 
618  // ignore duplicates
619  unique.insert( envvar );
620 
621  // delete the last match and search again
622  uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString );
623  }
624  }
625  }
626 
627  // Make sure this special environment variable shows up even if it was
628  // not used yet. It is automatically set by KiCad to the directory holding
629  // the current project.
630  unique.insert( PROJECT_VAR_NAME );
632 
633  for( wxString evName : unique )
634  {
635  int row = m_path_subs_grid->GetNumberRows();
636  m_path_subs_grid->AppendRows( 1 );
637 
638  m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) );
639  m_path_subs_grid->SetCellEditor( row, 0, new GRID_CELL_READONLY_TEXT_EDITOR() );
640 
641  wxString evValue;
642  wxGetEnv( evName, &evValue );
643  m_path_subs_grid->SetCellValue( row, 1, evValue );
644  m_path_subs_grid->SetCellEditor( row, 1, new GRID_CELL_READONLY_TEXT_EDITOR() );
645  }
646 
647  // No combobox editors here, but it looks better if its consistent with the other
648  // grids in the dialog.
649  m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 2 );
650 
651  adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() );
652 }
653 
654 
656 {
657  // Account for scroll bars
658  aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
659 
660  m_path_subs_grid->AutoSizeColumn( 0 );
661  m_path_subs_grid->SetColSize( 1, aWidth - m_path_subs_grid->GetColSize( 0 ) );
662 }
663 
664 
665 void PANEL_SYM_LIB_TABLE::onSizeGrid( wxSizeEvent& event )
666 {
667  adjustPathSubsGridColumns( event.GetSize().GetX() );
668 
669  event.Skip();
670 }
671 
672 
674 {
675  return (SYMBOL_LIB_TABLE_GRID*) m_global_grid->GetTable();
676 }
677 
678 
680 {
681  return (SYMBOL_LIB_TABLE_GRID*) m_project_grid->GetTable();
682 }
683 
684 
686 {
687  return (SYMBOL_LIB_TABLE_GRID*) m_cur_grid->GetTable();
688 }
689 
690 
692 
693 
694 void InvokeSchEditSymbolLibTable( KIWAY* aKiway, wxWindow *aParent )
695 {
697  wxString globalTablePath = SYMBOL_LIB_TABLE::GetGlobalTableFileName();
698  SYMBOL_LIB_TABLE* projectTable = aKiway->Prj().SchSymbolLibTable();
699  wxString projectPath = aKiway->Prj().GetProjectPath();
700  wxFileName projectTableFn( projectPath, SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
701  wxString msg;
702 
703  DIALOG_EDIT_LIBRARY_TABLES dlg( aParent, _( "Symbol Libraries" ) );
704 
705  dlg.InstallPanel( new PANEL_SYM_LIB_TABLE( &dlg, globalTable, globalTablePath,
706  projectTable, projectTableFn.GetFullPath(),
707  aKiway->Prj().GetProjectPath() ) );
708 
709  if( dlg.ShowModal() == wxID_CANCEL )
710  return;
711 
712  if( dlg.m_GlobalTableChanged )
713  {
714  try
715  {
716  globalTable->Save( globalTablePath );
717  }
718  catch( const IO_ERROR& ioe )
719  {
720  msg.Printf( _( "Error saving global library table:\n\n%s" ), ioe.What() );
721  wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
722  }
723  }
724 
725  if( dlg.m_ProjectTableChanged )
726  {
727 
728  try
729  {
730  projectTable->Save( projectTableFn.GetFullPath() );
731  }
732  catch( const IO_ERROR& ioe )
733  {
734  msg.Printf( _( "Error saving project-specific library table:\n\n%s" ), ioe.What() );
735  wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
736  }
737  }
738 
739  auto editor = (LIB_EDIT_FRAME*) aKiway->Player( FRAME_SCH_LIB_EDITOR, false );
740 
741  if( editor )
742  editor->SyncLibraries( true );
743 
744  LIB_VIEW_FRAME* viewer = (LIB_VIEW_FRAME*) aKiway->Player( FRAME_SCH_VIEWER, false );
745 
746  if( viewer )
747  viewer->ReCreateListLib();
748 }
749 
750 
int GetCount()
static const wxString & GetSymbolLibTableFileName()
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...
void moveUpHandler(wxCommandEvent &event) override
void pageChangedHandler(wxAuiNotebookEvent &event) override
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
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)
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:76
LIB_TABLE_ROW * at(size_t aIndex) override
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:37
void InvokeSchEditSymbolLibTable(KIWAY *aKiway, wxWindow *aParent)
WX_GRID * m_cur_grid
changed based on tab choice
Class GRID_TRICKS is used to add cut, copy, and paste to an otherwise unmodied wxGrid instance...
Definition: grid_tricks.h:51
SYMBOL_LIB_TABLE_GRID * cur_model() const
static unsigned FindIllegalLibNicknameChar(const UTF8 &aNickname, LIB_ID_TYPE aType)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:398
wxString SchematicLibraryFileWildcard()
static const wxString GlobalPathEnvVariableName()
Return the name of the environment variable used to hold the directory of locally installed "KiCad sp...
LIB_TABLE_ROW * At(int aIndex)
static size_t m_pageNdx
Remember the last notebook page selected during a session.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
LIB_TABLE_ROWS rows
int YesOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Function YesOrCancelDialog displays a warning dialog with aMessage and returns the user response...
Definition: confirm.cpp:226
SYMBOL_LIB_TABLE_GRID * global_model() const
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid&#39;s SetTable() method with one which doesn&#39;t mess up the grid column widths when setting th...
Definition: wx_grid.cpp:46
int GetNumberRows() override
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:115
Symbol library viewer main window.
Definition: viewlib_frame.h:44
void adjustPathSubsGridColumns(int aWidth)
This abstract base class mixes any object derived from LIB_TABLE into wxGridTableBase so the result c...
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:47
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
void populateEnvironReadOnlyTable()
Populate the readonly environment variable table with names and values by examining all the full_uri ...
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
VTBL_ENTRY const ENV_VAR_MAP & GetLocalEnvVariables() const
Definition: pgm_base.h:312
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:300
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:129
SYMBOL_LIB_TABLE * m_projectTable
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:142
bool TransferDataFromWindow() override
Class PANEL_SYM_LIB_TABLE_BASE.
SYMBOL_GRID_TRICKS(DIALOG_EDIT_LIBRARY_TABLES *aParent, wxGrid *aGrid)
The common library.
DIALOG_EDIT_LIBRARY_TABLES * m_dialog
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:258
void push_back(LIB_TABLE_ROW *aRow) override
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
void deleteRowHandler(wxCommandEvent &event) override
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
bool AppendRows(size_t aNumRows=1) override
void appendRowHandler(wxCommandEvent &event) override
SYMBOL_LIB_TABLE_GRID(const SYMBOL_LIB_TABLE &aTableToEdit)
DIALOG_EDIT_LIBRARY_TABLES * m_parent
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
Struct PARSE_ERROR contains a filename or source description, a problem input line, a line number, a byte offset, and an error message which contains the the caller&#39;s report and his call site information: CPP source file, function, and line number.
Definition: ki_exception.h:123
The symbol library editor main window.
wxString m_lastBrowseDir
last browsed directory
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define max(a, b)
Definition: auxiliary.h:86
SYMBOL_LIB_TABLE_GRID * project_model() const
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...
size_t i
Definition: json11.cpp:597
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:102
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 &#39;_&#39;.
Definition: lib_id.cpp:352
Definition of class LIB_EDIT_FRAME.
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
bool ReCreateListLib()
Creates or recreates a sorted list of currently loaded libraries.
LIB_TABLE_ROW * makeNewRow() override
Class STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:254
LIB_TABLE_ROWS_ITER begin() override
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:245
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
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:67
#define min(a, b)
Definition: auxiliary.h:85
void browseLibrariesHandler(wxCommandEvent &event) override