928 lines
26 KiB
C++
928 lines
26 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@gmail.com>
|
|
* Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#include <sch_screen.h>
|
|
#include <sch_item.h>
|
|
#include <sch_marker.h>
|
|
#include <sch_reference_list.h>
|
|
#include <class_library.h>
|
|
#include <sch_sheet_path.h>
|
|
#include <sch_component.h>
|
|
#include <sch_sheet.h>
|
|
#include <schematic.h>
|
|
#include <template_fieldnames.h>
|
|
#include <trace_helpers.h>
|
|
|
|
#include <boost/functional/hash.hpp>
|
|
#include <wx/filename.h>
|
|
#include "erc_item.h"
|
|
|
|
|
|
/**
|
|
* A singleton item of this class is returned for a weak reference that no longer exists.
|
|
* Its sole purpose is to flag the item as having been deleted.
|
|
*/
|
|
class DELETED_SHEET_ITEM : public SCH_ITEM
|
|
{
|
|
public:
|
|
DELETED_SHEET_ITEM() :
|
|
SCH_ITEM( nullptr, NOT_USED )
|
|
{}
|
|
|
|
wxString GetSelectMenuText( EDA_UNITS aUnits ) const override
|
|
{
|
|
return _( "(Deleted Item)" );
|
|
}
|
|
|
|
wxString GetClass() const override
|
|
{
|
|
return wxT( "DELETED_SHEET_ITEM" );
|
|
}
|
|
|
|
static DELETED_SHEET_ITEM* GetInstance()
|
|
{
|
|
static DELETED_SHEET_ITEM* item = nullptr;
|
|
|
|
if( !item )
|
|
item = new DELETED_SHEET_ITEM();
|
|
|
|
return item;
|
|
}
|
|
|
|
// pure virtuals:
|
|
void SetPosition( const wxPoint& ) override {}
|
|
void Print( RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override {}
|
|
void Move( const wxPoint& aMoveVector ) override {}
|
|
void MirrorY( int aYaxis_position ) override {}
|
|
void MirrorX( int aXaxis_position ) override {}
|
|
void Rotate( wxPoint aPosition ) override {}
|
|
|
|
#if defined(DEBUG)
|
|
void Show( int , std::ostream& ) const override {}
|
|
#endif
|
|
};
|
|
|
|
|
|
namespace std
|
|
{
|
|
size_t hash<SCH_SHEET_PATH>::operator()( const SCH_SHEET_PATH& path ) const
|
|
{
|
|
return path.GetCurrentHash();
|
|
}
|
|
}
|
|
|
|
|
|
SCH_SHEET_PATH::SCH_SHEET_PATH()
|
|
{
|
|
m_pageNumber = 0;
|
|
m_current_hash = 0;
|
|
}
|
|
|
|
|
|
SCH_SHEET_PATH::SCH_SHEET_PATH( const SCH_SHEET_PATH& aOther )
|
|
{
|
|
initFromOther( aOther );
|
|
}
|
|
|
|
|
|
SCH_SHEET_PATH& SCH_SHEET_PATH::operator=( const SCH_SHEET_PATH& aOther )
|
|
{
|
|
initFromOther( aOther );
|
|
return *this;
|
|
}
|
|
|
|
|
|
void SCH_SHEET_PATH::initFromOther( const SCH_SHEET_PATH& aOther )
|
|
{
|
|
m_sheets = aOther.m_sheets;
|
|
m_pageNumber = aOther.m_pageNumber;
|
|
m_current_hash = aOther.m_current_hash;
|
|
|
|
// Note: don't copy m_recursion_test_cache as it is slow and we want SCH_SHEET_PATHS to be
|
|
// very fast to construct for use in the connectivity algorithm.
|
|
}
|
|
|
|
|
|
void SCH_SHEET_PATH::Rehash()
|
|
{
|
|
m_current_hash = 0;
|
|
|
|
for( auto sheet : m_sheets )
|
|
boost::hash_combine( m_current_hash, sheet->m_Uuid.Hash() );
|
|
}
|
|
|
|
|
|
int SCH_SHEET_PATH::Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const
|
|
{
|
|
if( size() > aSheetPathToTest.size() )
|
|
return 1;
|
|
|
|
if( size() < aSheetPathToTest.size() )
|
|
return -1;
|
|
|
|
//otherwise, same number of sheets.
|
|
for( unsigned i = 0; i < size(); i++ )
|
|
{
|
|
if( at( i )->m_Uuid < aSheetPathToTest.at( i )->m_Uuid )
|
|
return -1;
|
|
|
|
if( at( i )->m_Uuid != aSheetPathToTest.at( i )->m_Uuid )
|
|
return 1;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
SCH_SHEET* SCH_SHEET_PATH::Last() const
|
|
{
|
|
if( !empty() )
|
|
return m_sheets.back();
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
SCH_SCREEN* SCH_SHEET_PATH::LastScreen()
|
|
{
|
|
SCH_SHEET* lastSheet = Last();
|
|
|
|
if( lastSheet )
|
|
return lastSheet->GetScreen();
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
SCH_SCREEN* SCH_SHEET_PATH::LastScreen() const
|
|
{
|
|
SCH_SHEET* lastSheet = Last();
|
|
|
|
if( lastSheet )
|
|
return lastSheet->GetScreen();
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
wxString SCH_SHEET_PATH::PathAsString() const
|
|
{
|
|
wxString s;
|
|
|
|
s = wxT( "/" ); // This is the root path
|
|
|
|
// Start at 1 to avoid the root sheet, which does not need to be added to the path.
|
|
// It's timestamp changes anyway.
|
|
for( unsigned i = 1; i < size(); i++ )
|
|
s += at( i )->m_Uuid.AsString() + "/";
|
|
|
|
return s;
|
|
}
|
|
|
|
|
|
KIID_PATH SCH_SHEET_PATH::Path() const
|
|
{
|
|
KIID_PATH path;
|
|
|
|
for( const SCH_SHEET* sheet : m_sheets )
|
|
path.push_back( sheet->m_Uuid );
|
|
|
|
return path;
|
|
}
|
|
|
|
|
|
KIID_PATH SCH_SHEET_PATH::PathWithoutRootUuid() const
|
|
{
|
|
KIID_PATH path;
|
|
|
|
for( size_t i = 1; i < size(); i++ )
|
|
path.push_back( at( i )->m_Uuid );
|
|
|
|
return path;
|
|
}
|
|
|
|
|
|
wxString SCH_SHEET_PATH::GetRootPathName( bool aUseShortName )
|
|
{
|
|
// return a PathName for the root sheet (like "/" or "<root>"
|
|
// DO NOT use it in netlists, because it can easily break these netlists
|
|
// especially after translation, because many netlists (i.e. spice) do not accept any char
|
|
// Use only the short name ("/") and the full name only in messages
|
|
return aUseShortName ? wxT( "/" ) : _( "<root_sheet>" );
|
|
}
|
|
|
|
|
|
wxString SCH_SHEET_PATH::PathHumanReadable() const
|
|
{
|
|
wxString s;
|
|
|
|
if( size() == 1 )
|
|
return GetRootPathName( true ); // Use only the short name in netlists
|
|
|
|
s = wxT( "/" );
|
|
|
|
// Start at 1 to avoid the root sheet, as above.
|
|
for( unsigned i = 1; i < size(); i++ )
|
|
s = s + at( i )->GetFields()[ SHEETNAME ].GetShownText() + wxT( "/" );
|
|
|
|
return s;
|
|
}
|
|
|
|
|
|
void SCH_SHEET_PATH::UpdateAllScreenReferences()
|
|
{
|
|
for( auto item : LastScreen()->Items().OfType( SCH_COMPONENT_T ) )
|
|
{
|
|
auto component = static_cast<SCH_COMPONENT*>( item );
|
|
component->GetField( REFERENCE )->SetText( component->GetRef( this ) );
|
|
component->GetField( VALUE )->SetText( component->GetValue( this ) );
|
|
component->GetField( FOOTPRINT )->SetText( component->GetFootprint( this ) );
|
|
component->UpdateUnit( component->GetUnitSelection( this ) );
|
|
}
|
|
}
|
|
|
|
|
|
|
|
void SCH_SHEET_PATH::GetComponents( SCH_REFERENCE_LIST& aReferences, bool aIncludePowerSymbols,
|
|
bool aForceIncludeOrphanComponents ) const
|
|
{
|
|
for( SCH_ITEM* item : LastScreen()->Items().OfType( SCH_COMPONENT_T ) )
|
|
{
|
|
SCH_COMPONENT* component = static_cast<SCH_COMPONENT*>( item );
|
|
|
|
// Skip pseudo components, which have a reference starting with #. This mainly
|
|
// affects power symbols.
|
|
if( aIncludePowerSymbols || component->GetRef( this )[0] != wxT( '#' ) )
|
|
{
|
|
LIB_PART* part = component->GetPartRef().get();
|
|
|
|
if( part || aForceIncludeOrphanComponents )
|
|
{
|
|
SCH_REFERENCE schReference( component, part, *this );
|
|
|
|
schReference.SetSheetNumber( m_pageNumber );
|
|
aReferences.AddItem( schReference );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET_PATH::GetMultiUnitComponents( SCH_MULTI_UNIT_REFERENCE_MAP& aRefList,
|
|
bool aIncludePowerSymbols ) const
|
|
{
|
|
for( auto item : LastScreen()->Items().OfType( SCH_COMPONENT_T ) )
|
|
{
|
|
auto component = static_cast<SCH_COMPONENT*>( item );
|
|
|
|
// Skip pseudo components, which have a reference starting with #. This mainly
|
|
// affects power symbols.
|
|
if( !aIncludePowerSymbols && component->GetRef( this )[0] == wxT( '#' ) )
|
|
continue;
|
|
|
|
LIB_PART* part = component->GetPartRef().get();
|
|
|
|
if( part && part->GetUnitCount() > 1 )
|
|
{
|
|
SCH_REFERENCE schReference = SCH_REFERENCE( component, part, *this );
|
|
schReference.SetSheetNumber( m_pageNumber );
|
|
wxString reference_str = schReference.GetRef();
|
|
|
|
// Never lock unassigned references
|
|
if( reference_str[reference_str.Len() - 1] == '?' )
|
|
continue;
|
|
|
|
aRefList[reference_str].AddItem( schReference );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_SHEET_PATH::operator==( const SCH_SHEET_PATH& d1 ) const
|
|
{
|
|
return m_current_hash == d1.GetCurrentHash();
|
|
}
|
|
|
|
|
|
bool SCH_SHEET_PATH::TestForRecursion( const wxString& aSrcFileName, const wxString& aDestFileName )
|
|
{
|
|
auto pair = std::make_pair( aSrcFileName, aDestFileName );
|
|
|
|
if( m_recursion_test_cache.count( pair ) )
|
|
return m_recursion_test_cache.at( pair );
|
|
|
|
SCHEMATIC* sch = LastScreen()->Schematic();
|
|
|
|
wxCHECK_MSG( sch, false, "No SCHEMATIC found in SCH_SHEET_PATH::TestForRecursion!" );
|
|
|
|
wxFileName rootFn = sch->GetFileName();
|
|
wxFileName srcFn = aSrcFileName;
|
|
wxFileName destFn = aDestFileName;
|
|
|
|
if( srcFn.IsRelative() )
|
|
srcFn.MakeAbsolute( rootFn.GetPath() );
|
|
|
|
if( destFn.IsRelative() )
|
|
destFn.MakeAbsolute( rootFn.GetPath() );
|
|
|
|
|
|
// The source and destination sheet file names cannot be the same.
|
|
if( srcFn == destFn )
|
|
{
|
|
m_recursion_test_cache[pair] = true;
|
|
return true;
|
|
}
|
|
|
|
/// @todo Store sheet file names with full path, either relative to project path
|
|
/// or absolute path. The current design always assumes subsheet files are
|
|
/// located in the project folder which may or may not be desirable.
|
|
unsigned i = 0;
|
|
|
|
while( i < size() )
|
|
{
|
|
wxFileName cmpFn = at( i )->GetFileName();
|
|
|
|
if( cmpFn.IsRelative() )
|
|
cmpFn.MakeAbsolute( rootFn.GetPath() );
|
|
|
|
// Test if the file name of the destination sheet is in anywhere in this sheet path.
|
|
if( cmpFn == destFn )
|
|
break;
|
|
|
|
i++;
|
|
}
|
|
|
|
// The destination sheet file name was not found in the sheet path or the destination
|
|
// sheet file name is the root sheet so no recursion is possible.
|
|
if( i >= size() || i == 0 )
|
|
{
|
|
m_recursion_test_cache[pair] = false;
|
|
return false;
|
|
}
|
|
|
|
// Walk back up to the root sheet to see if the source file name is already a parent in
|
|
// the sheet path. If so, recursion will occur.
|
|
do
|
|
{
|
|
i -= 1;
|
|
|
|
wxFileName cmpFn = at( i )->GetFileName();
|
|
|
|
if( cmpFn.IsRelative() )
|
|
cmpFn.MakeAbsolute( rootFn.GetPath() );
|
|
|
|
if( cmpFn == srcFn )
|
|
{
|
|
m_recursion_test_cache[pair] = true;
|
|
return true;
|
|
}
|
|
|
|
} while( i != 0 );
|
|
|
|
// The source sheet file name is not a parent of the destination sheet file name.
|
|
m_recursion_test_cache[pair] = false;
|
|
return false;
|
|
}
|
|
|
|
|
|
wxString SCH_SHEET_PATH::GetPageNumber() const
|
|
{
|
|
SCH_SHEET* sheet = Last();
|
|
|
|
wxCHECK( sheet, wxEmptyString );
|
|
|
|
return sheet->GetPageNumber( *this );
|
|
}
|
|
|
|
|
|
void SCH_SHEET_PATH::SetPageNumber( const wxString& aPageNumber )
|
|
{
|
|
SCH_SHEET* sheet = Last();
|
|
|
|
wxCHECK( sheet, /* void */ );
|
|
|
|
sheet->SetPageNumber( *this, aPageNumber );
|
|
}
|
|
|
|
|
|
SCH_SHEET_LIST::SCH_SHEET_LIST( SCH_SHEET* aSheet, bool aCheckIntegrity )
|
|
{
|
|
if( aSheet != NULL )
|
|
BuildSheetList( aSheet, aCheckIntegrity );
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::BuildSheetList( SCH_SHEET* aSheet, bool aCheckIntegrity )
|
|
{
|
|
wxCHECK_RET( aSheet != NULL, wxT( "Cannot build sheet list from undefined sheet." ) );
|
|
|
|
std::vector<SCH_SHEET*> badSheets;
|
|
|
|
m_currentSheetPath.push_back( aSheet );
|
|
|
|
push_back( m_currentSheetPath );
|
|
|
|
if( m_currentSheetPath.LastScreen() )
|
|
{
|
|
wxString parentFileName = aSheet->GetFileName();
|
|
std::vector<SCH_ITEM*> childSheets;
|
|
m_currentSheetPath.LastScreen()->GetSheets( &childSheets );
|
|
|
|
for( SCH_ITEM* item : childSheets )
|
|
{
|
|
SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
|
|
|
|
if( aCheckIntegrity )
|
|
{
|
|
if( !m_currentSheetPath.TestForRecursion( sheet->GetFileName(), parentFileName ) )
|
|
BuildSheetList( sheet, true );
|
|
else
|
|
badSheets.push_back( sheet );
|
|
}
|
|
else
|
|
{
|
|
BuildSheetList( sheet, false );
|
|
}
|
|
}
|
|
}
|
|
|
|
if( aCheckIntegrity )
|
|
{
|
|
for( SCH_SHEET* sheet : badSheets )
|
|
{
|
|
m_currentSheetPath.LastScreen()->Remove( sheet );
|
|
m_currentSheetPath.LastScreen()->SetModify();
|
|
}
|
|
}
|
|
|
|
m_currentSheetPath.pop_back();
|
|
}
|
|
|
|
|
|
bool SCH_SHEET_LIST::NameExists( const wxString& aSheetName )
|
|
{
|
|
for( const SCH_SHEET_PATH& sheet : *this )
|
|
{
|
|
if( sheet.Last()->GetName() == aSheetName )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET_LIST::IsModified()
|
|
{
|
|
for( const SCH_SHEET_PATH& sheet : *this )
|
|
{
|
|
if( sheet.LastScreen() && sheet.LastScreen()->IsModify() )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::ClearModifyStatus()
|
|
{
|
|
for( const SCH_SHEET_PATH& sheet : *this )
|
|
{
|
|
if( sheet.LastScreen() )
|
|
sheet.LastScreen()->ClrModify();
|
|
}
|
|
}
|
|
|
|
|
|
SCH_ITEM* SCH_SHEET_LIST::GetItem( const KIID& aID, SCH_SHEET_PATH* aPathOut )
|
|
{
|
|
for( const SCH_SHEET_PATH& sheet : *this )
|
|
{
|
|
SCH_SCREEN* screen = sheet.LastScreen();
|
|
|
|
for( SCH_ITEM* aItem : screen->Items() )
|
|
{
|
|
if( aItem->m_Uuid == aID )
|
|
{
|
|
if( aPathOut )
|
|
*aPathOut = sheet;
|
|
|
|
return aItem;
|
|
}
|
|
else if( aItem->Type() == SCH_COMPONENT_T )
|
|
{
|
|
SCH_COMPONENT* comp = static_cast<SCH_COMPONENT*>( aItem );
|
|
|
|
for( SCH_FIELD& field : comp->GetFields() )
|
|
{
|
|
if( field.m_Uuid == aID )
|
|
{
|
|
if( aPathOut )
|
|
*aPathOut = sheet;
|
|
|
|
return &field;
|
|
}
|
|
}
|
|
|
|
for( SCH_PIN* pin : comp->GetPins() )
|
|
{
|
|
if( pin->m_Uuid == aID )
|
|
{
|
|
if( aPathOut )
|
|
*aPathOut = sheet;
|
|
|
|
return pin;
|
|
}
|
|
}
|
|
}
|
|
else if( aItem->Type() == SCH_SHEET_T )
|
|
{
|
|
SCH_SHEET* sch_sheet = static_cast<SCH_SHEET*>( aItem );
|
|
|
|
for( SCH_FIELD& field : sch_sheet->GetFields() )
|
|
{
|
|
if( field.m_Uuid == aID )
|
|
{
|
|
if( aPathOut )
|
|
*aPathOut = sheet;
|
|
return &field;
|
|
}
|
|
}
|
|
|
|
for( SCH_SHEET_PIN* pin : sch_sheet->GetPins() )
|
|
{
|
|
if( pin->m_Uuid == aID )
|
|
{
|
|
if( aPathOut )
|
|
*aPathOut = sheet;
|
|
|
|
return pin;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Not found; weak reference has been deleted.
|
|
return DELETED_SHEET_ITEM::GetInstance();
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::FillItemMap( std::map<KIID, EDA_ITEM*>& aMap )
|
|
{
|
|
for( const SCH_SHEET_PATH& sheet : *this )
|
|
{
|
|
SCH_SCREEN* screen = sheet.LastScreen();
|
|
|
|
for( SCH_ITEM* aItem : screen->Items() )
|
|
{
|
|
aMap[ aItem->m_Uuid ] = aItem;
|
|
|
|
if( aItem->Type() == SCH_COMPONENT_T )
|
|
{
|
|
SCH_COMPONENT* comp = static_cast<SCH_COMPONENT*>( aItem );
|
|
|
|
for( SCH_FIELD& field : comp->GetFields() )
|
|
aMap[ field.m_Uuid ] = &field;
|
|
|
|
for( SCH_PIN* pin : comp->GetPins() )
|
|
aMap[ pin->m_Uuid ] = pin;
|
|
}
|
|
else if( aItem->Type() == SCH_SHEET_T )
|
|
{
|
|
SCH_SHEET* sch_sheet = static_cast<SCH_SHEET*>( aItem );
|
|
|
|
for( SCH_FIELD& field : sch_sheet->GetFields() )
|
|
aMap[ field.m_Uuid ] = &field;
|
|
|
|
for( SCH_SHEET_PIN* pin : sch_sheet->GetPins() )
|
|
aMap[ pin->m_Uuid ] = pin;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::AnnotatePowerSymbols()
|
|
{
|
|
// List of reference for power symbols
|
|
SCH_REFERENCE_LIST references;
|
|
|
|
// Map of locked components (not used, but needed by Annotate()
|
|
SCH_MULTI_UNIT_REFERENCE_MAP lockedComponents;
|
|
|
|
// Build the list of power components:
|
|
for( SCH_SHEET_PATH& sheet : *this )
|
|
{
|
|
for( auto item : sheet.LastScreen()->Items().OfType( SCH_COMPONENT_T ) )
|
|
{
|
|
auto component = static_cast<SCH_COMPONENT*>( item );
|
|
LIB_PART* part = component->GetPartRef().get();
|
|
|
|
if( !part || !part->IsPower() )
|
|
continue;
|
|
|
|
if( part )
|
|
{
|
|
SCH_REFERENCE schReference( component, part, sheet );
|
|
references.AddItem( schReference );
|
|
}
|
|
}
|
|
}
|
|
|
|
// Find duplicate, and silently clear annotation of duplicate
|
|
std::map<wxString, int> ref_list; // stores the existing references
|
|
|
|
for( unsigned ii = 0; ii< references.GetCount(); ++ii )
|
|
{
|
|
wxString curr_ref = references[ii].GetRef();
|
|
|
|
if( ref_list.find( curr_ref ) == ref_list.end() )
|
|
{
|
|
ref_list[curr_ref] = ii;
|
|
continue;
|
|
}
|
|
|
|
// Possible duplicate, if the ref ends by a number:
|
|
if( curr_ref.Last() < '0' && curr_ref.Last() > '9' )
|
|
continue; // not annotated
|
|
|
|
// Duplicate: clear annotation by removing the number ending the ref
|
|
while( curr_ref.Last() >= '0' && curr_ref.Last() <= '9' )
|
|
curr_ref.RemoveLast();
|
|
|
|
references[ii].SetRef( curr_ref );
|
|
}
|
|
|
|
|
|
// Break full components reference in name (prefix) and number:
|
|
// example: IC1 become IC, and 1
|
|
references.SplitReferences();
|
|
|
|
// Ensure all power symbols have the reference starting by '#'
|
|
// (No sure this is really useful)
|
|
for( unsigned ii = 0; ii< references.GetCount(); ++ii )
|
|
{
|
|
if( references[ii].GetRef()[0] != '#' )
|
|
{
|
|
wxString new_ref = "#" + references[ii].GetRef();
|
|
references[ii].SetRef( new_ref );
|
|
}
|
|
}
|
|
|
|
// Recalculate and update reference numbers in schematic
|
|
references.Annotate( false, 0, 100, lockedComponents );
|
|
references.UpdateAnnotation();
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::GetComponents( SCH_REFERENCE_LIST& aReferences, bool aIncludePowerSymbols,
|
|
bool aForceIncludeOrphanComponents ) const
|
|
{
|
|
for( const SCH_SHEET_PATH& sheet : *this )
|
|
sheet.GetComponents( aReferences, aIncludePowerSymbols, aForceIncludeOrphanComponents );
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::GetMultiUnitComponents( SCH_MULTI_UNIT_REFERENCE_MAP &aRefList,
|
|
bool aIncludePowerSymbols ) const
|
|
{
|
|
for( SCH_SHEET_PATHS::const_iterator it = begin(); it != end(); ++it )
|
|
{
|
|
SCH_MULTI_UNIT_REFERENCE_MAP tempMap;
|
|
(*it).GetMultiUnitComponents( tempMap );
|
|
|
|
for( SCH_MULTI_UNIT_REFERENCE_MAP::value_type& pair : tempMap )
|
|
{
|
|
// Merge this list into the main one
|
|
unsigned n_refs = pair.second.GetCount();
|
|
|
|
for( unsigned thisRef = 0; thisRef < n_refs; ++thisRef )
|
|
{
|
|
aRefList[pair.first].AddItem( pair.second[thisRef] );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_SHEET_LIST::TestForRecursion( const SCH_SHEET_LIST& aSrcSheetHierarchy,
|
|
const wxString& aDestFileName )
|
|
{
|
|
if( empty() )
|
|
return false;
|
|
|
|
SCHEMATIC* sch = at( 0 ).LastScreen()->Schematic();
|
|
|
|
wxCHECK_MSG( sch, false, "No SCHEMATIC found in SCH_SHEET_LIST::TestForRecursion!" );
|
|
|
|
wxFileName rootFn = sch->GetFileName();
|
|
wxFileName destFn = aDestFileName;
|
|
|
|
if( destFn.IsRelative() )
|
|
destFn.MakeAbsolute( rootFn.GetPath() );
|
|
|
|
// Test each SCH_SHEET_PATH in this SCH_SHEET_LIST for potential recursion.
|
|
for( unsigned i = 0; i < size(); i++ )
|
|
{
|
|
// Test each SCH_SHEET_PATH in the source sheet.
|
|
for( unsigned j = 0; j < aSrcSheetHierarchy.size(); j++ )
|
|
{
|
|
const SCH_SHEET_PATH* sheetPath = &aSrcSheetHierarchy[j];
|
|
|
|
for( unsigned k = 0; k < sheetPath->size(); k++ )
|
|
{
|
|
if( at( i ).TestForRecursion( sheetPath->GetSheet( k )->GetFileName(),
|
|
aDestFileName ) )
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
// The source sheet file can safely be added to the destination sheet file.
|
|
return false;
|
|
}
|
|
|
|
|
|
SCH_SHEET_PATH* SCH_SHEET_LIST::FindSheetForScreen( SCH_SCREEN* aScreen )
|
|
{
|
|
for( SCH_SHEET_PATH& sheetpath : *this )
|
|
{
|
|
if( sheetpath.LastScreen() == aScreen )
|
|
return &sheetpath;
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::UpdateSymbolInstances(
|
|
const std::vector<COMPONENT_INSTANCE_REFERENCE>& aSymbolInstances )
|
|
{
|
|
SCH_REFERENCE_LIST symbolInstances;
|
|
|
|
GetComponents( symbolInstances, true, true );
|
|
|
|
std::map<KIID_PATH, wxString> pathNameCache;
|
|
|
|
// Calculating the name of a path is somewhat expensive; on large designs with many components
|
|
// this can blow up to a serious amount of time when loading the schematic
|
|
auto getName = [&pathNameCache]( const KIID_PATH& aPath ) -> const wxString&
|
|
{
|
|
if( pathNameCache.count( aPath ) )
|
|
return pathNameCache.at( aPath );
|
|
|
|
pathNameCache[aPath] = aPath.AsString();
|
|
return pathNameCache[aPath];
|
|
};
|
|
|
|
for( size_t i = 0; i < symbolInstances.GetCount(); i++ )
|
|
{
|
|
// The instance paths are stored in the file sans root path so the comparison
|
|
// should not include the root path.
|
|
wxString path = symbolInstances[i].GetPath();
|
|
|
|
auto it = std::find_if( aSymbolInstances.begin(), aSymbolInstances.end(),
|
|
[ path, &getName ]( const COMPONENT_INSTANCE_REFERENCE& r ) -> bool
|
|
{
|
|
return path == getName( r.m_Path );
|
|
} );
|
|
|
|
if( it == aSymbolInstances.end() )
|
|
{
|
|
wxLogTrace( traceSchSheetPaths, "No symbol instance found for path \"%s\"", path );
|
|
continue;
|
|
}
|
|
|
|
SCH_COMPONENT* symbol = symbolInstances[i].GetComp();
|
|
|
|
wxCHECK2( symbol, continue );
|
|
|
|
// Symbol instance paths are stored and looked up in memory with the root path so use
|
|
// the full path here.
|
|
symbol->AddHierarchicalReference( symbolInstances[i].GetSheetPath().Path(),
|
|
it->m_Reference, it->m_Unit, it->m_Value,
|
|
it->m_Footprint );
|
|
symbol->GetField( REFERENCE )->SetText( it->m_Reference );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::UpdateSheetInstances( const std::vector<SCH_SHEET_INSTANCE>& aSheetInstances )
|
|
{
|
|
|
|
for( const SCH_SHEET_PATH& instance : *this )
|
|
{
|
|
auto it = std::find_if( aSheetInstances.begin(), aSheetInstances.end(),
|
|
[ instance ]( const SCH_SHEET_INSTANCE& r ) -> bool
|
|
{
|
|
return instance.PathWithoutRootUuid() == r.m_Path;
|
|
} );
|
|
|
|
if( it == aSheetInstances.end() )
|
|
{
|
|
wxLogTrace( traceSchSheetPaths, "No sheet instance found for path \"%s\"",
|
|
instance.PathWithoutRootUuid().AsString() );
|
|
continue;
|
|
}
|
|
|
|
SCH_SHEET* sheet = instance.Last();
|
|
|
|
wxCHECK2( sheet, continue );
|
|
|
|
sheet->AddInstance( instance.Path() );
|
|
sheet->SetPageNumber( instance, it->m_PageNumber );
|
|
}
|
|
}
|
|
|
|
|
|
std::vector<KIID_PATH> SCH_SHEET_LIST::GetPaths() const
|
|
{
|
|
std::vector<KIID_PATH> paths;
|
|
|
|
for( const SCH_SHEET_PATH& sheetPath : *this )
|
|
paths.emplace_back( sheetPath.Path() );
|
|
|
|
return paths;
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::ReplaceLegacySheetPaths( const std::vector<KIID_PATH>& aOldSheetPaths )
|
|
{
|
|
wxCHECK( size() == aOldSheetPaths.size(), /* void */ );
|
|
|
|
for( size_t i = 0; i < size(); i++ )
|
|
{
|
|
const KIID_PATH oldSheetPath = aOldSheetPaths.at( i );
|
|
const KIID_PATH newSheetPath = at( i ).Path();
|
|
SCH_SCREEN* screen = at(i).LastScreen();
|
|
|
|
wxCHECK( screen, /* void */ );
|
|
|
|
for( SCH_ITEM* symbol : screen->Items().OfType( SCH_COMPONENT_T ) )
|
|
{
|
|
static_cast<SCH_COMPONENT*>( symbol )->ReplaceInstanceSheetPath( oldSheetPath,
|
|
newSheetPath );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_SHEET_LIST::AllSheetPageNumbersEmpty() const
|
|
{
|
|
for( const SCH_SHEET_PATH& instance : *this )
|
|
{
|
|
const SCH_SHEET* sheet = instance.Last();
|
|
|
|
wxCHECK2( sheet, continue );
|
|
|
|
if( !sheet->GetPageNumber( instance ).IsEmpty() )
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void SCH_SHEET_LIST::SetInitialPageNumbers()
|
|
{
|
|
// Don't accidently renumber existing sheets.
|
|
wxCHECK( AllSheetPageNumbersEmpty(), /* void */ );
|
|
|
|
wxString tmp;
|
|
int pageNumber = 1;
|
|
|
|
for( const SCH_SHEET_PATH& instance : *this )
|
|
{
|
|
SCH_SHEET* sheet = instance.Last();
|
|
|
|
wxCHECK2( sheet, continue );
|
|
|
|
sheet->AddInstance( instance.Path() );
|
|
tmp.Printf( "%d", pageNumber );
|
|
sheet->SetPageNumber( instance, tmp );
|
|
pageNumber += 1;
|
|
}
|
|
}
|