KiCad PCB EDA Suite
RESCUE_CACHE_CANDIDATE Class Reference

#include <project_rescue.h>

Inheritance diagram for RESCUE_CACHE_CANDIDATE:
RESCUE_CANDIDATE

Public Member Functions

 RESCUE_CACHE_CANDIDATE (const wxString &aRequestedName, const wxString &aNewName, LIB_PART *aCacheCandidate, LIB_PART *aLibCandidate)
 Constructor RESCUE_CACHE_CANDIDATE. More...
 
 RESCUE_CACHE_CANDIDATE ()
 
virtual LIB_PARTGetCacheCandidate () const override
 Get the part that can be loaded from the project cache, if possible, or else NULL. More...
 
virtual wxString GetActionDescription () const override
 Get a description of the action proposed, for displaying in the UI. More...
 
virtual bool PerformAction (RESCUER *aRescuer) override
 Perform the actual rescue action. More...
 
virtual wxString GetRequestedName () const
 Get the name that was originally requested in the schematic. More...
 
virtual wxString GetNewName () const
 Get the name we're proposing changing it to. More...
 
virtual LIB_PARTGetLibCandidate () const
 Get the part the would be loaded from the libraries, if possible, or else NULL. More...
 

Static Public Member Functions

static void FindRescues (RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
 Grab all possible RESCUE_CACHE_CANDIDATE objectss into a vector. More...
 

Protected Attributes

wxString m_requested_name
 
wxString m_new_name
 
LIB_PARTm_lib_candidate
 

Private Attributes

LIB_PARTm_cache_candidate
 

Detailed Description

Definition at line 140 of file project_rescue.h.

Constructor & Destructor Documentation

◆ RESCUE_CACHE_CANDIDATE() [1/2]

RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE ( const wxString &  aRequestedName,
const wxString &  aNewName,
LIB_PART aCacheCandidate,
LIB_PART aLibCandidate 
)

Constructor RESCUE_CACHE_CANDIDATE.

Parameters
aRequestedName- the name the schematic asks for
aNewName- the name we want to change it to
aCacheCandidate- the part from the cache
aLibCandidate- the part that would be loaded from the library

Definition at line 212 of file project_rescue.cpp.

216 {
217  m_requested_name = aRequestedName;
218  m_new_name = aNewName;
219  m_cache_candidate = aCacheCandidate;
220  m_lib_candidate = aLibCandidate;
221 }
LIB_PART * m_lib_candidate
wxString m_requested_name

References m_cache_candidate, RESCUE_CANDIDATE::m_lib_candidate, RESCUE_CANDIDATE::m_new_name, and RESCUE_CANDIDATE::m_requested_name.

◆ RESCUE_CACHE_CANDIDATE() [2/2]

RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE ( )

Definition at line 224 of file project_rescue.cpp.

225 {
226  m_cache_candidate = NULL;
227  m_lib_candidate = NULL;
228 }
LIB_PART * m_lib_candidate

References m_cache_candidate, and RESCUE_CANDIDATE::m_lib_candidate.

Referenced by FindRescues().

Member Function Documentation

◆ FindRescues()

void RESCUE_CACHE_CANDIDATE::FindRescues ( RESCUER aRescuer,
boost::ptr_vector< RESCUE_CANDIDATE > &  aCandidates 
)
static

Grab all possible RESCUE_CACHE_CANDIDATE objectss into a vector.

Parameters
aRescuer- the working RESCUER instance.
aCandidates- the vector the will hold the candidates.

Definition at line 231 of file project_rescue.cpp.

233 {
234  typedef std::map<wxString, RESCUE_CACHE_CANDIDATE> candidate_map_t;
235  candidate_map_t candidate_map;
236 
237  // Remember the list of components is sorted by part name.
238  // So a search in libraries is made only once by group
239  LIB_PART* cache_match = nullptr;
240  LIB_PART* lib_match = nullptr;
241  wxString old_part_name;
242 
243  for( SCH_COMPONENT* each_component : *( aRescuer.GetComponents() ) )
244  {
245  wxString part_name = each_component->GetLibId().GetLibItemName();
246 
247  if( old_part_name != part_name )
248  {
249  // A new part name is found (a new group starts here).
250  // Search the symbol names candidates only once for this group:
251  old_part_name = part_name;
252  cache_match = find_component( part_name, aRescuer.GetPrj()->SchLibs(), true );
253  lib_match = find_component( part_name, aRescuer.GetPrj()->SchLibs(), false );
254 
255  if( !cache_match && !lib_match )
256  continue;
257 
258  // Test whether there is a conflict or if the symbol can only be found in the cache
259  // and the symbol name does not have any illegal characters.
260  if( LIB_ID::HasIllegalChars( part_name, LIB_ID::ID_SCH ) == -1 )
261  {
262  if( cache_match && lib_match &&
263  !cache_match->PinsConflictWith( *lib_match, true, true, true, true, false ) )
264  continue;
265 
266  if( !cache_match && lib_match )
267  continue;
268  }
269 
270  // Check if the symbol has already been rescued.
271  wxString new_name = LIB_ID::FixIllegalChars( part_name, LIB_ID::ID_SCH );
272 
273  RESCUE_CACHE_CANDIDATE candidate( part_name, new_name, cache_match, lib_match );
274 
275  candidate_map[part_name] = candidate;
276  }
277  }
278 
279  // Now, dump the map into aCandidates
280  for( const candidate_map_t::value_type& each_pair : candidate_map )
281  {
282  aCandidates.push_back( new RESCUE_CACHE_CANDIDATE( each_pair.second ) );
283  }
284 }
bool PinsConflictWith(LIB_PART &aOtherPart, bool aTestNums, bool aTestNames, bool aTestType, bool aTestOrientation, bool aTestLength)
Return true if this part's pins do not match another part's pins.
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
PROJECT * GetPrj()
Return the #SCH_PROJECT object for access to the symbol libraries.
static int HasIllegalChars(const UTF8 &aLibItemName, LIB_ID_TYPE aType)
Examine aLibItemName for invalid LIB_ID item name characters.
Definition: lib_id.cpp:336
const LIB_ID & GetLibId() const
Define a library symbol object.
static LIB_PART * find_component(const wxString &aName, PART_LIBS *aLibs, bool aCached)
Search the libraries for the first component with a given name.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
std::vector< SCH_COMPONENT * > * GetComponents()
Get the list of symbols that need rescued.
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, LIB_ID_TYPE aType, bool aLib=false)
Replace illegal LIB_ID item name characters with underscores '_'.
Definition: lib_id.cpp:352

References find_component(), LIB_ID::FixIllegalChars(), RESCUER::GetComponents(), LIB_PART::GetLibId(), LIB_ID::GetLibItemName(), RESCUER::GetPrj(), LIB_ID::HasIllegalChars(), LIB_ID::ID_SCH, LIB_PART::PinsConflictWith(), and RESCUE_CACHE_CANDIDATE().

Referenced by LEGACY_RESCUER::FindCandidates().

◆ GetActionDescription()

wxString RESCUE_CACHE_CANDIDATE::GetActionDescription ( ) const
overridevirtual

Get a description of the action proposed, for displaying in the UI.

Implements RESCUE_CANDIDATE.

Definition at line 287 of file project_rescue.cpp.

288 {
289  wxString action;
290 
292  action.Printf( _( "Cannot rescue symbol %s which is not available in any library or "
293  "the cache." ), m_requested_name );
294  else if( m_cache_candidate && !m_lib_candidate )
295  action.Printf( _( "Rescue symbol %s found only in cache library to %s." ),
297  else
298  action.Printf( _( "Rescue modified symbol %s to %s" ),
300 
301  return action;
302 }
LIB_PART * m_lib_candidate
#define _(s)
wxString m_requested_name

References _, m_cache_candidate, RESCUE_CANDIDATE::m_lib_candidate, RESCUE_CANDIDATE::m_new_name, and RESCUE_CANDIDATE::m_requested_name.

◆ GetCacheCandidate()

virtual LIB_PART* RESCUE_CACHE_CANDIDATE::GetCacheCandidate ( ) const
inlineoverridevirtual

Get the part that can be loaded from the project cache, if possible, or else NULL.

Reimplemented from RESCUE_CANDIDATE.

Definition at line 165 of file project_rescue.h.

165 { return m_cache_candidate; }

References m_cache_candidate.

◆ GetLibCandidate()

virtual LIB_PART* RESCUE_CANDIDATE::GetLibCandidate ( ) const
inlinevirtualinherited

Get the part the would be loaded from the libraries, if possible, or else NULL.

Definition at line 96 of file project_rescue.h.

96 { return m_lib_candidate; }
LIB_PART * m_lib_candidate

References RESCUE_CANDIDATE::m_lib_candidate.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ GetNewName()

virtual wxString RESCUE_CANDIDATE::GetNewName ( ) const
inlinevirtualinherited

Get the name we're proposing changing it to.

Definition at line 84 of file project_rescue.h.

84 { return m_new_name; }

References RESCUE_CANDIDATE::m_new_name.

◆ GetRequestedName()

virtual wxString RESCUE_CANDIDATE::GetRequestedName ( ) const
inlinevirtualinherited

Get the name that was originally requested in the schematic.

Definition at line 79 of file project_rescue.h.

79 { return m_requested_name; }
wxString m_requested_name

References RESCUE_CANDIDATE::m_requested_name.

Referenced by DIALOG_RESCUE_EACH::PopulateConflictList(), and DIALOG_RESCUE_EACH::PopulateInstanceList().

◆ PerformAction()

bool RESCUE_CACHE_CANDIDATE::PerformAction ( RESCUER aRescuer)
overridevirtual

Perform the actual rescue action.

If successful, this must log the rescue using RESCUER::LogRescue to allow it to be reversed.

Returns
True on success.

Implements RESCUE_CANDIDATE.

Definition at line 305 of file project_rescue.cpp.

306 {
308 
309  wxCHECK_MSG( tmp, false, "Both cache and library symbols undefined." );
310 
311  LIB_PART new_part( *tmp );
312  new_part.SetName( m_new_name );
313  new_part.RemoveAllAliases();
314  aRescuer->AddPart( &new_part );
315 
316  for( SCH_COMPONENT* each_component : *aRescuer->GetComponents() )
317  {
318  if( each_component->GetLibId().GetLibItemName() != UTF8( m_requested_name ) )
319  continue;
320 
321  LIB_ID libId;
322 
323  libId.SetLibItemName( m_new_name, false );
324  each_component->SetLibId( libId );
325  each_component->ClearFlags();
326  aRescuer->LogRescue( each_component, m_requested_name, m_new_name );
327  }
328 
329  return true;
330 }
Class UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion supp...
Definition: utf8.h:73
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
LIB_PART * m_lib_candidate
Define a library symbol object.
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
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
virtual void AddPart(LIB_PART *aNewPart)=0
std::vector< SCH_COMPONENT * > * GetComponents()
Get the list of symbols that need rescued.
void LogRescue(SCH_COMPONENT *aComponent, const wxString &aOldName, const wxString &aNewName)
Used by individual RESCUE_CANDIDATE objects to log a rescue for undoing.
wxString m_requested_name

References RESCUER::AddPart(), RESCUER::GetComponents(), RESCUER::LogRescue(), m_cache_candidate, RESCUE_CANDIDATE::m_lib_candidate, RESCUE_CANDIDATE::m_new_name, RESCUE_CANDIDATE::m_requested_name, LIB_PART::RemoveAllAliases(), LIB_ID::SetLibItemName(), and LIB_PART::SetName().

Member Data Documentation

◆ m_cache_candidate

LIB_PART* RESCUE_CACHE_CANDIDATE::m_cache_candidate
private

◆ m_lib_candidate

◆ m_new_name

◆ m_requested_name


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