KiCad PCB EDA Suite
SYMBOL_LIB_TABLE_RESCUER Class Reference

#include <project_rescue.h>

Inheritance diagram for SYMBOL_LIB_TABLE_RESCUER:
RESCUER

Public Member Functions

 SYMBOL_LIB_TABLE_RESCUER (PROJECT &aProject, SCHEMATIC *aSchematic, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)
 
virtual ~SYMBOL_LIB_TABLE_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

SCH_PLUGIN::SCH_PLUGIN_RELEASER m_pi
 
std::unique_ptr< PROPERTIESm_properties
 Library plugin properties. More...
 

Detailed Description

Definition at line 356 of file project_rescue.h.

Constructor & Destructor Documentation

◆ SYMBOL_LIB_TABLE_RESCUER()

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

Definition at line 761 of file project_rescue.cpp.

763  :
764  RESCUER( aProject, aSchematic, aCurrentSheet, aGalBackEndType )
765 {
766  m_properties = std::make_unique<PROPERTIES>();
767 }
RESCUER(PROJECT &aProject, SCHEMATIC *aSchematic, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)
std::unique_ptr< PROPERTIES > m_properties
Library plugin properties.

References m_properties.

◆ ~SYMBOL_LIB_TABLE_RESCUER()

virtual SYMBOL_LIB_TABLE_RESCUER::~SYMBOL_LIB_TABLE_RESCUER ( )
inlinevirtual

Definition at line 368 of file project_rescue.h.

369  {
370  }

Member Function Documentation

◆ AddPart()

void SYMBOL_LIB_TABLE_RESCUER::AddPart ( LIB_PART aNewPart)
overridevirtual

Implements RESCUER.

Definition at line 849 of file project_rescue.cpp.

850 {
851  wxCHECK_RET( aNewPart, "Invalid LIB_PART pointer." );
852 
853  wxFileName fn = GetRescueLibraryFileName( m_schematic );
854 
855  try
856  {
857  if( !m_prj->SchSymbolLibTable()->HasLibrary( fn.GetName() ) )
858  m_pi->SaveSymbol( fn.GetFullPath(), new LIB_PART( *aNewPart ), m_properties.get() );
859  else
860  m_prj->SchSymbolLibTable()->SaveSymbol( fn.GetName(), new LIB_PART( *aNewPart ) );
861  }
862  catch( ... /* IO_ERROR */ )
863  {
864  }
865 }
static wxFileName GetRescueLibraryFileName(SCHEMATIC *aSchematic)
SCH_PLUGIN::SCH_PLUGIN_RELEASER m_pi
std::unique_ptr< PROPERTIES > m_properties
Library plugin properties.
Define a library symbol object.
PROJECT * m_prj
SCHEMATIC * m_schematic

References GetRescueLibraryFileName(), m_pi, RESCUER::m_prj, m_properties, and RESCUER::m_schematic.

◆ 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 SYMBOL_LIB_TABLE_RESCUER::FindCandidates ( )
overridevirtual

Populate the RESCUER with all possible candidates.

Implements RESCUER.

Definition at line 770 of file project_rescue.cpp.

771 {
773 }
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates
static void FindRescues(RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
Grab all possible RESCUE_SYMBOL_LIB_TABLE_CANDIDATE objects into a vector.

References RESCUE_SYMBOL_LIB_TABLE_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 SYMBOL_LIB_TABLE_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 776 of file project_rescue.cpp.

777 {
778  InvokeDialogRescueEach( aParent, static_cast< RESCUER& >( *this ), m_currentSheet,
779  m_galBackEndType, aAskShowAgain );
780 }
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 SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary ( )
overridevirtual

Implements RESCUER.

Definition at line 783 of file project_rescue.cpp.

784 {
785  m_pi.set( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_LEGACY ) );
786  (*m_properties)[ SCH_LEGACY_PLUGIN::PropBuffering ] = "";
787 }
void set(SCH_PLUGIN *aPlugin)
Definition: sch_io_mgr.h:496
SCH_PLUGIN::SCH_PLUGIN_RELEASER m_pi
static const char * PropBuffering
The property used internally by the plugin to enable cache buffering which prevents the library file ...

References m_pi, SCH_LEGACY_PLUGIN::PropBuffering, and SCH_PLUGIN::SCH_PLUGIN_RELEASER::set().

◆ 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 SYMBOL_LIB_TABLE_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 790 of file project_rescue.cpp.

791 {
792  wxString msg;
793  wxFileName fn = GetRescueLibraryFileName( m_schematic );
794 
795  // If the rescue library already exists in the symbol library table no need save it to add
796  // it to the table.
797  if( !m_prj->SchSymbolLibTable()->HasLibrary( fn.GetName() ) )
798  {
799  try
800  {
801  m_pi->SaveLibrary( fn.GetFullPath() );
802  }
803  catch( const IO_ERROR& ioe )
804  {
805  msg.Printf( _( "Failed to save rescue library %s." ), fn.GetFullPath() );
806  DisplayErrorMessage( aParent, msg, ioe.What() );
807  return false;
808  }
809 
810  wxString uri = "${KIPRJMOD}/" + fn.GetFullName();
811  wxString libNickname = fn.GetName();
812 
813  // Spaces in the file name will break the symbol name because they are not
814  // quoted in the symbol library file format.
815  libNickname.Replace( " ", "-" );
816 
817  SYMBOL_LIB_TABLE_ROW* row = new SYMBOL_LIB_TABLE_ROW( libNickname, uri,
818  wxString( "Legacy" ) );
819  m_prj->SchSymbolLibTable()->InsertRow( row );
820 
822 
823  try
824  {
825  m_prj->SchSymbolLibTable()->Save( fn.GetFullPath() );
826  }
827  catch( const IO_ERROR& ioe )
828  {
829  msg.Printf( _( "Error occurred saving project specific symbol library table." ) );
830  DisplayErrorMessage( aParent, msg, ioe.What() );
831  return false;
832  }
833  }
834 
835  // Relaod the symbol library table.
837 
838  // This can only happen if the symbol library table file was currupted on write.
839  if( !m_prj->SchSymbolLibTable() )
840  return false;
841 
842  // Update the schematic symbol library links since the library list has changed.
843  SCH_SCREENS schematic( m_schematic->Root() );
844  schematic.UpdateSymbolLinks();
845  return true;
846 }
static const wxString & GetSymbolLibTableFileName()
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:252
static wxFileName GetRescueLibraryFileName(SCHEMATIC *aSchematic)
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:122
VTBL_ENTRY void SetElem(ELEM_T aIndex, _ELEM *aElem)
Definition: project.cpp:252
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
SCH_PLUGIN::SCH_PLUGIN_RELEASER m_pi
PROJECT * m_prj
SCH_SHEET & Root() const
Definition: schematic.h:97
#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:546

References _, DisplayErrorMessage(), PROJECT::ELEM_SYMBOL_LIB_TABLE, PROJECT::GetProjectPath(), GetRescueLibraryFileName(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), m_pi, RESCUER::m_prj, RESCUER::m_schematic, NULL, SCHEMATIC::Root(), PROJECT::SetElem(), SCH_SCREENS::UpdateSymbolLinks(), and IO_ERROR::What().

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

Definition at line 240 of file project_rescue.h.

Referenced by LEGACY_RESCUER::InvokeDialog(), InvokeDialog(), and RESCUER::RESCUER().

◆ m_galBackEndType

EDA_DRAW_PANEL_GAL::GAL_TYPE RESCUER::m_galBackEndType
protectedinherited

Definition at line 239 of file project_rescue.h.

Referenced by LEGACY_RESCUER::InvokeDialog(), InvokeDialog(), and RESCUER::RESCUER().

◆ m_pi

SCH_PLUGIN::SCH_PLUGIN_RELEASER SYMBOL_LIB_TABLE_RESCUER::m_pi
private

Definition at line 359 of file project_rescue.h.

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

◆ m_prj

◆ m_properties

std::unique_ptr< PROPERTIES > SYMBOL_LIB_TABLE_RESCUER::m_properties
private

Library plugin properties.

Definition at line 361 of file project_rescue.h.

Referenced by AddPart(), and SYMBOL_LIB_TABLE_RESCUER().

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