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 139 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 207 of file project_rescue.cpp.

211 {
212  m_requested_name = aRequestedName;
213  m_new_name = aNewName;
214  m_cache_candidate = aCacheCandidate;
215  m_lib_candidate = aLibCandidate;
216 }
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 219 of file project_rescue.cpp.

220 {
223 }
LIB_PART * m_lib_candidate
#define NULL

References m_cache_candidate, RESCUE_CANDIDATE::m_lib_candidate, and NULL.

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 226 of file project_rescue.cpp.

228 {
229  typedef std::map<wxString, RESCUE_CACHE_CANDIDATE> candidate_map_t;
230  candidate_map_t candidate_map;
231 
232  // Remember the list of components is sorted by part name.
233  // So a search in libraries is made only once by group
234  LIB_PART* cache_match = nullptr;
235  LIB_PART* lib_match = nullptr;
236  wxString old_part_name;
237 
238  for( SCH_COMPONENT* each_component : *( aRescuer.GetComponents() ) )
239  {
240  wxString part_name = each_component->GetLibId().GetLibItemName();
241 
242  if( old_part_name != part_name )
243  {
244  // A new part name is found (a new group starts here).
245  // Search the symbol names candidates only once for this group:
246  old_part_name = part_name;
247  cache_match = find_component( part_name, aRescuer.GetPrj()->SchLibs(), true );
248  lib_match = find_component( part_name, aRescuer.GetPrj()->SchLibs(), false );
249 
250  if( !cache_match && !lib_match )
251  continue;
252 
253  // Test whether there is a conflict or if the symbol can only be found in the cache
254  // and the symbol name does not have any illegal characters.
255  if( LIB_ID::HasIllegalChars( part_name, LIB_ID::ID_SCH ) == -1 )
256  {
257  if( cache_match && lib_match &&
258  !cache_match->PinsConflictWith( *lib_match, true, true, true, true, false ) )
259  continue;
260 
261  if( !cache_match && lib_match )
262  continue;
263  }
264 
265  // Check if the symbol has already been rescued.
266  wxString new_name = LIB_ID::FixIllegalChars( part_name, LIB_ID::ID_SCH );
267 
268  RESCUE_CACHE_CANDIDATE candidate( part_name, new_name, cache_match, lib_match );
269 
270  candidate_map[part_name] = candidate;
271  }
272  }
273 
274  // Now, dump the map into aCandidates
275  for( const candidate_map_t::value_type& each_pair : candidate_map )
276  {
277  aCandidates.push_back( new RESCUE_CACHE_CANDIDATE( each_pair.second ) );
278  }
279 }
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
LIB_ID GetLibId() const override
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
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.
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:99
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 282 of file project_rescue.cpp.

283 {
284  wxString action;
285 
287  action.Printf( _( "Cannot rescue symbol %s which is not available in any library or "
288  "the cache." ), m_requested_name );
289  else if( m_cache_candidate && !m_lib_candidate )
290  action.Printf( _( "Rescue symbol %s found only in cache library to %s." ),
292  else
293  action.Printf( _( "Rescue modified symbol %s to %s" ),
295 
296  return action;
297 }
LIB_PART * m_lib_candidate
#define _(s)
Definition: 3d_actions.cpp:33
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 164 of file project_rescue.h.

164 { 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 95 of file project_rescue.h.

95 { 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 83 of file project_rescue.h.

83 { 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 78 of file project_rescue.h.

78 { 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 300 of file project_rescue.cpp.

301 {
303 
304  wxCHECK_MSG( tmp, false, "Both cache and library symbols undefined." );
305 
306  LIB_PART new_part( *tmp );
307  new_part.SetName( m_new_name );
308  aRescuer->AddPart( &new_part );
309 
310  for( SCH_COMPONENT* each_component : *aRescuer->GetComponents() )
311  {
312  if( each_component->GetLibId().GetLibItemName() != UTF8( m_requested_name ) )
313  continue;
314 
315  LIB_ID libId;
316 
317  libId.SetLibItemName( m_new_name, false );
318  each_component->SetLibId( libId );
319  each_component->ClearFlags();
320  aRescuer->LogRescue( each_component, m_requested_name, m_new_name );
321  }
322 
323  return true;
324 }
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
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
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:99
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_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: