/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2017 Wayne Stambaugh * Copyright (C) 2017-2018 KiCad Developers, see AUTHORS.txt for contributors. * * This program is free software: you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the * Free Software Foundation, either version 3 of the License, or (at your * option) any later version. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program. If not, see . */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /** * Build a wxGridTableBase by wrapping an #SYMBOL_LIB_TABLE object. */ class SYMBOL_LIB_TABLE_GRID : public LIB_TABLE_GRID, public SYMBOL_LIB_TABLE { friend class SYMBOL_GRID_TRICKS; protected: LIB_TABLE_ROW* at( size_t aIndex ) override { return &rows.at( aIndex ); } size_t size() const override { return rows.size(); } LIB_TABLE_ROW* makeNewRow() override { return dynamic_cast< LIB_TABLE_ROW* >( new SYMBOL_LIB_TABLE_ROW ); } LIB_TABLE_ROWS_ITER begin() override { return rows.begin(); } LIB_TABLE_ROWS_ITER insert( LIB_TABLE_ROWS_ITER aIterator, LIB_TABLE_ROW* aRow ) override { return rows.insert( aIterator, aRow ); } void push_back( LIB_TABLE_ROW* aRow ) override { rows.push_back( aRow ); } LIB_TABLE_ROWS_ITER erase( LIB_TABLE_ROWS_ITER aFirst, LIB_TABLE_ROWS_ITER aLast ) override { return rows.erase( aFirst, aLast ); } public: SYMBOL_LIB_TABLE_GRID( const SYMBOL_LIB_TABLE& aTableToEdit ) { rows = aTableToEdit.rows; } }; class SYMBOL_GRID_TRICKS : public GRID_TRICKS { public: SYMBOL_GRID_TRICKS( DIALOG_EDIT_LIBRARY_TABLES* aParent, wxGrid* aGrid ) : GRID_TRICKS( aGrid ), m_dialog( aParent ) { } protected: DIALOG_EDIT_LIBRARY_TABLES* m_dialog; /// handle specialized clipboard text, with leading "(sym_lib_table" or /// spreadsheet formatted text. virtual void paste_text( const wxString& cb_text ) override { SYMBOL_LIB_TABLE_GRID* tbl = (SYMBOL_LIB_TABLE_GRID*) m_grid->GetTable(); size_t ndx = cb_text.find( "(sym_lib_table" ); if( ndx != std::string::npos ) { // paste the SYMBOL_LIB_TABLE_ROWs of s-expression (sym_lib_table), starting // at column 0 regardless of current cursor column. STRING_LINE_READER slr( TO_UTF8( cb_text ), "Clipboard" ); LIB_TABLE_LEXER lexer( &slr ); SYMBOL_LIB_TABLE tmp_tbl; bool parsed = true; try { tmp_tbl.Parse( &lexer ); } catch( PARSE_ERROR& pe ) { DisplayError( m_dialog, pe.What() ); parsed = false; } if( parsed ) { // make sure the table is big enough... if( tmp_tbl.GetCount() > tbl->GetNumberRows() ) tbl->AppendRows( tmp_tbl.GetCount() - tbl->GetNumberRows() ); for( int i = 0; i < tmp_tbl.GetCount(); ++i ) tbl->rows.replace( i, tmp_tbl.At( i ) ); } m_grid->AutoSizeColumns( false ); } else { // paste spreadsheet formatted text. GRID_TRICKS::paste_text( cb_text ); m_grid->AutoSizeColumns( false ); } } }; PANEL_SYM_LIB_TABLE::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& aProjectBasePath ) : PANEL_SYM_LIB_TABLE_BASE( aParent ), m_globalTable( aGlobal ), m_projectTable( aProject ), m_projectBasePath( aProjectBasePath ), m_parent( aParent ) { // For user info, shows the table filenames: m_GblTableFilename->SetLabel( aGlobalTablePath ); m_PrjTableFilename->SetLabel( aProjectTablePath ); // wxGrid only supports user owned tables if they exist past end of ~wxGrid(), // so make it a grid owned table. m_global_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aGlobal ), true ); m_project_grid->SetTable( new SYMBOL_LIB_TABLE_GRID( *aProject ), true ); // Give a bit more room for combobox editors m_global_grid->SetDefaultRowSize( m_global_grid->GetDefaultRowSize() + 4 ); m_project_grid->SetDefaultRowSize( m_project_grid->GetDefaultRowSize() + 4 ); // add Cut, Copy, and Paste to wxGrids m_global_grid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, m_global_grid ) ); m_project_grid->PushEventHandler( new SYMBOL_GRID_TRICKS( m_parent, m_project_grid ) ); m_global_grid->AutoSizeColumns( false ); m_project_grid->AutoSizeColumns( false ); wxArrayString pluginChoices; // pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_KICAD ) ); pluginChoices.Add( SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) ); populateEnvironReadOnlyTable(); for( int i=0; i<2; ++i ) { wxGrid* g = i==0 ? m_global_grid : m_project_grid; // Set special attributes wxGridCellAttr* attr; attr = new wxGridCellAttr; attr->SetEditor( new wxGridCellChoiceEditor( pluginChoices ) ); g->SetColAttr( COL_TYPE, attr ); attr = new wxGridCellAttr; attr->SetRenderer( new wxGridCellBoolRenderer() ); attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS g->SetColAttr( COL_ENABLED, attr ); // all but COL_OPTIONS, which is edited with Option Editor anyways. g->AutoSizeColumn( COL_NICKNAME, false ); g->AutoSizeColumn( COL_TYPE, false ); g->AutoSizeColumn( COL_URI, false ); g->AutoSizeColumn( COL_DESCR, false ); g->AutoSizeColumn( COL_ENABLED, false ); // would set this to width of title, if it was easily known. g->SetColSize( COL_OPTIONS, 80 ); } // select the last selected page m_auinotebook->SetSelection( m_pageNdx ); m_cur_grid = ( m_pageNdx == 0 ) ? m_global_grid : m_project_grid; // for ALT+A handling, we want the initial focus to be on the first selected grid. m_parent->SetInitialFocus( m_cur_grid ); // Gives a selection for each grid, mainly for delete lib button. // Without that, we do not see what lib will be deleted m_global_grid->SelectRow( 0 ); m_project_grid->SelectRow( 0 ); // Configure button logos m_append_button->SetBitmap( KiBitmap( small_plus_xpm ) ); m_delete_button->SetBitmap( KiBitmap( trash_xpm ) ); m_move_up_button->SetBitmap( KiBitmap( small_up_xpm ) ); m_move_down_button->SetBitmap( KiBitmap( small_down_xpm ) ); m_browse_button->SetBitmap( KiBitmap( folder_xpm ) ); } PANEL_SYM_LIB_TABLE::~PANEL_SYM_LIB_TABLE() { // When the dialog is closed it will hide the current notebook page first, which will // in turn select the other one. We then end up saving its index as the "current page". // So flip them back again: m_pageNdx = m_pageNdx == 1 ? 0 : 1; // Delete the GRID_TRICKS. // Any additional event handlers should be popped before the window is deleted. m_global_grid->PopEventHandler( true ); m_project_grid->PopEventHandler( true ); } bool PANEL_SYM_LIB_TABLE::verifyTables() { for( int t=0; t<2; ++t ) { SYMBOL_LIB_TABLE_GRID& model = t==0 ? *global_model() : *project_model(); for( int r = 0; r < model.GetNumberRows(); ) { wxString nick = model.GetValue( r, COL_NICKNAME ).Trim( false ).Trim(); wxString uri = model.GetValue( r, COL_URI ).Trim( false ).Trim(); unsigned illegalCh = 0; if( !nick || !uri ) { // Delete the "empty" row, where empty means missing nick or uri. // This also updates the UI which could be slow, but there should only be a few // rows to delete, unless the user fell asleep on the Add Row // button. model.DeleteRows( r, 1 ); } else if( ( illegalCh = LIB_ID::FindIllegalLibNicknameChar( nick, LIB_ID::ID_SCH ) ) ) { wxString msg = wxString::Format( _( "Illegal character '%c' in Nickname: \"%s\"" ), illegalCh, nick ); // show the tabbed panel holding the grid we have flunked: if( &model != cur_model() ) m_auinotebook->SetSelection( &model == global_model() ? 0 : 1 ); m_cur_grid->MakeCellVisible( r, 0 ); m_cur_grid->SetGridCursor( r, 1 ); wxMessageDialog errdlg( this, msg, _( "No Colon in Nicknames" ) ); errdlg.ShowModal(); return false; } else { // set the trimmed values back into the table so they get saved to disk. model.SetValue( r, COL_NICKNAME, nick ); model.SetValue( r, COL_URI, uri ); ++r; // this row was OK. } } } // check for duplicate nickNames, separately in each table. for( int t=0; t<2; ++t ) { SYMBOL_LIB_TABLE_GRID& model = t==0 ? *global_model() : *project_model(); for( int r1 = 0; r1 < model.GetNumberRows() - 1; ++r1 ) { wxString nick1 = model.GetValue( r1, COL_NICKNAME ); for( int r2=r1+1; r2 < model.GetNumberRows(); ++r2 ) { wxString nick2 = model.GetValue( r2, COL_NICKNAME ); if( nick1 == nick2 ) { wxString msg = wxString::Format( _( "Duplicate Nickname: \"%s\"." ), nick1 ); // show the tabbed panel holding the grid we have flunked: if( &model != cur_model() ) m_auinotebook->SetSelection( &model == global_model() ? 0 : 1 ); // go to the lower of the two rows, it is technically the duplicate: m_cur_grid->MakeCellVisible( r2, 0 ); m_cur_grid->SetGridCursor( r2, 1 ); wxMessageDialog errdlg( this, msg, _( "Please Delete or Modify One" ) ); errdlg.ShowModal(); return false; } } } } return true; } void PANEL_SYM_LIB_TABLE::pageChangedHandler( wxAuiNotebookEvent& event ) { m_pageNdx = (unsigned) std::max( 0, m_auinotebook->GetSelection() ); m_cur_grid = m_pageNdx == 0 ? m_global_grid : m_project_grid; } void PANEL_SYM_LIB_TABLE::browseLibrariesHandler( wxCommandEvent& event ) { if( m_lastBrowseDir.IsEmpty() ) m_lastBrowseDir = m_projectBasePath; wxFileDialog dlg( this, _( "Select Library" ), m_lastBrowseDir, wxEmptyString, SchematicLibraryFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE ); auto result = dlg.ShowModal(); if( result == wxID_CANCEL ) return; m_lastBrowseDir = dlg.GetDirectory(); const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables(); bool addDuplicates = false; bool applyToAll = false; wxString warning = _( "Warning: Duplicate Nickname" ); wxString msg = _( "A library nicknamed \"%s\" already exists." ); wxArrayString files; dlg.GetFilenames( files ); for( const auto& file : files ) { wxString filePath = dlg.GetDirectory() + wxFileName::GetPathSeparator() + file; wxFileName fn( filePath ); wxString nickname = LIB_ID::FixIllegalChars( fn.GetName(), LIB_ID::ID_SCH ); bool doAdd = true; if( cur_model()->ContainsNickname( nickname ) ) { if( !applyToAll ) { int ret = YesOrCancelDialog( this, warning, wxString::Format( msg, nickname ), _( "Skip" ), _( "Add Anyway" ), &applyToAll ); addDuplicates = (ret == wxID_CANCEL ); } doAdd = addDuplicates; } if( doAdd && m_cur_grid->AppendRows( 1 ) ) { int last_row = m_cur_grid->GetNumberRows() - 1; m_cur_grid->SetCellValue( last_row, COL_NICKNAME, nickname ); // TODO the following code can detect only schematic types, not libs // SCH_IO_MGR needs to provide file extension information for libraries too // auto detect the plugin type /*for( auto pluginType : SCH_IO_MGR::SCH_FILE_T_vector ) { if( SCH_IO_MGR::GetFileExtension( pluginType ).Lower() == fn.GetExt().Lower() ) { m_cur_grid->SetCellValue( last_row, COL_TYPE, SCH_IO_MGR::ShowType( pluginType ) ); break; } }*/ m_cur_grid->SetCellValue( last_row, COL_TYPE, SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) ); // try to use path normalized to an environmental variable or project path wxString path = NormalizePath( filePath, &envVars, m_projectBasePath ); if( path.IsEmpty() ) path = fn.GetFullPath(); m_cur_grid->SetCellValue( last_row, COL_URI, path ); } } if( !files.IsEmpty() ) { m_cur_grid->MakeCellVisible( m_cur_grid->GetNumberRows() - 1, 0 ); m_cur_grid->SetGridCursor( m_cur_grid->GetNumberRows() - 1, 1 ); } } void PANEL_SYM_LIB_TABLE::appendRowHandler( wxCommandEvent& event ) { if( m_cur_grid->AppendRows( 1 ) ) { int row = m_cur_grid->GetNumberRows() - 1; // Gives a default type (currently, only one type exists): m_cur_grid->SetCellValue( row, COL_TYPE, SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY ) ); // wx documentation is wrong, SetGridCursor does not make visible. m_cur_grid->MakeCellVisible( row, 0 ); m_cur_grid->SetGridCursor( row, 1 ); m_cur_grid->EnableCellEditControl( true ); m_cur_grid->ShowCellEditControl(); } } void PANEL_SYM_LIB_TABLE::deleteRowHandler( wxCommandEvent& event ) { int curRow = m_cur_grid->GetGridCursorRow(); int curCol = m_cur_grid->GetGridCursorCol(); // In a wxGrid, collect rows that have a selected cell, or are selected // is not so easy: it depend on the way the selection was made. // Here, we collect row selected by clicking on a row label, and // row that contain a cell previously selected. // If no candidate, just delete the row with the grid cursor. wxArrayInt selectedRows = m_cur_grid->GetSelectedRows(); wxGridCellCoordsArray cells = m_cur_grid->GetSelectedCells(); wxGridCellCoordsArray blockTopLeft = m_cur_grid->GetSelectionBlockTopLeft(); wxGridCellCoordsArray blockBotRight = m_cur_grid->GetSelectionBlockBottomRight(); // Add all row having cell selected to list: for( unsigned ii = 0; ii < cells.GetCount(); ii++ ) selectedRows.Add( cells[ii].GetRow() ); // Handle block selection if( !blockTopLeft.IsEmpty() && !blockBotRight.IsEmpty() ) { for( int i = blockTopLeft[0].GetRow(); i <= blockBotRight[0].GetRow(); ++i ) selectedRows.Add( i ); } // Use the row having the grid cursor only if we have no candidate: if( selectedRows.size() == 0 && m_cur_grid->GetGridCursorRow() >= 0 ) selectedRows.Add( m_cur_grid->GetGridCursorRow() ); std::sort( selectedRows.begin(), selectedRows.end() ); // Remove selected rows (note: a row can be stored more than once in list) int last_row = -1; for( int ii = selectedRows.GetCount()-1; ii >= 0; ii-- ) { int row = selectedRows[ii]; if( row != last_row ) { last_row = row; m_cur_grid->DeleteRows( row, 1 ); } } m_cur_grid->SetGridCursor( std::min( curRow, m_cur_grid->GetNumberRows() - 1 ), curCol ); } void PANEL_SYM_LIB_TABLE::moveUpHandler( wxCommandEvent& event ) { SYMBOL_LIB_TABLE_GRID* tbl = cur_model(); int curRow = m_cur_grid->GetGridCursorRow(); // @todo: add multiple selection moves. if( curRow >= 1 ) { boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me = tbl->rows.release( tbl->rows.begin() + curRow ); --curRow; tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() ); if( tbl->GetView() ) { // Update the wxGrid wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow, 0 ); tbl->GetView()->ProcessTableMessage( msg ); } m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() ); m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() ); } } void PANEL_SYM_LIB_TABLE::moveDownHandler( wxCommandEvent& event ) { SYMBOL_LIB_TABLE_GRID* tbl = cur_model(); int curRow = m_cur_grid->GetGridCursorRow(); // @todo: add multiple selection moves. if( unsigned( curRow + 1 ) < tbl->rows.size() ) { boost::ptr_vector< LIB_TABLE_ROW >::auto_type move_me = tbl->rows.release( tbl->rows.begin() + curRow ); ++curRow; tbl->rows.insert( tbl->rows.begin() + curRow, move_me.release() ); if( tbl->GetView() ) { // Update the wxGrid wxGridTableMessage msg( tbl, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, curRow - 1, 0 ); tbl->GetView()->ProcessTableMessage( msg ); } m_cur_grid->MakeCellVisible( curRow, m_cur_grid->GetGridCursorCol() ); m_cur_grid->SetGridCursor( curRow, m_cur_grid->GetGridCursorCol() ); } } bool PANEL_SYM_LIB_TABLE::TransferDataFromWindow() { // Commit any pending in-place edits and close the editor m_cur_grid->DisableCellEditControl(); if( !verifyTables() ) return false; if( *global_model() != *m_globalTable ) { m_parent->m_GlobalTableChanged = true; m_globalTable->Clear(); m_globalTable->rows.transfer( m_globalTable->rows.end(), global_model()->rows.begin(), global_model()->rows.end(), global_model()->rows ); m_globalTable->reindex(); } if( *project_model() != *m_projectTable ) { m_parent->m_ProjectTableChanged = true; m_projectTable->Clear(); m_projectTable->rows.transfer( m_projectTable->rows.end(), project_model()->rows.begin(), project_model()->rows.end(), project_model()->rows ); m_projectTable->reindex(); } return true; } void PANEL_SYM_LIB_TABLE::populateEnvironReadOnlyTable() { wxRegEx re( ".*?(\\$\\{(.+?)\\})|(\\$\\((.+?)\\)).*?", wxRE_ADVANCED ); wxASSERT( re.IsValid() ); // wxRE_ADVANCED is required. std::set< wxString > unique; // clear the table m_path_subs_grid->DeleteRows( 0, m_path_subs_grid->GetNumberRows() ); for( int i = 0; i < 2; ++i ) { SYMBOL_LIB_TABLE_GRID* tbl = i == 0 ? global_model() : project_model(); for( int row = 0; row < tbl->GetNumberRows(); ++row ) { wxString uri = tbl->GetValue( row, COL_URI ); while( re.Matches( uri ) ) { wxString envvar = re.GetMatch( uri, 2 ); // if not ${...} form then must be $(...) if( envvar.IsEmpty() ) envvar = re.GetMatch( uri, 4 ); // ignore duplicates unique.insert( envvar ); // delete the last match and search again uri.Replace( re.GetMatch( uri, 0 ), wxEmptyString ); } } } // Make sure this special environment variable shows up even if it was // not used yet. It is automatically set by KiCad to the directory holding // the current project. unique.insert( PROJECT_VAR_NAME ); unique.insert( SYMBOL_LIB_TABLE::GlobalPathEnvVariableName() ); for( wxString evName : unique ) { int row = m_path_subs_grid->GetNumberRows(); m_path_subs_grid->AppendRows( 1 ); m_path_subs_grid->SetCellValue( row, 0, wxT( "${" ) + evName + wxT( "}" ) ); wxString evValue; wxGetEnv( evName, &evValue ); m_path_subs_grid->SetCellValue( row, 1, evValue ); } // No combobox editors here, but it looks better if its consistent with the other // grids in the dialog. m_path_subs_grid->SetDefaultRowSize( m_path_subs_grid->GetDefaultRowSize() + 4 ); adjustPathSubsGridColumns( m_path_subs_grid->GetRect().GetWidth() ); } void PANEL_SYM_LIB_TABLE::adjustPathSubsGridColumns( int aWidth ) { // Account for scroll bars aWidth -= ( m_path_subs_grid->GetSize().x - m_path_subs_grid->GetClientSize().x ); m_path_subs_grid->AutoSizeColumn( 0 ); m_path_subs_grid->SetColSize( 1, aWidth - m_path_subs_grid->GetColSize( 0 ) ); } void PANEL_SYM_LIB_TABLE::onSizeGrid( wxSizeEvent& event ) { adjustPathSubsGridColumns( event.GetSize().GetX() ); event.Skip(); } SYMBOL_LIB_TABLE_GRID* PANEL_SYM_LIB_TABLE::global_model() const { return (SYMBOL_LIB_TABLE_GRID*) m_global_grid->GetTable(); } SYMBOL_LIB_TABLE_GRID* PANEL_SYM_LIB_TABLE::project_model() const { return (SYMBOL_LIB_TABLE_GRID*) m_project_grid->GetTable(); } SYMBOL_LIB_TABLE_GRID* PANEL_SYM_LIB_TABLE::cur_model() const { return (SYMBOL_LIB_TABLE_GRID*) m_cur_grid->GetTable(); } size_t PANEL_SYM_LIB_TABLE::m_pageNdx = 0; void InvokeSchEditSymbolLibTable( KIWAY* aKiway, wxWindow *aParent ) { SYMBOL_LIB_TABLE* globalTable = &SYMBOL_LIB_TABLE::GetGlobalLibTable(); wxString globalTablePath = SYMBOL_LIB_TABLE::GetGlobalTableFileName(); SYMBOL_LIB_TABLE* projectTable = aKiway->Prj().SchSymbolLibTable(); wxString projectPath = aKiway->Prj().GetProjectPath(); wxFileName projectTableFn( projectPath, SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() ); wxString msg; DIALOG_EDIT_LIBRARY_TABLES dlg( aParent, _( "Symbol Libraries" ) ); dlg.InstallPanel( new PANEL_SYM_LIB_TABLE( &dlg, globalTable, globalTablePath, projectTable, projectTableFn.GetFullPath(), aKiway->Prj().GetProjectPath() ) ); if( dlg.ShowModal() == wxID_CANCEL ) return; if( dlg.m_GlobalTableChanged ) { try { globalTable->Save( globalTablePath ); } catch( const IO_ERROR& ioe ) { msg.Printf( _( "Error saving global library table:\n\n%s" ), ioe.What() ); wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR ); } } if( dlg.m_ProjectTableChanged ) { try { projectTable->Save( projectTableFn.GetFullPath() ); } catch( const IO_ERROR& ioe ) { msg.Printf( _( "Error saving project-specific library table:\n\n%s" ), ioe.What() ); wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR ); } } auto editor = (LIB_EDIT_FRAME*) aKiway->Player( FRAME_SCH_LIB_EDITOR, false ); if( editor ) editor->SyncLibraries( true ); LIB_VIEW_FRAME* viewer = (LIB_VIEW_FRAME*) aKiway->Player( FRAME_SCH_VIEWER, false ); if( viewer ) viewer->ReCreateListLib(); }