mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-13 17:53:11 +02:00
Properties panel and properties dialog now share a validator with shared strings Fixes https://gitlab.com/kicad/code/kicad/issues/21689
1706 lines
46 KiB
C++
1706 lines
46 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2023 CERN
|
|
* Copyright The 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 <cstdlib>
|
|
|
|
#include <bitmaps.h>
|
|
#include <core/mirror.h>
|
|
#include <core/kicad_algo.h>
|
|
#include <sch_draw_panel.h>
|
|
#include <trigo.h>
|
|
#include <sch_edit_frame.h>
|
|
#include <plotters/plotter.h>
|
|
#include <sch_plotter.h>
|
|
#include <string_utils.h>
|
|
#include <widgets/msgpanel.h>
|
|
#include <math/util.h> // for KiROUND
|
|
#include <geometry/geometry_utils.h>
|
|
#include <sch_sheet.h>
|
|
#include <sch_sheet_path.h>
|
|
#include <sch_sheet_pin.h>
|
|
#include <sch_symbol.h>
|
|
#include <sch_painter.h>
|
|
#include <schematic.h>
|
|
#include <settings/color_settings.h>
|
|
#include <settings/settings_manager.h>
|
|
#include <trace_helpers.h>
|
|
#include <validators.h>
|
|
#include <properties/property_validators.h>
|
|
#include <pgm_base.h>
|
|
#include <wx/log.h>
|
|
|
|
SCH_SHEET::SCH_SHEET( EDA_ITEM* aParent, const VECTOR2I& aPos, VECTOR2I aSize ) :
|
|
SCH_ITEM( aParent, SCH_SHEET_T ),
|
|
m_excludedFromSim( false ),
|
|
m_excludedFromBOM( false ),
|
|
m_excludedFromBoard( false ),
|
|
m_DNP( false )
|
|
{
|
|
m_layer = LAYER_SHEET;
|
|
m_pos = aPos;
|
|
m_size = aSize;
|
|
m_screen = nullptr;
|
|
|
|
m_borderWidth = 0;
|
|
m_borderColor = COLOR4D::UNSPECIFIED;
|
|
m_backgroundColor = COLOR4D::UNSPECIFIED;
|
|
m_fieldsAutoplaced = AUTOPLACE_AUTO;
|
|
|
|
m_fields.emplace_back( this, FIELD_T::SHEET_NAME,
|
|
GetDefaultFieldName( FIELD_T::SHEET_NAME, DO_TRANSLATE ) );
|
|
|
|
m_fields.emplace_back( this, FIELD_T::SHEET_FILENAME,
|
|
GetDefaultFieldName( FIELD_T::SHEET_FILENAME, DO_TRANSLATE ) );
|
|
|
|
AutoplaceFields( nullptr, m_fieldsAutoplaced );
|
|
}
|
|
|
|
|
|
SCH_SHEET::SCH_SHEET( const SCH_SHEET& aSheet ) :
|
|
SCH_ITEM( aSheet )
|
|
{
|
|
m_pos = aSheet.m_pos;
|
|
m_size = aSheet.m_size;
|
|
m_layer = aSheet.m_layer;
|
|
const_cast<KIID&>( m_Uuid ) = aSheet.m_Uuid;
|
|
m_fields = aSheet.m_fields;
|
|
m_fieldsAutoplaced = aSheet.m_fieldsAutoplaced;
|
|
m_screen = aSheet.m_screen;
|
|
|
|
m_excludedFromSim = aSheet.m_excludedFromSim;
|
|
m_excludedFromBOM = aSheet.m_excludedFromBOM;
|
|
m_excludedFromBoard = aSheet.m_excludedFromBoard;
|
|
m_DNP = aSheet.m_DNP;
|
|
|
|
m_borderWidth = aSheet.m_borderWidth;
|
|
m_borderColor = aSheet.m_borderColor;
|
|
m_backgroundColor = aSheet.m_backgroundColor;
|
|
m_instances = aSheet.m_instances;
|
|
|
|
for( SCH_SHEET_PIN* pin : aSheet.m_pins )
|
|
{
|
|
m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
|
|
m_pins.back()->SetParent( this );
|
|
}
|
|
|
|
for( SCH_FIELD& field : m_fields )
|
|
field.SetParent( this );
|
|
|
|
if( m_screen )
|
|
m_screen->IncRefCount();
|
|
}
|
|
|
|
|
|
SCH_SHEET::~SCH_SHEET()
|
|
{
|
|
// also, look at the associated sheet & its reference count
|
|
// perhaps it should be deleted also.
|
|
if( m_screen )
|
|
{
|
|
m_screen->DecRefCount();
|
|
|
|
if( m_screen->GetRefCount() == 0 )
|
|
delete m_screen;
|
|
}
|
|
|
|
// We own our pins; delete them
|
|
for( SCH_SHEET_PIN* pin : m_pins )
|
|
delete pin;
|
|
}
|
|
|
|
|
|
EDA_ITEM* SCH_SHEET::Clone() const
|
|
{
|
|
return new SCH_SHEET( *this );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::SetScreen( SCH_SCREEN* aScreen )
|
|
{
|
|
if( aScreen == m_screen )
|
|
return;
|
|
|
|
if( m_screen != nullptr )
|
|
{
|
|
m_screen->DecRefCount();
|
|
|
|
if( m_screen->GetRefCount() == 0 )
|
|
{
|
|
delete m_screen;
|
|
m_screen = nullptr;
|
|
}
|
|
}
|
|
|
|
m_screen = aScreen;
|
|
|
|
if( m_screen )
|
|
m_screen->IncRefCount();
|
|
}
|
|
|
|
|
|
int SCH_SHEET::GetScreenCount() const
|
|
{
|
|
if( m_screen == nullptr )
|
|
return 0;
|
|
|
|
return m_screen->GetRefCount();
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::IsRootSheet() const
|
|
{
|
|
wxCHECK_MSG( Schematic(), false, "Can't call IsRootSheet without setting a schematic" );
|
|
|
|
return &Schematic()->Root() == this;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::GetContextualTextVars( wxArrayString* aVars ) const
|
|
{
|
|
auto add =
|
|
[&]( const wxString& aVar )
|
|
{
|
|
if( !alg::contains( *aVars, aVar ) )
|
|
aVars->push_back( aVar );
|
|
};
|
|
|
|
for( const SCH_FIELD& field : m_fields )
|
|
{
|
|
if( field.IsMandatory() )
|
|
add( field.GetCanonicalName().Upper() );
|
|
else
|
|
add( field.GetName() );
|
|
}
|
|
|
|
SCH_SHEET_PATH sheetPath = findSelf();
|
|
|
|
if( sheetPath.size() >= 2 )
|
|
{
|
|
sheetPath.pop_back();
|
|
sheetPath.Last()->GetContextualTextVars( aVars );
|
|
}
|
|
else if( Schematic() )
|
|
{
|
|
Schematic()->GetContextualTextVars( aVars );
|
|
}
|
|
|
|
add( wxT( "#" ) );
|
|
add( wxT( "##" ) );
|
|
add( wxT( "SHEETPATH" ) );
|
|
add( wxT( "EXCLUDE_FROM_BOM" ) );
|
|
add( wxT( "EXCLUDE_FROM_BOARD" ) );
|
|
add( wxT( "EXCLUDE_FROM_SIM" ) );
|
|
add( wxT( "DNP" ) );
|
|
add( wxT( "ERC_ERROR <message_text>" ) );
|
|
add( wxT( "ERC_WARNING <message_text>" ) );
|
|
|
|
m_screen->GetTitleBlock().GetContextualTextVars( aVars );
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::ResolveTextVar( const SCH_SHEET_PATH* aPath, wxString* token, int aDepth ) const
|
|
{
|
|
wxCHECK( aPath, false );
|
|
|
|
SCHEMATIC* schematic = Schematic();
|
|
|
|
if( !schematic )
|
|
return false;
|
|
|
|
if( token->Contains( ':' ) )
|
|
{
|
|
if( schematic->ResolveCrossReference( token, aDepth + 1 ) )
|
|
return true;
|
|
}
|
|
|
|
for( const SCH_FIELD& field : m_fields )
|
|
{
|
|
wxString fieldName = field.IsMandatory() ? field.GetCanonicalName().Upper()
|
|
: field.GetName();
|
|
|
|
if( token->IsSameAs( fieldName ) )
|
|
{
|
|
*token = field.GetShownText( aPath, false, aDepth + 1 );
|
|
return true;
|
|
}
|
|
}
|
|
|
|
PROJECT* project = &schematic->Project();
|
|
|
|
// We cannot resolve text variables initially on load as we need to first load the screen and
|
|
// then parse the hierarchy. So skip the resolution if the screen isn't set yet
|
|
if( m_screen && m_screen->GetTitleBlock().TextVarResolver( token, project ) )
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if( token->IsSameAs( wxT( "#" ) ) )
|
|
{
|
|
*token = wxString::Format( "%s", aPath->GetPageNumber() );
|
|
return true;
|
|
}
|
|
else if( token->IsSameAs( wxT( "##" ) ) )
|
|
{
|
|
*token = wxString::Format( wxT( "%d" ), (int) schematic->Hierarchy().size() );
|
|
return true;
|
|
}
|
|
else if( token->IsSameAs( wxT( "SHEETPATH" ) ) )
|
|
{
|
|
*token = aPath->PathHumanReadable();
|
|
return true;
|
|
}
|
|
else if( token->IsSameAs( wxT( "EXCLUDE_FROM_BOM" ) ) )
|
|
{
|
|
*token = wxEmptyString;
|
|
|
|
if( aPath->GetExcludedFromBOM() || this->ResolveExcludedFromBOM() )
|
|
*token = _( "Excluded from BOM" );
|
|
|
|
return true;
|
|
}
|
|
else if( token->IsSameAs( wxT( "EXCLUDE_FROM_BOARD" ) ) )
|
|
{
|
|
*token = wxEmptyString;
|
|
|
|
if( aPath->GetExcludedFromBoard() || this->ResolveExcludedFromBoard() )
|
|
*token = _( "Excluded from board" );
|
|
|
|
return true;
|
|
}
|
|
else if( token->IsSameAs( wxT( "EXCLUDE_FROM_SIM" ) ) )
|
|
{
|
|
*token = wxEmptyString;
|
|
|
|
if( aPath->GetExcludedFromSim() || this->ResolveExcludedFromSim() )
|
|
*token = _( "Excluded from simulation" );
|
|
|
|
return true;
|
|
}
|
|
else if( token->IsSameAs( wxT( "DNP" ) ) )
|
|
{
|
|
*token = wxEmptyString;
|
|
|
|
if( aPath->GetDNP() || this->ResolveDNP() )
|
|
*token = _( "DNP" );
|
|
|
|
return true;
|
|
}
|
|
|
|
// See if parent can resolve it (these will recurse to ancestors)
|
|
|
|
if( aPath->size() >= 2 )
|
|
{
|
|
SCH_SHEET_PATH path = *aPath;
|
|
path.pop_back();
|
|
|
|
if( path.Last()->ResolveTextVar( &path, token, aDepth + 1 ) )
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
if( schematic->ResolveTextVar( aPath, token, aDepth + 1 ) )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::swapData( SCH_ITEM* aItem )
|
|
{
|
|
wxCHECK_RET( aItem->Type() == SCH_SHEET_T,
|
|
wxString::Format( wxT( "SCH_SHEET object cannot swap data with %s object." ),
|
|
aItem->GetClass() ) );
|
|
|
|
SCH_SHEET* sheet = ( SCH_SHEET* ) aItem;
|
|
|
|
std::swap( m_pos, sheet->m_pos );
|
|
std::swap( m_size, sheet->m_size );
|
|
m_fields.swap( sheet->m_fields );
|
|
std::swap( m_fieldsAutoplaced, sheet->m_fieldsAutoplaced );
|
|
m_pins.swap( sheet->m_pins );
|
|
|
|
// Update parent pointers after swapping.
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
sheetPin->SetParent( this );
|
|
|
|
for( SCH_SHEET_PIN* sheetPin : sheet->m_pins )
|
|
sheetPin->SetParent( sheet );
|
|
|
|
for( SCH_FIELD& field : m_fields )
|
|
field.SetParent( this );
|
|
|
|
for( SCH_FIELD& field : sheet->m_fields )
|
|
field.SetParent( sheet );
|
|
|
|
std::swap( m_excludedFromSim, sheet->m_excludedFromSim );
|
|
std::swap( m_excludedFromBOM, sheet->m_excludedFromBOM );
|
|
std::swap( m_excludedFromBoard, sheet->m_excludedFromBoard );
|
|
std::swap( m_DNP, sheet->m_DNP );
|
|
|
|
std::swap( m_borderWidth, sheet->m_borderWidth );
|
|
std::swap( m_borderColor, sheet->m_borderColor );
|
|
std::swap( m_backgroundColor, sheet->m_backgroundColor );
|
|
std::swap( m_instances, sheet->m_instances );
|
|
}
|
|
|
|
|
|
SCH_FIELD* SCH_SHEET::GetField( FIELD_T aFieldType )
|
|
{
|
|
if( SCH_FIELD* field = FindField( m_fields, aFieldType ) )
|
|
return field;
|
|
|
|
m_fields.emplace_back( this, aFieldType );
|
|
return &m_fields.back();
|
|
}
|
|
|
|
|
|
const SCH_FIELD* SCH_SHEET::GetField( FIELD_T aFieldType ) const
|
|
{
|
|
return FindField( m_fields, aFieldType );
|
|
}
|
|
|
|
|
|
int SCH_SHEET::GetNextFieldOrdinal() const
|
|
{
|
|
return NextFieldOrdinal( m_fields );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::SetFields( const std::vector<SCH_FIELD>& aFields )
|
|
{
|
|
m_fields = aFields;
|
|
|
|
// Make sure that we get the UNIX variant of the file path
|
|
SetFileName( GetField( FIELD_T::SHEET_FILENAME )->GetText() );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::AddPin( SCH_SHEET_PIN* aSheetPin )
|
|
{
|
|
wxASSERT( aSheetPin != nullptr );
|
|
wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
|
|
|
|
aSheetPin->SetParent( this );
|
|
m_pins.push_back( aSheetPin );
|
|
renumberPins();
|
|
}
|
|
|
|
|
|
void SCH_SHEET::RemovePin( const SCH_SHEET_PIN* aSheetPin )
|
|
{
|
|
wxASSERT( aSheetPin != nullptr );
|
|
wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
|
|
|
|
for( auto i = m_pins.begin(); i < m_pins.end(); ++i )
|
|
{
|
|
if( *i == aSheetPin )
|
|
{
|
|
m_pins.erase( i );
|
|
renumberPins();
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HasPin( const wxString& aName ) const
|
|
{
|
|
for( SCH_SHEET_PIN* pin : m_pins )
|
|
{
|
|
if( pin->GetText().Cmp( aName ) == 0 )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::doIsConnected( const VECTOR2I& aPosition ) const
|
|
{
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
{
|
|
if( sheetPin->GetPosition() == aPosition )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::IsVerticalOrientation() const
|
|
{
|
|
int leftRight = 0;
|
|
int topBottom = 0;
|
|
|
|
for( SCH_SHEET_PIN* pin : m_pins )
|
|
{
|
|
switch( pin->GetSide() )
|
|
{
|
|
case SHEET_SIDE::LEFT: leftRight++; break;
|
|
case SHEET_SIDE::RIGHT: leftRight++; break;
|
|
case SHEET_SIDE::TOP: topBottom++; break;
|
|
case SHEET_SIDE::BOTTOM: topBottom++; break;
|
|
default: break;
|
|
}
|
|
}
|
|
|
|
return topBottom > 0 && leftRight == 0;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HasUndefinedPins() const
|
|
{
|
|
for( SCH_SHEET_PIN* pin : m_pins )
|
|
{
|
|
/* Search the schematic for a hierarchical label corresponding to this sheet label. */
|
|
const SCH_HIERLABEL* HLabel = nullptr;
|
|
|
|
for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
|
|
{
|
|
if( !pin->GetText().Cmp( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) )
|
|
{
|
|
HLabel = static_cast<SCH_HIERLABEL*>( aItem );
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( HLabel == nullptr ) // Corresponding hierarchical label not found.
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
int bumpToNextGrid( const int aVal, const int aDirection )
|
|
{
|
|
constexpr int gridSize = schIUScale.MilsToIU( 50 );
|
|
|
|
int base = aVal / gridSize;
|
|
int excess = abs( aVal % gridSize );
|
|
|
|
if( aDirection > 0 )
|
|
{
|
|
return ( base + 1 ) * gridSize;
|
|
}
|
|
else if( excess > 0 )
|
|
{
|
|
return ( base ) * gridSize;
|
|
}
|
|
else
|
|
{
|
|
return ( base - 1 ) * gridSize;
|
|
}
|
|
}
|
|
|
|
|
|
int SCH_SHEET::GetMinWidth( bool aFromLeft ) const
|
|
{
|
|
int pinsLeft = m_pos.x + m_size.x;
|
|
int pinsRight = m_pos.x;
|
|
|
|
for( size_t i = 0; i < m_pins.size(); i++ )
|
|
{
|
|
SHEET_SIDE edge = m_pins[i]->GetSide();
|
|
|
|
if( edge == SHEET_SIDE::TOP || edge == SHEET_SIDE::BOTTOM )
|
|
{
|
|
BOX2I pinRect = m_pins[i]->GetBoundingBox();
|
|
|
|
pinsLeft = std::min( pinsLeft, pinRect.GetLeft() );
|
|
pinsRight = std::max( pinsRight, pinRect.GetRight() );
|
|
}
|
|
}
|
|
|
|
pinsLeft = bumpToNextGrid( pinsLeft, -1 );
|
|
pinsRight = bumpToNextGrid( pinsRight, 1 );
|
|
|
|
int pinMinWidth;
|
|
|
|
if( pinsLeft >= pinsRight )
|
|
pinMinWidth = 0;
|
|
else if( aFromLeft )
|
|
pinMinWidth = pinsRight - m_pos.x;
|
|
else
|
|
pinMinWidth = m_pos.x + m_size.x - pinsLeft;
|
|
|
|
return std::max( pinMinWidth, schIUScale.MilsToIU( MIN_SHEET_WIDTH ) );
|
|
}
|
|
|
|
|
|
int SCH_SHEET::GetMinHeight( bool aFromTop ) const
|
|
{
|
|
int pinsTop = m_pos.y + m_size.y;
|
|
int pinsBottom = m_pos.y;
|
|
|
|
for( size_t i = 0; i < m_pins.size(); i++ )
|
|
{
|
|
SHEET_SIDE edge = m_pins[i]->GetSide();
|
|
|
|
if( edge == SHEET_SIDE::RIGHT || edge == SHEET_SIDE::LEFT )
|
|
{
|
|
BOX2I pinRect = m_pins[i]->GetBoundingBox();
|
|
|
|
pinsTop = std::min( pinsTop, pinRect.GetTop() );
|
|
pinsBottom = std::max( pinsBottom, pinRect.GetBottom() );
|
|
}
|
|
}
|
|
|
|
pinsTop = bumpToNextGrid( pinsTop, -1 );
|
|
pinsBottom = bumpToNextGrid( pinsBottom, 1 );
|
|
|
|
int pinMinHeight;
|
|
|
|
if( pinsTop >= pinsBottom )
|
|
pinMinHeight = 0;
|
|
else if( aFromTop )
|
|
pinMinHeight = pinsBottom - m_pos.y;
|
|
else
|
|
pinMinHeight = m_pos.y + m_size.y - pinsTop;
|
|
|
|
return std::max( pinMinHeight, schIUScale.MilsToIU( MIN_SHEET_HEIGHT ) );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::CleanupSheet()
|
|
{
|
|
std::vector<SCH_SHEET_PIN*> pins = m_pins;
|
|
|
|
m_pins.clear();
|
|
|
|
for( SCH_SHEET_PIN* pin : pins )
|
|
{
|
|
/* Search the schematic for a hierarchical label corresponding to this sheet label. */
|
|
const SCH_HIERLABEL* HLabel = nullptr;
|
|
|
|
for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
|
|
{
|
|
if( pin->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) == 0 )
|
|
{
|
|
HLabel = static_cast<SCH_HIERLABEL*>( aItem );
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( HLabel )
|
|
m_pins.push_back( pin );
|
|
}
|
|
}
|
|
|
|
|
|
SCH_SHEET_PIN* SCH_SHEET::GetPin( const VECTOR2I& aPosition )
|
|
{
|
|
for( SCH_SHEET_PIN* pin : m_pins )
|
|
{
|
|
if( pin->HitTest( aPosition ) )
|
|
return pin;
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
int SCH_SHEET::GetPenWidth() const
|
|
{
|
|
if( GetBorderWidth() > 0 )
|
|
return GetBorderWidth();
|
|
|
|
if( Schematic() )
|
|
return Schematic()->Settings().m_DefaultLineWidth;
|
|
|
|
return schIUScale.MilsToIU( DEFAULT_LINE_WIDTH_MILS );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::AutoplaceFields( SCH_SCREEN* aScreen, AUTOPLACE_ALGO aAlgo )
|
|
{
|
|
SCH_FIELD* sheetNameField = GetField( FIELD_T::SHEET_NAME );
|
|
VECTOR2I textSize = sheetNameField->GetTextSize();
|
|
int borderMargin = KiROUND( GetPenWidth() / 2.0 ) + 4;
|
|
int margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.5 );
|
|
|
|
if( IsVerticalOrientation() )
|
|
{
|
|
sheetNameField->SetTextPos( m_pos + VECTOR2I( -margin, m_size.y ) );
|
|
sheetNameField->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
|
|
sheetNameField->SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
|
|
sheetNameField->SetTextAngle( ANGLE_VERTICAL );
|
|
}
|
|
else
|
|
{
|
|
sheetNameField->SetTextPos( m_pos + VECTOR2I( 0, -margin ) );
|
|
sheetNameField->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
|
|
sheetNameField->SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
|
|
sheetNameField->SetTextAngle( ANGLE_HORIZONTAL );
|
|
}
|
|
|
|
SCH_FIELD* sheetFilenameField = GetField( FIELD_T::SHEET_FILENAME );
|
|
|
|
textSize = sheetFilenameField->GetTextSize();
|
|
margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.4 );
|
|
|
|
if( IsVerticalOrientation() )
|
|
{
|
|
sheetFilenameField->SetTextPos( m_pos + VECTOR2I( m_size.x + margin, m_size.y ) );
|
|
sheetFilenameField->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
|
|
sheetFilenameField->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
|
|
sheetFilenameField->SetTextAngle( ANGLE_VERTICAL );
|
|
}
|
|
else
|
|
{
|
|
sheetFilenameField->SetTextPos( m_pos + VECTOR2I( 0, m_size.y + margin ) );
|
|
sheetFilenameField->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
|
|
sheetFilenameField->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
|
|
sheetFilenameField->SetTextAngle( ANGLE_HORIZONTAL );
|
|
}
|
|
|
|
if( aAlgo == AUTOPLACE_AUTO || aAlgo == AUTOPLACE_MANUAL )
|
|
m_fieldsAutoplaced = aAlgo;
|
|
}
|
|
|
|
|
|
std::vector<int> SCH_SHEET::ViewGetLayers() const
|
|
{
|
|
// Sheet pins are drawn by their parent sheet, so the parent needs to draw to LAYER_DANGLING
|
|
return { LAYER_DANGLING, LAYER_HIERLABEL, LAYER_SHEETNAME, LAYER_SHEETFILENAME,
|
|
LAYER_SHEETFIELDS, LAYER_SHEET, LAYER_SHEET_BACKGROUND, LAYER_SELECTION_SHADOWS };
|
|
}
|
|
|
|
|
|
const BOX2I SCH_SHEET::GetBodyBoundingBox() const
|
|
{
|
|
VECTOR2I end;
|
|
BOX2I box( m_pos, m_size );
|
|
int lineWidth = GetPenWidth();
|
|
int textLength = 0;
|
|
|
|
// Calculate bounding box X size:
|
|
end.x = std::max( m_size.x, textLength );
|
|
|
|
// Calculate bounding box pos:
|
|
end.y = m_size.y;
|
|
end += m_pos;
|
|
|
|
box.SetEnd( end );
|
|
box.Inflate( lineWidth / 2 );
|
|
|
|
return box;
|
|
}
|
|
|
|
|
|
const BOX2I SCH_SHEET::GetBoundingBox() const
|
|
{
|
|
BOX2I bbox = GetBodyBoundingBox();
|
|
|
|
for( const SCH_FIELD& field : m_fields )
|
|
bbox.Merge( field.GetBoundingBox() );
|
|
|
|
return bbox;
|
|
}
|
|
|
|
|
|
VECTOR2I SCH_SHEET::GetRotationCenter() const
|
|
{
|
|
BOX2I box( m_pos, m_size );
|
|
return box.GetCenter();
|
|
}
|
|
|
|
|
|
int SCH_SHEET::SymbolCount() const
|
|
{
|
|
int n = 0;
|
|
|
|
if( m_screen )
|
|
{
|
|
for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SYMBOL_T ) )
|
|
{
|
|
SCH_SYMBOL* symbol = (SCH_SYMBOL*) aItem;
|
|
|
|
if( !symbol->IsPower() )
|
|
n++;
|
|
}
|
|
|
|
for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
|
|
n += static_cast<const SCH_SHEET*>( aItem )->SymbolCount();
|
|
}
|
|
|
|
return n;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::SearchHierarchy( const wxString& aFilename, SCH_SCREEN** aScreen )
|
|
{
|
|
if( m_screen )
|
|
{
|
|
// Only check the root sheet once and don't recurse.
|
|
if( !GetParent() )
|
|
{
|
|
if( m_screen && m_screen->GetFileName().Cmp( aFilename ) == 0 )
|
|
{
|
|
*aScreen = m_screen;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
|
|
{
|
|
SCH_SHEET* sheet = static_cast<SCH_SHEET*>( aItem );
|
|
SCH_SCREEN* screen = sheet->m_screen;
|
|
|
|
// Must use the screen's path (which is always absolute) rather than the
|
|
// sheet's (which could be relative).
|
|
if( screen && screen->GetFileName().Cmp( aFilename ) == 0 )
|
|
{
|
|
*aScreen = screen;
|
|
return true;
|
|
}
|
|
|
|
if( sheet->SearchHierarchy( aFilename, aScreen ) )
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::LocatePathOfScreen( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aList )
|
|
{
|
|
if( m_screen )
|
|
{
|
|
aList->push_back( this );
|
|
|
|
if( m_screen == aScreen )
|
|
return true;
|
|
|
|
for( EDA_ITEM* item : m_screen->Items().OfType( SCH_SHEET_T ) )
|
|
{
|
|
SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
|
|
|
|
if( sheet->LocatePathOfScreen( aScreen, aList ) )
|
|
return true;
|
|
}
|
|
|
|
aList->pop_back();
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
int SCH_SHEET::CountSheets( const wxString& aFilename ) const
|
|
{
|
|
int count = 0;
|
|
|
|
if( m_screen )
|
|
{
|
|
if( m_screen->GetFileName().Cmp( aFilename ) == 0 )
|
|
count++;
|
|
|
|
for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
|
|
count += static_cast<SCH_SHEET*>( aItem )->CountSheets( aFilename );
|
|
}
|
|
|
|
return count;
|
|
}
|
|
|
|
|
|
int SCH_SHEET::CountSheets() const
|
|
{
|
|
int count = 1; //1 = this!!
|
|
|
|
if( m_screen )
|
|
{
|
|
for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
|
|
count += static_cast<SCH_SHEET*>( aItem )->CountSheets();
|
|
}
|
|
|
|
return count;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
|
|
{
|
|
// Don't use GetShownText(); we want to see the variable references here
|
|
aList.emplace_back( _( "Sheet Name" ), KIUI::EllipsizeStatusText( aFrame, GetName() ) );
|
|
|
|
if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
|
|
{
|
|
SCH_SHEET_PATH path = schframe->GetCurrentSheet();
|
|
path.push_back( this );
|
|
|
|
aList.emplace_back( _( "Hierarchical Path" ), path.PathHumanReadable( false, true ) );
|
|
}
|
|
|
|
// Don't use GetShownText(); we want to see the variable references here
|
|
aList.emplace_back( _( "File Name" ), KIUI::EllipsizeStatusText( aFrame, GetFileName() ) );
|
|
|
|
wxArrayString msgs;
|
|
wxString msg;
|
|
|
|
if( GetExcludedFromSim() )
|
|
msgs.Add( _( "Simulation" ) );
|
|
|
|
if( GetExcludedFromBOM() )
|
|
msgs.Add( _( "BOM" ) );
|
|
|
|
if( GetExcludedFromBoard() )
|
|
msgs.Add( _( "Board" ) );
|
|
|
|
if( GetDNP() )
|
|
msgs.Add( _( "DNP" ) );
|
|
|
|
msg = wxJoin( msgs, '|' );
|
|
msg.Replace( '|', wxS( ", " ) );
|
|
|
|
if( !msg.empty() )
|
|
aList.emplace_back( _( "Exclude from" ), msg );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::SetPositionIgnoringPins( const VECTOR2I& aPosition )
|
|
{
|
|
VECTOR2I delta = aPosition - m_pos;
|
|
|
|
m_pos = aPosition;
|
|
|
|
for( SCH_FIELD& field : m_fields )
|
|
field.Move( delta );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Move( const VECTOR2I& aMoveVector )
|
|
{
|
|
m_pos += aMoveVector;
|
|
|
|
for( SCH_SHEET_PIN* pin : m_pins )
|
|
pin->Move( aMoveVector );
|
|
|
|
for( SCH_FIELD& field : m_fields )
|
|
field.Move( aMoveVector );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Rotate( const VECTOR2I& aCenter, bool aRotateCCW )
|
|
{
|
|
VECTOR2I prev = m_pos;
|
|
|
|
RotatePoint( m_pos, aCenter, aRotateCCW ? ANGLE_90 : ANGLE_270 );
|
|
RotatePoint( &m_size.x, &m_size.y, aRotateCCW ? ANGLE_90 : ANGLE_270 );
|
|
|
|
if( m_size.x < 0 )
|
|
{
|
|
m_pos.x += m_size.x;
|
|
m_size.x = -m_size.x;
|
|
}
|
|
|
|
if( m_size.y < 0 )
|
|
{
|
|
m_pos.y += m_size.y;
|
|
m_size.y = -m_size.y;
|
|
}
|
|
|
|
// Pins must be rotated first as that's how we determine vertical vs horizontal
|
|
// orientation for auto-placement
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
sheetPin->Rotate( aCenter, aRotateCCW );
|
|
|
|
if( m_fieldsAutoplaced == AUTOPLACE_AUTO || m_fieldsAutoplaced == AUTOPLACE_MANUAL )
|
|
{
|
|
AutoplaceFields( nullptr, m_fieldsAutoplaced );
|
|
}
|
|
else
|
|
{
|
|
// Move the fields to the new position because the parent itself has moved.
|
|
for( SCH_FIELD& field : m_fields )
|
|
{
|
|
VECTOR2I pos = field.GetTextPos();
|
|
pos.x -= prev.x - m_pos.x;
|
|
pos.y -= prev.y - m_pos.y;
|
|
field.SetTextPos( pos );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::MirrorVertically( int aCenter )
|
|
{
|
|
int dy = m_pos.y;
|
|
|
|
MIRROR( m_pos.y, aCenter );
|
|
m_pos.y -= m_size.y;
|
|
dy -= m_pos.y; // 0,dy is the move vector for this transform
|
|
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
sheetPin->MirrorVertically( aCenter );
|
|
|
|
for( SCH_FIELD& field : m_fields )
|
|
{
|
|
VECTOR2I pos = field.GetTextPos();
|
|
pos.y -= dy;
|
|
field.SetTextPos( pos );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::MirrorHorizontally( int aCenter )
|
|
{
|
|
int dx = m_pos.x;
|
|
|
|
MIRROR( m_pos.x, aCenter );
|
|
m_pos.x -= m_size.x;
|
|
dx -= m_pos.x; // dx,0 is the move vector for this transform
|
|
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
sheetPin->MirrorHorizontally( aCenter );
|
|
|
|
for( SCH_FIELD& field : m_fields )
|
|
{
|
|
VECTOR2I pos = field.GetTextPos();
|
|
pos.x -= dx;
|
|
field.SetTextPos( pos );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::SetPosition( const VECTOR2I& aPosition )
|
|
{
|
|
// Remember the sheet and all pin sheet positions must be
|
|
// modified. So use Move function to do that.
|
|
Move( aPosition - m_pos );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Resize( const VECTOR2I& aSize )
|
|
{
|
|
if( aSize == m_size )
|
|
return;
|
|
|
|
m_size = aSize;
|
|
|
|
// Move the fields if we're in autoplace mode
|
|
if( m_fieldsAutoplaced == AUTOPLACE_AUTO || m_fieldsAutoplaced == AUTOPLACE_MANUAL )
|
|
AutoplaceFields( nullptr, m_fieldsAutoplaced );
|
|
|
|
// Move the sheet labels according to the new sheet size.
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
sheetPin->ConstrainOnEdge( sheetPin->GetPosition(), false );
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const
|
|
{
|
|
// Sheets are searchable via the child field and pin item text.
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::renumberPins()
|
|
{
|
|
int id = 2;
|
|
|
|
for( SCH_SHEET_PIN* pin : m_pins )
|
|
{
|
|
pin->SetNumber( id );
|
|
id++;
|
|
}
|
|
}
|
|
|
|
|
|
SCH_SHEET_PATH SCH_SHEET::findSelf() const
|
|
{
|
|
wxCHECK_MSG( Schematic(), SCH_SHEET_PATH(), "Can't call findSelf without a schematic" );
|
|
|
|
SCH_SHEET_PATH sheetPath = Schematic()->CurrentSheet();
|
|
|
|
while( !sheetPath.empty() && sheetPath.Last() != this )
|
|
sheetPath.pop_back();
|
|
|
|
if( sheetPath.empty() )
|
|
{
|
|
// If we weren't in the hierarchy, then we must be a child of the current sheet.
|
|
sheetPath = Schematic()->CurrentSheet();
|
|
sheetPath.push_back( const_cast<SCH_SHEET*>( this ) );
|
|
}
|
|
|
|
return sheetPath;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::GetEndPoints( std::vector <DANGLING_END_ITEM>& aItemList )
|
|
{
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
{
|
|
wxCHECK2_MSG( sheetPin->Type() == SCH_SHEET_PIN_T, continue,
|
|
wxT( "Invalid item in schematic sheet pin list. Bad programmer!" ) );
|
|
|
|
sheetPin->GetEndPoints( aItemList );
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
|
|
std::vector<DANGLING_END_ITEM>& aItemListByPos,
|
|
const SCH_SHEET_PATH* aPath )
|
|
{
|
|
bool changed = false;
|
|
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
changed |= sheetPin->UpdateDanglingState( aItemListByType, aItemListByPos );
|
|
|
|
return changed;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HasConnectivityChanges( const SCH_ITEM* aItem,
|
|
const SCH_SHEET_PATH* aInstance ) const
|
|
{
|
|
// Do not compare to ourself.
|
|
if( aItem == this )
|
|
return false;
|
|
|
|
const SCH_SHEET* sheet = dynamic_cast<const SCH_SHEET*>( aItem );
|
|
|
|
// Don't compare against a different SCH_ITEM.
|
|
wxCHECK( sheet, false );
|
|
|
|
if( GetPosition() != sheet->GetPosition() )
|
|
return true;
|
|
|
|
// Technically this cannot happen because undo/redo does not support reloading sheet
|
|
// file association changes. This was just added so that it doesn't get missed should
|
|
// we ever fix the undo/redo issue.
|
|
if( ( GetFileName() != sheet->GetFileName() ) || ( GetName() != sheet->GetName() ) )
|
|
return true;
|
|
|
|
if( m_pins.size() != sheet->m_pins.size() )
|
|
return true;
|
|
|
|
for( size_t i = 0; i < m_pins.size(); i++ )
|
|
{
|
|
if( m_pins[i]->HasConnectivityChanges( sheet->m_pins[i] ) )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
std::vector<VECTOR2I> SCH_SHEET::GetConnectionPoints() const
|
|
{
|
|
std::vector<VECTOR2I> retval;
|
|
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
retval.push_back( sheetPin->GetPosition() );
|
|
|
|
return retval;
|
|
}
|
|
|
|
|
|
INSPECT_RESULT SCH_SHEET::Visit( INSPECTOR aInspector, void* testData,
|
|
const std::vector<KICAD_T>& aScanTypes )
|
|
{
|
|
for( KICAD_T scanType : aScanTypes )
|
|
{
|
|
// If caller wants to inspect my type
|
|
if( scanType == SCH_LOCATE_ANY_T || scanType == Type() )
|
|
{
|
|
if( INSPECT_RESULT::QUIT == aInspector( this, nullptr ) )
|
|
return INSPECT_RESULT::QUIT;
|
|
}
|
|
|
|
if( scanType == SCH_LOCATE_ANY_T || scanType == SCH_FIELD_T )
|
|
{
|
|
// Test the sheet fields.
|
|
for( SCH_FIELD& field : m_fields )
|
|
{
|
|
if( INSPECT_RESULT::QUIT == aInspector( &field, this ) )
|
|
return INSPECT_RESULT::QUIT;
|
|
}
|
|
}
|
|
|
|
if( scanType == SCH_LOCATE_ANY_T || scanType == SCH_SHEET_PIN_T )
|
|
{
|
|
// Test the sheet labels.
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
{
|
|
if( INSPECT_RESULT::QUIT == aInspector( sheetPin, this ) )
|
|
return INSPECT_RESULT::QUIT;
|
|
}
|
|
}
|
|
}
|
|
|
|
return INSPECT_RESULT::CONTINUE;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction, RECURSE_MODE aMode )
|
|
{
|
|
for( SCH_FIELD& field : m_fields )
|
|
aFunction( &field );
|
|
|
|
for( SCH_SHEET_PIN* pin : m_pins )
|
|
aFunction( pin );
|
|
}
|
|
|
|
|
|
wxString SCH_SHEET::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
|
|
{
|
|
const SCH_FIELD* sheetnameField = GetField( FIELD_T::SHEET_NAME );
|
|
|
|
return wxString::Format( _( "Hierarchical Sheet '%s'" ),
|
|
aFull ? sheetnameField->GetShownText( false )
|
|
: KIUI::EllipsizeMenuText( sheetnameField->GetText() ) );
|
|
}
|
|
|
|
|
|
BITMAPS SCH_SHEET::GetMenuImage() const
|
|
{
|
|
return BITMAPS::add_hierarchical_subsheet;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
|
|
{
|
|
BOX2I rect = GetBodyBoundingBox();
|
|
|
|
rect.Inflate( aAccuracy );
|
|
|
|
return rect.Contains( aPosition );
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
|
|
{
|
|
BOX2I rect = aRect;
|
|
|
|
rect.Inflate( aAccuracy );
|
|
|
|
if( aContained )
|
|
return rect.Contains( GetBodyBoundingBox() );
|
|
|
|
return rect.Intersects( GetBodyBoundingBox() );
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
|
|
{
|
|
return KIGEOM::BoxHitTest( aPoly, GetBodyBoundingBox(), aContained );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
|
|
int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed )
|
|
{
|
|
if( aBackground && !aPlotter->GetColorMode() )
|
|
return;
|
|
|
|
SCH_RENDER_SETTINGS* renderSettings = getRenderSettings( aPlotter );
|
|
COLOR4D borderColor = GetBorderColor();
|
|
COLOR4D backgroundColor = GetBackgroundColor();
|
|
|
|
if( renderSettings->m_OverrideItemColors || borderColor == COLOR4D::UNSPECIFIED )
|
|
borderColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET );
|
|
|
|
if( renderSettings->m_OverrideItemColors || backgroundColor == COLOR4D::UNSPECIFIED )
|
|
backgroundColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET_BACKGROUND );
|
|
|
|
if( aBackground && backgroundColor.a > 0.0 )
|
|
{
|
|
aPlotter->SetColor( backgroundColor );
|
|
aPlotter->Rect( m_pos, m_pos + m_size, FILL_T::FILLED_SHAPE, 1, 0 );
|
|
}
|
|
else
|
|
{
|
|
aPlotter->SetColor( borderColor );
|
|
|
|
int penWidth = GetEffectivePenWidth( getRenderSettings( aPlotter ) );
|
|
aPlotter->Rect( m_pos, m_pos + m_size, FILL_T::NO_FILL, penWidth, 0 );
|
|
}
|
|
|
|
// Make the sheet object a clickable hyperlink (e.g. for PDF plotter)
|
|
if( aPlotOpts.m_PDFHierarchicalLinks )
|
|
{
|
|
aPlotter->HyperlinkBox( GetBoundingBox(),
|
|
EDA_TEXT::GotoPageHref( findSelf().GetPageNumber() ) );
|
|
}
|
|
else if( aPlotOpts.m_PDFPropertyPopups )
|
|
{
|
|
std::vector<wxString> properties;
|
|
|
|
properties.emplace_back( EDA_TEXT::GotoPageHref( findSelf().GetPageNumber() ) );
|
|
|
|
for( const SCH_FIELD& field : GetFields() )
|
|
{
|
|
properties.emplace_back( wxString::Format( wxT( "!%s = %s" ), field.GetName(),
|
|
field.GetShownText( false ) ) );
|
|
}
|
|
|
|
aPlotter->HyperlinkMenu( GetBoundingBox(), properties );
|
|
}
|
|
|
|
// Plot sheet pins
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
sheetPin->Plot( aPlotter, aBackground, aPlotOpts, aUnit, aBodyStyle, aOffset, aDimmed );
|
|
|
|
// Plot the fields
|
|
for( SCH_FIELD& field : m_fields )
|
|
field.Plot( aPlotter, aBackground, aPlotOpts, aUnit, aBodyStyle, aOffset, aDimmed );
|
|
|
|
if( GetDNP() )
|
|
{
|
|
COLOR_SETTINGS* colors = ::GetColorSettings( DEFAULT_THEME );
|
|
BOX2I bbox = GetBodyBoundingBox();
|
|
BOX2I pins = GetBoundingBox();
|
|
VECTOR2D margins( std::max( bbox.GetX() - pins.GetX(),
|
|
pins.GetEnd().x - bbox.GetEnd().x ),
|
|
std::max( bbox.GetY() - pins.GetY(),
|
|
pins.GetEnd().y - bbox.GetEnd().y ) );
|
|
int strokeWidth = 3.0 * schIUScale.MilsToIU( DEFAULT_LINE_WIDTH_MILS );
|
|
|
|
margins.x = std::max( margins.x * 0.6, margins.y * 0.3 );
|
|
margins.y = std::max( margins.y * 0.6, margins.x * 0.3 );
|
|
bbox.Inflate( KiROUND( margins.x ), KiROUND( margins.y ) );
|
|
|
|
aPlotter->SetColor( colors->GetColor( LAYER_DNP_MARKER ) );
|
|
|
|
aPlotter->ThickSegment( bbox.GetOrigin(), bbox.GetEnd(), strokeWidth, nullptr );
|
|
|
|
aPlotter->ThickSegment( bbox.GetOrigin() + VECTOR2I( bbox.GetWidth(), 0 ),
|
|
bbox.GetOrigin() + VECTOR2I( 0, bbox.GetHeight() ),
|
|
strokeWidth, nullptr );
|
|
}
|
|
}
|
|
|
|
|
|
SCH_SHEET& SCH_SHEET::operator=( const SCH_ITEM& aItem )
|
|
{
|
|
wxCHECK_MSG( Type() == aItem.Type(), *this,
|
|
wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
|
|
GetClass() );
|
|
|
|
if( &aItem != this )
|
|
{
|
|
SCH_ITEM::operator=( aItem );
|
|
|
|
SCH_SHEET* sheet = (SCH_SHEET*) &aItem;
|
|
|
|
m_pos = sheet->m_pos;
|
|
m_size = sheet->m_size;
|
|
m_fields = sheet->m_fields;
|
|
|
|
for( SCH_SHEET_PIN* pin : sheet->m_pins )
|
|
{
|
|
m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
|
|
m_pins.back()->SetParent( this );
|
|
}
|
|
|
|
for( const SCH_SHEET_INSTANCE& instance : sheet->m_instances )
|
|
m_instances.emplace_back( instance );
|
|
}
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::operator <( const SCH_ITEM& aItem ) const
|
|
{
|
|
if( Type() != aItem.Type() )
|
|
return Type() < aItem.Type();
|
|
|
|
const SCH_SHEET* otherSheet = static_cast<const SCH_SHEET*>( &aItem );
|
|
|
|
if( GetName() != otherSheet->GetName() )
|
|
return GetName() < otherSheet->GetName();
|
|
|
|
if( GetFileName() != otherSheet->GetFileName() )
|
|
return GetFileName() < otherSheet->GetFileName();
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::RemoveInstance( const KIID_PATH& aInstancePath )
|
|
{
|
|
// Search for an existing path and remove it if found (should not occur)
|
|
// (search from back to avoid invalidating iterator on remove)
|
|
for( int ii = m_instances.size() - 1; ii >= 0; --ii )
|
|
{
|
|
if( m_instances[ii].m_Path == aInstancePath )
|
|
{
|
|
wxLogTrace( traceSchSheetPaths, "Removing sheet instance:\n"
|
|
" sheet path %s\n"
|
|
" page %s, from project %s.",
|
|
aInstancePath.AsString(),
|
|
m_instances[ii].m_PageNumber,
|
|
m_instances[ii].m_ProjectName );
|
|
|
|
m_instances.erase( m_instances.begin() + ii );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::AddInstance( const SCH_SHEET_INSTANCE& aInstance )
|
|
{
|
|
SCH_SHEET_INSTANCE oldInstance;
|
|
|
|
if( getInstance( oldInstance, aInstance.m_Path ) )
|
|
RemoveInstance( aInstance.m_Path );
|
|
|
|
m_instances.emplace_back( aInstance );
|
|
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::addInstance( const KIID_PATH& aPath )
|
|
{
|
|
for( const SCH_SHEET_INSTANCE& instance : m_instances )
|
|
{
|
|
// if aSheetPath is found, nothing to do:
|
|
if( instance.m_Path == aPath )
|
|
return false;
|
|
}
|
|
|
|
wxLogTrace( traceSchSheetPaths, wxT( "Adding instance `%s` to sheet `%s`." ),
|
|
aPath.AsString(),
|
|
( GetName().IsEmpty() ) ? wxString( wxT( "root" ) ) : GetName() );
|
|
|
|
SCH_SHEET_INSTANCE instance;
|
|
|
|
instance.m_Path = aPath;
|
|
|
|
// This entry does not exist: add it with an empty page number.
|
|
m_instances.emplace_back( instance );
|
|
return true;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::getInstance( SCH_SHEET_INSTANCE& aInstance, const KIID_PATH& aSheetPath,
|
|
bool aTestFromEnd ) const
|
|
{
|
|
for( const SCH_SHEET_INSTANCE& instance : m_instances )
|
|
{
|
|
if( !aTestFromEnd )
|
|
{
|
|
if( instance.m_Path == aSheetPath )
|
|
{
|
|
aInstance = instance;
|
|
return true;
|
|
}
|
|
}
|
|
else if( instance.m_Path.EndsWith( aSheetPath ) )
|
|
{
|
|
aInstance = instance;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HasRootInstance() const
|
|
{
|
|
for( const SCH_SHEET_INSTANCE& instance : m_instances )
|
|
{
|
|
if( instance.m_Path.size() == 0 )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
const SCH_SHEET_INSTANCE& SCH_SHEET::GetRootInstance() const
|
|
{
|
|
for( const SCH_SHEET_INSTANCE& instance : m_instances )
|
|
{
|
|
if( instance.m_Path.size() == 0 )
|
|
return instance;
|
|
}
|
|
|
|
wxFAIL;
|
|
|
|
static SCH_SHEET_INSTANCE dummy;
|
|
|
|
return dummy;
|
|
}
|
|
|
|
|
|
wxString SCH_SHEET::getPageNumber( const KIID_PATH& aParentPath ) const
|
|
{
|
|
wxString pageNumber;
|
|
|
|
for( const SCH_SHEET_INSTANCE& instance : m_instances )
|
|
{
|
|
if( instance.m_Path == aParentPath )
|
|
{
|
|
pageNumber = instance.m_PageNumber;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return pageNumber;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::setPageNumber( const KIID_PATH& aPath, const wxString& aPageNumber )
|
|
{
|
|
for( SCH_SHEET_INSTANCE& instance : m_instances )
|
|
{
|
|
if( instance.m_Path == aPath )
|
|
{
|
|
instance.m_PageNumber = aPageNumber;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HasPageNumberChanges( const SCH_SHEET& aOther ) const
|
|
{
|
|
// Avoid self comparison.
|
|
if( &aOther == this )
|
|
return false;
|
|
|
|
// A difference in the instance data count implies a page numbering change.
|
|
if( GetInstances().size() != aOther.GetInstances().size() )
|
|
return true;
|
|
|
|
std::vector<SCH_SHEET_INSTANCE> instances = GetInstances();
|
|
std::vector<SCH_SHEET_INSTANCE> otherInstances = aOther.GetInstances();
|
|
|
|
// Sorting may not be necessary but there is no guarantee that sheet
|
|
// instance data will be in the correct KIID_PATH order. We should
|
|
// probably use a std::map instead of a std::vector to store the sheet
|
|
// instance data.
|
|
std::sort( instances.begin(), instances.end(),
|
|
[]( const SCH_SHEET_INSTANCE& aLhs, const SCH_SHEET_INSTANCE& aRhs )
|
|
{
|
|
if( aLhs.m_Path > aRhs.m_Path )
|
|
return true;
|
|
|
|
return false;
|
|
} );
|
|
std::sort( otherInstances.begin(), otherInstances.end(),
|
|
[]( const SCH_SHEET_INSTANCE& aLhs, const SCH_SHEET_INSTANCE& aRhs )
|
|
{
|
|
if( aLhs.m_Path > aRhs.m_Path )
|
|
return true;
|
|
|
|
return false;
|
|
} );
|
|
|
|
auto itThis = instances.begin();
|
|
auto itOther = otherInstances.begin();
|
|
|
|
while( itThis != instances.end() )
|
|
{
|
|
if( ( itThis->m_Path == itOther->m_Path )
|
|
&& ( itThis->m_PageNumber != itOther->m_PageNumber ) )
|
|
{
|
|
return true;
|
|
}
|
|
|
|
itThis++;
|
|
itOther++;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
int SCH_SHEET::ComparePageNum( const wxString& aPageNumberA, const wxString& aPageNumberB )
|
|
{
|
|
if( aPageNumberA == aPageNumberB )
|
|
return 0; // A == B
|
|
|
|
// First sort numerically if the page numbers are integers
|
|
long pageA, pageB;
|
|
bool isIntegerPageA = aPageNumberA.ToLong( &pageA );
|
|
bool isIntegerPageB = aPageNumberB.ToLong( &pageB );
|
|
|
|
if( isIntegerPageA && isIntegerPageB )
|
|
{
|
|
if( pageA < pageB )
|
|
return -1; //A < B
|
|
else
|
|
return 1; // A > B
|
|
}
|
|
|
|
// Numerical page numbers always before strings
|
|
if( isIntegerPageA )
|
|
return -1; //A < B
|
|
else if( isIntegerPageB )
|
|
return 1; // A > B
|
|
|
|
// If not numeric, then sort as strings using natural sort
|
|
int result = StrNumCmp( aPageNumberA, aPageNumberB );
|
|
|
|
// Divide by zero bad.
|
|
wxCHECK( result != 0, 0 );
|
|
|
|
result = result / std::abs( result );
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::operator==( const SCH_ITEM& aOther ) const
|
|
{
|
|
if( Type() != aOther.Type() )
|
|
return false;
|
|
|
|
const SCH_SHEET* other = static_cast<const SCH_SHEET*>( &aOther );
|
|
|
|
if( m_pos != other->m_pos )
|
|
return false;
|
|
|
|
if( m_size != other->m_size )
|
|
return false;
|
|
|
|
if( GetExcludedFromSim() != other->GetExcludedFromSim() )
|
|
return false;
|
|
|
|
if( GetExcludedFromBOM() != other->GetExcludedFromBOM() )
|
|
return false;
|
|
|
|
if( GetExcludedFromBoard() != other->GetExcludedFromBoard() )
|
|
return false;
|
|
|
|
if( GetDNP() != other->GetDNP() )
|
|
return false;
|
|
|
|
if( GetBorderColor() != other->GetBorderColor() )
|
|
return false;
|
|
|
|
if( GetBackgroundColor() != other->GetBackgroundColor() )
|
|
return false;
|
|
|
|
if( GetBorderWidth() != other->GetBorderWidth() )
|
|
return false;
|
|
|
|
if( GetFields().size() != other->GetFields().size() )
|
|
return false;
|
|
|
|
for( size_t i = 0; i < GetFields().size(); ++i )
|
|
{
|
|
if( !( GetFields()[i] == other->GetFields()[i] ) )
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
double SCH_SHEET::Similarity( const SCH_ITEM& aOther ) const
|
|
{
|
|
if( Type() != aOther.Type() )
|
|
return 0.0;
|
|
|
|
const SCH_SHEET* other = static_cast<const SCH_SHEET*>( &aOther );
|
|
|
|
if( m_screen->GetFileName() == other->m_screen->GetFileName() )
|
|
return 1.0;
|
|
|
|
return 0.0;
|
|
}
|
|
|
|
|
|
#if defined(DEBUG)
|
|
|
|
void SCH_SHEET::Show( int nestLevel, std::ostream& os ) const
|
|
{
|
|
// XML output:
|
|
wxString s = GetClass();
|
|
|
|
NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str() << ">" << " sheet_name=\""
|
|
<< TO_UTF8( GetName() ) << '"' << ">\n";
|
|
|
|
// show all the pins, and check the linked list integrity
|
|
for( SCH_SHEET_PIN* sheetPin : m_pins )
|
|
sheetPin->Show( nestLevel + 1, os );
|
|
|
|
NestedSpace( nestLevel, os ) << "</" << s.Lower().mb_str() << ">\n" << std::flush;
|
|
}
|
|
|
|
#endif
|
|
|
|
static struct SCH_SHEET_DESC
|
|
{
|
|
SCH_SHEET_DESC()
|
|
{
|
|
PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
|
|
REGISTER_TYPE( SCH_SHEET );
|
|
propMgr.InheritsAfter( TYPE_HASH( SCH_SHEET ), TYPE_HASH( SCH_ITEM ) );
|
|
|
|
propMgr.AddProperty( new PROPERTY<SCH_SHEET, wxString>( _HKI( "Sheet Name" ),
|
|
&SCH_SHEET::SetName, &SCH_SHEET::GetName ) )
|
|
.SetValidator( []( const wxAny&& aValue, EDA_ITEM* ) -> VALIDATOR_RESULT
|
|
{
|
|
wxString value;
|
|
|
|
if( !aValue.GetAs( &value ) )
|
|
return {};
|
|
|
|
wxString msg = GetFieldValidationErrorMessage( FIELD_T::SHEET_NAME, value );
|
|
|
|
if( msg.empty() )
|
|
return {};
|
|
|
|
return std::make_unique<VALIDATION_ERROR_MSG>( msg );
|
|
} );
|
|
|
|
propMgr.AddProperty( new PROPERTY<SCH_SHEET, int>( _HKI( "Border Width" ),
|
|
&SCH_SHEET::SetBorderWidth, &SCH_SHEET::GetBorderWidth,
|
|
PROPERTY_DISPLAY::PT_SIZE ) );
|
|
|
|
propMgr.AddProperty( new PROPERTY<SCH_SHEET, COLOR4D>( _HKI( "Border Color" ),
|
|
&SCH_SHEET::SetBorderColor, &SCH_SHEET::GetBorderColor ) );
|
|
|
|
propMgr.AddProperty( new PROPERTY<SCH_SHEET, COLOR4D>( _HKI( "Background Color" ),
|
|
&SCH_SHEET::SetBackgroundColor, &SCH_SHEET::GetBackgroundColor ) );
|
|
|
|
const wxString groupAttributes = _HKI( "Attributes" );
|
|
|
|
propMgr.AddProperty( new PROPERTY<SCH_SHEET, bool>( _HKI( "Exclude From Board" ),
|
|
&SCH_SHEET::SetExcludedFromBoard, &SCH_SHEET::GetExcludedFromBoard ),
|
|
groupAttributes );
|
|
propMgr.AddProperty( new PROPERTY<SCH_SHEET, bool>( _HKI( "Exclude From Simulation" ),
|
|
&SCH_SHEET::SetExcludedFromSim, &SCH_SHEET::GetExcludedFromSim ),
|
|
groupAttributes );
|
|
propMgr.AddProperty(
|
|
new PROPERTY<SCH_SHEET, bool>( _HKI( "Exclude From Bill of Materials" ),
|
|
&SCH_SHEET::SetExcludedFromBOM,
|
|
&SCH_SHEET::GetExcludedFromBOM ),
|
|
groupAttributes );
|
|
propMgr.AddProperty( new PROPERTY<SCH_SHEET, bool>( _HKI( "Do not Populate" ),
|
|
&SCH_SHEET::SetDNP, &SCH_SHEET::GetDNP ),
|
|
groupAttributes );
|
|
}
|
|
} _SCH_SHEET_DESC;
|