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
 Writes out 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 ()
 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
 

Friends

class DIALOG_RESCUE_EACH
 

Detailed Description

Definition at line 231 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 499 of file project_rescue.cpp.

501 {
502  m_schematic = aSchematic ? aSchematic : aCurrentSheet->LastScreen()->Schematic();
503 
504  wxASSERT( m_schematic );
505 
506  if( m_schematic )
508 
509  m_prj = &aProject;
510  m_currentSheet = aCurrentSheet;
511  m_galBackEndType = aGalBackEndType;
512 }
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()
Function LastScreen.
SCHEMATIC * Schematic() const
Definition: sch_screen.cpp:93
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 251 of file project_rescue.h.

252  {
253  }

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 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 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

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

302 { 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 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, 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 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 m_all_candidates.

Referenced by RescueProject().

◆ RescueProject()

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

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 _, 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 304 of file project_rescue.h.

304 { 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 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 m_rescue_log, and LIB_ID::SetLibItemName().

Referenced by RescueProject().

◆ WriteRescueLibrary()

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

Writes out 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 234 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 236 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 245 of file project_rescue.h.

Referenced by LogRescue(), and UndoRescues().

◆ m_schematic


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