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 ~LEGACY_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
 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 310 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 316 of file project_rescue.h.

317  :
318  RESCUER( aProject, aCurrentSheet, aGalBackEndType )
319  {
320  }
RESCUER(PROJECT &aProject, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)

◆ ~LEGACY_RESCUER()

virtual LEGACY_RESCUER::~LEGACY_RESCUER ( )
inlinevirtual

Definition at line 322 of file project_rescue.h.

323  {
324  }

Member Function Documentation

◆ AddPart()

void LEGACY_RESCUER::AddPart ( LIB_PART aNewPart)
overridevirtual

Implements RESCUER.

Definition at line 776 of file project_rescue.cpp.

777 {
778  wxCHECK_RET( aNewPart, "Invalid LIB_PART pointer." );
779 
780  aNewPart->SetLib( m_rescue_lib.get() );
781  m_rescue_lib->AddPart( aNewPart );
782 }
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 501 of file project_rescue.cpp.

502 {
503  for( RESCUE_CANDIDATE* each_candidate : m_chosen_candidates )
504  {
505  if( ! each_candidate->PerformAction( this ) )
506  return false;
507  }
508 
509  return true;
510 }
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 650 of file project_rescue.cpp.

651 {
654 }
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 271 of file project_rescue.h.

271 { 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 276 of file project_rescue.h.

276 { 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 286 of file project_rescue.h.

286 { 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 657 of file project_rescue.cpp.

658 {
659  InvokeDialogRescueEach( aParent, static_cast< RESCUER& >( *this ), m_currentSheet,
660  m_galBackEndType, aAskShowAgain );
661 }
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 490 of file project_rescue.cpp.

492 {
493  RESCUE_LOG logitem;
494  logitem.component = aComponent;
495  logitem.old_name = aOldName;
496  logitem.new_name = aNewName;
497  m_rescue_log.push_back( logitem );
498 }
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 664 of file project_rescue.cpp.

665 {
666  wxFileName fn = GetRescueLibraryFileName();
667 
668  std::unique_ptr<PART_LIB> rescue_lib( new PART_LIB( LIBRARY_TYPE_EESCHEMA, fn.GetFullPath() ) );
669 
670  m_rescue_lib = std::move( rescue_lib );
671  m_rescue_lib->EnableBuffering();
672 
673  // If a rescue library already exists copy the contents of that library so we do not
674  // lose an previous rescues.
675  PART_LIB* rescueLib = m_prj->SchLibs()->FindLibrary( fn.GetName() );
676 
677  if( rescueLib )
678  {
679  // For items in the rescue library, aliases are the root symbol.
680  std::vector< LIB_PART* > symbols;
681 
682  rescueLib->GetParts( symbols );
683 
684  for( auto symbol : symbols )
685  {
686  // The LIB_PART copy constructor flattens derived symbols (formerly known as aliases).
687  m_rescue_lib->AddPart( new LIB_PART( *symbol, m_rescue_lib.get() ) );
688  }
689  }
690 }
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 619 of file project_rescue.cpp.

620 {
621  std::vector<wxString> names_seen;
622 
623  for( boost::ptr_vector<RESCUE_CANDIDATE>::iterator it = m_all_candidates.begin();
624  it != m_all_candidates.end(); )
625  {
626  bool seen_already = false;
627 
628  for( wxString& name_seen : names_seen )
629  {
630  if( name_seen == it->GetRequestedName() )
631  {
632  seen_already = true;
633  break;
634  }
635  }
636 
637  if( seen_already )
638  {
639  it = m_all_candidates.erase( it );
640  }
641  else
642  {
643  names_seen.push_back( it->GetRequestedName() );
644  ++it;
645  }
646  }
647 }
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 573 of file project_rescue.cpp.

574 {
575  aRescuer.FindCandidates();
576 
577  if( !aRescuer.GetCandidateCount() )
578  {
579  if( aRunningOnDemand )
580  {
581  wxMessageDialog dlg( aParent, _( "This project has nothing to rescue." ),
582  _( "Project Rescue Helper" ) );
583  dlg.ShowModal();
584  }
585 
586  return true;
587  }
588 
589  aRescuer.RemoveDuplicates();
590  aRescuer.InvokeDialog( aParent, !aRunningOnDemand );
591 
592  // If no symbols were rescued, let the user know what's going on. He might
593  // have clicked cancel by mistake, and should have some indication of that.
594  if( !aRescuer.GetChosenCandidateCount() )
595  {
596  wxMessageDialog dlg( aParent, _( "No symbols were rescued." ),
597  _( "Project Rescue Helper" ) );
598  dlg.ShowModal();
599 
600  // Set the modified flag even on Cancel. Many users seem to instinctively want to Save at
601  // this point, due to the reloading of the symbols, so we'll make the save button active.
602  return true;
603  }
604 
605  aRescuer.OpenRescueLibrary();
606 
607  if( !aRescuer.DoRescues() )
608  {
609  aRescuer.UndoRescues();
610  return false;
611  }
612 
613  aRescuer.WriteRescueLibrary( aParent );
614 
615  return true;
616 }
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.
virtual void OpenRescueLibrary()=0
bool DoRescues()
Perform all chosen rescue actions, logging them to be undone if necessary.
#define _(s)
Definition: 3d_actions.cpp:33
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 513 of file project_rescue.cpp.

514 {
515  for( RESCUE_LOG& each_logitem : m_rescue_log )
516  {
517  LIB_ID libId;
518 
519  libId.SetLibItemName( each_logitem.old_name, false );
520  each_logitem.component->SetLibId( libId );
521  each_logitem.component->ClearFlags();
522  }
523 }
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 693 of file project_rescue.cpp.

694 {
695  try
696  {
697  m_rescue_lib->Save( false );
698  }
699  catch( ... /* IO_ERROR ioe */ )
700  {
701  wxString msg;
702 
703  msg.Printf( _( "Failed to create symbol library file \"%s\"" ),
704  m_rescue_lib->GetFullFileName() );
705  DisplayError( aParent, msg );
706  return false;
707  }
708 
709  wxArrayString libNames;
710  wxString libPaths;
711 
712  wxString libName = m_rescue_lib->GetName();
713  PART_LIBS *libs = dynamic_cast<PART_LIBS*>( m_prj->GetElem( PROJECT::ELEM_SCH_PART_LIBS ) );
714 
715  if( !libs )
716  {
717  libs = new PART_LIBS();
719  }
720 
721  try
722  {
723  PART_LIBS::LibNamesAndPaths( m_prj, false, &libPaths, &libNames );
724 
725  // Make sure the library is not already in the list
726  while( libNames.Index( libName ) != wxNOT_FOUND )
727  libNames.Remove( libName );
728 
729  // Add the library to the top of the list and save.
730  libNames.Insert( libName, 0 );
731  PART_LIBS::LibNamesAndPaths( m_prj, true, &libPaths, &libNames );
732  }
733  catch( const IO_ERROR& )
734  {
735  // Could not get or save the current libraries.
736  return false;
737  }
738 
739  // Save the old libraries in case there is a problem after clear(). We'll
740  // put them back in.
741  boost::ptr_vector<PART_LIB> libsSave;
742  libsSave.transfer( libsSave.end(), libs->begin(), libs->end(), *libs );
743 
745 
746  libs = new PART_LIBS();
747 
748  try
749  {
750  libs->LoadAllLibraries( m_prj );
751  }
752  catch( const PARSE_ERROR& )
753  {
754  // Some libraries were not found. There's no point in showing the error,
755  // because it was already shown. Just don't do anything.
756  }
757  catch( const IO_ERROR& )
758  {
759  // Restore the old list
760  libs->clear();
761  libs->transfer( libs->end(), libsSave.begin(), libsSave.end(), libsSave );
762  return false;
763  }
764 
766 
767  // Update the schematic symbol library links since the library list has changed.
768  SCH_SCREENS schematic;
769 
770  schematic.UpdateSymbolLinks();
771 
772  return true;
773 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
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:232
VTBL_ENTRY void SetElem(ELEM_T aIndex, _ELEM *aElem)
Definition: project.cpp:244
#define NULL
PROJECT * m_prj
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...
#define _(s)
Definition: 3d_actions.cpp:33
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, NULL, 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 221 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 313 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 229 of file project_rescue.h.

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


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