KiCad PCB EDA Suite
LEGACY_RESCUER Class Reference

#include <project_rescue.h>

Inheritance diagram for LEGACY_RESCUER:
RESCUER

Public Member Functions

 LEGACY_RESCUER (PROJECT &aProject, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType)
 
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
 Writes out the rescue library. More...
 
virtual void AddPart (LIB_PART *aNewPart) override
 
void RemoveDuplicates ()
 Filter out duplicately named rescue candidates. More...
 
size_t GetCandidateCount ()
 Returen the number of rescue candidates found. More...
 
size_t GetChosenCandidateCount ()
 Get the number of resuce candidates chosen by the user. More...
 
std::vector< SCH_COMPONENT * > * GetComponents ()
 Get the list of symbols that need rescued. More...
 
PROJECTGetPrj ()
 Return the #SCH_PROJECT object for access to the symbol libraries. More...
 
void LogRescue (SCH_COMPONENT *aComponent, 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_COMPONENT * > m_components
 
PROJECTm_prj
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_galBackEndType
 
SCH_SHEET_PATHm_currentSheet
 
boost::ptr_vector< RESCUE_CANDIDATEm_all_candidates
 
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates
 
std::vector< RESCUE_LOGm_rescue_log
 

Private Attributes

std::unique_ptr< PART_LIBm_rescue_lib
 

Detailed Description

Definition at line 307 of file project_rescue.h.

Constructor & Destructor Documentation

◆ LEGACY_RESCUER()

LEGACY_RESCUER::LEGACY_RESCUER ( PROJECT aProject,
SCH_SHEET_PATH aCurrentSheet,
EDA_DRAW_PANEL_GAL::GAL_TYPE  aGalBackEndType 
)
inline

Definition at line 313 of file project_rescue.h.

314  :
315  RESCUER( aProject, aCurrentSheet, aGalBackEndType )
316  {
317  }
RESCUER(PROJECT &aProject, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)

Member Function Documentation

◆ AddPart()

void LEGACY_RESCUER::AddPart ( LIB_PART aNewPart)
overridevirtual

Implements RESCUER.

Definition at line 782 of file project_rescue.cpp.

783 {
784  wxCHECK_RET( aNewPart, "Invalid LIB_PART pointer." );
785 
786  aNewPart->SetLib( m_rescue_lib.get() );
787  m_rescue_lib->AddPart( aNewPart );
788 }
void SetLib(PART_LIB *aLibrary)
std::unique_ptr< PART_LIB > m_rescue_lib

References m_rescue_lib, and LIB_PART::SetLib().

◆ DoRescues()

bool RESCUER::DoRescues ( )
inherited

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

Returns
True on success

Definition at line 507 of file project_rescue.cpp.

508 {
509  for( RESCUE_CANDIDATE* each_candidate : m_chosen_candidates )
510  {
511  if( ! each_candidate->PerformAction( this ) )
512  return false;
513  }
514 
515  return true;
516 }
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates

References RESCUER::m_chosen_candidates.

Referenced by RESCUER::RescueProject().

◆ FindCandidates()

void LEGACY_RESCUER::FindCandidates ( )
overridevirtual

Populate the RESCUER with all possible candidates.

Implements RESCUER.

Definition at line 656 of file project_rescue.cpp.

657 {
660 }
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates
static void FindRescues(RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
Grab all possible RESCUE_CACHE_CANDIDATE objectss into a vector.
static void FindRescues(RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
Grab all possible RESCUE_CASE_CANDIDATE objects into a vector.

References RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_CANDIDATE::FindRescues(), and RESCUER::m_all_candidates.

◆ GetCandidateCount()

size_t RESCUER::GetCandidateCount ( )
inlineinherited

Returen the number of rescue candidates found.

Definition at line 268 of file project_rescue.h.

268 { return m_all_candidates.size(); }
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates

References RESCUER::m_all_candidates.

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

◆ GetChosenCandidateCount()

size_t RESCUER::GetChosenCandidateCount ( )
inlineinherited

Get the number of resuce candidates chosen by the user.

Definition at line 273 of file project_rescue.h.

273 { return m_chosen_candidates.size(); }
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates

References RESCUER::m_chosen_candidates.

Referenced by RESCUER::RescueProject().

◆ GetComponents()

◆ GetPrj()

PROJECT* RESCUER::GetPrj ( )
inlineinherited

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

Definition at line 283 of file project_rescue.h.

283 { return m_prj; }
PROJECT * m_prj

References RESCUER::m_prj.

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

◆ InvokeDialog()

void LEGACY_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 663 of file project_rescue.cpp.

664 {
665  InvokeDialogRescueEach( aParent, static_cast< RESCUER& >( *this ), m_currentSheet,
666  m_galBackEndType, aAskShowAgain );
667 }
EDA_DRAW_PANEL_GAL::GAL_TYPE m_galBackEndType
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.
SCH_SHEET_PATH * m_currentSheet

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

◆ LogRescue()

void RESCUER::LogRescue ( SCH_COMPONENT aComponent,
const wxString &  aOldName,
const wxString &  aNewName 
)
inherited

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

Definition at line 496 of file project_rescue.cpp.

498 {
499  RESCUE_LOG logitem;
500  logitem.component = aComponent;
501  logitem.old_name = aOldName;
502  logitem.new_name = aNewName;
503  m_rescue_log.push_back( logitem );
504 }
SCH_COMPONENT * component
std::vector< RESCUE_LOG > m_rescue_log
wxString old_name
wxString new_name

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

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

◆ OpenRescueLibrary()

void LEGACY_RESCUER::OpenRescueLibrary ( )
overridevirtual

Implements RESCUER.

Definition at line 670 of file project_rescue.cpp.

671 {
672  wxFileName fn = GetRescueLibraryFileName();
673 
674  std::unique_ptr<PART_LIB> rescue_lib( new PART_LIB( LIBRARY_TYPE_EESCHEMA, fn.GetFullPath() ) );
675 
676  m_rescue_lib = std::move( rescue_lib );
677  m_rescue_lib->EnableBuffering();
678 
679  // If a rescue library already exists copy the contents of that library so we do not
680  // lose an previous rescues.
681  PART_LIB* rescueLib = m_prj->SchLibs()->FindLibrary( fn.GetName() );
682 
683  if( rescueLib )
684  {
685  // For items in the rescue library, aliases are the root symbol.
686  std::vector< LIB_PART* > symbols;
687 
688  rescueLib->GetParts( symbols );
689 
690  for( auto symbol : symbols )
691  {
692  // The LIB_PART copy constructor flattens derived symbols (formerly known as aliases).
693  m_rescue_lib->AddPart( new LIB_PART( *symbol, m_rescue_lib.get() ) );
694  }
695  }
696 }
Define a library symbol object.
PROJECT * m_prj
void GetParts(std::vector< LIB_PART * > &aPart) const
Load a vector with all the entries in this library.
static wxFileName GetRescueLibraryFileName()
std::unique_ptr< PART_LIB > m_rescue_lib
Object used to load, save, search, and otherwise manipulate symbol library files.

References PART_LIB::GetParts(), GetRescueLibraryFileName(), LIBRARY_TYPE_EESCHEMA, RESCUER::m_prj, and m_rescue_lib.

◆ RemoveDuplicates()

void RESCUER::RemoveDuplicates ( )
inherited

Filter out duplicately named rescue candidates.

Definition at line 625 of file project_rescue.cpp.

626 {
627  std::vector<wxString> names_seen;
628 
629  for( boost::ptr_vector<RESCUE_CANDIDATE>::iterator it = m_all_candidates.begin();
630  it != m_all_candidates.end(); )
631  {
632  bool seen_already = false;
633 
634  for( wxString& name_seen : names_seen )
635  {
636  if( name_seen == it->GetRequestedName() )
637  {
638  seen_already = true;
639  break;
640  }
641  }
642 
643  if( seen_already )
644  {
645  it = m_all_candidates.erase( it );
646  }
647  else
648  {
649  names_seen.push_back( it->GetRequestedName() );
650  ++it;
651  }
652  }
653 }
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates

References RESCUER::m_all_candidates.

Referenced by RESCUER::RescueProject().

◆ RescueProject()

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

Definition at line 579 of file project_rescue.cpp.

580 {
581  aRescuer.FindCandidates();
582 
583  if( !aRescuer.GetCandidateCount() )
584  {
585  if( aRunningOnDemand )
586  {
587  wxMessageDialog dlg( aParent, _( "This project has nothing to rescue." ),
588  _( "Project Rescue Helper" ) );
589  dlg.ShowModal();
590  }
591 
592  return true;
593  }
594 
595  aRescuer.RemoveDuplicates();
596  aRescuer.InvokeDialog( aParent, !aRunningOnDemand );
597 
598  // If no symbols were rescued, let the user know what's going on. He might
599  // have clicked cancel by mistake, and should have some indication of that.
600  if( !aRescuer.GetChosenCandidateCount() )
601  {
602  wxMessageDialog dlg( aParent, _( "No symbols were rescued." ),
603  _( "Project Rescue Helper" ) );
604  dlg.ShowModal();
605 
606  // Set the modified flag even on Cancel. Many users seem to instinctively want to Save at
607  // this point, due to the reloading of the symbols, so we'll make the save button active.
608  return true;
609  }
610 
611  aRescuer.OpenRescueLibrary();
612 
613  if( !aRescuer.DoRescues() )
614  {
615  aRescuer.UndoRescues();
616  return false;
617  }
618 
619  aRescuer.WriteRescueLibrary( aParent );
620 
621  return true;
622 }
virtual bool WriteRescueLibrary(wxWindow *aParent)=0
Writes out the rescue library.
virtual void FindCandidates()=0
Populate the RESCUER with all possible candidates.
size_t GetChosenCandidateCount()
Get the number of resuce candidates chosen by the user.
virtual void InvokeDialog(wxWindow *aParent, bool aAskShowAgain)=0
Display a dialog to allow the user to select rescues.
void RemoveDuplicates()
Filter out duplicately named rescue candidates.
size_t GetCandidateCount()
Returen the number of rescue candidates found.
#define _(s)
virtual void OpenRescueLibrary()=0
bool DoRescues()
Perform all chosen rescue actions, logging them to be undone if necessary.
void UndoRescues()
Reverse the effects of all rescues on the project.

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_EDIT_FRAME::rescueProject().

◆ UndoRescues()

void RESCUER::UndoRescues ( )
inherited

Reverse the effects of all rescues on the project.

Definition at line 519 of file project_rescue.cpp.

520 {
521  for( RESCUE_LOG& each_logitem : m_rescue_log )
522  {
523  LIB_ID libId;
524 
525  libId.SetLibItemName( each_logitem.old_name, false );
526  each_logitem.component->SetLibId( libId );
527  each_logitem.component->ClearFlags();
528  }
529 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:206
std::vector< RESCUE_LOG > m_rescue_log

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

Referenced by RESCUER::RescueProject().

◆ WriteRescueLibrary()

bool LEGACY_RESCUER::WriteRescueLibrary ( wxWindow *  aParent)
overridevirtual

Writes out the rescue library.

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

Returns
True on success.

Implements RESCUER.

Definition at line 699 of file project_rescue.cpp.

700 {
701  try
702  {
703  m_rescue_lib->Save( false );
704  }
705  catch( ... /* IO_ERROR ioe */ )
706  {
707  wxString msg;
708 
709  msg.Printf( _( "Failed to create symbol library file \"%s\"" ),
710  m_rescue_lib->GetFullFileName() );
711  DisplayError( aParent, msg );
712  return false;
713  }
714 
715  wxArrayString libNames;
716  wxString libPaths;
717 
718  wxString libName = m_rescue_lib->GetName();
719  PART_LIBS *libs = dynamic_cast<PART_LIBS*>( m_prj->GetElem( PROJECT::ELEM_SCH_PART_LIBS ) );
720 
721  if( !libs )
722  {
723  libs = new PART_LIBS();
725  }
726 
727  try
728  {
729  PART_LIBS::LibNamesAndPaths( m_prj, false, &libPaths, &libNames );
730 
731  // Make sure the library is not already in the list
732  while( libNames.Index( libName ) != wxNOT_FOUND )
733  libNames.Remove( libName );
734 
735  // Add the library to the top of the list and save.
736  libNames.Insert( libName, 0 );
737  PART_LIBS::LibNamesAndPaths( m_prj, true, &libPaths, &libNames );
738  }
739  catch( const IO_ERROR& )
740  {
741  // Could not get or save the current libraries.
742  return false;
743  }
744 
745  // Save the old libraries in case there is a problem after clear(). We'll
746  // put them back in.
747  boost::ptr_vector<PART_LIB> libsSave;
748  libsSave.transfer( libsSave.end(), libs->begin(), libs->end(), *libs );
749 
751 
752  libs = new PART_LIBS();
753 
754  try
755  {
756  libs->LoadAllLibraries( m_prj );
757  }
758  catch( const PARSE_ERROR& )
759  {
760  // Some libraries were not found. There's no point in showing the error,
761  // because it was already shown. Just don't do anything.
762  }
763  catch( const IO_ERROR& )
764  {
765  // Restore the old list
766  libs->clear();
767  libs->transfer( libs->end(), libsSave.begin(), libsSave.end(), libsSave );
768  return false;
769  }
770 
772 
773  // Update the schematic symbol library links since the library list has changed.
774  SCH_SCREENS schematic;
775 
776  schematic.UpdateSymbolLinks();
777 
778  return true;
779 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
static void LibNamesAndPaths(PROJECT *aProject, bool doSave, wxString *aPaths, wxArrayString *aNames=NULL)
Save or load the names of the currently configured part libraries (without paths).
void LoadAllLibraries(PROJECT *aProject, bool aShowProgress=true)
Load all of the project's libraries into this container, which should be cleared before calling it.
VTBL_ENTRY _ELEM * GetElem(ELEM_T aIndex)
Typically wrapped somewhere else in a more meaningful function wrapper.
Definition: project.cpp:205
VTBL_ENTRY void SetElem(ELEM_T aIndex, _ELEM *aElem)
Definition: project.cpp:217
PROJECT * m_prj
#define _(s)
A collection of PART_LIB objects.
Struct PARSE_ERROR contains a filename or source description, a problem input line,...
Definition: ki_exception.h:123
std::unique_ptr< PART_LIB > m_rescue_lib
void UpdateSymbolLinks(bool aForce=false)
Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in the ful...
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:491

References _, DisplayError(), PROJECT::ELEM_SCH_PART_LIBS, PROJECT::GetElem(), PART_LIBS::LibNamesAndPaths(), PART_LIBS::LoadAllLibraries(), RESCUER::m_prj, m_rescue_lib, PROJECT::SetElem(), and SCH_SCREENS::UpdateSymbolLinks().

Member Data Documentation

◆ m_all_candidates

◆ m_chosen_candidates

◆ m_components

std::vector<SCH_COMPONENT*> RESCUER::m_components
protectedinherited

Definition at line 222 of file project_rescue.h.

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

◆ m_currentSheet

SCH_SHEET_PATH* RESCUER::m_currentSheet
protectedinherited

◆ m_galBackEndType

EDA_DRAW_PANEL_GAL::GAL_TYPE RESCUER::m_galBackEndType
protectedinherited

◆ m_prj

◆ m_rescue_lib

std::unique_ptr<PART_LIB> LEGACY_RESCUER::m_rescue_lib
private

Definition at line 310 of file project_rescue.h.

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

◆ m_rescue_log

std::vector<RESCUE_LOG> RESCUER::m_rescue_log
protectedinherited

Definition at line 230 of file project_rescue.h.

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


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