KiCad PCB EDA Suite
RESCUER Class Referenceabstract

#include <project_rescue.h>

Inheritance diagram for RESCUER:
LEGACY_RESCUER SYMBOL_LIB_TABLE_RESCUER

Public Member Functions

 RESCUER (PROJECT &aProject, SCHEMATIC *aSchematic, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)
 
virtual ~RESCUER ()
 
virtual bool WriteRescueLibrary (wxWindow *aParent)=0
 Write the rescue library. More...
 
virtual void OpenRescueLibrary ()=0
 
virtual void FindCandidates ()=0
 Populate the RESCUER with all possible candidates. More...
 
virtual void AddPart (LIB_PART *aNewPart)=0
 
virtual void InvokeDialog (wxWindow *aParent, bool aAskShowAgain)=0
 Display a dialog to allow the user to select rescues. More...
 
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_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
 

Friends

class DIALOG_RESCUE_EACH
 

Detailed Description

Definition at line 235 of file project_rescue.h.

Constructor & Destructor Documentation

◆ RESCUER()

RESCUER::RESCUER ( PROJECT aProject,
SCHEMATIC aSchematic,
SCH_SHEET_PATH aCurrentSheet,
EDA_DRAW_PANEL_GAL::GAL_TYPE  aGalBackeEndType 
)

Definition at line 500 of file project_rescue.cpp.

502 {
503  m_schematic = aSchematic ? aSchematic : aCurrentSheet->LastScreen()->Schematic();
504 
505  wxASSERT( m_schematic );
506 
507  if( m_schematic )
509 
510  m_prj = &aProject;
511  m_currentSheet = aCurrentSheet;
512  m_galBackEndType = aGalBackEndType;
513 }
EDA_DRAW_PANEL_GAL::GAL_TYPE m_galBackEndType
SCH_SHEET_PATH * m_currentSheet
PROJECT * m_prj
std::vector< SCH_COMPONENT * > m_components
SCH_SCREEN * LastScreen()
SCHEMATIC * Schematic() const
Definition: sch_screen.cpp:88
SCHEMATIC * m_schematic
static void get_components(SCHEMATIC *aSchematic, std::vector< SCH_COMPONENT * > &aComponents)
Fill a vector with all of the project's symbols, to ease iterating over them.

References get_components(), SCH_SHEET_PATH::LastScreen(), m_components, m_currentSheet, m_galBackEndType, m_prj, m_schematic, and SCH_SCREEN::Schematic().

◆ ~RESCUER()

virtual RESCUER::~RESCUER ( )
inlinevirtual

Definition at line 241 of file project_rescue.h.

242  {
243  }

Member Function Documentation

◆ AddPart()

virtual void RESCUER::AddPart ( LIB_PART aNewPart)
pure virtual

◆ DoRescues()

bool RESCUER::DoRescues ( )

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

Returns
True on success

Definition at line 527 of file project_rescue.cpp.

528 {
529  for( RESCUE_CANDIDATE* each_candidate : m_chosen_candidates )
530  {
531  if( ! each_candidate->PerformAction( this ) )
532  return false;
533  }
534 
535  return true;
536 }
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates

References m_chosen_candidates.

Referenced by RescueProject().

◆ FindCandidates()

virtual void RESCUER::FindCandidates ( )
pure virtual

Populate the RESCUER with all possible candidates.

Implemented in SYMBOL_LIB_TABLE_RESCUER, and LEGACY_RESCUER.

Referenced by RescueProject().

◆ GetCandidateCount()

size_t RESCUER::GetCandidateCount ( )
inline

Return the number of rescue candidates found.

Definition at line 278 of file project_rescue.h.

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

References m_all_candidates.

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

◆ GetChosenCandidateCount()

size_t RESCUER::GetChosenCandidateCount ( )
inline

Get the number of rescue candidates chosen by the user.

Definition at line 283 of file project_rescue.h.

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

References m_chosen_candidates.

Referenced by RescueProject().

◆ GetComponents()

◆ GetPrj()

PROJECT* RESCUER::GetPrj ( )
inline

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

Definition at line 293 of file project_rescue.h.

293 { return m_prj; }
PROJECT * m_prj

References m_prj.

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

◆ InvokeDialog()

virtual void RESCUER::InvokeDialog ( wxWindow *  aParent,
bool  aAskShowAgain 
)
pure virtual

Display a dialog to allow the user to select rescues.

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

Implemented in SYMBOL_LIB_TABLE_RESCUER, and LEGACY_RESCUER.

Referenced by RescueProject().

◆ LogRescue()

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

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

Definition at line 516 of file project_rescue.cpp.

518 {
519  RESCUE_LOG logitem;
520  logitem.component = aComponent;
521  logitem.old_name = aOldName;
522  logitem.new_name = aNewName;
523  m_rescue_log.push_back( logitem );
524 }
SCH_COMPONENT * component
std::vector< RESCUE_LOG > m_rescue_log
wxString old_name
wxString new_name

References RESCUE_LOG::component, 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()

virtual void RESCUER::OpenRescueLibrary ( )
pure virtual

Implemented in SYMBOL_LIB_TABLE_RESCUER, and LEGACY_RESCUER.

Referenced by RescueProject().

◆ RemoveDuplicates()

void RESCUER::RemoveDuplicates ( )

Filter out duplicately named rescue candidates.

Definition at line 598 of file project_rescue.cpp.

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

References m_all_candidates.

Referenced by RescueProject().

◆ RescueProject()

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

Definition at line 552 of file project_rescue.cpp.

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

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

◆ Schematic()

SCHEMATIC* RESCUER::Schematic ( )
inline

Definition at line 295 of file project_rescue.h.

295 { return m_schematic; }
SCHEMATIC * m_schematic

References m_schematic.

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

◆ UndoRescues()

void RESCUER::UndoRescues ( )

Reverse the effects of all rescues on the project.

Definition at line 539 of file project_rescue.cpp.

540 {
541  for( RESCUE_LOG& each_logitem : m_rescue_log )
542  {
543  LIB_ID libId;
544 
545  libId.SetLibItemName( each_logitem.old_name, false );
546  each_logitem.component->SetLibId( libId );
547  each_logitem.component->ClearFlags();
548  }
549 }
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:204
std::vector< RESCUE_LOG > m_rescue_log

References m_rescue_log, and LIB_ID::SetLibItemName().

Referenced by RescueProject().

◆ WriteRescueLibrary()

virtual bool RESCUER::WriteRescueLibrary ( wxWindow *  aParent)
pure virtual

Write the rescue library.

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

Returns
True on success.

Implemented in SYMBOL_LIB_TABLE_RESCUER, and LEGACY_RESCUER.

Referenced by RescueProject().

Friends And Related Function Documentation

◆ DIALOG_RESCUE_EACH

friend class DIALOG_RESCUE_EACH
friend

Definition at line 318 of file project_rescue.h.

Member Data Documentation

◆ m_all_candidates

◆ m_chosen_candidates

◆ m_components

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

Definition at line 320 of file project_rescue.h.

Referenced by GetComponents(), and RESCUER().

◆ m_currentSheet

SCH_SHEET_PATH* RESCUER::m_currentSheet
protected

◆ m_galBackEndType

EDA_DRAW_PANEL_GAL::GAL_TYPE RESCUER::m_galBackEndType
protected

◆ m_prj

◆ m_rescue_log

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

Definition at line 329 of file project_rescue.h.

Referenced by LogRescue(), and UndoRescues().

◆ m_schematic


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