kicad/eeschema/project_rescue.cpp

892 lines
28 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 Chris Pavlina <pavlina.chris@gmail.com>
* Copyright (C) 2015-2022 KiCad Developers, see change_log.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 <sch_draw_panel.h>
#include <symbol_library.h>
#include <confirm.h>
#include <connection_graph.h>
#include <invoke_sch_dialog.h>
#include <kiway.h>
2020-12-25 23:37:01 +00:00
#include <symbol_viewer_frame.h>
#include <project_rescue.h>
#include <sch_symbol.h>
#include <sch_sheet.h>
2018-01-30 10:49:51 +00:00
#include <sch_edit_frame.h>
#include <schematic.h>
#include <string_utils.h>
#include <symbol_lib_table.h>
#include <wildcards_and_files_ext.h>
#include <cctype>
#include <map>
2021-06-10 14:10:55 +00:00
typedef std::pair<SCH_SYMBOL*, wxString> SYMBOL_NAME_PAIR;
2021-06-10 14:10:55 +00:00
// Helper sort function, used in getSymbols, to sort a symbol list by lib_id
static bool sort_by_libid( const SCH_SYMBOL* ref, SCH_SYMBOL* cmp )
2017-06-21 07:32:19 +00:00
{
return ref->GetLibId() < cmp->GetLibId();
}
/**
* Fill a vector with all of the project's symbols, to ease iterating over them.
*
2021-06-10 14:10:55 +00:00
* The list is sorted by #LIB_ID, therefore symbols using the same library
* symbol are grouped, allowing later faster calculations (one library search by group
* of symbols)
*
2021-06-10 14:10:55 +00:00
* @param aSymbols is a vector that will take the symbols.
*/
2021-06-10 14:10:55 +00:00
static void getSymbols( SCHEMATIC* aSchematic, std::vector<SCH_SYMBOL*>& aSymbols )
{
SCH_SCREENS screens( aSchematic->Root() );
// Get the full list
for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
{
2021-06-10 14:10:55 +00:00
for( auto aItem : screen->Items().OfType( SCH_SYMBOL_T ) )
aSymbols.push_back( static_cast<SCH_SYMBOL*>( aItem ) );
}
2021-06-10 14:10:55 +00:00
if( aSymbols.empty() )
return;
2021-06-10 18:51:46 +00:00
// sort aSymbols by lib symbol. symbols will be grouped by same lib symbol.
2021-06-10 14:10:55 +00:00
std::sort( aSymbols.begin(), aSymbols.end(), sort_by_libid );
}
/**
2021-06-10 14:10:55 +00:00
* Search the libraries for the first symbol with a given name.
*
* @param aName - name to search for
* @param aLibs - the loaded SYMBOL_LIBS
2021-06-10 18:51:46 +00:00
* @param aCached - whether we are looking for the cached symbol
*/
static LIB_SYMBOL* findSymbol( const wxString& aName, SYMBOL_LIBS* aLibs, bool aCached )
{
2021-07-16 20:13:26 +00:00
LIB_SYMBOL *symbol = nullptr;
for( SYMBOL_LIB& each_lib : *aLibs )
{
if( aCached && !each_lib.IsCache() )
continue;
if( !aCached && each_lib.IsCache() )
continue;
symbol = each_lib.FindSymbol( aName );
2021-06-10 18:51:46 +00:00
if( symbol )
break;
}
2021-06-10 18:51:46 +00:00
return symbol;
}
static wxFileName GetRescueLibraryFileName( SCHEMATIC* aSchematic )
{
wxFileName fn = aSchematic->GetFileName();
fn.SetName( fn.GetName() + wxT( "-rescue" ) );
fn.SetExt( LegacySymbolLibFileExtension );
return fn;
}
RESCUE_CASE_CANDIDATE::RESCUE_CASE_CANDIDATE( const wxString& aRequestedName,
const wxString& aNewName,
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* aLibCandidate,
int aUnit,
int aConvert )
{
m_requested_name = aRequestedName;
m_new_name = aNewName;
m_lib_candidate = aLibCandidate;
m_unit = aUnit;
m_convert = aConvert;
}
void RESCUE_CASE_CANDIDATE::FindRescues( RESCUER& aRescuer,
boost::ptr_vector<RESCUE_CANDIDATE>& aCandidates )
{
typedef std::map<wxString, RESCUE_CASE_CANDIDATE> candidate_map_t;
candidate_map_t candidate_map;
2021-06-10 14:10:55 +00:00
2021-06-10 18:51:46 +00:00
// Remember the list of symbols is sorted by symbol name.
// So a search in libraries is made only once by group
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* case_sensitive_match = nullptr;
std::vector<LIB_SYMBOL*> case_insensitive_matches;
2021-06-10 18:51:46 +00:00
wxString symbol_name;
wxString search_name;
2021-06-10 18:51:46 +00:00
wxString last_symbol_name;
2021-06-10 14:10:55 +00:00
for( SCH_SYMBOL* eachSymbol : *( aRescuer.GetSymbols() ) )
{
2021-06-10 18:51:46 +00:00
symbol_name = eachSymbol->GetLibId().GetLibItemName();
search_name = EscapeString ( symbol_name, CTX_LIBID );
2021-06-10 18:51:46 +00:00
if( last_symbol_name != symbol_name )
{
2021-06-10 18:51:46 +00:00
// A new symbol name is found (a new group starts here).
// Search the symbol names candidates only once for this group:
2021-06-10 18:51:46 +00:00
last_symbol_name = symbol_name;
case_insensitive_matches.clear();
LIB_ID id( wxEmptyString, search_name );
case_sensitive_match = aRescuer.GetPrj()->SchLibs()->FindLibSymbol( id );
2017-03-10 09:31:50 +00:00
// If the case sensitive match failed, try a case insensitive match.
if( !case_sensitive_match )
aRescuer.GetPrj()->SchLibs()->FindLibraryNearEntries( case_insensitive_matches,
search_name );
}
if( case_sensitive_match || !( case_insensitive_matches.size() ) )
continue;
2017-03-10 09:31:50 +00:00
2021-06-10 18:51:46 +00:00
RESCUE_CASE_CANDIDATE candidate( symbol_name, case_insensitive_matches[0]->GetName(),
case_insensitive_matches[0],
2021-06-10 14:10:55 +00:00
eachSymbol->GetUnit(),
eachSymbol->GetConvert() );
2021-06-10 18:51:46 +00:00
candidate_map[symbol_name] = candidate;
}
// Now, dump the map into aCandidates
for( const candidate_map_t::value_type& each_pair : candidate_map )
{
aCandidates.push_back( new RESCUE_CASE_CANDIDATE( each_pair.second ) );
}
}
wxString RESCUE_CASE_CANDIDATE::GetActionDescription() const
{
wxString action;
action.Printf( _( "Rename %s to %s" ), m_requested_name, m_new_name );
return action;
}
bool RESCUE_CASE_CANDIDATE::PerformAction( RESCUER* aRescuer )
{
2021-06-10 14:10:55 +00:00
for( SCH_SYMBOL* eachSymbol : *aRescuer->GetSymbols() )
{
2021-06-10 14:10:55 +00:00
if( eachSymbol->GetLibId().GetLibItemName() != UTF8( m_requested_name ) )
continue;
LIB_ID libId;
libId.SetLibItemName( m_new_name );
2021-06-10 14:10:55 +00:00
eachSymbol->SetLibId( libId );
eachSymbol->ClearFlags();
aRescuer->LogRescue( eachSymbol, m_requested_name, m_new_name );
}
return true;
}
RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE( const wxString& aRequestedName,
const wxString& aNewName,
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* aCacheCandidate,
LIB_SYMBOL* aLibCandidate,
int aUnit,
int aConvert )
{
m_requested_name = aRequestedName;
m_new_name = aNewName;
m_cache_candidate = aCacheCandidate;
m_lib_candidate = aLibCandidate;
m_unit = aUnit;
m_convert = aConvert;
}
RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE()
{
2021-07-16 20:13:26 +00:00
m_cache_candidate = nullptr;
m_lib_candidate = nullptr;
}
void RESCUE_CACHE_CANDIDATE::FindRescues( RESCUER& aRescuer,
boost::ptr_vector<RESCUE_CANDIDATE>& aCandidates )
{
typedef std::map<wxString, RESCUE_CACHE_CANDIDATE> candidate_map_t;
candidate_map_t candidate_map;
2021-06-10 18:51:46 +00:00
// Remember the list of symbols is sorted by symbol name.
// So a search in libraries is made only once by group
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* cache_match = nullptr;
LIB_SYMBOL* lib_match = nullptr;
wxString symbol_name;
wxString search_name;
2021-06-10 18:51:46 +00:00
wxString old_symbol_name;
2021-06-10 14:10:55 +00:00
for( SCH_SYMBOL* eachSymbol : *( aRescuer.GetSymbols() ) )
{
2021-06-10 18:51:46 +00:00
symbol_name = eachSymbol->GetLibId().GetLibItemName();
search_name = EscapeString ( symbol_name, CTX_LIBID );
2021-06-10 18:51:46 +00:00
if( old_symbol_name != symbol_name )
{
2021-06-10 18:51:46 +00:00
// A new symbol name is found (a new group starts here).
// Search the symbol names candidates only once for this group:
2021-06-10 18:51:46 +00:00
old_symbol_name = symbol_name;
2021-06-10 14:10:55 +00:00
cache_match = findSymbol( search_name, aRescuer.GetPrj()->SchLibs(), true );
lib_match = findSymbol( search_name, aRescuer.GetPrj()->SchLibs(), false );
if( !cache_match && !lib_match )
continue;
// Test whether there is a conflict or if the symbol can only be found in the cache
// and the symbol name does not have any illegal characters.
if( cache_match && lib_match &&
!cache_match->PinsConflictWith( *lib_match, true, true, true, true, false ) )
continue;
if( !cache_match && lib_match )
continue;
// Check if the symbol has already been rescued.
2021-06-10 18:51:46 +00:00
RESCUE_CACHE_CANDIDATE candidate( symbol_name, search_name, cache_match, lib_match,
2021-06-10 14:10:55 +00:00
eachSymbol->GetUnit(),
eachSymbol->GetConvert() );
2021-06-10 18:51:46 +00:00
candidate_map[symbol_name] = candidate;
}
}
// Now, dump the map into aCandidates
for( const candidate_map_t::value_type& each_pair : candidate_map )
{
aCandidates.push_back( new RESCUE_CACHE_CANDIDATE( each_pair.second ) );
}
}
wxString RESCUE_CACHE_CANDIDATE::GetActionDescription() const
{
wxString action;
if( !m_cache_candidate && !m_lib_candidate )
2018-01-10 13:48:00 +00:00
action.Printf( _( "Cannot rescue symbol %s which is not available in any library or "
"the cache." ), m_requested_name );
else if( m_cache_candidate && !m_lib_candidate )
action.Printf( _( "Rescue symbol %s found only in cache library to %s." ),
m_requested_name, m_new_name );
else
action.Printf( _( "Rescue modified symbol %s to %s" ),
m_requested_name, m_new_name );
return action;
}
bool RESCUE_CACHE_CANDIDATE::PerformAction( RESCUER* aRescuer )
{
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* tmp = ( m_cache_candidate ) ? m_cache_candidate : m_lib_candidate;
wxCHECK_MSG( tmp, false, "Both cache and library symbols undefined." );
2021-06-10 18:51:46 +00:00
std::unique_ptr<LIB_SYMBOL> new_symbol = tmp->Flatten();
new_symbol->SetName( m_new_name );
aRescuer->AddSymbol( new_symbol.get() );
2021-06-10 14:10:55 +00:00
for( SCH_SYMBOL* eachSymbol : *aRescuer->GetSymbols() )
{
2021-06-10 14:10:55 +00:00
if( eachSymbol->GetLibId().GetLibItemName() != UTF8( m_requested_name ) )
continue;
LIB_ID libId;
libId.SetLibItemName( m_new_name );
2021-06-10 14:10:55 +00:00
eachSymbol->SetLibId( libId );
eachSymbol->ClearFlags();
aRescuer->LogRescue( eachSymbol, m_requested_name, m_new_name );
}
return true;
}
RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(
const LIB_ID& aRequestedId,
const LIB_ID& aNewId,
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* aCacheCandidate,
LIB_SYMBOL* aLibCandidate,
int aUnit,
int aConvert ) : RESCUE_CANDIDATE()
{
m_requested_id = aRequestedId;
m_requested_name = aRequestedId.Format();
m_new_id = aNewId;
m_lib_candidate = aLibCandidate;
m_cache_candidate = aCacheCandidate;
m_unit = aUnit;
m_convert = aConvert;
}
RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE()
{
2021-07-16 20:13:26 +00:00
m_cache_candidate = nullptr;
m_lib_candidate = nullptr;
}
void RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(
RESCUER& aRescuer,
boost::ptr_vector<RESCUE_CANDIDATE>& aCandidates )
{
typedef std::map<LIB_ID, RESCUE_SYMBOL_LIB_TABLE_CANDIDATE> candidate_map_t;
candidate_map_t candidate_map;
2021-06-10 14:10:55 +00:00
// Remember the list of symbols is sorted by LIB_ID.
// So a search in libraries is made only once by group
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* cache_match = nullptr;
LIB_SYMBOL* lib_match = nullptr;
LIB_ID old_symbol_id;
wxString escapedSymbolName;
2021-06-10 14:10:55 +00:00
for( SCH_SYMBOL* eachSymbol : *( aRescuer.GetSymbols() ) )
{
2021-06-10 18:51:46 +00:00
const LIB_ID& symbol_id = eachSymbol->GetLibId();
2021-06-10 18:51:46 +00:00
if( old_symbol_id != symbol_id )
{
2021-06-10 18:51:46 +00:00
// A new symbol name is found (a new group starts here).
// Search the symbol names candidates only once for this group:
2021-06-10 18:51:46 +00:00
old_symbol_id = symbol_id;
escapedSymbolName = EscapeString( symbol_id.Format().wx_str(), CTX_LIBID );
// Get the library symbol from the cache library. It will be a flattened
// symbol by default (no inheritance).
cache_match = findSymbol( escapedSymbolName, aRescuer.GetPrj()->SchLibs(),
2021-06-10 14:10:55 +00:00
true );
// At some point during V5 development, the LIB_ID delimiter character ':' was
// replaced by '_' when writing the symbol cache library so we have to test for
// the LIB_NICKNAME_LIB_SYMBOL_NAME case.
if( !cache_match )
{
escapedSymbolName = EscapeString( symbol_id.GetLibNickname().wx_str() +
wxT( "_" ) + symbol_id.GetLibItemName().wx_str(),
CTX_LIBID );
cache_match = findSymbol( escapedSymbolName, aRescuer.GetPrj()->SchLibs(),
true );
}
// Get the library symbol from the symbol library table.
2021-06-17 21:22:10 +00:00
lib_match = SchGetLibSymbol( symbol_id, aRescuer.GetPrj()->SchSymbolLibTable() );
if( !cache_match && !lib_match )
continue;
LIB_SYMBOL_SPTR lib_match_parent;
// If it's a derive symbol, use the parent symbol to perform the pin test.
if( lib_match && lib_match->IsAlias() )
{
lib_match_parent = lib_match->GetParent().lock();
if( !lib_match_parent )
lib_match = nullptr;
else
lib_match = lib_match_parent.get();
}
// Test whether there is a conflict or if the symbol can only be found in the cache.
2021-06-10 18:51:46 +00:00
if( LIB_ID::HasIllegalChars( symbol_id.GetLibItemName() ) == -1 )
{
if( cache_match && lib_match &&
!cache_match->PinsConflictWith( *lib_match, true, true, true, true, false ) )
2021-06-17 21:22:10 +00:00
{
continue;
2021-06-17 21:22:10 +00:00
}
if( !cache_match && lib_match )
continue;
}
// Fix illegal LIB_ID name characters.
wxString new_name = LIB_ID::FixIllegalChars( symbol_id.GetLibItemName(), false );
// Differentiate symbol name in the rescue library by appending the symbol library
// table nickname to the symbol name to prevent name clashes in the rescue library.
wxString libNickname = GetRescueLibraryFileName( aRescuer.Schematic() ).GetName();
// Spaces in the file name will break the symbol name because they are not
// quoted in the symbol library file format.
libNickname.Replace( " ", "-" );
2021-06-10 18:51:46 +00:00
LIB_ID new_id( libNickname, new_name + "-" + symbol_id.GetLibNickname().wx_str() );
2021-06-10 18:51:46 +00:00
RESCUE_SYMBOL_LIB_TABLE_CANDIDATE candidate( symbol_id, new_id, cache_match, lib_match,
2021-06-10 14:10:55 +00:00
eachSymbol->GetUnit(),
eachSymbol->GetConvert() );
2021-06-10 18:51:46 +00:00
candidate_map[symbol_id] = candidate;
}
}
// Now, dump the map into aCandidates
for( const candidate_map_t::value_type& each_pair : candidate_map )
{
aCandidates.push_back( new RESCUE_SYMBOL_LIB_TABLE_CANDIDATE( each_pair.second ) );
}
}
wxString RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::GetActionDescription() const
{
wxString action;
if( !m_cache_candidate && !m_lib_candidate )
2021-06-17 21:22:10 +00:00
{
2018-01-10 13:48:00 +00:00
action.Printf( _( "Cannot rescue symbol %s which is not available in any library or "
2021-06-17 21:22:10 +00:00
"the cache." ),
m_requested_id.GetLibItemName().wx_str() );
}
else if( m_cache_candidate && !m_lib_candidate )
2021-06-17 21:22:10 +00:00
{
action.Printf( _( "Rescue symbol %s found only in cache library to %s." ),
2021-06-17 21:22:10 +00:00
m_requested_id.Format().wx_str(),
m_new_id.Format().wx_str() );
}
else
2021-06-17 21:22:10 +00:00
{
action.Printf( _( "Rescue modified symbol %s to %s" ),
2021-06-17 21:22:10 +00:00
m_requested_id.Format().wx_str(),
m_new_id.Format().wx_str() );
}
return action;
}
bool RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction( RESCUER* aRescuer )
{
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* tmp = ( m_cache_candidate ) ? m_cache_candidate : m_lib_candidate;
wxCHECK_MSG( tmp, false, "Both cache and library symbols undefined." );
2021-06-10 18:51:46 +00:00
std::unique_ptr<LIB_SYMBOL> new_symbol = tmp->Flatten();
new_symbol->SetLibId( m_new_id );
new_symbol->SetName( m_new_id.GetLibItemName() );
aRescuer->AddSymbol( new_symbol.get() );
2021-06-10 14:10:55 +00:00
for( SCH_SYMBOL* eachSymbol : *aRescuer->GetSymbols() )
{
2021-06-10 14:10:55 +00:00
if( eachSymbol->GetLibId() != m_requested_id )
continue;
2021-06-10 14:10:55 +00:00
eachSymbol->SetLibId( m_new_id );
eachSymbol->ClearFlags();
aRescuer->LogRescue( eachSymbol, m_requested_id.Format(), m_new_id.Format() );
}
return true;
}
RESCUER::RESCUER( PROJECT& aProject, SCHEMATIC* aSchematic, SCH_SHEET_PATH* aCurrentSheet,
EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType )
{
m_schematic = aSchematic ? aSchematic : aCurrentSheet->LastScreen()->Schematic();
wxASSERT( m_schematic );
2020-05-19 02:58:28 +00:00
if( m_schematic )
2021-06-10 14:10:55 +00:00
getSymbols( m_schematic, m_symbols );
2020-05-19 02:58:28 +00:00
m_prj = &aProject;
m_currentSheet = aCurrentSheet;
m_galBackEndType = aGalBackEndType;
}
2021-06-10 14:10:55 +00:00
void RESCUER::LogRescue( SCH_SYMBOL* aSymbol, const wxString &aOldName,
const wxString &aNewName )
{
RESCUE_LOG logitem;
2021-06-10 14:10:55 +00:00
logitem.symbol = aSymbol;
logitem.old_name = aOldName;
logitem.new_name = aNewName;
m_rescue_log.push_back( logitem );
}
bool RESCUER::DoRescues()
{
for( RESCUE_CANDIDATE* each_candidate : m_chosen_candidates )
{
if( ! each_candidate->PerformAction( this ) )
return false;
}
return true;
}
void RESCUER::UndoRescues()
{
for( RESCUE_LOG& each_logitem : m_rescue_log )
{
LIB_ID libId;
libId.SetLibItemName( each_logitem.old_name );
2021-06-10 14:10:55 +00:00
each_logitem.symbol->SetLibId( libId );
each_logitem.symbol->ClearFlags();
}
}
bool RESCUER::RescueProject( wxWindow* aParent, RESCUER& aRescuer, bool aRunningOnDemand )
{
aRescuer.FindCandidates();
if( !aRescuer.GetCandidateCount() )
{
if( aRunningOnDemand )
{
wxMessageDialog dlg( aParent, _( "This project has nothing to rescue." ),
_( "Project Rescue Helper" ) );
dlg.ShowModal();
}
return true;
}
aRescuer.RemoveDuplicates();
aRescuer.InvokeDialog( aParent, !aRunningOnDemand );
// If no symbols were rescued, let the user know what's going on. He might
// have clicked cancel by mistake, and should have some indication of that.
if( !aRescuer.GetChosenCandidateCount() )
{
wxMessageDialog dlg( aParent, _( "No symbols were rescued." ),
_( "Project Rescue Helper" ) );
dlg.ShowModal();
// Set the modified flag even on Cancel. Many users seem to instinctively want to Save at
// this point, due to the reloading of the symbols, so we'll make the save button active.
return true;
}
aRescuer.OpenRescueLibrary();
if( !aRescuer.DoRescues() )
{
aRescuer.UndoRescues();
return false;
}
aRescuer.WriteRescueLibrary( aParent );
return true;
}
void RESCUER::RemoveDuplicates()
{
std::vector<wxString> names_seen;
for( boost::ptr_vector<RESCUE_CANDIDATE>::iterator it = m_all_candidates.begin();
it != m_all_candidates.end(); )
{
bool seen_already = false;
for( wxString& name_seen : names_seen )
{
if( name_seen == it->GetRequestedName() )
{
seen_already = true;
break;
}
}
if( seen_already )
{
it = m_all_candidates.erase( it );
}
else
{
names_seen.push_back( it->GetRequestedName() );
++it;
}
}
}
void LEGACY_RESCUER::FindCandidates()
{
RESCUE_CASE_CANDIDATE::FindRescues( *this, m_all_candidates );
RESCUE_CACHE_CANDIDATE::FindRescues( *this, m_all_candidates );
}
void LEGACY_RESCUER::InvokeDialog( wxWindow* aParent, bool aAskShowAgain )
{
InvokeDialogRescueEach( aParent, static_cast< RESCUER& >( *this ), m_currentSheet,
m_galBackEndType, aAskShowAgain );
}
void LEGACY_RESCUER::OpenRescueLibrary()
{
wxFileName fn = GetRescueLibraryFileName( m_schematic );
std::unique_ptr<SYMBOL_LIB> rescue_lib = std::make_unique<SYMBOL_LIB>( SCH_LIB_TYPE::LT_EESCHEMA,
fn.GetFullPath() );
m_rescue_lib = std::move( rescue_lib );
m_rescue_lib->EnableBuffering();
// If a rescue library already exists copy the contents of that library so we do not
// lose an previous rescues.
SYMBOL_LIB* rescueLib = m_prj->SchLibs()->FindLibrary( fn.GetName() );
if( rescueLib )
{
// For items in the rescue library, aliases are the root symbol.
2021-06-10 18:51:46 +00:00
std::vector< LIB_SYMBOL* > symbols;
rescueLib->GetSymbols( symbols );
for( auto symbol : symbols )
{
2021-06-10 18:51:46 +00:00
// The LIB_SYMBOL copy constructor flattens derived symbols (formerly known as aliases).
m_rescue_lib->AddSymbol( new LIB_SYMBOL( *symbol, m_rescue_lib.get() ) );
}
}
}
bool LEGACY_RESCUER::WriteRescueLibrary( wxWindow *aParent )
{
try
{
m_rescue_lib->Save( false );
}
catch( ... /* IO_ERROR ioe */ )
{
wxString msg;
msg.Printf( _( "Failed to create symbol library file '%s'." ),
m_rescue_lib->GetFullFileName() );
DisplayError( aParent, msg );
return false;
}
wxArrayString libNames;
wxString libPaths;
wxString libName = m_rescue_lib->GetName();
SYMBOL_LIBS *libs = dynamic_cast<SYMBOL_LIBS*>( m_prj->GetElem( PROJECT::ELEM_SCH_SYMBOL_LIBS ) );
if( !libs )
{
libs = new SYMBOL_LIBS();
m_prj->SetElem( PROJECT::ELEM_SCH_SYMBOL_LIBS, libs );
}
try
{
SYMBOL_LIBS::LibNamesAndPaths( m_prj, false, &libPaths, &libNames );
// Make sure the library is not already in the list
while( libNames.Index( libName ) != wxNOT_FOUND )
libNames.Remove( libName );
// Add the library to the top of the list and save.
libNames.Insert( libName, 0 );
SYMBOL_LIBS::LibNamesAndPaths( m_prj, true, &libPaths, &libNames );
}
catch( const IO_ERROR& )
{
// Could not get or save the current libraries.
return false;
}
// Save the old libraries in case there is a problem after clear(). We'll
// put them back in.
boost::ptr_vector<SYMBOL_LIB> libsSave;
libsSave.transfer( libsSave.end(), libs->begin(), libs->end(), *libs );
2021-07-16 20:13:26 +00:00
m_prj->SetElem( PROJECT::ELEM_SCH_SYMBOL_LIBS, nullptr );
libs = new SYMBOL_LIBS();
try
{
libs->LoadAllLibraries( m_prj );
}
catch( const PARSE_ERROR& )
{
// Some libraries were not found. There's no point in showing the error,
// because it was already shown. Just don't do anything.
}
catch( const IO_ERROR& )
{
// Restore the old list
libs->clear();
libs->transfer( libs->end(), libsSave.begin(), libsSave.end(), libsSave );
return false;
}
m_prj->SetElem( PROJECT::ELEM_SCH_SYMBOL_LIBS, libs );
// Update the schematic symbol library links since the library list has changed.
SCH_SCREENS schematic( m_schematic->Root() );
schematic.UpdateSymbolLinks();
return true;
}
void LEGACY_RESCUER::AddSymbol( LIB_SYMBOL* aNewSymbol )
{
2021-06-10 18:51:46 +00:00
wxCHECK_RET( aNewSymbol, "Invalid LIB_SYMBOL pointer." );
2021-06-10 18:51:46 +00:00
aNewSymbol->SetLib( m_rescue_lib.get() );
m_rescue_lib->AddSymbol( aNewSymbol );
}
SYMBOL_LIB_TABLE_RESCUER::SYMBOL_LIB_TABLE_RESCUER( PROJECT& aProject, SCHEMATIC* aSchematic,
SCH_SHEET_PATH* aCurrentSheet,
EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType ) :
RESCUER( aProject, aSchematic, aCurrentSheet, aGalBackEndType )
{
m_properties = std::make_unique<PROPERTIES>();
}
void SYMBOL_LIB_TABLE_RESCUER::FindCandidates()
{
RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues( *this, m_all_candidates );
}
void SYMBOL_LIB_TABLE_RESCUER::InvokeDialog( wxWindow* aParent, bool aAskShowAgain )
{
InvokeDialogRescueEach( aParent, static_cast< RESCUER& >( *this ), m_currentSheet,
m_galBackEndType, aAskShowAgain );
}
void SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary()
{
m_pi.set( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_LEGACY ) );
(*m_properties)[ SCH_LEGACY_PLUGIN::PropBuffering ] = "";
}
bool SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary( wxWindow *aParent )
{
wxString msg;
wxFileName fn = GetRescueLibraryFileName( m_schematic );
// If the rescue library already exists in the symbol library table no need save it to add
// it to the table.
if( !m_prj->SchSymbolLibTable()->HasLibrary( fn.GetName() ) )
{
try
{
m_pi->SaveLibrary( fn.GetFullPath() );
}
catch( const IO_ERROR& ioe )
{
msg.Printf( _( "Failed to save rescue library %s." ), fn.GetFullPath() );
DisplayErrorMessage( aParent, msg, ioe.What() );
return false;
}
wxString uri = "${KIPRJMOD}/" + fn.GetFullName();
wxString libNickname = fn.GetName();
// Spaces in the file name will break the symbol name because they are not
// quoted in the symbol library file format.
libNickname.Replace( " ", "-" );
SYMBOL_LIB_TABLE_ROW* row = new SYMBOL_LIB_TABLE_ROW( libNickname, uri,
wxString( "Legacy" ) );
m_prj->SchSymbolLibTable()->InsertRow( row );
fn = wxFileName( m_prj->GetProjectPath(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
try
{
m_prj->SchSymbolLibTable()->Save( fn.GetFullPath() );
}
catch( const IO_ERROR& ioe )
{
msg.Printf( _( "Error occurred saving project specific symbol library table." ) );
DisplayErrorMessage( aParent, msg, ioe.What() );
return false;
}
}
// Relaod the symbol library table.
2021-07-16 20:13:26 +00:00
m_prj->SetElem( PROJECT::ELEM_SYMBOL_LIB_TABLE, nullptr );
// This can only happen if the symbol library table file was corrupted on write.
if( !m_prj->SchSymbolLibTable() )
return false;
// Update the schematic symbol library links since the library list has changed.
SCH_SCREENS schematic( m_schematic->Root() );
Make the new schematic and symbol library file formats the default. This is a very large and potentially disruptive change so this will be an unusually long and detailed commit message. The new file formats are now the default in both the schematic and symbol library editors. Existing symbol libraries will be saved in their current format until new features are added to library symbols. Once this happens, both the legacy schematic and symbol file formats will be no longer be savable and existing libraries will have to be converted. Saving to the legacy file formats is still available for round robin testing and should not be used for normal editing. When loading the legacy schematic file, it is imperative that the schematic library symbols are rescued and/or remapped to valid library identifiers. Otherwise, there will be no way to link to the original library symbol and the user will be required manually set the library identifier. The cached symbol will be saved in the schematic file so the last library symbol in the cache will still be used but there will be no way to update it from the original library. The next save after loading a legacy schematic file will be converted to the s-expression file format. Schematics with hierarchical sheets will automatically have all sheet file name extensions changed to .kicad_sym and saved to the new format as well. Appending schematics requires that the schematic to append has already been converted to the new file format. This is required to ensure that library symbols are guaranteed to be valid for the appended schematic. The schematic symbol library symbol link resolution has been moved out of the SCH_COMPONENT object and move into the SCH_SCREEN object that owns the symbol. This was done to ensure that there is a single place where the library symbol links get resolved rather than the dozen or so different code paths that previously existed. It also removes the necessity of the SCH_COMPONENT object of requiring any knowledge of the symbol library table and/or the cache library. When opening an s-expression schematic, the legacy cache library is not loaded so any library symbols not rescued cannot be loaded. Broken library symbol links will have to be manually resolved by adding the cache library to the symbol library table and changing the links in the schematic symbol. Now that the library symbols are embedded in the schematic file, the SCH_SCREEN object maintains the list of library symbols for the schematic automatically. No external manipulation of this library cache should ever occur. ADDED: S-expression schematic and symbol library file formats.
2020-04-16 16:43:50 +00:00
schematic.UpdateSymbolLinks();
return true;
}
void SYMBOL_LIB_TABLE_RESCUER::AddSymbol( LIB_SYMBOL* aNewSymbol )
{
2021-06-10 18:51:46 +00:00
wxCHECK_RET( aNewSymbol, "Invalid LIB_SYMBOL pointer." );
wxFileName fn = GetRescueLibraryFileName( m_schematic );
try
{
if( !m_prj->SchSymbolLibTable()->HasLibrary( fn.GetName() ) )
2021-06-10 18:51:46 +00:00
m_pi->SaveSymbol( fn.GetFullPath(), new LIB_SYMBOL( *aNewSymbol ), m_properties.get() );
else
2021-06-10 18:51:46 +00:00
m_prj->SchSymbolLibTable()->SaveSymbol( fn.GetName(), new LIB_SYMBOL( *aNewSymbol ) );
}
catch( ... /* IO_ERROR */ )
{
}
}