/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2018-2021 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 2 * 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, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include "eda_doc.h" #include #include enum { MYID_SELECT_FOOTPRINT = GRIDTRICKS_FIRST_SHOWHIDE - 2, // must be within GRID_TRICKS' enum range MYID_SHOW_DATASHEET }; template FIELDS_GRID_TABLE::FIELDS_GRID_TABLE( DIALOG_SHIM* aDialog, SCH_BASE_FRAME* aFrame, WX_GRID* aGrid, LIB_SYMBOL* aSymbol ) : m_frame( aFrame ), m_dialog( aDialog ), m_grid( aGrid ), m_parentType( SCH_SYMBOL_T ), m_mandatoryFieldCount( MANDATORY_FIELDS ), m_part( aSymbol ), m_fieldNameValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), FIELD_NAME ), m_referenceValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), REFERENCE_FIELD ), m_valueValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), VALUE_FIELD ), m_libIdValidator(), m_urlValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), FIELD_VALUE ), m_nonUrlValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), FIELD_VALUE ), m_filepathValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), SHEETFILENAME ) { initGrid( aGrid ); } template FIELDS_GRID_TABLE::FIELDS_GRID_TABLE( DIALOG_SHIM* aDialog, SCH_BASE_FRAME* aFrame, WX_GRID* aGrid, SCH_SHEET* aSheet ) : m_frame( aFrame ), m_dialog( aDialog ), m_grid( aGrid ), m_parentType( SCH_SHEET_T ), m_mandatoryFieldCount( SHEET_MANDATORY_FIELDS ), m_part( nullptr ), m_fieldNameValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), FIELD_NAME ), m_referenceValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), SHEETNAME_V ), m_valueValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), VALUE_FIELD ), m_libIdValidator(), m_urlValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), FIELD_VALUE ), m_nonUrlValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), FIELD_VALUE ), m_filepathValidator( aFrame->IsType( FRAME_SCH_SYMBOL_EDITOR ), SHEETFILENAME_V ) { initGrid( aGrid ); } template void FIELDS_GRID_TABLE::initGrid( WX_GRID* aGrid ) { // Build the various grid cell attributes. // NOTE: validators and cellAttrs are member variables to get the destruction order // right. wxGrid is VERY cranky about this. m_readOnlyAttr = new wxGridCellAttr; m_readOnlyAttr->SetReadOnly( true ); m_fieldNameAttr = new wxGridCellAttr; GRID_CELL_TEXT_EDITOR* nameEditor = new GRID_CELL_TEXT_EDITOR(); nameEditor->SetValidator( m_fieldNameValidator ); m_fieldNameAttr->SetEditor( nameEditor ); m_referenceAttr = new wxGridCellAttr; GRID_CELL_TEXT_EDITOR* referenceEditor = new GRID_CELL_TEXT_EDITOR(); referenceEditor->SetValidator( m_referenceValidator ); m_referenceAttr->SetEditor( referenceEditor ); m_valueAttr = new wxGridCellAttr; GRID_CELL_TEXT_EDITOR* valueEditor = new GRID_CELL_TEXT_EDITOR(); valueEditor->SetValidator( m_valueValidator ); m_valueAttr->SetEditor( valueEditor ); m_footprintAttr = new wxGridCellAttr; GRID_CELL_FOOTPRINT_ID_EDITOR* fpIdEditor = new GRID_CELL_FOOTPRINT_ID_EDITOR( m_dialog ); fpIdEditor->SetValidator( m_libIdValidator ); m_footprintAttr->SetEditor( fpIdEditor ); m_urlAttr = new wxGridCellAttr; GRID_CELL_URL_EDITOR* urlEditor = new GRID_CELL_URL_EDITOR( m_dialog, m_frame->Prj().SchSearchS() ); urlEditor->SetValidator( m_urlValidator ); m_urlAttr->SetEditor( urlEditor ); m_nonUrlAttr = new wxGridCellAttr; GRID_CELL_TEXT_EDITOR* nonUrlEditor = new GRID_CELL_TEXT_EDITOR(); nonUrlEditor->SetValidator( m_nonUrlValidator ); m_nonUrlAttr->SetEditor( nonUrlEditor ); m_curdir = m_frame->Prj().GetProjectPath(); m_filepathAttr = new wxGridCellAttr; // Create a wild card using wxFileDialog syntax. wxString wildCard( _( "Schematic Files" ) ); std::vector exts; exts.push_back( KiCadSchematicFileExtension ); wildCard += AddFileExtListToFilter( exts ); auto filepathEditor = new GRID_CELL_PATH_EDITOR( m_dialog, aGrid, &m_curdir, wildCard ); filepathEditor->SetValidator( m_filepathValidator ); m_filepathAttr->SetEditor( filepathEditor ); m_boolAttr = new wxGridCellAttr; m_boolAttr->SetRenderer( new wxGridCellBoolRenderer() ); m_boolAttr->SetEditor( new wxGridCellBoolEditor() ); m_boolAttr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER ); wxArrayString vAlignNames; vAlignNames.Add( _( "Top" ) ); vAlignNames.Add( _( "Center" ) ); vAlignNames.Add( _( "Bottom" ) ); m_vAlignAttr = new wxGridCellAttr; m_vAlignAttr->SetEditor( new wxGridCellChoiceEditor( vAlignNames ) ); m_vAlignAttr->SetAlignment( wxALIGN_CENTER, wxALIGN_BOTTOM ); wxArrayString hAlignNames; hAlignNames.Add( _( "Left" ) ); hAlignNames.Add(_( "Center" ) ); hAlignNames.Add(_( "Right" ) ); m_hAlignAttr = new wxGridCellAttr; m_hAlignAttr->SetEditor( new wxGridCellChoiceEditor( hAlignNames ) ); m_hAlignAttr->SetAlignment( wxALIGN_CENTER, wxALIGN_BOTTOM ); wxArrayString orientationNames; orientationNames.Add( _( "Horizontal" ) ); orientationNames.Add(_( "Vertical" ) ); m_orientationAttr = new wxGridCellAttr; m_orientationAttr->SetEditor( new wxGridCellChoiceEditor( orientationNames ) ); m_orientationAttr->SetAlignment( wxALIGN_CENTER, wxALIGN_BOTTOM ); m_frame->Bind( UNITS_CHANGED, &FIELDS_GRID_TABLE::onUnitsChanged, this ); } template FIELDS_GRID_TABLE::~FIELDS_GRID_TABLE() { m_readOnlyAttr->DecRef(); m_fieldNameAttr->DecRef(); m_boolAttr->DecRef(); m_referenceAttr->DecRef(); m_valueAttr->DecRef(); m_footprintAttr->DecRef(); m_urlAttr->DecRef(); m_nonUrlAttr->DecRef(); m_filepathAttr->DecRef(); m_vAlignAttr->DecRef(); m_hAlignAttr->DecRef(); m_orientationAttr->DecRef(); m_frame->Unbind( UNITS_CHANGED, &FIELDS_GRID_TABLE::onUnitsChanged, this ); } template void FIELDS_GRID_TABLE::onUnitsChanged( wxCommandEvent& aEvent ) { if( GetView() ) GetView()->ForceRefresh(); aEvent.Skip(); } template wxString FIELDS_GRID_TABLE::GetColLabelValue( int aCol ) { switch( aCol ) { case FDC_NAME: return _( "Name" ); case FDC_VALUE: return _( "Value" ); case FDC_SHOWN: return _( "Show" ); case FDC_H_ALIGN: return _( "H Align" ); case FDC_V_ALIGN: return _( "V Align" ); case FDC_ITALIC: return _( "Italic" ); case FDC_BOLD: return _( "Bold" ); case FDC_TEXT_SIZE: return _( "Text Size" ); case FDC_ORIENTATION: return _( "Orientation" ); case FDC_POSX: return _( "X Position" ); case FDC_POSY: return _( "Y Position" ); default: wxFAIL; return wxEmptyString; } } template bool FIELDS_GRID_TABLE::CanGetValueAs( int aRow, int aCol, const wxString& aTypeName ) { switch( aCol ) { case FDC_NAME: case FDC_VALUE: case FDC_H_ALIGN: case FDC_V_ALIGN: case FDC_TEXT_SIZE: case FDC_ORIENTATION: case FDC_POSX: case FDC_POSY: return aTypeName == wxGRID_VALUE_STRING; case FDC_SHOWN: case FDC_ITALIC: case FDC_BOLD: return aTypeName == wxGRID_VALUE_BOOL; default: wxFAIL; return false; } } template bool FIELDS_GRID_TABLE::CanSetValueAs( int aRow, int aCol, const wxString& aTypeName ) { return CanGetValueAs( aRow, aCol, aTypeName ); } template wxGridCellAttr* FIELDS_GRID_TABLE::GetAttr( int aRow, int aCol, wxGridCellAttr::wxAttrKind ) { wxGridCellAttr* tmp; switch( aCol ) { case FDC_NAME: if( aRow < m_mandatoryFieldCount ) { tmp = m_fieldNameAttr->Clone(); tmp->SetReadOnly( true ); return tmp; } else { m_fieldNameAttr->IncRef(); return m_fieldNameAttr; } case FDC_VALUE: if( m_parentType == SCH_SYMBOL_T && aRow == REFERENCE_FIELD ) { m_referenceAttr->IncRef(); return m_referenceAttr; } else if( m_parentType == SCH_SYMBOL_T && aRow == VALUE_FIELD ) { // For power symbols, the value is not editable, because value and pin name must // be the same and can be edited only in library editor. if( ( m_part && m_part->IsPower() && !m_frame->IsType( FRAME_SCH_SYMBOL_EDITOR ) ) ) { tmp = m_readOnlyAttr->Clone(); tmp->SetReadOnly( true ); tmp->SetTextColour( wxSystemSettings::GetColour( wxSYS_COLOUR_GRAYTEXT ) ); return tmp; } else { m_valueAttr->IncRef(); return m_valueAttr; } } else if( m_parentType == SCH_SYMBOL_T && aRow == FOOTPRINT_FIELD ) { m_footprintAttr->IncRef(); return m_footprintAttr; } else if( m_parentType == SCH_SYMBOL_T && aRow == DATASHEET_FIELD ) { m_urlAttr->IncRef(); return m_urlAttr; } else if( m_parentType == SCH_SHEET_T && aRow == SHEETNAME ) { m_referenceAttr->IncRef(); return m_referenceAttr; } else if( m_parentType == SCH_SHEET_T && aRow == SHEETFILENAME ) { m_filepathAttr->IncRef(); return m_filepathAttr; } else { wxString fn = GetValue( aRow, FDC_NAME ); SCHEMATIC_SETTINGS* settings = m_frame->Prj().GetProjectFile().m_SchematicSettings; const TEMPLATE_FIELDNAME* templateFn = settings ? settings->m_TemplateFieldNames.GetFieldName( fn ) : nullptr; if( templateFn && templateFn->m_URL ) { m_urlAttr->IncRef(); return m_urlAttr; } else { m_nonUrlAttr->IncRef(); return m_nonUrlAttr; } } return nullptr; case FDC_TEXT_SIZE: case FDC_POSX: case FDC_POSY: return nullptr; case FDC_H_ALIGN: m_hAlignAttr->IncRef(); return m_hAlignAttr; case FDC_V_ALIGN: m_vAlignAttr->IncRef(); return m_vAlignAttr; case FDC_ORIENTATION: m_orientationAttr->IncRef(); return m_orientationAttr; case FDC_SHOWN: case FDC_ITALIC: case FDC_BOLD: m_boolAttr->IncRef(); return m_boolAttr; default: wxFAIL; return nullptr; } } template wxString FIELDS_GRID_TABLE::GetValue( int aRow, int aCol ) { wxCHECK( aRow < GetNumberRows(), wxEmptyString ); const T& field = this->at( (size_t) aRow ); switch( aCol ) { case FDC_NAME: // Use default field name for mandatory fields, because they are translated // according to the current locale if( aRow < m_mandatoryFieldCount ) { if( m_parentType == SCH_SYMBOL_T ) return TEMPLATE_FIELDNAME::GetDefaultFieldName( aRow, DO_TRANSLATE ); else if( m_parentType == SCH_SHEET_T ) return SCH_SHEET::GetDefaultFieldName( aRow ); } return field.GetName( false ); case FDC_VALUE: return UnescapeString( field.GetText() ); case FDC_SHOWN: return StringFromBool( field.IsVisible() ); case FDC_H_ALIGN: switch ( field.GetHorizJustify() ) { case GR_TEXT_HJUSTIFY_LEFT: return _( "Left" ); case GR_TEXT_HJUSTIFY_CENTER: return _( "Center" ); case GR_TEXT_HJUSTIFY_RIGHT: return _( "Right" ); } break; case FDC_V_ALIGN: switch ( field.GetVertJustify() ) { case GR_TEXT_VJUSTIFY_TOP: return _( "Top" ); case GR_TEXT_VJUSTIFY_CENTER: return _( "Center" ); case GR_TEXT_VJUSTIFY_BOTTOM: return _( "Bottom" ); } break; case FDC_ITALIC: return StringFromBool( field.IsItalic() ); case FDC_BOLD: return StringFromBool( field.IsBold() ); case FDC_TEXT_SIZE: return StringFromValue( m_frame->GetUserUnits(), field.GetTextSize().GetHeight(), true ); case FDC_ORIENTATION: switch ( (int) field.GetTextAngle() ) { case TEXT_ANGLE_HORIZ: return _( "Horizontal" ); case TEXT_ANGLE_VERT: return _( "Vertical" ); } break; case FDC_POSX: return StringFromValue( m_frame->GetUserUnits(), field.GetTextPos().x, true ); case FDC_POSY: return StringFromValue( m_frame->GetUserUnits(), field.GetTextPos().y, true ); default: // we can't assert here because wxWidgets sometimes calls this without checking // the column type when trying to see if there's an overflow break; } return wxT( "bad wxWidgets!" ); } template bool FIELDS_GRID_TABLE::GetValueAsBool( int aRow, int aCol ) { wxCHECK( aRow < GetNumberRows(), false ); const T& field = this->at( (size_t) aRow ); switch( aCol ) { case FDC_SHOWN: return field.IsVisible(); case FDC_ITALIC: return field.IsItalic(); case FDC_BOLD: return field.IsBold(); default: wxFAIL_MSG( wxString::Format( wxT( "column %d doesn't hold a bool value" ), aCol ) ); return false; } } template void FIELDS_GRID_TABLE::SetValue( int aRow, int aCol, const wxString &aValue ) { wxCHECK( aRow < GetNumberRows(), /*void*/ ); T& field = this->at( (size_t) aRow ); wxPoint pos; switch( aCol ) { case FDC_NAME: field.SetName( aValue ); break; case FDC_VALUE: { wxString value( aValue ); if( m_parentType == SCH_SHEET_T && aRow == SHEETFILENAME ) { wxFileName fn( value ); // It's annoying to throw up nag dialogs when the extension isn't right. Just // fix it. if( fn.GetExt().CmpNoCase( KiCadSchematicFileExtension ) != 0 ) { fn.SetExt( KiCadSchematicFileExtension ); value = fn.GetFullPath(); } } else if( m_parentType == LIB_SYMBOL_T && aRow == VALUE_FIELD ) { value = EscapeString( value, CTX_LIBID ); } field.SetText( value ); } break; case FDC_SHOWN: field.SetVisible( BoolFromString( aValue ) ); break; case FDC_H_ALIGN: if( aValue == _( "Left" ) ) field.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); else if( aValue == _( "Center" ) ) field.SetHorizJustify( GR_TEXT_HJUSTIFY_CENTER ); else if( aValue == _( "Right" ) ) field.SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); else wxFAIL_MSG( wxT( "unknown horizontal alignment: " ) + aValue ); break; case FDC_V_ALIGN: if( aValue == _( "Top" ) ) field.SetVertJustify( GR_TEXT_VJUSTIFY_TOP ); else if( aValue == _( "Center" ) ) field.SetVertJustify( GR_TEXT_VJUSTIFY_CENTER ); else if( aValue == _( "Bottom" ) ) field.SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM ); else wxFAIL_MSG( wxT( "unknown vertical alignment: " ) + aValue); break; case FDC_ITALIC: field.SetItalic( BoolFromString( aValue ) ); break; case FDC_BOLD: field.SetBold( BoolFromString( aValue ) ); break; case FDC_TEXT_SIZE: field.SetTextSize( wxSize( ValueFromString( m_frame->GetUserUnits(), aValue ), ValueFromString( m_frame->GetUserUnits(), aValue ) ) ); break; case FDC_ORIENTATION: if( aValue == _( "Horizontal" ) ) field.SetTextAngle( TEXT_ANGLE_HORIZ ); else if( aValue == _( "Vertical" ) ) field.SetTextAngle( TEXT_ANGLE_VERT ); else wxFAIL_MSG( wxT( "unknown orientation: " ) + aValue ); break; case FDC_POSX: case FDC_POSY: pos = field.GetTextPos(); if( aCol == FDC_POSX ) pos.x = ValueFromString( m_frame->GetUserUnits(), aValue ); else pos.y = ValueFromString( m_frame->GetUserUnits(), aValue ); field.SetTextPos( pos ); break; default: wxFAIL_MSG( wxString::Format( wxT( "column %d doesn't hold a string value" ), aCol ) ); break; } m_dialog->OnModify(); GetView()->Refresh(); } template void FIELDS_GRID_TABLE::SetValueAsBool( int aRow, int aCol, bool aValue ) { wxCHECK( aRow < GetNumberRows(), /*void*/ ); T& field = this->at( (size_t) aRow ); switch( aCol ) { case FDC_SHOWN: field.SetVisible( aValue ); break; case FDC_ITALIC: field.SetItalic( aValue ); break; case FDC_BOLD: field.SetBold( aValue ); break; default: wxFAIL_MSG( wxString::Format( wxT( "column %d doesn't hold a bool value" ), aCol ) ); break; } m_dialog->OnModify(); } // Explicit Instantiations template class FIELDS_GRID_TABLE; template class FIELDS_GRID_TABLE; void FIELDS_GRID_TRICKS::showPopupMenu( wxMenu& menu ) { if( m_grid->GetGridCursorRow() == FOOTPRINT_FIELD && m_grid->GetGridCursorCol() == FDC_VALUE ) { menu.Append( MYID_SELECT_FOOTPRINT, _( "Select Footprint..." ), _( "Browse for footprint" ) ); menu.AppendSeparator(); } else if( m_grid->GetGridCursorRow() == DATASHEET_FIELD && m_grid->GetGridCursorCol() == FDC_VALUE ) { menu.Append( MYID_SHOW_DATASHEET, _( "Show Datasheet" ), _( "Show datasheet in browser" ) ); menu.AppendSeparator(); } GRID_TRICKS::showPopupMenu( menu ); } void FIELDS_GRID_TRICKS::doPopupSelection( wxCommandEvent& event ) { if( event.GetId() == MYID_SELECT_FOOTPRINT ) { // pick a footprint using the footprint picker. wxString fpid = m_grid->GetCellValue( FOOTPRINT_FIELD, FDC_VALUE ); KIWAY_PLAYER* frame = m_dlg->Kiway().Player( FRAME_FOOTPRINT_VIEWER_MODAL, true, m_dlg ); if( frame->ShowModal( &fpid, m_dlg ) ) m_grid->SetCellValue( FOOTPRINT_FIELD, FDC_VALUE, fpid ); frame->Destroy(); } else if (event.GetId() == MYID_SHOW_DATASHEET ) { wxString datasheet_uri = m_grid->GetCellValue( DATASHEET_FIELD, FDC_VALUE ); GetAssociatedDocument( m_dlg, datasheet_uri, &m_dlg->Prj(), m_dlg->Prj().SchSearchS() ); } else { GRID_TRICKS::doPopupSelection( event ); } } template wxString FIELDS_GRID_TABLE::StringFromBool( bool aValue ) const { if( aValue ) return wxT( "1" ); else return wxT( "0" ); } template bool FIELDS_GRID_TABLE::BoolFromString( wxString aValue ) const { if( aValue == wxT( "1" ) ) { return true; } else if( aValue == wxT( "0" ) ) { return false; } else { wxFAIL_MSG( wxString::Format( wxT( "string '%s' can't be converted to boolean " ) wxT( "correctly, it will have been perceived as FALSE" ), aValue ) ); return false; } }