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, SCHEMATIC *aSchematic, 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...
 
SCHEMATICSchematic ()
 
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
 
SCHEMATICm_schematic
 
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 328 of file project_rescue.h.

Constructor & Destructor Documentation

◆ LEGACY_RESCUER()

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

Definition at line 334 of file project_rescue.h.

335  :
336  RESCUER( aProject, aSchematic, aCurrentSheet, aGalBackEndType )
337  {
338  }
RESCUER(PROJECT &aProject, SCHEMATIC *aSchematic, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)

◆ ~LEGACY_RESCUER()

virtual LEGACY_RESCUER::~LEGACY_RESCUER ( )
inlinevirtual

Definition at line 340 of file project_rescue.h.

341  {
342  }

Member Function Documentation

◆ AddPart()

void LEGACY_RESCUER::AddPart ( LIB_PART aNewPart)
overridevirtual

Implements RESCUER.

Definition at line 752 of file project_rescue.cpp.

753 {
754  wxCHECK_RET( aNewPart, "Invalid LIB_PART pointer." );
755 
756  aNewPart->SetLib( m_rescue_lib.get() );
757  m_rescue_lib->AddPart( aNewPart );
758 }
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 526 of file project_rescue.cpp.

527 {
528  for( RESCUE_CANDIDATE* each_candidate : m_chosen_candidates )
529  {
530  if( ! each_candidate->PerformAction( this ) )
531  return false;
532  }
533 
534  return true;
535 }
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 628 of file project_rescue.cpp.

629 {
632 }
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 287 of file project_rescue.h.

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

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 resuce candidates chosen by the user.

Definition at line 292 of file project_rescue.h.

292 { 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 302 of file project_rescue.h.

302 { 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 635 of file project_rescue.cpp.

636 {
637  InvokeDialogRescueEach( aParent, static_cast< RESCUER& >( *this ), m_currentSheet,
638  m_galBackEndType, aAskShowAgain );
639 }
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 515 of file project_rescue.cpp.

517 {
518  RESCUE_LOG logitem;
519  logitem.component = aComponent;
520  logitem.old_name = aOldName;
521  logitem.new_name = aNewName;
522  m_rescue_log.push_back( logitem );
523 }
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 642 of file project_rescue.cpp.

643 {
644  wxFileName fn = GetRescueLibraryFileName( m_schematic );
645 
646  std::unique_ptr<PART_LIB> rescue_lib( new PART_LIB( LIBRARY_TYPE_EESCHEMA, fn.GetFullPath() ) );
647 
648  m_rescue_lib = std::move( rescue_lib );
649  m_rescue_lib->EnableBuffering();
650 
651  // If a rescue library already exists copy the contents of that library so we do not
652  // lose an previous rescues.
653  PART_LIB* rescueLib = m_prj->SchLibs()->FindLibrary( fn.GetName() );
654 
655  if( rescueLib )
656  {
657  // For items in the rescue library, aliases are the root symbol.
658  std::vector< LIB_PART* > symbols;
659 
660  rescueLib->GetParts( symbols );
661 
662  for( auto symbol : symbols )
663  {
664  // The LIB_PART copy constructor flattens derived symbols (formerly known as aliases).
665  m_rescue_lib->AddPart( new LIB_PART( *symbol, m_rescue_lib.get() ) );
666  }
667  }
668 }
static wxFileName GetRescueLibraryFileName(SCHEMATIC *aSchematic)
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.
std::unique_ptr< PART_LIB > m_rescue_lib
SCHEMATIC * m_schematic
Object used to load, save, search, and otherwise manipulate symbol library files.

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

◆ RemoveDuplicates()

void RESCUER::RemoveDuplicates ( )
inherited

Filter out duplicately named rescue candidates.

Definition at line 597 of file project_rescue.cpp.

598 {
599  std::vector<wxString> names_seen;
600 
601  for( boost::ptr_vector<RESCUE_CANDIDATE>::iterator it = m_all_candidates.begin();
602  it != m_all_candidates.end(); )
603  {
604  bool seen_already = false;
605 
606  for( wxString& name_seen : names_seen )
607  {
608  if( name_seen == it->GetRequestedName() )
609  {
610  seen_already = true;
611  break;
612  }
613  }
614 
615  if( seen_already )
616  {
617  it = m_all_candidates.erase( it );
618  }
619  else
620  {
621  names_seen.push_back( it->GetRequestedName() );
622  ++it;
623  }
624  }
625 }
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 551 of file project_rescue.cpp.

552 {
553  aRescuer.FindCandidates();
554 
555  if( !aRescuer.GetCandidateCount() )
556  {
557  if( aRunningOnDemand )
558  {
559  wxMessageDialog dlg( aParent, _( "This project has nothing to rescue." ),
560  _( "Project Rescue Helper" ) );
561  dlg.ShowModal();
562  }
563 
564  return true;
565  }
566 
567  aRescuer.RemoveDuplicates();
568  aRescuer.InvokeDialog( aParent, !aRunningOnDemand );
569 
570  // If no symbols were rescued, let the user know what's going on. He might
571  // have clicked cancel by mistake, and should have some indication of that.
572  if( !aRescuer.GetChosenCandidateCount() )
573  {
574  wxMessageDialog dlg( aParent, _( "No symbols were rescued." ),
575  _( "Project Rescue Helper" ) );
576  dlg.ShowModal();
577 
578  // Set the modified flag even on Cancel. Many users seem to instinctively want to Save at
579  // this point, due to the reloading of the symbols, so we'll make the save button active.
580  return true;
581  }
582 
583  aRescuer.OpenRescueLibrary();
584 
585  if( !aRescuer.DoRescues() )
586  {
587  aRescuer.UndoRescues();
588  return false;
589  }
590 
591  aRescuer.WriteRescueLibrary( aParent );
592 
593  return true;
594 }
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_EDITOR_CONTROL::rescueProject().

◆ Schematic()

SCHEMATIC* RESCUER::Schematic ( )
inlineinherited

Definition at line 304 of file project_rescue.h.

304 { return m_schematic; }
SCHEMATIC * 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 538 of file project_rescue.cpp.

539 {
540  for( RESCUE_LOG& each_logitem : m_rescue_log )
541  {
542  LIB_ID libId;
543 
544  libId.SetLibItemName( each_logitem.old_name, false );
545  each_logitem.component->SetLibId( libId );
546  each_logitem.component->ClearFlags();
547  }
548 }
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 671 of file project_rescue.cpp.

672 {
673  try
674  {
675  m_rescue_lib->Save( false );
676  }
677  catch( ... /* IO_ERROR ioe */ )
678  {
679  wxString msg;
680 
681  msg.Printf( _( "Failed to create symbol library file \"%s\"" ),
682  m_rescue_lib->GetFullFileName() );
683  DisplayError( aParent, msg );
684  return false;
685  }
686 
687  wxArrayString libNames;
688  wxString libPaths;
689 
690  wxString libName = m_rescue_lib->GetName();
691  PART_LIBS *libs = dynamic_cast<PART_LIBS*>( m_prj->GetElem( PROJECT::ELEM_SCH_PART_LIBS ) );
692 
693  if( !libs )
694  {
695  libs = new PART_LIBS();
697  }
698 
699  try
700  {
701  PART_LIBS::LibNamesAndPaths( m_prj, false, &libPaths, &libNames );
702 
703  // Make sure the library is not already in the list
704  while( libNames.Index( libName ) != wxNOT_FOUND )
705  libNames.Remove( libName );
706 
707  // Add the library to the top of the list and save.
708  libNames.Insert( libName, 0 );
709  PART_LIBS::LibNamesAndPaths( m_prj, true, &libPaths, &libNames );
710  }
711  catch( const IO_ERROR& )
712  {
713  // Could not get or save the current libraries.
714  return false;
715  }
716 
717  // Save the old libraries in case there is a problem after clear(). We'll
718  // put them back in.
719  boost::ptr_vector<PART_LIB> libsSave;
720  libsSave.transfer( libsSave.end(), libs->begin(), libs->end(), *libs );
721 
723 
724  libs = new PART_LIBS();
725 
726  try
727  {
728  libs->LoadAllLibraries( m_prj );
729  }
730  catch( const PARSE_ERROR& )
731  {
732  // Some libraries were not found. There's no point in showing the error,
733  // because it was already shown. Just don't do anything.
734  }
735  catch( const IO_ERROR& )
736  {
737  // Restore the old list
738  libs->clear();
739  libs->transfer( libs->end(), libsSave.begin(), libsSave.end(), libsSave );
740  return false;
741  }
742 
744 
745  // Update the schematic symbol library links since the library list has changed.
746  SCH_SCREENS schematic( m_schematic->Root() );
747  schematic.UpdateSymbolLinks();
748  return true;
749 }
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:247
VTBL_ENTRY void SetElem(ELEM_T aIndex, _ELEM *aElem)
Definition: project.cpp:259
#define NULL
PROJECT * m_prj
A collection of PART_LIB objects.
SCH_SHEET & Root() const
Definition: schematic.h:97
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
#define _(s)
Definition: 3d_actions.cpp:33
SCHEMATIC * m_schematic
void UpdateSymbolLinks(REPORTER *aReporter=nullptr)
Initialize the LIB_PART reference for each SCH_COMPONENT found in the full schematic.
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:528

References _, DisplayError(), PROJECT::ELEM_SCH_PART_LIBS, PROJECT::GetElem(), PART_LIBS::LibNamesAndPaths(), PART_LIBS::LoadAllLibraries(), RESCUER::m_prj, m_rescue_lib, RESCUER::m_schematic, NULL, SCHEMATIC::Root(), 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 236 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 331 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 245 of file project_rescue.h.

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

◆ m_schematic


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