68 aSymbols.push_back(
static_cast<SCH_SYMBOL*
>( aItem ) );
71 if( aSymbols.empty() )
92 if( aCached && !each_lib.IsCache() )
95 if( !aCached && each_lib.IsCache() )
98 symbol = each_lib.FindSymbol( aName );
111 fn.SetName( fn.GetName() + wxT(
"-rescue" ) );
118 LIB_SYMBOL* aLibCandidate,
int aUnit,
int aBodyStyle ) :
119 RESCUE_CANDIDATE( aRequestedName, aNewName, aLibCandidate, aUnit, aBodyStyle )
125 std::map<wxString, RESCUE_CASE_CANDIDATE> candidate_map;
130 std::vector<LIB_SYMBOL*> case_insensitive_matches;
132 wxString symbol_name;
133 wxString last_symbol_name;
137 symbol_name = eachSymbol->GetLibId().GetUniStringLibItemName();
139 if( last_symbol_name != symbol_name )
143 last_symbol_name = symbol_name;
144 case_insensitive_matches.clear();
146 LIB_ID id( wxEmptyString, symbol_name );
150 if( case_sensitive_match )
158 if( !case_insensitive_matches.size() )
162 case_insensitive_matches[0], eachSymbol->GetUnit(),
163 eachSymbol->GetBodyStyle() );
165 candidate_map[symbol_name] = candidate;
170 for(
const auto& [
name, candidate ] : candidate_map )
199 eachSymbol->SetLibId( libId );
200 eachSymbol->ClearFlags();
210 std::map<wxString, RESCUE_CACHE_CANDIDATE> candidate_map;
216 wxString symbol_name;
217 wxString old_symbol_name;
221 symbol_name = eachSymbol->GetLibId().GetUniStringLibItemName();
223 if( old_symbol_name != symbol_name )
227 old_symbol_name = symbol_name;
236 wxString tmp = wxString::Format( wxT(
"%s-%s" ),
237 eachSymbol->GetLibId().GetLibNickname().wx_str(),
238 eachSymbol->GetLibId().GetLibItemName().wx_str() );
244 if( cache_match && lib_match
245 && !cache_match->
PinsConflictWith( *lib_match,
true,
true,
true,
true,
false ) )
250 if( !cache_match && lib_match )
255 eachSymbol->
GetUnit(), eachSymbol->GetBodyStyle() );
257 candidate_map[symbol_name] = candidate;
262 for(
const auto& [
name, candidate] : candidate_map )
273 action.Printf(
_(
"Cannot rescue symbol %s which is not available in any library or the cache." ),
278 action.Printf(
_(
"Rescue symbol %s found only in cache library to %s." ),
284 action.Printf(
_(
"Rescue modified symbol %s to %s" ),
301 std::unique_ptr<LIB_SYMBOL> new_symbol = tmp->
Flatten();
313 eachSymbol->SetLibId( libId );
314 eachSymbol->ClearFlags();
326 int aUnit,
int aBodyStyle ) :
343 boost::ptr_vector<RESCUE_CANDIDATE>& aCandidates )
345 std::map<LIB_ID, RESCUE_SYMBOL_LIB_TABLE_CANDIDATE> candidate_map;
357 const LIB_ID& symbol_id = eachSymbol->GetLibId();
359 if( old_symbol_id != symbol_id )
363 old_symbol_id = symbol_id;
376 symbolName.Printf( wxT(
"%s-%s" ),
385 if( !cache_match && !lib_match )
391 if( lib_match && lib_match->
IsDerived() )
395 if( !lib_match_parent )
398 lib_match = lib_match_parent.get();
404 if( cache_match && lib_match
405 && !cache_match->
PinsConflictWith( *lib_match,
true,
true,
true,
true,
false ) )
410 if( !cache_match && lib_match )
422 LIB_ID new_id( libNickname, wxString::Format( wxT(
"%s-%s" ),
428 eachSymbol->GetBodyStyle() );
430 candidate_map[symbol_id] = candidate;
435 for(
const auto& [
name, candidate] : candidate_map )
446 action.Printf(
_(
"Cannot rescue symbol %s which is not available in any library or the cache." ),
451 action.Printf(
_(
"Rescue symbol %s found only in cache library to %s." ),
457 action.Printf(
_(
"Rescue modified symbol %s to %s" ),
470 wxCHECK_MSG( tmp,
false, wxS(
"Both cache and library symbols undefined." ) );
472 std::unique_ptr<LIB_SYMBOL> new_symbol = tmp->
Flatten();
474 new_symbol->SetName(
m_new_id.GetLibItemName() );
483 eachSymbol->ClearFlags();
521 if( ! each_candidate->PerformAction(
this ) )
536 each_logitem.symbol->SetLibId( libId );
537 each_logitem.symbol->ClearFlags();
548 if( aRunningOnDemand )
550 wxMessageDialog dlg( aParent,
_(
"This project has nothing to rescue." ),
551 _(
"Project Rescue Helper" ) );
565 wxMessageDialog dlg( aParent,
_(
"No symbols were rescued." ),
566 _(
"Project Rescue Helper" ) );
590 std::vector<wxString> names_seen;
592 for( boost::ptr_vector<RESCUE_CANDIDATE>::iterator it =
m_all_candidates.begin();
595 bool seen_already =
false;
597 for( wxString& name_seen : names_seen )
599 if( name_seen == it->GetRequestedName() )
612 names_seen.push_back( it->GetRequestedName() );
637 std::unique_ptr<SYMBOL_LIB> rescue_lib =
650 std::vector< LIB_SYMBOL* > symbols;
671 DisplayError( aParent, wxString::Format(
_(
"Failed to create symbol library file '%s'." ),
676 wxArrayString libNames;
693 while( libNames.Index( libName ) != wxNOT_FOUND )
694 libNames.Remove( libName );
697 libNames.Insert( libName, 0 );
708 boost::ptr_vector<SYMBOL_LIB> libsSave;
709 libsSave.transfer( libsSave.end(), libs->begin(), libs->end(), *libs );
728 libs->transfer( libs->end(), libsSave.begin(), libsSave.end(), libsSave );
743 wxCHECK_RET( aNewSymbol, wxS(
"Invalid LIB_SYMBOL pointer." ) );
753 RESCUER( aProject, aSchematic, aCurrentSheet, aGalBackEndType )
755 m_properties = std::make_unique<std::map<std::string, UTF8>>();
787 std::vector<LIB_SYMBOL*> symbols;
819 pi->SaveLibrary( fn.GetFullPath() );
823 msg.Printf(
_(
"Failed to save rescue library %s." ), fn.GetFullPath() );
832 wxString uri = wxS(
"${KIPRJMOD}/" ) + fn.GetFullName();
833 wxString libNickname = fn.GetName();
846 msg.Printf(
_(
"Error occurred saving project specific symbol library table." ) );
867 wxCHECK_RET( aNewSymbol, wxS(
"Invalid LIB_SYMBOL pointer." ) );
A base class for most all the KiCad significant classes used in schematics and boards.
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()
virtual void FindCandidates() override
Populate the RESCUER with all possible candidates.
virtual bool WriteRescueLibrary(wxWindow *aParent) override
Write the rescue library.
virtual void InvokeDialog(wxWindow *aParent, bool aAskShowAgain) override
Display a dialog to allow the user to select rescues.
virtual void AddSymbol(LIB_SYMBOL *aNewSymbol) override
std::unique_ptr< SYMBOL_LIB > m_rescue_lib
virtual void OpenRescueLibrary() override
A logical library item identifier and consists of various portions much like a URI.
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
bool IsValid() const
Check if this LID_ID is valid.
static int HasIllegalChars(const UTF8 &aLibItemName)
Examine aLibItemName for invalid LIB_ID item name characters.
const UTF8 & GetLibItemName() const
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Define a library symbol object.
const LIB_ID & GetLibId() const override
bool PinsConflictWith(const LIB_SYMBOL &aOtherSymbol, bool aTestNums, bool aTestNames, bool aTestType, bool aTestOrientation, bool aTestLength) const
Return true if this symbol's pins do not match another symbol's pins.
void SetLib(SYMBOL_LIB *aLibrary)
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
LIB_SYMBOL_SPTR GetRootSymbol() const
Get the parent symbol that does not have another parent.
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
static SYMBOL_LIBS * SchLibs(PROJECT *aProject)
These are all prefaced with "Sch".
Container for project specific data.
virtual void AddSymbol(LIB_SYMBOL *aNewSymbol)=0
virtual bool WriteRescueLibrary(wxWindow *aParent)=0
Write the rescue library.
std::vector< RESCUE_LOG > m_rescue_log
void UndoRescues()
Reverse the effects of all rescues on the project.
bool DoRescues()
Perform all chosen rescue actions, logging them to be undone if necessary.
std::vector< SCH_SYMBOL * > m_symbols
static bool RescueProject(wxWindow *aParent, RESCUER &aRescuer, bool aRunningOnDemand)
void LogRescue(SCH_SYMBOL *aSymbol, const wxString &aOldName, const wxString &aNewName)
Used by individual RESCUE_CANDIDATE objects to log a rescue for undoing.
SCH_SHEET_PATH * m_currentSheet
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates
std::vector< SCH_SYMBOL * > * GetSymbols()
Get the list of symbols that need rescued.
size_t GetCandidateCount()
Return the number of rescue candidates found.
PROJECT * GetPrj()
Return the #SCH_PROJECT object for access to the symbol libraries.
virtual void InvokeDialog(wxWindow *aParent, bool aAskShowAgain)=0
Display a dialog to allow the user to select rescues.
EDA_DRAW_PANEL_GAL::GAL_TYPE m_galBackEndType
RESCUER(PROJECT &aProject, SCHEMATIC *aSchematic, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)
virtual void OpenRescueLibrary()=0
size_t GetChosenCandidateCount()
Get the number of rescue candidates chosen by the user.
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates
virtual void FindCandidates()=0
Populate the RESCUER with all possible candidates.
void RemoveDuplicates()
Filter out duplicately named rescue candidates.
LIB_SYMBOL * m_cache_candidate
RESCUE_CACHE_CANDIDATE(const wxString &aRequestedName, const wxString &aNewName, LIB_SYMBOL *aCacheCandidate, LIB_SYMBOL *aLibCandidate, int aUnit=0, int aBodyStyle=0)
Create a RESCUE_CACHE_CANDIDATE.
static void FindRescues(RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
Grab all possible RESCUE_CACHE_CANDIDATE objects into a vector.
virtual wxString GetActionDescription() const override
Get a description of the action proposed, for displaying in the UI.
virtual bool PerformAction(RESCUER *aRescuer) override
Perform the actual rescue action.
RESCUE_CANDIDATE(const wxString &aRequestedName, const wxString &aNewName, LIB_SYMBOL *aLibCandidate, int aUnit, int aBodyStyle)
wxString m_requested_name
LIB_SYMBOL * m_lib_candidate
static void FindRescues(RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
Grab all possible RESCUE_CASE_CANDIDATE objects into a vector.
virtual wxString GetActionDescription() const override
Get a description of the action proposed, for displaying in the UI.
RESCUE_CASE_CANDIDATE(const wxString &aRequestedName, const wxString &aNewName, LIB_SYMBOL *aLibCandidate, int aUnit=0, int aBodyStyle=0)
Create a RESCUE_CANDIDATE.
virtual bool PerformAction(RESCUER *aRescuer) override
Perform the actual rescue action.
virtual bool PerformAction(RESCUER *aRescuer) override
Perform the actual rescue action.
virtual wxString GetActionDescription() const override
Get a description of the action proposed, for displaying in the UI.
RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(const LIB_ID &aRequestedId, const LIB_ID &aNewId, LIB_SYMBOL *aCacheCandidate, LIB_SYMBOL *aLibCandidate, int aUnit=0, int aBodyStyle=0)
Create RESCUE_CANDIDATE.
LIB_SYMBOL * m_cache_candidate
static void FindRescues(RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
Grab all possible RESCUE_SYMBOL_LIB_TABLE_CANDIDATE objects into a vector.
RESCUE_SYMBOL_LIB_TABLE_CANDIDATE()
Holds all the data relating to one schematic.
wxString GetFileName() const
Helper to retrieve the filename from the root sheet screen.
static const char * PropBuffering
The property used internally by the plugin to enable cache buffering which prevents the library file ...
static SCH_FILE_T EnumFromStr(const wxString &aFileType)
Return the #SCH_FILE_T from the corresponding plugin type name: "kicad", "legacy",...
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
void UpdateSymbolLinks(REPORTER *aReporter=nullptr)
Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in the full schematic.
SCHEMATIC * Schematic() const
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SCREEN * LastScreen()
const LIB_ID & GetLibId() const override
A collection of SYMBOL_LIB objects.
void FindLibraryNearEntries(std::vector< LIB_SYMBOL * > &aCandidates, const wxString &aEntryName, const wxString &aLibraryName=wxEmptyString)
Search all libraries in the list for a LIB_SYMBOL using a case insensitive comparison.
static void SetLibNamesAndPaths(PROJECT *aProject, const wxString &aPaths, const wxArrayString &aNames)
SYMBOL_LIB * FindLibrary(const wxString &aName)
Find a symbol library by aName.
void LoadAllLibraries(PROJECT *aProject, bool aShowProgress=true)
Load all of the project's libraries into this container, which should be cleared before calling it.
LIB_SYMBOL * FindLibSymbol(const LIB_ID &aLibId, const wxString &aLibraryName=wxEmptyString)
Search all libraries in the list for a symbol.
static void GetLibNamesAndPaths(PROJECT *aProject, wxString *aPaths, wxArrayString *aNames=nullptr)
virtual void OpenRescueLibrary() override
virtual bool WriteRescueLibrary(wxWindow *aParent) override
Write the rescue library.
SYMBOL_LIB_TABLE_RESCUER(PROJECT &aProject, SCHEMATIC *aSchematic, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)
virtual void InvokeDialog(wxWindow *aParent, bool aAskShowAgain) override
Display a dialog to allow the user to select rescues.
std::unique_ptr< std::map< std::string, UTF8 > > m_properties
Library plugin properties.
virtual void FindCandidates() override
Populate the RESCUER with all possible candidates.
virtual void AddSymbol(LIB_SYMBOL *aNewSymbol) override
std::vector< std::unique_ptr< LIB_SYMBOL > > m_rescueLibSymbols
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_IO object i...
const wxString GetType() const override
Return the type of symbol library table represented by this row.
void LoadSymbolLib(std::vector< LIB_SYMBOL * > &aAliasList, const wxString &aNickname, bool aPowerSymbolsOnly=false)
static const wxString GetSymbolLibTableFileName()
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Object used to load, save, search, and otherwise manipulate symbol library files.
void GetSymbols(std::vector< LIB_SYMBOL * > &aSymbols) const
Load a vector with all the entries in this library.
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
This file is part of the common library.
static bool sort_by_libid(const SYMBOL_CANDIDATE &candidate1, const SYMBOL_CANDIDATE &candidate2)
int InvokeDialogRescueEach(wxWindow *aParent, RESCUER &aRescuer, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType, bool aAskShowAgain)
This dialog asks the user which rescuable, cached parts he wants to rescue.
static const std::string LegacySymbolLibFileExtension
static const std::string KiCadSymbolLibFileExtension
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
static bool sort_by_libid(const SCH_SYMBOL *ref, SCH_SYMBOL *cmp)
static LIB_SYMBOL * findSymbol(const wxString &aName, SYMBOL_LIBS *aLibs, bool aCached)
Search the libraries for the first symbol with a given name.
static void getSymbols(SCHEMATIC *aSchematic, std::vector< SCH_SYMBOL * > &aSymbols)
Fill a vector with all of the project's symbols, to ease iterating over them.
static wxFileName GetRescueLibraryFileName(SCHEMATIC *aSchematic)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
LIB_SYMBOL * SchGetLibSymbol(const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, SYMBOL_LIB *aCacheLib, wxWindow *aParent, bool aShowErrorMsg)
Load symbol from symbol library table.
wxString UnescapeString(const wxString &aSource)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
A filename or source description, a problem input line, a line number, a byte offset,...
Definition for symbol library class.
Definition of file extensions used in Kicad.