kicad/eeschema/dialogs/dialog_update_symbol_fields...

224 lines
7.2 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 CERN
* Copyright (C) 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 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 <http://www.gnu.org/licenses/>.
*/
#include <algorithm>
#include <core/kicad_algo.h>
#include <dialog_update_symbol_fields.h>
#include <lib_symbol.h>
#include <symbol_edit_frame.h>
#include <template_fieldnames.h>
#include <string_utils.h>
bool g_removeExtraLibFields = false;
bool g_resetEmptyLibFields = false;
bool g_resetLibFieldText = true;
bool g_resetLibFieldVisibilities = true;
bool g_resetLibFieldEffects = true;
bool g_resetLibFieldPositions = true;
DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS( SYMBOL_EDIT_FRAME* aParent,
LIB_SYMBOL* aSymbol ) :
DIALOG_UPDATE_SYMBOL_FIELDS_BASE( aParent ),
m_editFrame( aParent ),
m_symbol( aSymbol)
{
wxASSERT( aParent );
wxASSERT( aSymbol );
m_parentSymbolReadOnly->SetValue( UnescapeString( m_symbol->GetParent().lock()->GetName() ) );
for( int i = 0; i < MANDATORY_FIELDS; ++i )
{
m_fieldsBox->Append( TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );
m_fieldsBox->Check( i, true );
}
updateFieldsList();
m_removeExtraBox->SetValue( g_removeExtraLibFields );
m_resetEmptyFields->SetValue( g_resetEmptyLibFields );
m_resetFieldText->SetValue( g_resetLibFieldText );
m_resetFieldVisibilities->SetValue( g_resetLibFieldVisibilities );
m_resetFieldEffects->SetValue( g_resetLibFieldEffects );
m_resetFieldPositions->SetValue( g_resetLibFieldPositions );
m_sdbSizerOK->SetDefault();
// Now all widgets have the size fixed, call FinishDialogSettings
finishDialogSettings();
}
DIALOG_UPDATE_SYMBOL_FIELDS::~DIALOG_UPDATE_SYMBOL_FIELDS()
{
g_removeExtraLibFields = m_removeExtraBox->GetValue();
g_resetEmptyLibFields = m_resetEmptyFields->GetValue();
g_resetLibFieldText = m_resetFieldText->GetValue();
g_resetLibFieldVisibilities = m_resetFieldVisibilities->GetValue();
g_resetLibFieldEffects = m_resetFieldEffects->GetValue();
g_resetLibFieldPositions = m_resetFieldPositions->GetValue();
}
void DIALOG_UPDATE_SYMBOL_FIELDS::updateFieldsList()
{
// Load non-mandatory fields from the parent part
std::vector<LIB_FIELD*> libFields;
std::set<wxString> fieldNames;
std::unique_ptr<LIB_SYMBOL> flattenedParent = m_symbol->GetParent().lock()->Flatten();
flattenedParent->GetFields( libFields );
for( unsigned i = MANDATORY_FIELDS; i < libFields.size(); ++i )
fieldNames.insert( libFields[i]->GetName() );
libFields.clear(); // flattenedPart is about to go out of scope...
// Load non-mandatory fields from the editor symbol
m_symbol->GetFields( libFields );
for( unsigned i = MANDATORY_FIELDS; i < libFields.size(); ++i )
fieldNames.insert( libFields[i]->GetName() );
libFields.clear();
// Update the listbox widget
for( unsigned i = m_fieldsBox->GetCount() - 1; i >= MANDATORY_FIELDS; --i )
m_fieldsBox->Delete( i );
for( const wxString& fieldName : fieldNames )
m_fieldsBox->Append( fieldName );
for( unsigned i = MANDATORY_FIELDS; i < m_fieldsBox->GetCount(); ++i )
m_fieldsBox->Check( i, true );
}
void DIALOG_UPDATE_SYMBOL_FIELDS::checkAll( bool aCheck )
{
for( unsigned i = 0; i < m_fieldsBox->GetCount(); ++i )
m_fieldsBox->Check( i, aCheck );
}
void DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked( wxCommandEvent& aEvent )
{
wxBusyCursor dummy;
m_editFrame->SaveCopyInUndoList( m_symbol, UNDO_REDO::LIBEDIT );
// Create the set of fields to be updated
m_updateFields.clear();
for( unsigned i = 0; i < m_fieldsBox->GetCount(); ++i )
{
if( m_fieldsBox->IsChecked( i ) )
m_updateFields.insert( m_fieldsBox->GetString( i ) );
}
std::unique_ptr<LIB_SYMBOL> flattenedParent = m_symbol->GetParent().lock()->Flatten();
bool removeExtras = m_removeExtraBox->GetValue();
bool resetVis = m_resetFieldVisibilities->GetValue();
bool resetEffects = m_resetFieldEffects->GetValue();
bool resetPositions = m_resetFieldPositions->GetValue();
std::vector<LIB_FIELD> fields;
std::vector<LIB_FIELD> result;
m_symbol->GetFields( fields );
for( LIB_FIELD& field : fields )
{
bool copy = true;
LIB_FIELD* parentField = nullptr;
if( alg::contains( m_updateFields, field.GetName() ) )
{
parentField = flattenedParent->FindField( field.GetName() );
if( parentField )
{
bool resetText = parentField->GetText().IsEmpty() ? m_resetEmptyFields->GetValue()
: m_resetFieldText->GetValue();
if( resetText )
field.SetText( parentField->GetText() );
if( resetVis )
field.SetVisible( parentField->IsVisible() );
if( resetEffects )
{
// Careful: the visible bit and position are also in Effects
bool visible = field.IsVisible();
wxPoint pos = field.GetPosition();
field.SetEffects( *parentField );
field.SetVisible( visible );
field.SetPosition( pos );
}
if( resetPositions )
field.SetTextPos( parentField->GetTextPos() );
}
else if( removeExtras )
{
copy = false;
}
}
if( copy )
result.emplace_back( std::move( field ) );
}
std::vector<LIB_FIELD*> parentFields;
int idx = result.size();
flattenedParent->GetFields( parentFields );
for( LIB_FIELD* parentField : parentFields )
{
if( !alg::contains( m_updateFields, parentField->GetName() ) )
continue;
if( !m_symbol->FindField( parentField->GetName() ) )
{
result.emplace_back( m_symbol, idx++ );
LIB_FIELD* newField = &result.back();
newField->SetName( parentField->GetCanonicalName() );
newField->SetText( parentField->GetText() );
newField->SetEffects( *parentField ); // Includes visible bit and position
}
}
m_symbol->SetFields( result );
m_editFrame->RebuildView();
m_editFrame->OnModify();
wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
}