39#include <wx/filedlg.h>
46#include <lib_table_lexer.h>
99static const std::map<int, SUPPORTED_FILE_TYPE>&
fileTypes()
108 static const std::map<int, SUPPORTED_FILE_TYPE>
fileTypes =
112 wxT(
"KiCad (folder with .kicad_mod files)" ), wxT(
"" ),
135 wxT(
"Geda (folder with *.fp files)" ), wxT(
"" ),
159 virtual wxDirTraverseResult
OnFile(
const wxString& aFileName )
override
161 wxFileName file( aFileName );
166 return wxDIR_CONTINUE;
169 virtual wxDirTraverseResult
OnOpenError(
const wxString& aOpenErrorName )
override
180 virtual wxDirTraverseResult
OnDir(
const wxString& aDirName )
override
183 return wxDIR_CONTINUE;
188 for( std::pair<const wxString, int>& foundDirsPair :
m_foundDirs )
189 aPathArray.Add( foundDirsPair.first );
194 for( std::pair<const wxString, int>& failedDirsPair :
m_failedDirs )
195 aPathArray.Add( failedDirsPair.first );
228 return m_rows.insert( aIterator, aRow );
235 return m_rows.erase( aFirst, aLast );
247#define MYID_OPTIONS_EDITOR 15151
268 wxString result = options;
273 if( options != result )
297 menu.AppendSeparator();
316 size_t ndx = cb_text.find(
"(fp_lib_table" );
318 if( ndx != std::string::npos )
324 LIB_TABLE_LEXER lexer( &slr );
330 tmp_tbl.
Parse( &lexer );
344 for(
unsigned i = 0; i < tmp_tbl.
GetCount(); ++i )
348 m_grid->AutoSizeColumns(
false );
355 m_grid->AutoSizeColumns(
false );
363 FP_LIB_TABLE* aProject,
const wxString& aProjectTblPath,
364 const wxString& aProjectBasePath ) :
367 m_project( aProject ),
368 m_projectBasePath( aProjectBasePath ),
376 wxArrayString choices;
395 [&](
WX_GRID* aGrid,
int aCol )
397 int prevWidth = aGrid->GetColSize( aCol );
399 aGrid->AutoSizeColumn( aCol,
false );
400 aGrid->SetColSize( aCol, std::max( prevWidth, aGrid->GetColSize( aCol ) ) );
407 aGrid->SetDefaultRowSize( aGrid->GetDefaultRowSize() + 4 );
412 aGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
414 wxGridCellAttr* attr;
416 attr =
new wxGridCellAttr;
421 aGrid->SetColAttr(
COL_URI, attr );
423 attr =
new wxGridCellAttr;
424 attr->SetEditor(
new wxGridCellChoiceEditor( choices ) );
425 aGrid->SetColAttr(
COL_TYPE, attr );
427 attr =
new wxGridCellAttr;
428 attr->SetRenderer(
new wxGridCellBoolRenderer() );
445 if( aGrid->GetNumberRows() > 0 )
446 aGrid->SelectRow( 0 );
531 for(
int r = 0; r < model->GetNumberRows(); )
533 wxString nick = model->GetValue( r,
COL_NICKNAME ).Trim(
false ).Trim();
534 wxString uri = model->GetValue( r,
COL_URI ).Trim(
false ).Trim();
535 unsigned illegalCh = 0;
540 msg =
_(
"A library table row nickname and path cells are empty." );
542 msg =
_(
"A library table row nickname cell is empty." );
544 msg =
_(
"A library table row path cell is empty." );
546 wxMessageDialog badCellDlg(
this, msg,
_(
"Invalid Row Definition" ),
547 wxYES_NO | wxCENTER | wxICON_QUESTION | wxYES_DEFAULT );
548 badCellDlg.SetExtendedMessage(
_(
"Empty cells will result in all rows that are "
549 "invalid to be removed from the table." ) );
550 badCellDlg.SetYesNoLabels( wxMessageDialog::ButtonLabel(
_(
"Remove Invalid Cells" ) ),
551 wxMessageDialog::ButtonLabel(
_(
"Cancel Table Update" ) ) );
553 if( badCellDlg.ShowModal() == wxID_NO )
560 model->DeleteRows( r, 1 );
575 wxMessageDialog errdlg(
this, msg,
_(
"Library Nickname Error" ) );
583 model->SetValue( r,
COL_URI, uri );
599 for(
int r1 = 0; r1 < model->GetNumberRows() - 1; ++r1 )
603 for(
int r2 = r1 + 1; r2 < model->GetNumberRows(); ++r2 )
610 "nickname ('%s')." ),
621 wxMessageDialog errdlg(
this, msg,
_(
"Library Nickname Error" ) );
647 int last_row =
m_cur_grid->GetNumberRows() - 1;
671 wxArrayInt selectedRows =
m_cur_grid->GetSelectedRows();
672 wxGridCellCoordsArray cells =
m_cur_grid->GetSelectedCells();
673 wxGridCellCoordsArray blockTopLeft =
m_cur_grid->GetSelectionBlockTopLeft();
674 wxGridCellCoordsArray blockBotRight =
m_cur_grid->GetSelectionBlockBottomRight();
677 for(
unsigned ii = 0; ii < cells.GetCount(); ii++ )
678 selectedRows.Add( cells[ii].GetRow() );
681 if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() )
683 for(
int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i )
684 selectedRows.Add( i );
688 if( selectedRows.size() == 0 &&
m_cur_grid->GetGridCursorRow() >= 0 )
689 selectedRows.Add(
m_cur_grid->GetGridCursorRow() );
691 if( selectedRows.size() == 0 )
697 std::sort( selectedRows.begin(), selectedRows.end() );
702 for(
int ii = selectedRows.GetCount()-1; ii >= 0; ii-- )
704 int row = selectedRows[ii];
706 if( row != last_row )
713 if(
m_cur_grid->GetNumberRows() > 0 && curRow >= 0 )
729 boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
733 tbl->
m_rows.insert( tbl->
m_rows.begin() + curRow, move_me.release() );
738 wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 );
739 tbl->GetView()->ProcessTableMessage( msg );
757 if(
unsigned( curRow + 1 ) < tbl->
m_rows.size() )
759 boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me =
763 tbl->
m_rows.insert( tbl->
m_rows.begin() + curRow, move_me.release() );
768 wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 );
769 tbl->GetView()->ProcessTableMessage( msg );
783 std::map<int, SUPPORTED_FILE_TYPE>::const_iterator fileTypeIt;
787 if( event.GetEventType() == wxEVT_BUTTON )
794 fileTypeIt =
fileTypes().find( event.GetId() );
799 wxLogWarning( wxT(
"File type selection event received but could not find the file type "
812 title.Printf(
_(
"Select %s Library" ),
fileType.m_Description );
821 wxFileDialog dlg(
this, title, openDir, wxEmptyString,
fileType.m_FileFilter,
822 wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
824 int result = dlg.ShowModal();
826 if( result == wxID_CANCEL )
829 dlg.GetPaths( files );
838#if wxCHECK_VERSION( 3, 1, 4 )
839 wxDirDialog dlg(
nullptr, title, openDir,
840 wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST | wxDD_MULTIPLE );
842 int result = dlg.ShowModal();
844 if( result == wxID_CANCEL )
847 dlg.GetPaths( files );
849 wxDirDialog dlg(
nullptr, title, openDir, wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
851 int result = dlg.ShowModal();
853 if( result == wxID_CANCEL )
857 if(
fileType.m_FolderSearchExtension !=
"" )
859 wxDir rootDir( dlg.GetPath() );
862 rootDir.Traverse( traverser );
868 wxArrayString failedDirs;
870 wxString detailedMsg =
_(
"The following directories could not be opened: \n" );
872 for(
const wxString&
path : failedDirs )
873 detailedMsg <<
path << wxT(
"\n" );
881 files.Add( dlg.GetPath() );
885 if( !files.IsEmpty() )
887 wxFileName first( files.front() );
901 bool addDuplicates =
false;
902 bool applyToAll =
false;
903 wxString warning =
_(
"Warning: Duplicate Nicknames" );
904 wxString msg =
_(
"A library nicknamed '%s' already exists." );
905 wxString detailedMsg =
_(
"One of the nicknames will need to be changed after "
906 "adding this library." );
908 for(
const wxString& filePath : files )
910 wxFileName fn( filePath );
917 if(
cur_model()->ContainsNickname( nickname ) )
923 detailedMsg,
_(
"Skip" ),
_(
"Add Anyway" ),
924 &applyToAll ) == wxID_CANCEL;
927 doAdd = addDuplicates;
932 int last_row =
m_cur_grid->GetNumberRows() - 1;
943 if(
m_pageNdx == 0 &&
path.Contains( wxT(
"${KIPRJMOD}" ) ) )
944 path = fn.GetFullPath();
950 if( !files.IsEmpty() )
952 int new_row =
m_cur_grid->GetNumberRows() - 1;
1016 wxRegEx re(
".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED );
1017 wxASSERT( re.IsValid() );
1019 std::set< wxString > unique;
1029 for(
int row = 0; row < tbl->GetNumberRows(); ++row )
1031 wxString uri = tbl->GetValue( row,
COL_URI );
1033 while( re.Matches( uri ) )
1035 wxString envvar = re.GetMatch( uri, 2 );
1038 if( envvar.IsEmpty() )
1039 envvar = re.GetMatch( uri, 4 );
1042 unique.insert( envvar );
1045 uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString );
1058 for(
const wxString& evName : unique )
1063 m_path_subs_grid->SetCellValue( row, 0, wxT(
"${" ) + evName + wxT(
"}" ) );
1067 wxGetEnv( evName, &evValue );
1098 projectTable =
nullptr;
1101 projectTable, projectTablePath,
1104 if( dlg.ShowModal() == wxID_CANCEL )
1111 globalTable->
Save( globalTablePath );
1115 msg.Printf(
_(
"Error saving global library table:\n\n%s" ), ioe.
What() );
1116 wxMessageBox( msg,
_(
"File Save Error" ), wxOK | wxICON_ERROR );
1124 projectTable->
Save( projectTablePath );
1128 msg.Printf(
_(
"Error saving project-specific library table:\n\n%s" ), ioe.
What() );
1129 wxMessageBox( msg,
_(
"File Save Error" ), wxOK | wxICON_ERROR );
1137 editor->SyncLibraryTree(
true );
1138 editor->RefreshLibraryTree();
1144 viewer->ReCreateLibraryList();
1146 std::string payload =
"";
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
bool m_ProjectTableChanged
void InstallPanel(wxPanel *aPanel)
bool m_GlobalTableChanged
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
bool handleDoubleClick(wxGridEvent &aEvent) override
void doPopupSelection(wxCommandEvent &event) override
void paste_text(const wxString &cb_text) override
handle specialized clipboard text, with leading "(fp_lib_table", OR spreadsheet formatted text.
DIALOG_EDIT_LIBRARY_TABLES * m_dialog
FP_GRID_TRICKS(DIALOG_EDIT_LIBRARY_TABLES *aParent, WX_GRID *aGrid)
void showPopupMenu(wxMenu &menu) override
void optionsEditor(int aRow)
This class builds a wxGridTableBase by wrapping an FP_LIB_TABLE object.
size_t size() const override
FP_LIB_TABLE_GRID(const FP_LIB_TABLE &aTableToEdit)
LIB_TABLE_ROWS_ITER begin() override
LIB_TABLE_ROWS_ITER erase(LIB_TABLE_ROWS_ITER aFirst, LIB_TABLE_ROWS_ITER aLast) override
LIB_TABLE_ROW * makeNewRow() override
LIB_TABLE_ROW * at(size_t aIndex) override
void push_back(LIB_TABLE_ROW *aRow) override
LIB_TABLE_ROWS_ITER insert(LIB_TABLE_ROWS_ITER aIterator, LIB_TABLE_ROW *aRow) override
Hold a record identifying a library accessed by the appropriate footprint library PLUGIN object in th...
static const wxString GlobalPathEnvVariableName()
Return the name of the environment variable used to hold the directory of locally installed "KiCad sp...
virtual void Parse(LIB_TABLE_LEXER *aLexer) override
Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objec...
static wxString GetGlobalTableFileName()
Editor for wxGrid cells that adds a file/folder browser to the grid input field.
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
virtual void paste_text(const wxString &cb_text)
WX_GRID * m_grid
I don't own the grid, but he owns me.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
static const wxString ShowType(PCB_FILE_T aFileType)
Return a brief name for a plugin given aFileType enum.
PCB_FILE_T
The set of file types that the IO_MGR knows about, and for which there has been a plugin written.
@ LEGACY
Legacy Pcbnew file formats prior to s-expression.
@ KICAD_SEXP
S-expression Pcbnew file format.
@ GEDA_PCB
Geda PCB file formats.
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
It is only used for debugging, since "this" is not a wxWindow*.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Traverser implementation that looks to find any and all "folder" libraries by looking for files with ...
void GetPaths(wxArrayString &aPathArray)
wxString m_searchExtension
virtual wxDirTraverseResult OnOpenError(const wxString &aOpenErrorName) override
std::unordered_map< wxString, int > m_failedDirs
void GetFailedPaths(wxArrayString &aPathArray)
bool HasDirectoryOpenFailures()
LIBRARY_TRAVERSER(wxString aSearchExtension, wxString aInitialDir)
std::unordered_map< wxString, int > m_foundDirs
virtual wxDirTraverseResult OnDir(const wxString &aDirName) override
virtual wxDirTraverseResult OnFile(const wxString &aFileName) override
static unsigned FindIllegalLibraryNameChar(const UTF8 &aLibraryName)
Looks for characters that are illegal in library nicknames.
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, bool aLib)
Replace illegal LIB_ID item name characters with underscores '_'.
void showPopupMenu(wxMenu &menu) override
void doPopupSelection(wxCommandEvent &event) override
This abstract base class mixes any object derived from LIB_TABLE into wxGridTableBase so the result c...
bool AppendRows(size_t aNumRows=1) override
int GetNumberRows() override
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
virtual const wxString GetType() const =0
Return the type of library represented by this row.
const wxString & GetNickName() const
LIB_TABLE_ROW * clone() const
void SetOptions(const wxString &aOptions)
Change the library options strings.
LIB_TABLE_ROW & At(unsigned aIndex)
Get the 'n'th LIB_TABLE_ROW object.
void Clear()
Delete all rows.
unsigned GetCount() const
Get the number of rows contained in the table.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
Class PANEL_FP_LIB_TABLE_BASE.
STD_BITMAP_BUTTON * m_move_up_button
WX_GRID * m_path_subs_grid
STD_BITMAP_BUTTON * m_append_button
STD_BITMAP_BUTTON * m_move_down_button
STD_BITMAP_BUTTON * m_delete_button
SPLIT_BUTTON * m_browseButton
Dialog to show and edit symbol library tables.
bool verifyTables()
Trim important fields, removes blank row entries, and checks for duplicates.
void onSizeGrid(wxSizeEvent &event) override
void moveUpHandler(wxCommandEvent &event) override
void adjustPathSubsGridColumns(int aWidth)
FP_LIB_TABLE_GRID * cur_model() const
FP_LIB_TABLE_GRID * project_model() const
void moveDownHandler(wxCommandEvent &event) override
FP_LIB_TABLE_GRID * global_model() const
wxString m_lastProjectLibDir
void populateEnvironReadOnlyTable()
Populate the readonly environment variable table with names and values by examining all the full_uri ...
~PANEL_FP_LIB_TABLE() override
void deleteRowHandler(wxCommandEvent &event) override
void browseLibrariesHandler(wxCommandEvent &event)
bool TransferDataFromWindow() override
wxString m_projectBasePath
DIALOG_EDIT_LIBRARY_TABLES * m_parent
void OnUpdateUI(wxUpdateUIEvent &event) override
void appendRowHandler(wxCommandEvent &event) override
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)
static wxString GetDefaultUserFootprintsPath()
Gets the default path we point users to create projects.
wxString m_lastFootprintLibDir
virtual const wxString GetProjectPath() const
Return the full path of the project.
virtual FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
virtual const wxString FootprintLibTblName() const
Returns the path and filename of this project's footprint library table.
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
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...
void ClearRows()
wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number...
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
int OKOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Display a warning dialog with aMessage and returns the user response.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
FP_LIB_TABLE GFootprintTable
The global footprint library table.
void InvokePluginOptionsEditor(wxWindow *aCaller, const wxString &aNickname, const wxString &aPluginType, const wxString &aOptions, wxString *aResult)
Function InvokePluginOptionsEditor calls DIALOG_FP_PLUGIN_OPTIONS dialog so that plugin options set c...
#define KICAD7_3DMODEL_DIR
A variable name whose value holds the path of 3D shape files.
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
const std::string KiCadFootprintLibPathExtension
const std::string KiCadFootprintFileExtension
const std::string GedaPcbFootprintLibFileExtension
wxString EagleFootprintLibPathWildcard()
wxString AltiumFootprintLibPathWildcard()
wxString LegacyFootprintLibPathWildcard()
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
This file contains miscellaneous commonly used macros and functions.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
static const std::map< int, SUPPORTED_FILE_TYPE > & fileTypes()
Map with event id as the key to supported file types that will be listed for the add a library option...
void InvokePcbLibTableEditor(KIWAY *aKiway, wxWindow *aCaller)
Function InvokePcbLibTableEditor shows the modal DIALOG_FP_LIB_TABLE for purposes of editing the glob...
#define MYID_OPTIONS_EDITOR
@ ID_PANEL_FPLIB_ADD_EAGLE6
@ ID_PANEL_FPLIB_ADD_KICADMOD
@ ID_PANEL_FPLIB_ADD_GEDA
@ ID_PANEL_FPLIB_ADD_ALTIUM
@ ID_PANEL_FPLIB_ADD_KICADLEGACY
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
FormatType fileType(const char *aFileName)
A filename or source description, a problem input line, a line number, a byte offset,...
Container that describes file type info for the add a library options.
bool m_IsFile
Whether the library is a folder or a file.
wxString m_Description
Description shown in the file picker dialog.
wxString m_FileFilter
Filter used for file pickers if m_IsFile is true.
IO_MGR::PCB_FILE_T m_Plugin
wxString m_FolderSearchExtension
In case of folders it stands for extensions of files stored inside.
Definition of file extensions used in Kicad.