KiCad PCB EDA Suite
PANEL_FP_LIB_TABLE Class Reference

Dialog to show and edit symbol library tables. More...

#include <panel_fp_lib_table.h>

Inheritance diagram for PANEL_FP_LIB_TABLE:
PANEL_FP_LIB_TABLE_BASE

Public Member Functions

 PANEL_FP_LIB_TABLE (DIALOG_EDIT_LIBRARY_TABLES *aParent, FP_LIB_TABLE *aGlobal, const wxString &aGlobalTblPath, FP_LIB_TABLE *aProject, const wxString &aProjectTblPath, const wxString &aProjectBasePath)
 
 ~PANEL_FP_LIB_TABLE () override
 

Protected Attributes

wxAuiNotebook * m_auinotebook
 
wxPanel * m_global_panel
 
wxStaticText * m_staticText3
 
wxStaticText * m_GblTableFilename
 
WX_GRIDm_global_grid
 
wxPanel * m_project_panel
 
wxStaticText * m_staticText4
 
wxStaticText * m_PrjTableFilename
 
WX_GRIDm_project_grid
 
wxBitmapButton * m_append_button
 
wxBitmapButton * m_browse_button
 
wxBitmapButton * m_move_up_button
 
wxBitmapButton * m_move_down_button
 
wxBitmapButton * m_delete_button
 
WX_GRIDm_path_subs_grid
 

Private Member Functions

bool TransferDataFromWindow () override
 
bool verifyTables ()
 Trim important fields, removes blank row entries, and checks for duplicates. More...
 
void pageChangedHandler (wxAuiNotebookEvent &event) override
 
void appendRowHandler (wxCommandEvent &event) override
 
void browseLibrariesHandler (wxCommandEvent &event) override
 
void deleteRowHandler (wxCommandEvent &event) override
 
void moveUpHandler (wxCommandEvent &event) override
 
void moveDownHandler (wxCommandEvent &event) override
 
void onSizeGrid (wxSizeEvent &event) override
 
void adjustPathSubsGridColumns (int aWidth)
 
void populateEnvironReadOnlyTable ()
 Populate the readonly environment variable table with names and values by examining all the full_uri columns. More...
 
FP_LIB_TABLE_GRIDglobal_model () const
 
FP_LIB_TABLE_GRIDproject_model () const
 
FP_LIB_TABLE_GRIDcur_model () const
 

Private Attributes

FP_LIB_TABLEm_global
 
FP_LIB_TABLEm_project
 
wxString m_projectBasePath
 
DIALOG_EDIT_LIBRARY_TABLESm_parent
 
WX_GRIDm_cur_grid
 

Static Private Attributes

static size_t m_pageNdx = 0
 
static wxString m_lastBrowseDir
 

Detailed Description

Dialog to show and edit symbol library tables.

Definition at line 34 of file panel_fp_lib_table.h.

Constructor & Destructor Documentation

◆ PANEL_FP_LIB_TABLE()

PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE ( DIALOG_EDIT_LIBRARY_TABLES aParent,
FP_LIB_TABLE aGlobal,
const wxString &  aGlobalTblPath,
FP_LIB_TABLE aProject,
const wxString &  aProjectTblPath,
const wxString &  aProjectBasePath 
)

Definition at line 268 of file panel_fp_lib_table.cpp.

References COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, IO_MGR::EAGLE, IO_MGR::GEDA_PCB, KiBitmap(), IO_MGR::KICAD_SEXP, IO_MGR::LEGACY, PANEL_FP_LIB_TABLE_BASE::m_append_button, PANEL_FP_LIB_TABLE_BASE::m_auinotebook, PANEL_FP_LIB_TABLE_BASE::m_browse_button, m_cur_grid, PANEL_FP_LIB_TABLE_BASE::m_delete_button, PANEL_FP_LIB_TABLE_BASE::m_GblTableFilename, PANEL_FP_LIB_TABLE_BASE::m_global_grid, m_lastBrowseDir, PANEL_FP_LIB_TABLE_BASE::m_move_down_button, PANEL_FP_LIB_TABLE_BASE::m_move_up_button, m_pageNdx, m_parent, PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid, PANEL_FP_LIB_TABLE_BASE::m_PrjTableFilename, PANEL_FP_LIB_TABLE_BASE::m_project_grid, populateEnvironReadOnlyTable(), DIALOG_SHIM::SetInitialFocus(), WX_GRID::SetTable(), and IO_MGR::ShowType().

271  :
272  PANEL_FP_LIB_TABLE_BASE( aParent ),
273  m_global( aGlobal ),
274  m_project( aProject ),
275  m_projectBasePath( aProjectBasePath ),
276  m_parent( aParent )
277 {
278  // For user info, shows the table filenames:
279  m_GblTableFilename->SetLabel( aGlobalTblPath );
280  m_PrjTableFilename->SetLabel( aProjectTblPath );
281 
282  m_global_grid->SetTable( new FP_LIB_TABLE_GRID( *aGlobal ), true );
283  m_project_grid->SetTable( new FP_LIB_TABLE_GRID( *aProject ), true );
284 
285  // Give a bit more room for wxChoice editors
286  m_global_grid->SetDefaultRowSize( m_global_grid->GetDefaultRowSize() + 4 );
287  m_project_grid->SetDefaultRowSize( m_project_grid->GetDefaultRowSize() + 4 );
288 
289  // add Cut, Copy, and Paste to wxGrids
290  m_global_grid->PushEventHandler( new FP_GRID_TRICKS( m_parent, m_global_grid ) );
291  m_project_grid->PushEventHandler( new FP_GRID_TRICKS( m_parent, m_project_grid ) );
292  m_path_subs_grid->PushEventHandler( new GRID_TRICKS( m_path_subs_grid ) );
293 
294  m_global_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
295  m_project_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
296 
297  m_global_grid->AutoSizeColumns( false );
298  m_project_grid->AutoSizeColumns( false );
299 
300  wxArrayString choices;
301 
302  choices.Add( IO_MGR::ShowType( IO_MGR::KICAD_SEXP ) );
303 #if defined(BUILD_GITHUB_PLUGIN)
304  choices.Add( IO_MGR::ShowType( IO_MGR::GITHUB ) );
305 #endif
306  choices.Add( IO_MGR::ShowType( IO_MGR::LEGACY ) );
307  choices.Add( IO_MGR::ShowType( IO_MGR::EAGLE ) );
308  choices.Add( IO_MGR::ShowType( IO_MGR::GEDA_PCB ) );
309 
310  /* PCAD_PLUGIN does not support Footprint*() functions
311  choices.Add( IO_MGR::ShowType( IO_MGR::PCAD ) );
312  */
313 
315 
316  for( wxGrid* g : { m_global_grid, m_project_grid } )
317  {
318  wxGridCellAttr* attr;
319 
320  attr = new wxGridCellAttr;
321  attr->SetEditor( new GRID_CELL_PATH_EDITOR( m_parent, &m_lastBrowseDir ) );
322  g->SetColAttr( COL_URI, attr );
323 
324  attr = new wxGridCellAttr;
325  attr->SetEditor( new wxGridCellChoiceEditor( choices ) );
326  g->SetColAttr( COL_TYPE, attr );
327 
328  attr = new wxGridCellAttr;
329  attr->SetRenderer( new wxGridCellBoolRenderer() );
330  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
331  g->SetColAttr( COL_ENABLED, attr );
332 
333  // all but COL_OPTIONS, which is edited with Option Editor anyways.
334  g->AutoSizeColumn( COL_NICKNAME, false );
335  g->AutoSizeColumn( COL_TYPE, false );
336  g->AutoSizeColumn( COL_URI, false );
337  g->AutoSizeColumn( COL_DESCR, false );
338 
339  // would set this to width of title, if it was easily known.
340  g->SetColSize( COL_OPTIONS, 80 );
341  }
342 
343  // select the last selected page
344  m_auinotebook->SetSelection( m_pageNdx );
346 
347  // for ALT+A handling, we want the initial focus to be on the first selected grid.
349 
350  // Configure button logos
351  m_append_button->SetBitmap( KiBitmap( small_plus_xpm ) );
352  m_browse_button->SetBitmap( KiBitmap( folder_xpm ) );
353  m_delete_button->SetBitmap( KiBitmap( trash_xpm ) );
354  m_move_up_button->SetBitmap( KiBitmap( small_up_xpm ) );
355  m_move_down_button->SetBitmap( KiBitmap( small_down_xpm ) );
356 
357  // Gives a selection to each grid, mainly for delete button. wxGrid's wake up with
358  // a currentCell which is sometimes not highlighted.
359  if( m_global_grid->GetNumberRows() > 0 )
360  m_global_grid->SelectRow( 0 );
361 
362  if( m_project_grid->GetNumberRows() > 0 )
363  m_project_grid->SelectRow( 0 );
364 }
FP_LIB_TABLE * m_project
Class GRID_TRICKS is used to add cut, copy, and paste to an otherwise unmodied wxGrid instance...
Definition: grid_tricks.h:51
static wxString m_lastBrowseDir
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
static const wxString ShowType(PCB_FILE_T aFileType)
Function ShowType returns a brief name for a plugin, given aFileType enum.
Definition: io_mgr.cpp:77
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:116
Geda PCB file formats.
Definition: io_mgr.h:60
static size_t m_pageNdx
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:56
PANEL_FP_LIB_TABLE_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(500, 300), long style=wxTAB_TRAVERSAL)
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.
DIALOG_EDIT_LIBRARY_TABLES * m_parent
FP_LIB_TABLE * m_global
void populateEnvironReadOnlyTable()
Populate the readonly environment variable table with names and values by examining all the full_uri ...
S-expression Pcbnew file format.
Definition: io_mgr.h:57

◆ ~PANEL_FP_LIB_TABLE()

PANEL_FP_LIB_TABLE::~PANEL_FP_LIB_TABLE ( )
override

Definition at line 367 of file panel_fp_lib_table.cpp.

References PANEL_FP_LIB_TABLE_BASE::m_global_grid, m_pageNdx, PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid, and PANEL_FP_LIB_TABLE_BASE::m_project_grid.

368 {
369  // When the dialog is closed it will hide the current notebook page first, which will
370  // in turn select the other one. We then end up saving its index as the "current page".
371  // So flip them back again:
372  m_pageNdx = m_pageNdx == 1 ? 0 : 1;
373 
374  // Delete the GRID_TRICKS.
375  // Any additional event handlers should be popped before the window is deleted.
376  m_global_grid->PopEventHandler( true );
377  m_project_grid->PopEventHandler( true );
378  m_path_subs_grid->PopEventHandler( true );
379 }
static size_t m_pageNdx

Member Function Documentation

◆ adjustPathSubsGridColumns()

void PANEL_FP_LIB_TABLE::adjustPathSubsGridColumns ( int  aWidth)
private

Definition at line 682 of file panel_fp_lib_table.cpp.

References PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid.

Referenced by onSizeGrid(), and populateEnvironReadOnlyTable().

683 {
684  // Account for scroll bars
685  aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x );
686 
687  m_path_subs_grid->AutoSizeColumn( 0 );
688  m_path_subs_grid->SetColSize( 1, aWidth - m_path_subs_grid->GetColSize( 0 ) );
689 }

◆ appendRowHandler()

void PANEL_FP_LIB_TABLE::appendRowHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 471 of file panel_fp_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), and m_cur_grid.

472 {
474  return;
475 
476  if( m_cur_grid->AppendRows( 1 ) )
477  {
478  int last_row = m_cur_grid->GetNumberRows() - 1;
479 
480  // wx documentation is wrong, SetGridCursor does not make visible.
481  m_cur_grid->MakeCellVisible( last_row, 0 );
482  m_cur_grid->SetGridCursor( last_row, 1 );
483  m_cur_grid->EnableCellEditControl( true );
484  m_cur_grid->ShowCellEditControl();
485  }
486 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156

◆ browseLibrariesHandler()

void PANEL_FP_LIB_TABLE::browseLibrariesHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 607 of file panel_fp_lib_table.cpp.

References COL_NICKNAME, COL_TYPE, COL_URI, WX_GRID::CommitPendingChanges(), LIB_TABLE_GRID::ContainsNickname(), cur_model(), FD_MULTIPLE, LIB_ID::FixIllegalChars(), Format(), DIALOG_FILE_DIR_PICKER::GetDirectory(), DIALOG_FILE_DIR_PICKER::GetFilenames(), getFilterString(), PGM_BASE::GetLocalEnvVariables(), IO_MGR::GuessPluginTypeFromLibPath(), LIB_ID::ID_PCB, KiCadFootprintLibPathExtension, m_cur_grid, m_lastBrowseDir, m_projectBasePath, NormalizePath(), Pgm(), IO_MGR::ShowType(), and YesOrCancelDialog().

608 {
610  return;
611 
612  if( m_lastBrowseDir.IsEmpty() )
614 
615  DIALOG_FILE_DIR_PICKER dlg( this, _( "Select Library" ), m_lastBrowseDir,
617 
618  auto result = dlg.ShowModal();
619 
620  if( result == wxID_CANCEL )
621  return;
622 
623  m_lastBrowseDir = dlg.GetDirectory();
624 
625  // Drop the last directory if the path is a .pretty folder
627  m_lastBrowseDir = m_lastBrowseDir.BeforeLast( wxFileName::GetPathSeparator() );
628 
629  const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
630  bool addDuplicates = false;
631  bool applyToAll = false;
632  wxString warning = _( "Warning: Duplicate Nickname" );
633  wxString msg = _( "A library nicknamed \"%s\" already exists." );
634  wxArrayString files;
635  dlg.GetFilenames( files );
636 
637  for( const auto& filePath : files )
638  {
639  wxFileName fn( filePath );
640  wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), LIB_ID::ID_PCB );
641  bool doAdd = true;
642 
643  if( cur_model()->ContainsNickname( nickname ) )
644  {
645  if( !applyToAll )
646  {
647  int ret = YesOrCancelDialog( this, warning, wxString::Format( msg, nickname ),
648  _( "Skip" ), _( "Add Anyway" ), &applyToAll );
649  addDuplicates = (ret == wxID_CANCEL );
650  }
651 
652  doAdd = addDuplicates;
653  }
654 
655  if( doAdd && m_cur_grid->AppendRows( 1 ) )
656  {
657  int last_row = m_cur_grid->GetNumberRows() - 1;
658 
659  m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname );
660 
661  auto type = IO_MGR::GuessPluginTypeFromLibPath( filePath );
662  m_cur_grid->SetCellValue( last_row, COL_TYPE, IO_MGR::ShowType( type ) );
663 
664  // try to use path normalized to an environmental variable or project path
665  wxString path = NormalizePath( filePath, &envVars, m_projectBasePath );
666 
667  if( path.IsEmpty() )
668  path = fn.GetFullPath();
669 
670  m_cur_grid->SetCellValue( last_row, COL_URI, path );
671  }
672  }
673 
674  if( !files.IsEmpty() )
675  {
676  int new_row = m_cur_grid->GetNumberRows() - 1;
677  m_cur_grid->MakeCellVisible( new_row, m_cur_grid->GetGridCursorCol() );
678  m_cur_grid->SetGridCursor( new_row, m_cur_grid->GetGridCursorCol() );
679  }
680 }
bool ContainsNickname(const wxString &aNickname)
static wxString m_lastBrowseDir
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
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
static const wxString ShowType(PCB_FILE_T aFileType)
Function ShowType returns a brief name for a plugin, given aFileType enum.
Definition: io_mgr.cpp:77
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Function GuessPluginTypeFromLibPath returns a plugin type given a footprint library&#39;s libPath...
Definition: io_mgr.cpp:124
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:131
static wxString getFilterString()
FP_LIB_TABLE_GRID * cur_model() const
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
VTBL_ENTRY const ENV_VAR_MAP & GetLocalEnvVariables() const
Definition: pgm_base.h:314
Dialog that can select both files and directories.
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
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
const std::string KiCadFootprintLibPathExtension
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

◆ cur_model()

FP_LIB_TABLE_GRID* PANEL_FP_LIB_TABLE::cur_model ( ) const
inlineprivate

Definition at line 83 of file panel_fp_lib_table.h.

References m_cur_grid.

Referenced by browseLibrariesHandler(), moveDownHandler(), moveUpHandler(), and verifyTables().

84  {
85  return (FP_LIB_TABLE_GRID*) m_cur_grid->GetTable();
86  }
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.

◆ deleteRowHandler()

void PANEL_FP_LIB_TABLE::deleteRowHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 489 of file panel_fp_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), i, m_cur_grid, and min.

490 {
492  return;
493 
494  int curRow = m_cur_grid->GetGridCursorRow();
495  int curCol = m_cur_grid->GetGridCursorCol();
496 
497  // In a wxGrid, collect rows that have a selected cell, or are selected
498  // is not so easy: it depend on the way the selection was made.
499  // Here, we collect row selected by clicking on a row label, and
500  // row that contain a cell previously selected.
501  // If no candidate, just delete the row with the grid cursor.
502  wxArrayInt selectedRows = m_cur_grid->GetSelectedRows();
503  wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells();
504  wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft();
505  wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight();
506 
507  // Add all row having cell selected to list:
508  for( unsigned ii = 0; ii < cells.GetCount(); ii++ )
509  selectedRows.Add( cells[ii].GetRow() );
510 
511  // Handle block selection
512  if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
513  {
514  for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
515  selectedRows.Add( i );
516  }
517 
518  // Use the row having the grid cursor only if we have no candidate:
519  if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 )
520  selectedRows.Add( m_cur_grid->GetGridCursorRow() );
521 
522  if( selectedRows.size() == 0 )
523  {
524  wxBell();
525  return;
526  }
527 
528  std::sort( selectedRows.begin(), selectedRows.end() );
529 
530  // Remove selected rows (note: a row can be stored more than once in list)
531  int last_row = -1;
532  for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
533  {
534  int row = selectedRows[ii];
535 
536  if( row != last_row )
537  {
538  last_row = row;
539  m_cur_grid->DeleteRows( row, 1 );
540  }
541  }
542 
543  m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol );
544 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
size_t i
Definition: json11.cpp:597
#define min(a, b)
Definition: auxiliary.h:85

◆ global_model()

FP_LIB_TABLE_GRID* PANEL_FP_LIB_TABLE::global_model ( ) const
inlineprivate

Definition at line 73 of file panel_fp_lib_table.h.

References PANEL_FP_LIB_TABLE_BASE::m_global_grid.

Referenced by populateEnvironReadOnlyTable(), TransferDataFromWindow(), and verifyTables().

74  {
75  return (FP_LIB_TABLE_GRID*) m_global_grid->GetTable();
76  }
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.

◆ moveDownHandler()

void PANEL_FP_LIB_TABLE::moveDownHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 577 of file panel_fp_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), cur_model(), m_cur_grid, and LIB_TABLE::rows.

578 {
580  return;
581 
582  FP_LIB_TABLE_GRID* tbl = cur_model();
583  int curRow = m_cur_grid->GetGridCursorRow();
584 
585  // @todo: add multiple selection moves.
586  if( unsigned( curRow + 1 ) < tbl->rows.size() )
587  {
588  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
589  tbl->rows.release( tbl->rows.begin() + curRow );
590 
591  ++curRow;
592  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
593 
594  if( tbl->GetView() )
595  {
596  // Update the wxGrid
597  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
598  tbl->GetView()->ProcessTableMessage( msg );
599  }
600 
601  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
602  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
603  }
604 }
LIB_TABLE_ROWS rows
FP_LIB_TABLE_GRID * cur_model() const
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.

◆ moveUpHandler()

void PANEL_FP_LIB_TABLE::moveUpHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 547 of file panel_fp_lib_table.cpp.

References WX_GRID::CommitPendingChanges(), cur_model(), m_cur_grid, and LIB_TABLE::rows.

548 {
550  return;
551 
552  FP_LIB_TABLE_GRID* tbl = cur_model();
553  int curRow = m_cur_grid->GetGridCursorRow();
554 
555  // @todo: add multiple selection moves.
556  if( curRow >= 1 )
557  {
558  boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
559  tbl->rows.release( tbl->rows.begin() + curRow );
560 
561  --curRow;
562  tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() );
563 
564  if( tbl->GetView() )
565  {
566  // Update the wxGrid
567  wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
568  tbl->GetView()->ProcessTableMessage( msg );
569  }
570 
571  m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() );
572  m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() );
573  }
574 }
LIB_TABLE_ROWS rows
FP_LIB_TABLE_GRID * cur_model() const
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.

◆ onSizeGrid()

void PANEL_FP_LIB_TABLE::onSizeGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from PANEL_FP_LIB_TABLE_BASE.

Definition at line 692 of file panel_fp_lib_table.cpp.

References adjustPathSubsGridColumns().

693 {
694  adjustPathSubsGridColumns( event.GetSize().GetX() );
695 
696  event.Skip();
697 }
void adjustPathSubsGridColumns(int aWidth)

◆ pageChangedHandler()

void PANEL_FP_LIB_TABLE::pageChangedHandler ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

◆ populateEnvironReadOnlyTable()

void PANEL_FP_LIB_TABLE::populateEnvironReadOnlyTable ( )
private

Populate the readonly environment variable table with names and values by examining all the full_uri columns.

Definition at line 736 of file panel_fp_lib_table.cpp.

References adjustPathSubsGridColumns(), COL_URI, global_model(), FP_LIB_TABLE::GlobalPathEnvVariableName(), KISYS3DMOD, PANEL_FP_LIB_TABLE_BASE::m_path_subs_grid, project_model(), and PROJECT_VAR_NAME.

Referenced by PANEL_FP_LIB_TABLE().

737 {
738  wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
739  wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required.
740 
741  std::set< wxString > unique;
742 
743  // clear the table
744  m_path_subs_grid->DeleteRows( 0, m_path_subs_grid->GetNumberRows() );
745 
746  for( FP_LIB_TABLE_GRID* tbl : { global_model(), project_model() } )
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 );
773  unique.insert( FP_LIB_TABLE::GlobalPathEnvVariableName() );
774  // This special environment variable is used to locate 3d shapes
775  unique.insert( KISYS3DMOD );
776 
777  for( wxString evName : unique )
778  {
779  int row = m_path_subs_grid->GetNumberRows();
780  m_path_subs_grid->AppendRows( 1 );
781 
782  m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) );
783  m_path_subs_grid->SetCellEditor( row, 0, new GRID_CELL_READONLY_TEXT_EDITOR() );
784 
785  wxString evValue;
786  wxGetEnv( evName, &evValue );
787  m_path_subs_grid->SetCellValue( row, 1, evValue );
788  m_path_subs_grid->SetCellEditor( row, 1, new GRID_CELL_READONLY_TEXT_EDITOR() );
789  }
790 
791  // No combobox editors here, but it looks better if its consistent with the other
792  // grids in the dialog.
793  m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 2 );
794 
795  adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() );
796 }
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:37
void adjustPathSubsGridColumns(int aWidth)
static const wxString GlobalPathEnvVariableName()
Function GlobalPathEnvVarVariableName.
FP_LIB_TABLE_GRID * global_model() const
FP_LIB_TABLE_GRID * project_model() const
#define KISYS3DMOD
A variable name whose value holds the path of 3D shape files.
Definition: 3d_viewer.h:38
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.

◆ project_model()

FP_LIB_TABLE_GRID* PANEL_FP_LIB_TABLE::project_model ( ) const
inlineprivate

Definition at line 78 of file panel_fp_lib_table.h.

References PANEL_FP_LIB_TABLE_BASE::m_project_grid.

Referenced by populateEnvironReadOnlyTable(), TransferDataFromWindow(), and verifyTables().

79  {
80  return (FP_LIB_TABLE_GRID*) m_project_grid->GetTable();
81  }
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.

◆ TransferDataFromWindow()

bool PANEL_FP_LIB_TABLE::TransferDataFromWindow ( )
overrideprivate

Definition at line 700 of file panel_fp_lib_table.cpp.

References LIB_TABLE::Clear(), WX_GRID::CommitPendingChanges(), global_model(), m_cur_grid, m_global, DIALOG_EDIT_LIBRARY_TABLES::m_GlobalTableChanged, m_parent, m_project, DIALOG_EDIT_LIBRARY_TABLES::m_ProjectTableChanged, project_model(), LIB_TABLE::reindex(), LIB_TABLE::rows, and verifyTables().

701 {
703  return false;
704 
705  if( verifyTables() )
706  {
707  if( *global_model() != *m_global )
708  {
710 
711  m_global->Clear();
712  m_global->rows.transfer( m_global->rows.end(), global_model()->rows.begin(),
713  global_model()->rows.end(), global_model()->rows );
714  m_global->reindex();
715  }
716 
717  if( *project_model() != *m_project )
718  {
720 
721  m_project->Clear();
722  m_project->rows.transfer( m_project->rows.end(), project_model()->rows.begin(),
723  project_model()->rows.end(), project_model()->rows );
724  m_project->reindex();
725  }
726 
727  return true;
728  }
729 
730  return false;
731 }
void Clear()
Delete all rows.
void reindex()
FP_LIB_TABLE * m_project
LIB_TABLE_ROWS rows
FP_LIB_TABLE_GRID * global_model() const
FP_LIB_TABLE_GRID * project_model() const
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:156
bool verifyTables()
Trim important fields, removes blank row entries, and checks for duplicates.
DIALOG_EDIT_LIBRARY_TABLES * m_parent
FP_LIB_TABLE * m_global

◆ verifyTables()

bool PANEL_FP_LIB_TABLE::verifyTables ( )
private

Trim important fields, removes blank row entries, and checks for duplicates.

Returns
bool - true if tables are OK, else false.

Definition at line 382 of file panel_fp_lib_table.cpp.

References COL_NICKNAME, COL_URI, cur_model(), LIB_ID::FindIllegalLibNicknameChar(), Format(), global_model(), LIB_ID::ID_PCB, PANEL_FP_LIB_TABLE_BASE::m_auinotebook, m_cur_grid, and project_model().

Referenced by TransferDataFromWindow().

383 {
384  for( FP_LIB_TABLE_GRID* model : { global_model(), project_model() } )
385  {
386  for( int r = 0; r < model->GetNumberRows(); )
387  {
388  wxString nick = model->GetValue( r, COL_NICKNAME ).Trim( false ).Trim();
389  wxString uri = model->GetValue( r, COL_URI ).Trim( false ).Trim();
390  unsigned illegalCh = 0;
391 
392  if( !nick || !uri )
393  {
394  // Delete the "empty" row, where empty means missing nick or uri.
395  // This also updates the UI which could be slow, but there should only be a few
396  // rows to delete, unless the user fell asleep on the Add Row
397  // button.
398  model->DeleteRows( r, 1 );
399  }
400  else if( ( illegalCh = LIB_ID::FindIllegalLibNicknameChar( nick, LIB_ID::ID_PCB ) ) )
401  {
402  wxString msg = wxString::Format( _( "Illegal character '%c' in Nickname: \"%s\"" ),
403  illegalCh,
404  nick );
405 
406  // show the tabbed panel holding the grid we have flunked:
407  if( model != cur_model() )
408  m_auinotebook->SetSelection( model == global_model() ? 0 : 1 );
409 
410  m_cur_grid->MakeCellVisible( r, 0 );
411  m_cur_grid->SetGridCursor( r, 1 );
412 
413  wxMessageDialog errdlg( this, msg, _( "No Colon in Nicknames" ) );
414  errdlg.ShowModal();
415  return false;
416  }
417  else
418  {
419  // set the trimmed values back into the table so they get saved to disk.
420  model->SetValue( r, COL_NICKNAME, nick );
421  model->SetValue( r, COL_URI, uri );
422  ++r; // this row was OK.
423  }
424  }
425  }
426 
427  // check for duplicate nickNames, separately in each table.
428  for( FP_LIB_TABLE_GRID* model : { global_model(), project_model() } )
429  {
430  for( int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
431  {
432  wxString nick1 = model->GetValue( r1, COL_NICKNAME );
433 
434  for( int r2 = r1 + 1; r2 < model->GetNumberRows(); ++r2 )
435  {
436  wxString nick2 = model->GetValue( r2, COL_NICKNAME );
437 
438  if( nick1 == nick2 )
439  {
440  wxString msg = wxString::Format( _( "Duplicate Nicknames \"%s\"." ), nick1 );
441 
442  // show the tabbed panel holding the grid we have flunked:
443  if( model != cur_model() )
444  m_auinotebook->SetSelection( model == global_model() ? 0 : 1 );
445 
446  // go to the lower of the two rows, it is technically the duplicate:
447  m_cur_grid->MakeCellVisible( r2, 0 );
448  m_cur_grid->SetGridCursor( r2, 1 );
449 
450  wxMessageDialog errdlg( this, msg, _( "Please Delete or Modify One" ) );
451  errdlg.ShowModal();
452  return false;
453  }
454  }
455  }
456  }
457 
458  return true;
459 }
static unsigned FindIllegalLibNicknameChar(const UTF8 &aNickname, LIB_ID_TYPE aType)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:398
FP_LIB_TABLE_GRID * global_model() const
FP_LIB_TABLE_GRID * project_model() const
FP_LIB_TABLE_GRID * cur_model() const
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
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.

Member Data Documentation

◆ m_append_button

wxBitmapButton* PANEL_FP_LIB_TABLE_BASE::m_append_button
protectedinherited

◆ m_auinotebook

wxAuiNotebook* PANEL_FP_LIB_TABLE_BASE::m_auinotebook
protectedinherited

◆ m_browse_button

wxBitmapButton* PANEL_FP_LIB_TABLE_BASE::m_browse_button
protectedinherited

◆ m_cur_grid

◆ m_delete_button

wxBitmapButton* PANEL_FP_LIB_TABLE_BASE::m_delete_button
protectedinherited

◆ m_GblTableFilename

wxStaticText* PANEL_FP_LIB_TABLE_BASE::m_GblTableFilename
protectedinherited

◆ m_global

FP_LIB_TABLE* PANEL_FP_LIB_TABLE::m_global
private

Definition at line 69 of file panel_fp_lib_table.h.

Referenced by TransferDataFromWindow().

◆ m_global_grid

WX_GRID* PANEL_FP_LIB_TABLE_BASE::m_global_grid
protectedinherited

◆ m_global_panel

wxPanel* PANEL_FP_LIB_TABLE_BASE::m_global_panel
protectedinherited

◆ m_lastBrowseDir

wxString PANEL_FP_LIB_TABLE::m_lastBrowseDir
staticprivate

Definition at line 92 of file panel_fp_lib_table.h.

Referenced by browseLibrariesHandler(), and PANEL_FP_LIB_TABLE().

◆ m_move_down_button

wxBitmapButton* PANEL_FP_LIB_TABLE_BASE::m_move_down_button
protectedinherited

◆ m_move_up_button

wxBitmapButton* PANEL_FP_LIB_TABLE_BASE::m_move_up_button
protectedinherited

◆ m_pageNdx

size_t PANEL_FP_LIB_TABLE::m_pageNdx = 0
staticprivate

◆ m_parent

DIALOG_EDIT_LIBRARY_TABLES* PANEL_FP_LIB_TABLE::m_parent
private

Definition at line 88 of file panel_fp_lib_table.h.

Referenced by PANEL_FP_LIB_TABLE(), and TransferDataFromWindow().

◆ m_path_subs_grid

◆ m_PrjTableFilename

wxStaticText* PANEL_FP_LIB_TABLE_BASE::m_PrjTableFilename
protectedinherited

◆ m_project

FP_LIB_TABLE* PANEL_FP_LIB_TABLE::m_project
private

Definition at line 70 of file panel_fp_lib_table.h.

Referenced by TransferDataFromWindow().

◆ m_project_grid

WX_GRID* PANEL_FP_LIB_TABLE_BASE::m_project_grid
protectedinherited

◆ m_project_panel

wxPanel* PANEL_FP_LIB_TABLE_BASE::m_project_panel
protectedinherited

◆ m_projectBasePath

wxString PANEL_FP_LIB_TABLE::m_projectBasePath
private

Definition at line 71 of file panel_fp_lib_table.h.

Referenced by browseLibrariesHandler().

◆ m_staticText3

wxStaticText* PANEL_FP_LIB_TABLE_BASE::m_staticText3
protectedinherited

◆ m_staticText4

wxStaticText* PANEL_FP_LIB_TABLE_BASE::m_staticText4
protectedinherited

The documentation for this class was generated from the following files: