SYMBOL_LIB_TABLE_RESCUER Class Reference

#include <project_rescue.h>

Inheritance diagram for SYMBOL_LIB_TABLE_RESCUER:

Public Member Functions
	SYMBOL_LIB_TABLE_RESCUER (PROJECT &aProject, SCHEMATIC *aSchematic, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)
virtual	~SYMBOL_LIB_TABLE_RESCUER ()
virtual void	FindCandidates () override
	Populate the RESCUER with all possible candidates. More...
virtual void	InvokeDialog (wxWindow *aParent, bool aAskShowAgain) override
	Display a dialog to allow the user to select rescues. More...
virtual void	OpenRescueLibrary () override
virtual bool	WriteRescueLibrary (wxWindow *aParent) override
	Write the rescue library. More...
virtual void	AddSymbol (LIB_SYMBOL *aNewSymbol) override
void	RemoveDuplicates ()
	Filter out duplicately named rescue candidates. More...
size_t	GetCandidateCount ()
	Return the number of rescue candidates found. More...
size_t	GetChosenCandidateCount ()
	Get the number of rescue candidates chosen by the user. More...
std::vector< SCH_SYMBOL * > *	GetSymbols ()
	Get the list of symbols that need rescued. More...
PROJECT *	GetPrj ()
	Return the #SCH_PROJECT object for access to the symbol libraries. More...
SCHEMATIC *	Schematic ()
void	LogRescue (SCH_SYMBOL *aSymbol, const wxString &aOldName, const wxString &aNewName)
	Used by individual RESCUE_CANDIDATE objects to log a rescue for undoing. More...
bool	DoRescues ()
	Perform all chosen rescue actions, logging them to be undone if necessary. More...
void	UndoRescues ()
	Reverse the effects of all rescues on the project. More...

Static Public Member Functions
static bool	RescueProject (wxWindow *aParent, RESCUER &aRescuer, bool aRunningOnDemand)

Protected Attributes
std::vector< SCH_SYMBOL * >	m_symbols
PROJECT *	m_prj
SCHEMATIC *	m_schematic
EDA_DRAW_PANEL_GAL::GAL_TYPE	m_galBackEndType
SCH_SHEET_PATH *	m_currentSheet
boost::ptr_vector< RESCUE_CANDIDATE >	m_all_candidates
std::vector< RESCUE_CANDIDATE * >	m_chosen_candidates
std::vector< RESCUE_LOG >	m_rescue_log

Private Attributes
std::vector< std::unique_ptr< LIB_SYMBOL > >	m_rescueLibSymbols
std::unique_ptr< STRING_UTF8_MAP >	m_properties
	Library plugin properties. More...

Detailed Description

Definition at line 360 of file project_rescue.h.

Constructor & Destructor Documentation

SYMBOL_LIB_TABLE_RESCUER()

SYMBOL_LIB_TABLE_RESCUER::SYMBOL_LIB_TABLE_RESCUER	(	PROJECT &	aProject,
		SCHEMATIC *	aSchematic,
		SCH_SHEET_PATH *	aCurrentSheet,
		EDA_DRAW_PANEL_GAL::GAL_TYPE	aGalBackeEndType
	)

Definition at line 798 of file project_rescue.cpp.

 :
 RESCUER( aProject, aSchematic, aCurrentSheet, aGalBackEndType )
{
 m_properties = std::make_unique<STRING_UTF8_MAP>();
}

References m_properties.

~SYMBOL_LIB_TABLE_RESCUER()

virtual SYMBOL_LIB_TABLE_RESCUER::~SYMBOL_LIB_TABLE_RESCUER ( )

inlinevirtual

Definition at line 367 of file project_rescue.h.

 {
 }

Member Function Documentation

AddSymbol()

void SYMBOL_LIB_TABLE_RESCUER::AddSymbol ( LIB_SYMBOL *  aNewSymbol )

overridevirtual

Implements RESCUER.

Definition at line 913 of file project_rescue.cpp.

{
 wxCHECK_RET( aNewSymbol, wxS( "Invalid LIB_SYMBOL pointer." ) );
 
 m_rescueLibSymbols.emplace_back( std::make_unique<LIB_SYMBOL>( *aNewSymbol ) );
}

References m_rescueLibSymbols.

DoRescues()

bool RESCUER::DoRescues ( )

inherited

Perform all chosen rescue actions, logging them to be undone if necessary.

Returns

True on success

Definition at line 562 of file project_rescue.cpp.

{
 for( RESCUE_CANDIDATE* each_candidate : m_chosen_candidates )
 {
 if( ! each_candidate->PerformAction( this ) )
 return false;
 }
 
 return true;
}

References RESCUER::m_chosen_candidates.

Referenced by RESCUER::RescueProject().

FindCandidates()

void SYMBOL_LIB_TABLE_RESCUER::FindCandidates ( )

overridevirtual

Populate the RESCUER with all possible candidates.

Implements RESCUER.

Definition at line 807 of file project_rescue.cpp.

{
 RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues( *this, m_all_candidates );
}

References RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), and RESCUER::m_all_candidates.

GetCandidateCount()

size_t RESCUER::GetCandidateCount ( )

inlineinherited

Return the number of rescue candidates found.

Definition at line 278 of file project_rescue.h.

{ return m_all_candidates.size(); }

References RESCUER::m_all_candidates.

Referenced by SCH_EDITOR_CONTROL::rescueProject(), RESCUER::RescueProject(), and DIALOG_RESCUE_EACH::TransferDataFromWindow().

GetChosenCandidateCount()

size_t RESCUER::GetChosenCandidateCount ( )

inlineinherited

Get the number of rescue candidates chosen by the user.

Definition at line 283 of file project_rescue.h.

{ return m_chosen_candidates.size(); }

References RESCUER::m_chosen_candidates.

Referenced by RESCUER::RescueProject().

GetPrj()

PROJECT * RESCUER::GetPrj ( )

inlineinherited

Return the #SCH_PROJECT object for access to the symbol libraries.

Definition at line 293 of file project_rescue.h.

{ return m_prj; }

References RESCUER::m_prj.

Referenced by RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_CANDIDATE::FindRescues(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

GetSymbols()

std::vector< SCH_SYMBOL * > * RESCUER::GetSymbols ( )

inlineinherited

Get the list of symbols that need rescued.

Definition at line 288 of file project_rescue.h.

{ return &m_symbols; }

References RESCUER::m_symbols.

Referenced by RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_CANDIDATE::FindRescues(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), RESCUE_CASE_CANDIDATE::PerformAction(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), and DIALOG_RESCUE_EACH::PopulateInstanceList().

InvokeDialog()

void SYMBOL_LIB_TABLE_RESCUER::InvokeDialog ( wxWindow *  aParent, bool  aAskShowAgain  )

overridevirtual

Display a dialog to allow the user to select rescues.

Parameters

aAskShowAgain

- whether the "Never Show Again" button should be visible

Implements RESCUER.

Definition at line 813 of file project_rescue.cpp.

{
 InvokeDialogRescueEach( aParent, static_cast< RESCUER& >( *this ), m_currentSheet,
 m_galBackEndType, aAskShowAgain );
}

References InvokeDialogRescueEach(), RESCUER::m_currentSheet, and RESCUER::m_galBackEndType.

LogRescue()

void RESCUER::LogRescue ( SCH_SYMBOL *  aSymbol, const wxString &  aOldName, const wxString &  aNewName  )

inherited

Used by individual RESCUE_CANDIDATE objects to log a rescue for undoing.

Definition at line 551 of file project_rescue.cpp.

{
 RESCUE_LOG logitem;
 logitem.symbol = aSymbol;
 logitem.old_name = aOldName;
 logitem.new_name = aNewName;
 m_rescue_log.push_back( logitem );
}

References RESCUER::m_rescue_log, RESCUE_LOG::new_name, RESCUE_LOG::old_name, and RESCUE_LOG::symbol.

Referenced by RESCUE_CASE_CANDIDATE::PerformAction(), RESCUE_CACHE_CANDIDATE::PerformAction(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction().

OpenRescueLibrary()

void SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary ( )

overridevirtual

Implements RESCUER.

Definition at line 820 of file project_rescue.cpp.

{
 (*m_properties)[ SCH_LEGACY_PLUGIN::PropBuffering ] = "";
 
 wxFileName fn = GetRescueLibraryFileName( m_schematic );
 
 SYMBOL_LIB_TABLE_ROW* row = m_prj->SchSymbolLibTable()->FindRow( fn.GetName() );
 
 // If a rescue library already exists copy the contents of that library so we do not
 // lose any previous rescues.
 if( row )
 {
 if( SCH_IO_MGR::EnumFromStr( row->GetType() ) == SCH_IO_MGR::SCH_KICAD )
 fn.SetExt( KiCadSymbolLibFileExtension );
 
 std::vector<LIB_SYMBOL*> symbols;
 
 try
 {
 m_prj->SchSymbolLibTable()->LoadSymbolLib( symbols, fn.GetName() );
 }
 catch( ... /* IO_ERROR */ )
 {
 return;
 }
 
 for( LIB_SYMBOL* symbol : symbols )
 m_rescueLibSymbols.emplace_back( std::make_unique<LIB_SYMBOL>( *symbol ) );
 }
}

References SCH_IO_MGR::EnumFromStr(), GetRescueLibraryFileName(), SYMBOL_LIB_TABLE_ROW::GetType(), KiCadSymbolLibFileExtension, RESCUER::m_prj, m_rescueLibSymbols, RESCUER::m_schematic, and SCH_LEGACY_PLUGIN::PropBuffering.

RemoveDuplicates()

void RESCUER::RemoveDuplicates ( )

inherited

Filter out duplicately named rescue candidates.

Definition at line 633 of file project_rescue.cpp.

{
 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;
 }
 }
}

References RESCUER::m_all_candidates.

Referenced by RESCUER::RescueProject().

RescueProject()

bool RESCUER::RescueProject ( wxWindow *  aParent, RESCUER &  aRescuer, bool  aRunningOnDemand  )

staticinherited

Definition at line 587 of file project_rescue.cpp.

{
 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;
}

References _, RESCUER::DoRescues(), RESCUER::FindCandidates(), RESCUER::GetCandidateCount(), RESCUER::GetChosenCandidateCount(), RESCUER::InvokeDialog(), RESCUER::OpenRescueLibrary(), RESCUER::RemoveDuplicates(), RESCUER::UndoRescues(), and RESCUER::WriteRescueLibrary().

Referenced by DIALOG_SYMBOL_REMAP::OnRemapSymbols(), and SCH_EDITOR_CONTROL::rescueProject().

Schematic()

SCHEMATIC * RESCUER::Schematic ( )

inlineinherited

Definition at line 295 of file project_rescue.h.

{ return m_schematic; }

References RESCUER::m_schematic.

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

UndoRescues()

void RESCUER::UndoRescues ( )

inherited

Reverse the effects of all rescues on the project.

Definition at line 574 of file project_rescue.cpp.

{
 for( RESCUE_LOG& each_logitem : m_rescue_log )
 {
 LIB_ID libId;
 
 libId.SetLibItemName( each_logitem.old_name );
 each_logitem.symbol->SetLibId( libId );
 each_logitem.symbol->ClearFlags();
 }
}

References RESCUER::m_rescue_log, and LIB_ID::SetLibItemName().

Referenced by RESCUER::RescueProject().

WriteRescueLibrary()

bool SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary ( wxWindow *  aParent )

overridevirtual

Write the rescue library.

Called after successful PerformAction()s. If this fails, undo the actions.

Returns

True on success.

Implements RESCUER.

Definition at line 852 of file project_rescue.cpp.

{
 wxString msg;
 wxFileName fn = GetRescueLibraryFileName( m_schematic );
 SYMBOL_LIB_TABLE_ROW* row = m_prj->SchSymbolLibTable()->FindRow( fn.GetName() );
 
 fn.SetExt( KiCadSymbolLibFileExtension );
 
 try
 {
 SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
 
 for( const std::unique_ptr<LIB_SYMBOL>& symbol : m_rescueLibSymbols )
 pi->SaveSymbol( fn.GetFullPath(), new LIB_SYMBOL( *symbol.get() ), m_properties.get() );
 
 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;
 }
 
 // If the rescue library already exists in the symbol library table no need save it to add
 // it to the table.
 if( !row || ( SCH_IO_MGR::EnumFromStr( row->GetType() ) == SCH_IO_MGR::SCH_LEGACY ) )
 {
 wxString uri = wxS( "${KIPRJMOD}/" ) + fn.GetFullName();
 wxString libNickname = fn.GetName();
 
 row = new SYMBOL_LIB_TABLE_ROW( libNickname, uri, wxT( "KiCad" ) );
 m_prj->SchSymbolLibTable()->InsertRow( row, true );
 
 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;
 }
 }
 
 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() );
 schematic.UpdateSymbolLinks();
 return true;
}

References _, DisplayErrorMessage(), PROJECT::ELEM_SYMBOL_LIB_TABLE, SCH_IO_MGR::EnumFromStr(), PROJECT::GetProjectPath(), GetRescueLibraryFileName(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), SYMBOL_LIB_TABLE_ROW::GetType(), KiCadSymbolLibFileExtension, RESCUER::m_prj, m_properties, m_rescueLibSymbols, RESCUER::m_schematic, SCHEMATIC::Root(), SCH_PLUGIN::SaveLibrary(), SCH_PLUGIN::SaveSymbol(), PROJECT::SetElem(), SCH_SCREENS::UpdateSymbolLinks(), and IO_ERROR::What().

Member Data Documentation

m_all_candidates

boost::ptr_vector<RESCUE_CANDIDATE> RESCUER::m_all_candidates

protectedinherited

Definition at line 325 of file project_rescue.h.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict(), LEGACY_RESCUER::FindCandidates(), FindCandidates(), RESCUER::GetCandidateCount(), DIALOG_RESCUE_EACH::PopulateConflictList(), DIALOG_RESCUE_EACH::PopulateInstanceList(), RESCUER::RemoveDuplicates(), and DIALOG_RESCUE_EACH::TransferDataFromWindow().

m_chosen_candidates

std::vector<RESCUE_CANDIDATE*> RESCUER::m_chosen_candidates

protectedinherited

Definition at line 326 of file project_rescue.h.

Referenced by RESCUER::DoRescues(), RESCUER::GetChosenCandidateCount(), DIALOG_RESCUE_EACH::OnCancelClick(), DIALOG_RESCUE_EACH::OnNeverShowClick(), and DIALOG_RESCUE_EACH::TransferDataFromWindow().

m_currentSheet

SCH_SHEET_PATH* RESCUER::m_currentSheet

protectedinherited

Definition at line 323 of file project_rescue.h.

Referenced by LEGACY_RESCUER::InvokeDialog(), InvokeDialog(), and RESCUER::RESCUER().

m_galBackEndType

EDA_DRAW_PANEL_GAL::GAL_TYPE RESCUER::m_galBackEndType

protectedinherited

Definition at line 322 of file project_rescue.h.

Referenced by LEGACY_RESCUER::InvokeDialog(), InvokeDialog(), and RESCUER::RESCUER().

m_prj

PROJECT* RESCUER::m_prj

protectedinherited

Definition at line 320 of file project_rescue.h.

Referenced by RESCUER::GetPrj(), LEGACY_RESCUER::OpenRescueLibrary(), OpenRescueLibrary(), RESCUER::RESCUER(), LEGACY_RESCUER::WriteRescueLibrary(), and WriteRescueLibrary().

m_properties

std::unique_ptr<STRING_UTF8_MAP> SYMBOL_LIB_TABLE_RESCUER::m_properties

private

Library plugin properties.

Definition at line 384 of file project_rescue.h.

Referenced by SYMBOL_LIB_TABLE_RESCUER(), and WriteRescueLibrary().

m_rescue_log

std::vector<RESCUE_LOG> RESCUER::m_rescue_log

protectedinherited

Definition at line 328 of file project_rescue.h.

Referenced by RESCUER::LogRescue(), and RESCUER::UndoRescues().

m_rescueLibSymbols

std::vector<std::unique_ptr<LIB_SYMBOL> > SYMBOL_LIB_TABLE_RESCUER::m_rescueLibSymbols

private

Definition at line 382 of file project_rescue.h.

Referenced by AddSymbol(), OpenRescueLibrary(), and WriteRescueLibrary().

m_schematic

SCHEMATIC* RESCUER::m_schematic

protectedinherited

Definition at line 321 of file project_rescue.h.

Referenced by LEGACY_RESCUER::OpenRescueLibrary(), OpenRescueLibrary(), RESCUER::RESCUER(), RESCUER::Schematic(), LEGACY_RESCUER::WriteRescueLibrary(), and WriteRescueLibrary().

m_symbols

std::vector<SCH_SYMBOL*> RESCUER::m_symbols

protectedinherited

Definition at line 319 of file project_rescue.h.

Referenced by RESCUER::GetSymbols(), and RESCUER::RESCUER().

---

The documentation for this class was generated from the following files:

• project_rescue.h
• project_rescue.cpp