1825 lines
50 KiB
C++
1825 lines
50 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* 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 <fctsys.h>
|
|
#include <sch_edit_frame.h>
|
|
#include <msgpanel.h>
|
|
#include <bitmaps.h>
|
|
#include <lib_rectangle.h>
|
|
#include <lib_pin.h>
|
|
#include <lib_text.h>
|
|
#include <sch_component.h>
|
|
#include <sch_sheet_path.h>
|
|
#include <schematic.h>
|
|
#include <trace_helpers.h>
|
|
|
|
|
|
/**
|
|
* Convert a wxString to UTF8 and replace any control characters with a ~,
|
|
* where a control character is one of the first ASCII values up to ' ' 32d.
|
|
*/
|
|
std::string toUTFTildaText( const wxString& txt )
|
|
{
|
|
std::string ret = TO_UTF8( txt );
|
|
|
|
for( std::string::iterator it = ret.begin(); it!=ret.end(); ++it )
|
|
{
|
|
if( (unsigned char) *it <= ' ' )
|
|
*it = '~';
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
|
|
/**
|
|
* Used to draw a dummy shape when a LIB_PART is not found in library
|
|
*
|
|
* This component is a 400 mils square with the text ??
|
|
* DEF DUMMY U 0 40 Y Y 1 0 N
|
|
* F0 "U" 0 -350 60 H V
|
|
* F1 "DUMMY" 0 350 60 H V
|
|
* DRAW
|
|
* T 0 0 0 150 0 0 0 ??
|
|
* S -200 200 200 -200 0 1 0
|
|
* ENDDRAW
|
|
* ENDDEF
|
|
*/
|
|
static LIB_PART* dummy()
|
|
{
|
|
static LIB_PART* part;
|
|
|
|
if( !part )
|
|
{
|
|
part = new LIB_PART( wxEmptyString );
|
|
|
|
LIB_RECTANGLE* square = new LIB_RECTANGLE( part );
|
|
|
|
square->MoveTo( wxPoint( Mils2iu( -200 ), Mils2iu( 200 ) ) );
|
|
square->SetEndPosition( wxPoint( Mils2iu( 200 ), Mils2iu( -200 ) ) );
|
|
|
|
LIB_TEXT* text = new LIB_TEXT( part );
|
|
|
|
text->SetTextSize( wxSize( Mils2iu( 150 ), Mils2iu( 150 ) ) );
|
|
text->SetText( wxString( wxT( "??" ) ) );
|
|
|
|
part->AddDrawItem( square );
|
|
part->AddDrawItem( text );
|
|
}
|
|
|
|
return part;
|
|
}
|
|
|
|
|
|
SCH_COMPONENT::SCH_COMPONENT( const wxPoint& aPos, SCH_ITEM* aParent ) :
|
|
SCH_ITEM( aParent, SCH_COMPONENT_T )
|
|
{
|
|
Init( aPos );
|
|
}
|
|
|
|
|
|
SCH_COMPONENT::SCH_COMPONENT( LIB_PART& aPart, LIB_ID aLibId, SCH_SHEET_PATH* sheet,
|
|
int unit, int convert, const wxPoint& pos ) :
|
|
SCH_ITEM( NULL, SCH_COMPONENT_T )
|
|
{
|
|
Init( pos );
|
|
|
|
m_unit = unit;
|
|
m_convert = convert;
|
|
m_lib_id = aLibId;
|
|
|
|
std::unique_ptr< LIB_PART > part;
|
|
|
|
part = aPart.Flatten();
|
|
part->SetParent();
|
|
SetLibSymbol( part.release() );
|
|
|
|
// Copy fields from the library component
|
|
UpdateFields( true, true );
|
|
|
|
// Update the reference -- just the prefix for now.
|
|
if( sheet )
|
|
SetRef( sheet, m_part->GetReferenceField().GetText() + wxT( "?" ) );
|
|
else
|
|
m_prefix = m_part->GetReferenceField().GetText() + wxT( "?" );
|
|
}
|
|
|
|
|
|
SCH_COMPONENT::SCH_COMPONENT( LIB_PART& aPart, SCH_SHEET_PATH* aSheet, COMPONENT_SELECTION& aSel,
|
|
const wxPoint& pos ) :
|
|
SCH_COMPONENT( aPart, aSel.LibId, aSheet, aSel.Unit, aSel.Convert, pos )
|
|
{
|
|
// Set any fields that were modified as part of the component selection
|
|
for( auto const& i : aSel.Fields )
|
|
{
|
|
auto field = this->GetField( i.first );
|
|
|
|
if( field )
|
|
field->SetText( i.second );
|
|
}
|
|
}
|
|
|
|
|
|
SCH_COMPONENT::SCH_COMPONENT( const SCH_COMPONENT& aComponent ) :
|
|
SCH_ITEM( aComponent )
|
|
{
|
|
m_Parent = aComponent.m_Parent;
|
|
m_Pos = aComponent.m_Pos;
|
|
m_unit = aComponent.m_unit;
|
|
m_convert = aComponent.m_convert;
|
|
m_lib_id = aComponent.m_lib_id;
|
|
m_isInNetlist = aComponent.m_isInNetlist;
|
|
m_inBom = aComponent.m_inBom;
|
|
m_onBoard = aComponent.m_onBoard;
|
|
|
|
if( aComponent.m_part )
|
|
SetLibSymbol( new LIB_PART( *aComponent.m_part.get() ) );
|
|
|
|
const_cast<KIID&>( m_Uuid ) = aComponent.m_Uuid;
|
|
|
|
m_transform = aComponent.m_transform;
|
|
m_prefix = aComponent.m_prefix;
|
|
m_instanceReferences = aComponent.m_instanceReferences;
|
|
m_Fields = aComponent.m_Fields;
|
|
|
|
// Re-parent the fields, which before this had aComponent as parent
|
|
for( SCH_FIELD& field : m_Fields )
|
|
field.SetParent( this );
|
|
|
|
m_fieldsAutoplaced = aComponent.m_fieldsAutoplaced;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::Init( const wxPoint& pos )
|
|
{
|
|
m_Pos = pos;
|
|
m_unit = 1; // In multi unit chip - which unit to draw.
|
|
m_convert = LIB_ITEM::LIB_CONVERT::BASE; // De Morgan Handling
|
|
|
|
// The rotation/mirror transformation matrix. pos normal
|
|
m_transform = TRANSFORM();
|
|
|
|
// construct only the mandatory fields, which are the first 4 only.
|
|
for( int i = 0; i < MANDATORY_FIELDS; ++i )
|
|
{
|
|
m_Fields.emplace_back( pos, i, this, TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );
|
|
|
|
if( i == REFERENCE )
|
|
m_Fields.back().SetLayer( LAYER_REFERENCEPART );
|
|
else if( i == VALUE )
|
|
m_Fields.back().SetLayer( LAYER_VALUEPART );
|
|
else
|
|
m_Fields.back().SetLayer( LAYER_FIELDS );
|
|
}
|
|
|
|
m_prefix = wxString( wxT( "U" ) );
|
|
m_isInNetlist = true;
|
|
m_inBom = true;
|
|
m_onBoard = true;
|
|
}
|
|
|
|
|
|
EDA_ITEM* SCH_COMPONENT::Clone() const
|
|
{
|
|
return new SCH_COMPONENT( *this );
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::ViewGetLayers( int aLayers[], int& aCount ) const
|
|
{
|
|
aCount = 3;
|
|
aLayers[0] = LAYER_DEVICE;
|
|
aLayers[1] = LAYER_DEVICE_BACKGROUND;
|
|
aLayers[2] = LAYER_SELECTION_SHADOWS;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetLibId( const LIB_ID& aLibId )
|
|
{
|
|
if( m_lib_id != aLibId )
|
|
{
|
|
m_lib_id = aLibId;
|
|
SetModified();
|
|
}
|
|
}
|
|
|
|
|
|
wxString SCH_COMPONENT::GetSchSymbolLibraryName() const
|
|
{
|
|
if( !m_schLibSymbolName.IsEmpty() )
|
|
return m_schLibSymbolName;
|
|
else
|
|
return m_lib_id.Format().wx_str();
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetLibSymbol( LIB_PART* aLibSymbol )
|
|
{
|
|
wxCHECK2( ( aLibSymbol == nullptr ) || ( aLibSymbol->IsRoot() ), aLibSymbol = nullptr );
|
|
|
|
m_part.reset( aLibSymbol );
|
|
UpdatePins();
|
|
}
|
|
|
|
|
|
wxString SCH_COMPONENT::GetDescription() const
|
|
{
|
|
if( m_part )
|
|
return m_part->GetDescription();
|
|
|
|
return wxEmptyString;
|
|
}
|
|
|
|
|
|
wxString SCH_COMPONENT::GetDatasheet() const
|
|
{
|
|
if( m_part )
|
|
return m_part->GetDatasheetField().GetText();
|
|
|
|
return wxEmptyString;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::UpdatePins()
|
|
{
|
|
std::map<wxString, wxString> altPinMap;
|
|
|
|
for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
|
|
{
|
|
if( !pin->GetAlt().IsEmpty() )
|
|
altPinMap[ pin->GetNumber() ] = pin->GetAlt();
|
|
}
|
|
|
|
m_pins.clear();
|
|
m_pinMap.clear();
|
|
|
|
if( !m_part )
|
|
return;
|
|
|
|
unsigned i = 0;
|
|
|
|
for( LIB_PIN* libPin = m_part->GetNextPin(); libPin; libPin = m_part->GetNextPin( libPin ) )
|
|
{
|
|
wxASSERT( libPin->Type() == LIB_PIN_T );
|
|
|
|
if( libPin->GetConvert() && m_convert && ( m_convert != libPin->GetConvert() ) )
|
|
continue;
|
|
|
|
m_pins.push_back( std::make_unique<SCH_PIN>( libPin, this ) );
|
|
|
|
auto ii = altPinMap.find( libPin->GetNumber() );
|
|
|
|
if( ii != altPinMap.end() )
|
|
m_pins.back()->SetAlt( ii->second );
|
|
|
|
m_pinMap[ libPin ] = i;
|
|
|
|
++i;
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetUnit( int aUnit )
|
|
{
|
|
if( m_unit != aUnit )
|
|
{
|
|
m_unit = aUnit;
|
|
SetModified();
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::UpdateUnit( int aUnit )
|
|
{
|
|
m_unit = aUnit;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetConvert( int aConvert )
|
|
{
|
|
if( m_convert != aConvert )
|
|
{
|
|
m_convert = aConvert;
|
|
|
|
// The convert may have a different pin layout so the update the pin map.
|
|
UpdatePins();
|
|
SetModified();
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetTransform( const TRANSFORM& aTransform )
|
|
{
|
|
if( m_transform != aTransform )
|
|
{
|
|
m_transform = aTransform;
|
|
SetModified();
|
|
}
|
|
}
|
|
|
|
|
|
int SCH_COMPONENT::GetUnitCount() const
|
|
{
|
|
if( m_part )
|
|
return m_part->GetUnitCount();
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::Print( RENDER_SETTINGS* aSettings, const wxPoint& aOffset )
|
|
{
|
|
PART_DRAW_OPTIONS opts;
|
|
opts.transform = m_transform;
|
|
opts.draw_visible_fields = false;
|
|
opts.draw_hidden_fields = false;
|
|
|
|
if( m_part )
|
|
{
|
|
m_part->Print( aSettings, m_Pos + aOffset, m_unit, m_convert, opts );
|
|
}
|
|
else // Use dummy() part if the actual cannot be found.
|
|
{
|
|
dummy()->Print( aSettings, m_Pos + aOffset, 0, 0, opts );
|
|
}
|
|
|
|
for( SCH_FIELD& field : m_Fields )
|
|
field.Print( aSettings, aOffset );
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::AddHierarchicalReference( const KIID_PATH& aPath, const wxString& aRef,
|
|
int aUnit, const wxString& aValue,
|
|
const wxString& aFootprint )
|
|
{
|
|
// Search for an existing path and remove it if found (should not occur)
|
|
for( unsigned ii = 0; ii < m_instanceReferences.size(); ii++ )
|
|
{
|
|
if( m_instanceReferences[ii].m_Path == aPath )
|
|
{
|
|
wxLogTrace( traceSchSheetPaths, "Removing symbol instance:\n"
|
|
" sheet path %s\n"
|
|
" reference %s, unit %d from symbol %s.",
|
|
aPath.AsString(),
|
|
m_instanceReferences[ii].m_Reference,
|
|
m_instanceReferences[ii].m_Unit,
|
|
m_Uuid.AsString() );
|
|
|
|
m_instanceReferences.erase( m_instanceReferences.begin() + ii );
|
|
ii--;
|
|
}
|
|
}
|
|
|
|
COMPONENT_INSTANCE_REFERENCE instance;
|
|
instance.m_Path = aPath;
|
|
instance.m_Reference = aRef;
|
|
instance.m_Unit = aUnit;
|
|
instance.m_Value = aValue;
|
|
instance.m_Footprint = aFootprint;
|
|
|
|
wxLogTrace( traceSchSheetPaths, "Adding symbol instance:\n"
|
|
" sheet path %s\n"
|
|
" reference %s, unit %d to symbol %s.",
|
|
aPath.AsString(),
|
|
aRef,
|
|
aUnit,
|
|
m_Uuid.AsString() );
|
|
|
|
m_instanceReferences.push_back( instance );
|
|
}
|
|
|
|
|
|
const wxString SCH_COMPONENT::GetRef( const SCH_SHEET_PATH* sheet, bool aIncludeUnit ) const
|
|
{
|
|
KIID_PATH path = sheet->Path();
|
|
wxString ref;
|
|
|
|
for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path )
|
|
{
|
|
ref = instance.m_Reference;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// If it was not found in m_Paths array, then see if it is in m_Field[REFERENCE] -- if so,
|
|
// use this as a default for this path. This will happen if we load a version 1 schematic
|
|
// file. It will also mean that multiple instances of the same sheet by default all have
|
|
// the same component references, but perhaps this is best.
|
|
if( ref.IsEmpty() && !GetField( REFERENCE )->GetText().IsEmpty() )
|
|
{
|
|
const_cast<SCH_COMPONENT*>( this )->SetRef( sheet, GetField( REFERENCE )->GetText() );
|
|
ref = GetField( REFERENCE )->GetText();
|
|
}
|
|
|
|
if( ref.IsEmpty() )
|
|
ref = m_prefix;
|
|
|
|
if( aIncludeUnit && GetUnitCount() > 1 )
|
|
ref += LIB_PART::SubReference( GetUnit() );
|
|
|
|
return ref;
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::IsReferenceStringValid( const wxString& aReferenceString )
|
|
{
|
|
wxString text = aReferenceString;
|
|
bool ok = true;
|
|
|
|
// Try to unannotate this reference
|
|
while( !text.IsEmpty() && ( text.Last() == '?' || wxIsdigit( text.Last() ) ) )
|
|
text.RemoveLast();
|
|
|
|
if( text.IsEmpty() )
|
|
ok = false;
|
|
|
|
return ok;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetRef( const SCH_SHEET_PATH* sheet, const wxString& ref )
|
|
{
|
|
KIID_PATH path = sheet->Path();
|
|
bool notInArray = true;
|
|
|
|
// check to see if it is already there before inserting it
|
|
for( COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path )
|
|
{
|
|
instance.m_Reference = ref;
|
|
notInArray = false;
|
|
}
|
|
}
|
|
|
|
if( notInArray )
|
|
AddHierarchicalReference( path, ref, m_unit );
|
|
|
|
for( std::unique_ptr<SCH_PIN>& pin : m_pins )
|
|
pin->ClearDefaultNetName( sheet );
|
|
|
|
SCH_FIELD* rf = GetField( REFERENCE );
|
|
|
|
// @todo Should we really be checking for what is a "reasonable" position?
|
|
if( rf->GetText().IsEmpty()
|
|
|| ( abs( rf->GetTextPos().x - m_Pos.x ) +
|
|
abs( rf->GetTextPos().y - m_Pos.y ) > Mils2iu( 10000 ) ) )
|
|
{
|
|
// move it to a reasonable position
|
|
rf->SetTextPos( m_Pos + wxPoint( Mils2iu( 50 ), Mils2iu( 50 ) ) );
|
|
}
|
|
|
|
rf->SetText( ref ); // for drawing.
|
|
|
|
// Reinit the m_prefix member if needed
|
|
wxString prefix = ref;
|
|
|
|
if( IsReferenceStringValid( prefix ) )
|
|
{
|
|
while( prefix.Last() == '?' || wxIsdigit( prefix.Last() ) )
|
|
prefix.RemoveLast();
|
|
}
|
|
else
|
|
{
|
|
prefix = wxT( "U" ); // Set to default ref prefix
|
|
}
|
|
|
|
if( m_prefix != prefix )
|
|
m_prefix = prefix;
|
|
|
|
// Power components have references starting with # and are not included in netlists
|
|
m_isInNetlist = ! ref.StartsWith( wxT( "#" ) );
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::IsAnnotated( const SCH_SHEET_PATH* aSheet )
|
|
{
|
|
KIID_PATH path = aSheet->Path();
|
|
|
|
for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path )
|
|
return instance.m_Reference.Last() != '?';
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
int SCH_COMPONENT::GetUnitSelection( const SCH_SHEET_PATH* aSheet ) const
|
|
{
|
|
KIID_PATH path = aSheet->Path();
|
|
|
|
for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path )
|
|
return instance.m_Unit;
|
|
}
|
|
|
|
// If it was not found in m_Paths array, then use m_unit. This will happen if we load a
|
|
// version 1 schematic file.
|
|
return m_unit;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetUnitSelection( const SCH_SHEET_PATH* aSheet, int aUnitSelection )
|
|
{
|
|
KIID_PATH path = aSheet->Path();
|
|
|
|
// check to see if it is already there before inserting it
|
|
for( COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path )
|
|
{
|
|
instance.m_Unit = aUnitSelection;
|
|
return;
|
|
}
|
|
}
|
|
|
|
// didn't find it; better add it
|
|
AddHierarchicalReference( path, m_prefix, aUnitSelection );
|
|
}
|
|
|
|
|
|
const wxString SCH_COMPONENT::GetValue( const SCH_SHEET_PATH* sheet ) const
|
|
{
|
|
KIID_PATH path = sheet->Path();
|
|
|
|
for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path && !instance.m_Footprint.IsEmpty() )
|
|
{
|
|
SCH_FIELD dummy( wxDefaultPosition, VALUE, const_cast<SCH_COMPONENT*>( this ) );
|
|
dummy.SetText( instance.m_Value );
|
|
return dummy.GetShownText();
|
|
}
|
|
}
|
|
|
|
return GetField( VALUE )->GetShownText();
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetValue( const SCH_SHEET_PATH* sheet, const wxString& aValue )
|
|
{
|
|
KIID_PATH path = sheet->Path();
|
|
|
|
// check to see if it is already there before inserting it
|
|
for( COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path )
|
|
{
|
|
instance.m_Value = aValue;
|
|
return;
|
|
}
|
|
}
|
|
|
|
// didn't find it; better add it
|
|
AddHierarchicalReference( path, m_prefix, m_unit, aValue, wxEmptyString );
|
|
}
|
|
|
|
|
|
const wxString SCH_COMPONENT::GetFootprint( const SCH_SHEET_PATH* sheet ) const
|
|
{
|
|
KIID_PATH path = sheet->Path();
|
|
|
|
for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path && !instance.m_Footprint.IsEmpty() )
|
|
{
|
|
SCH_FIELD dummy( wxDefaultPosition, FOOTPRINT, const_cast<SCH_COMPONENT*>( this ) );
|
|
dummy.SetText( instance.m_Footprint );
|
|
return dummy.GetShownText();
|
|
}
|
|
}
|
|
|
|
return GetField( FOOTPRINT )->GetShownText();
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetFootprint( const SCH_SHEET_PATH* sheet, const wxString& aFootprint )
|
|
{
|
|
KIID_PATH path = sheet->Path();
|
|
|
|
// check to see if it is already there before inserting it
|
|
for( COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path )
|
|
{
|
|
instance.m_Footprint = aFootprint;
|
|
return;
|
|
}
|
|
}
|
|
|
|
// didn't find it; better add it
|
|
AddHierarchicalReference( path, m_prefix, m_unit, wxEmptyString, aFootprint );
|
|
}
|
|
|
|
|
|
SCH_FIELD* SCH_COMPONENT::GetField( int aFieldNdx )
|
|
{
|
|
if( (unsigned) aFieldNdx < m_Fields.size() )
|
|
return &m_Fields[aFieldNdx];
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
const SCH_FIELD* SCH_COMPONENT::GetField( int aFieldNdx ) const
|
|
{
|
|
if( (unsigned) aFieldNdx < m_Fields.size() )
|
|
return &m_Fields[aFieldNdx];
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
wxString SCH_COMPONENT::GetFieldText( const wxString& aFieldName, SCH_EDIT_FRAME* aFrame ) const
|
|
{
|
|
for( const SCH_FIELD& field : m_Fields )
|
|
{
|
|
if( aFieldName == field.GetName() )
|
|
return field.GetText();
|
|
}
|
|
|
|
return wxEmptyString;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::GetFields( std::vector<SCH_FIELD*>& aVector, bool aVisibleOnly )
|
|
{
|
|
for( SCH_FIELD& field : m_Fields )
|
|
{
|
|
if( !aVisibleOnly || ( field.IsVisible() && !field.IsVoid() ) )
|
|
aVector.push_back( &field );
|
|
}
|
|
}
|
|
|
|
|
|
SCH_FIELD* SCH_COMPONENT::AddField( const SCH_FIELD& aField )
|
|
{
|
|
int newNdx = m_Fields.size();
|
|
|
|
m_Fields.push_back( aField );
|
|
return &m_Fields[newNdx];
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::RemoveField( const wxString& aFieldName )
|
|
{
|
|
for( unsigned i = MANDATORY_FIELDS; i < m_Fields.size(); ++i )
|
|
{
|
|
if( aFieldName == m_Fields[i].GetName( false ) )
|
|
{
|
|
m_Fields.erase( m_Fields.begin() + i );
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
SCH_FIELD* SCH_COMPONENT::FindField( const wxString& aFieldName, bool aIncludeDefaultFields )
|
|
{
|
|
unsigned start = aIncludeDefaultFields ? 0 : MANDATORY_FIELDS;
|
|
|
|
for( unsigned i = start; i < m_Fields.size(); ++i )
|
|
{
|
|
if( aFieldName == m_Fields[i].GetName( false ) )
|
|
return &m_Fields[i];
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::UpdateFields( bool aResetStyle, bool aResetRef )
|
|
{
|
|
if( m_part )
|
|
{
|
|
wxString symbolName;
|
|
LIB_FIELDS fields;
|
|
m_part->GetFields( fields );
|
|
|
|
for( const LIB_FIELD& libField : fields )
|
|
{
|
|
int idx = libField.GetId();
|
|
SCH_FIELD* schField;
|
|
|
|
if( idx == REFERENCE && !aResetRef )
|
|
continue;
|
|
|
|
if( idx >= 0 && idx < MANDATORY_FIELDS )
|
|
{
|
|
schField = GetField( idx );
|
|
}
|
|
else
|
|
{
|
|
schField = FindField( libField.GetCanonicalName() );
|
|
|
|
if( !schField )
|
|
{
|
|
wxString fieldName = libField.GetCanonicalName();
|
|
SCH_FIELD newField( wxPoint( 0, 0), GetFieldCount(), this, fieldName );
|
|
schField = AddField( newField );
|
|
}
|
|
}
|
|
|
|
if( aResetStyle )
|
|
{
|
|
schField->ImportValues( libField );
|
|
schField->SetTextPos( m_Pos + libField.GetTextPos() );
|
|
}
|
|
|
|
if( idx == VALUE )
|
|
{
|
|
schField->SetText( m_lib_id.GetLibItemName() ); // fetch alias-specific value
|
|
symbolName = m_lib_id.GetLibItemName();
|
|
}
|
|
else if( idx == DATASHEET )
|
|
{
|
|
schField->SetText( GetDatasheet() ); // fetch alias-specific value
|
|
}
|
|
else
|
|
{
|
|
schField->SetText( libField.GetText() );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
SCH_PIN* SCH_COMPONENT::GetPin( const wxString& aNumber )
|
|
{
|
|
for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
|
|
{
|
|
if( pin->GetNumber() == aNumber )
|
|
return pin.get();
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::GetLibPins( std::vector<LIB_PIN*>& aPinsList )
|
|
{
|
|
if( m_part )
|
|
m_part->GetPins( aPinsList, m_unit, m_convert );
|
|
}
|
|
|
|
|
|
SCH_PIN* SCH_COMPONENT::GetPin( LIB_PIN* aLibPin )
|
|
{
|
|
wxASSERT( m_pinMap.count( aLibPin ) );
|
|
return m_pins[ m_pinMap.at( aLibPin ) ].get();
|
|
}
|
|
|
|
|
|
std::vector<SCH_PIN*> SCH_COMPONENT::GetPins( const SCH_SHEET_PATH* aSheet ) const
|
|
{
|
|
std::vector<SCH_PIN*> pins;
|
|
|
|
if( aSheet == nullptr )
|
|
{
|
|
wxCHECK_MSG( Schematic(), pins, "Can't call GetPins on a component with no schematic" );
|
|
|
|
aSheet = &Schematic()->CurrentSheet();
|
|
}
|
|
|
|
int unit = GetUnitSelection( aSheet );
|
|
|
|
for( const auto& p : m_pins )
|
|
{
|
|
if( unit && p->GetLibPin()->GetUnit() && ( p->GetLibPin()->GetUnit() != unit ) )
|
|
continue;
|
|
|
|
pins.push_back( p.get() );
|
|
}
|
|
|
|
return pins;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SwapData( SCH_ITEM* aItem )
|
|
{
|
|
wxCHECK_RET( (aItem != NULL) && (aItem->Type() == SCH_COMPONENT_T),
|
|
wxT( "Cannot swap data with invalid component." ) );
|
|
|
|
SCH_COMPONENT* component = (SCH_COMPONENT*) aItem;
|
|
|
|
std::swap( m_lib_id, component->m_lib_id );
|
|
|
|
LIB_PART* part = component->m_part.release();
|
|
component->m_part.reset( m_part.release() );
|
|
component->UpdatePins();
|
|
m_part.reset( part );
|
|
UpdatePins();
|
|
|
|
std::swap( m_Pos, component->m_Pos );
|
|
std::swap( m_unit, component->m_unit );
|
|
std::swap( m_convert, component->m_convert );
|
|
|
|
m_Fields.swap( component->m_Fields ); // std::vector's swap()
|
|
|
|
for( SCH_FIELD& field : component->m_Fields )
|
|
field.SetParent( component );
|
|
|
|
for( SCH_FIELD& field : m_Fields )
|
|
field.SetParent( this );
|
|
|
|
TRANSFORM tmp = m_transform;
|
|
|
|
m_transform = component->m_transform;
|
|
component->m_transform = tmp;
|
|
|
|
std::swap( m_instanceReferences, component->m_instanceReferences );
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::GetContextualTextVars( wxArrayString* aVars ) const
|
|
{
|
|
for( int i = 0; i < MANDATORY_FIELDS; ++i )
|
|
aVars->push_back( m_Fields[i].GetCanonicalName().Upper() );
|
|
|
|
for( size_t i = MANDATORY_FIELDS; i < m_Fields.size(); ++i )
|
|
aVars->push_back( m_Fields[i].GetName() );
|
|
|
|
aVars->push_back( wxT( "FOOTPRINT_LIBRARY" ) );
|
|
aVars->push_back( wxT( "FOOTPRINT_NAME" ) );
|
|
aVars->push_back( wxT( "UNIT" ) );
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::ResolveTextVar( wxString* token, int aDepth ) const
|
|
{
|
|
SCHEMATIC* schematic = Schematic();
|
|
|
|
for( int i = 0; i < MANDATORY_FIELDS; ++i )
|
|
{
|
|
if( token->IsSameAs( m_Fields[ i ].GetCanonicalName().Upper() ) )
|
|
{
|
|
if( i == REFERENCE && schematic )
|
|
*token = GetRef( &schematic->CurrentSheet(), true );
|
|
else if( i == VALUE && schematic )
|
|
*token = GetValue( &schematic->CurrentSheet() );
|
|
else if( i == FOOTPRINT && schematic )
|
|
*token = GetFootprint( &schematic->CurrentSheet() );
|
|
else
|
|
*token = m_Fields[ i ].GetShownText( aDepth + 1 );
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
for( size_t i = MANDATORY_FIELDS; i < m_Fields.size(); ++i )
|
|
{
|
|
if( token->IsSameAs( m_Fields[ i ].GetName() )
|
|
|| token->IsSameAs( m_Fields[ i ].GetName().Upper() ) )
|
|
{
|
|
*token = m_Fields[ i ].GetShownText( aDepth + 1 );
|
|
return true;
|
|
}
|
|
}
|
|
|
|
if( token->IsSameAs( wxT( "FOOTPRINT_LIBRARY" ) ) )
|
|
{
|
|
wxString footprint;
|
|
|
|
if( schematic )
|
|
footprint = GetFootprint( &schematic->CurrentSheet() );
|
|
else
|
|
footprint = m_Fields[ FOOTPRINT ].GetShownText();
|
|
|
|
wxArrayString parts = wxSplit( footprint, ':' );
|
|
|
|
*token = parts[ 0 ];
|
|
return true;
|
|
}
|
|
else if( token->IsSameAs( wxT( "FOOTPRINT_NAME" ) ) )
|
|
{
|
|
wxString footprint;
|
|
|
|
if( schematic )
|
|
footprint = GetFootprint( &schematic->CurrentSheet() );
|
|
else
|
|
footprint = m_Fields[ FOOTPRINT ].GetShownText();
|
|
|
|
wxArrayString parts = wxSplit( footprint, ':' );
|
|
|
|
*token = parts[ std::min( 1, (int) parts.size() - 1 ) ];
|
|
return true;
|
|
}
|
|
else if( token->IsSameAs( wxT( "UNIT" ) ) )
|
|
{
|
|
int unit;
|
|
|
|
if( schematic )
|
|
unit = GetUnitSelection( &schematic->CurrentSheet() );
|
|
else
|
|
unit = GetUnit();
|
|
|
|
*token = LIB_PART::SubReference( unit );
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::ClearAnnotation( SCH_SHEET_PATH* aSheetPath )
|
|
{
|
|
// Build a reference with no annotation,
|
|
// i.e. a reference ended by only one '?'
|
|
wxString defRef = m_prefix;
|
|
|
|
if( !IsReferenceStringValid( defRef ) )
|
|
{ // This is a malformed reference: reinit this reference
|
|
m_prefix = defRef = wxT("U"); // Set to default ref prefix
|
|
}
|
|
|
|
while( defRef.Last() == '?' )
|
|
defRef.RemoveLast();
|
|
|
|
defRef.Append( wxT( "?" ) );
|
|
|
|
if( aSheetPath )
|
|
{
|
|
KIID_PATH path = aSheetPath->Path();
|
|
|
|
for( COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
if( instance.m_Path == path )
|
|
instance.m_Reference = defRef;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for( COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
instance.m_Reference = defRef;
|
|
}
|
|
|
|
for( std::unique_ptr<SCH_PIN>& pin : m_pins )
|
|
pin->ClearDefaultNetName( aSheetPath );
|
|
|
|
// These 2 changes do not work in complex hierarchy.
|
|
// When a clear annotation is made, the calling function must call a
|
|
// UpdateAllScreenReferences for the active sheet.
|
|
// But this call cannot made here.
|
|
m_Fields[REFERENCE].SetText( defRef ); //for drawing.
|
|
|
|
SetModified();
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing( const KIID_PATH& aSheetPath )
|
|
{
|
|
// a empty sheet path is illegal:
|
|
wxCHECK( aSheetPath.size() > 0, false );
|
|
|
|
wxString reference_path;
|
|
|
|
for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
|
|
{
|
|
// if aSheetPath is found, nothing to do:
|
|
if( instance.m_Path == aSheetPath )
|
|
return false;
|
|
}
|
|
|
|
// This entry does not exist: add it, with its last-used reference
|
|
AddHierarchicalReference( aSheetPath, m_Fields[REFERENCE].GetText(), m_unit );
|
|
return true;
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::ReplaceInstanceSheetPath( const KIID_PATH& aOldSheetPath,
|
|
const KIID_PATH& aNewSheetPath )
|
|
{
|
|
auto it = std::find_if( m_instanceReferences.begin(), m_instanceReferences.end(),
|
|
[ aOldSheetPath ]( COMPONENT_INSTANCE_REFERENCE& r )->bool
|
|
{
|
|
return aOldSheetPath == r.m_Path;
|
|
}
|
|
);
|
|
|
|
if( it != m_instanceReferences.end() )
|
|
{
|
|
wxLogTrace( traceSchSheetPaths,
|
|
"Replacing sheet path %s\n with sheet path %s\n for symbol %s.",
|
|
aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
|
|
|
|
it->m_Path = aNewSheetPath;
|
|
return true;
|
|
}
|
|
|
|
wxLogTrace( traceSchSheetPaths,
|
|
"Could not find sheet path %s\n to replace with sheet path %s\n for symbol %s.",
|
|
aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::SetOrientation( int aOrientation )
|
|
{
|
|
TRANSFORM temp = TRANSFORM();
|
|
bool transform = false;
|
|
|
|
switch( aOrientation )
|
|
{
|
|
case CMP_ORIENT_0:
|
|
case CMP_NORMAL: // default transform matrix
|
|
m_transform.x1 = 1;
|
|
m_transform.y2 = -1;
|
|
m_transform.x2 = m_transform.y1 = 0;
|
|
break;
|
|
|
|
case CMP_ROTATE_COUNTERCLOCKWISE: // Rotate + (incremental rotation)
|
|
temp.x1 = temp.y2 = 0;
|
|
temp.y1 = 1;
|
|
temp.x2 = -1;
|
|
transform = true;
|
|
break;
|
|
|
|
case CMP_ROTATE_CLOCKWISE: // Rotate - (incremental rotation)
|
|
temp.x1 = temp.y2 = 0;
|
|
temp.y1 = -1;
|
|
temp.x2 = 1;
|
|
transform = true;
|
|
break;
|
|
|
|
case CMP_MIRROR_Y: // Mirror Y (incremental rotation)
|
|
temp.x1 = -1;
|
|
temp.y2 = 1;
|
|
temp.y1 = temp.x2 = 0;
|
|
transform = true;
|
|
break;
|
|
|
|
case CMP_MIRROR_X: // Mirror X (incremental rotation)
|
|
temp.x1 = 1;
|
|
temp.y2 = -1;
|
|
temp.y1 = temp.x2 = 0;
|
|
transform = true;
|
|
break;
|
|
|
|
case CMP_ORIENT_90:
|
|
SetOrientation( CMP_ORIENT_0 );
|
|
SetOrientation( CMP_ROTATE_COUNTERCLOCKWISE );
|
|
break;
|
|
|
|
case CMP_ORIENT_180:
|
|
SetOrientation( CMP_ORIENT_0 );
|
|
SetOrientation( CMP_ROTATE_COUNTERCLOCKWISE );
|
|
SetOrientation( CMP_ROTATE_COUNTERCLOCKWISE );
|
|
break;
|
|
|
|
case CMP_ORIENT_270:
|
|
SetOrientation( CMP_ORIENT_0 );
|
|
SetOrientation( CMP_ROTATE_CLOCKWISE );
|
|
break;
|
|
|
|
case ( CMP_ORIENT_0 + CMP_MIRROR_X ):
|
|
SetOrientation( CMP_ORIENT_0 );
|
|
SetOrientation( CMP_MIRROR_X );
|
|
break;
|
|
|
|
case ( CMP_ORIENT_0 + CMP_MIRROR_Y ):
|
|
SetOrientation( CMP_ORIENT_0 );
|
|
SetOrientation( CMP_MIRROR_Y );
|
|
break;
|
|
|
|
case ( CMP_ORIENT_90 + CMP_MIRROR_X ):
|
|
SetOrientation( CMP_ORIENT_90 );
|
|
SetOrientation( CMP_MIRROR_X );
|
|
break;
|
|
|
|
case ( CMP_ORIENT_90 + CMP_MIRROR_Y ):
|
|
SetOrientation( CMP_ORIENT_90 );
|
|
SetOrientation( CMP_MIRROR_Y );
|
|
break;
|
|
|
|
case ( CMP_ORIENT_180 + CMP_MIRROR_X ):
|
|
SetOrientation( CMP_ORIENT_180 );
|
|
SetOrientation( CMP_MIRROR_X );
|
|
break;
|
|
|
|
case ( CMP_ORIENT_180 + CMP_MIRROR_Y ):
|
|
SetOrientation( CMP_ORIENT_180 );
|
|
SetOrientation( CMP_MIRROR_Y );
|
|
break;
|
|
|
|
case ( CMP_ORIENT_270 + CMP_MIRROR_X ):
|
|
SetOrientation( CMP_ORIENT_270 );
|
|
SetOrientation( CMP_MIRROR_X );
|
|
break;
|
|
|
|
case ( CMP_ORIENT_270 + CMP_MIRROR_Y ):
|
|
SetOrientation( CMP_ORIENT_270 );
|
|
SetOrientation( CMP_MIRROR_Y );
|
|
break;
|
|
|
|
default:
|
|
transform = false;
|
|
wxFAIL_MSG( "Invalid schematic symbol orientation type." );
|
|
break;
|
|
}
|
|
|
|
if( transform )
|
|
{
|
|
/* The new matrix transform is the old matrix transform modified by the
|
|
* requested transformation, which is the temp transform (rot,
|
|
* mirror ..) in order to have (in term of matrix transform):
|
|
* transform coord = new_m_transform * coord
|
|
* where transform coord is the coord modified by new_m_transform from
|
|
* the initial value coord.
|
|
* new_m_transform is computed (from old_m_transform and temp) to
|
|
* have:
|
|
* transform coord = old_m_transform * temp
|
|
*/
|
|
TRANSFORM newTransform;
|
|
|
|
newTransform.x1 = m_transform.x1 * temp.x1 + m_transform.x2 * temp.y1;
|
|
newTransform.y1 = m_transform.y1 * temp.x1 + m_transform.y2 * temp.y1;
|
|
newTransform.x2 = m_transform.x1 * temp.x2 + m_transform.x2 * temp.y2;
|
|
newTransform.y2 = m_transform.y1 * temp.x2 + m_transform.y2 * temp.y2;
|
|
m_transform = newTransform;
|
|
}
|
|
}
|
|
|
|
|
|
int SCH_COMPONENT::GetOrientation()
|
|
{
|
|
int rotate_values[] =
|
|
{
|
|
CMP_ORIENT_0,
|
|
CMP_ORIENT_90,
|
|
CMP_ORIENT_180,
|
|
CMP_ORIENT_270,
|
|
CMP_MIRROR_X + CMP_ORIENT_0,
|
|
CMP_MIRROR_X + CMP_ORIENT_90,
|
|
CMP_MIRROR_X + CMP_ORIENT_270,
|
|
CMP_MIRROR_Y,
|
|
CMP_MIRROR_Y + CMP_ORIENT_0,
|
|
CMP_MIRROR_Y + CMP_ORIENT_90,
|
|
CMP_MIRROR_Y + CMP_ORIENT_180,
|
|
CMP_MIRROR_Y + CMP_ORIENT_270
|
|
};
|
|
|
|
// Try to find the current transform option:
|
|
TRANSFORM transform = m_transform;
|
|
|
|
for( int type_rotate : rotate_values )
|
|
{
|
|
SetOrientation( type_rotate );
|
|
|
|
if( transform == m_transform )
|
|
return type_rotate;
|
|
}
|
|
|
|
// Error: orientation not found in list (should not happen)
|
|
wxFAIL_MSG( "Schematic symbol orientation matrix internal error." );
|
|
m_transform = transform;
|
|
|
|
return CMP_NORMAL;
|
|
}
|
|
|
|
|
|
#if defined(DEBUG)
|
|
|
|
void SCH_COMPONENT::Show( int nestLevel, std::ostream& os ) const
|
|
{
|
|
// for now, make it look like XML:
|
|
NestedSpace( nestLevel, os ) << '<' << GetClass().Lower().mb_str()
|
|
<< " ref=\"" << TO_UTF8( GetField( 0 )->GetName() )
|
|
<< '"' << " chipName=\""
|
|
<< GetLibId().Format() << '"' << m_Pos
|
|
<< " layer=\"" << m_Layer
|
|
<< '"' << ">\n";
|
|
|
|
// skip the reference, it's been output already.
|
|
for( int i = 1; i < GetFieldCount(); ++i )
|
|
{
|
|
wxString value = GetField( i )->GetText();
|
|
|
|
if( !value.IsEmpty() )
|
|
{
|
|
NestedSpace( nestLevel + 1, os ) << "<field" << " name=\""
|
|
<< TO_UTF8( GetField( i )->GetName() )
|
|
<< '"' << " value=\""
|
|
<< TO_UTF8( value ) << "\"/>\n";
|
|
}
|
|
}
|
|
|
|
NestedSpace( nestLevel, os ) << "</" << TO_UTF8( GetClass().Lower() ) << ">\n";
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
EDA_RECT SCH_COMPONENT::GetBodyBoundingBox() const
|
|
{
|
|
EDA_RECT bBox;
|
|
|
|
if( m_part )
|
|
bBox = m_part->GetBodyBoundingBox( m_unit, m_convert );
|
|
else
|
|
bBox = dummy()->GetBodyBoundingBox( m_unit, m_convert );
|
|
|
|
int x0 = bBox.GetX();
|
|
int xm = bBox.GetRight();
|
|
|
|
// We must reverse Y values, because matrix orientation
|
|
// suppose Y axis normal for the library items coordinates,
|
|
// m_transform reverse Y values, but bBox is already reversed!
|
|
int y0 = -bBox.GetY();
|
|
int ym = -bBox.GetBottom();
|
|
|
|
// Compute the real Boundary box (rotated, mirrored ...)
|
|
int x1 = m_transform.x1 * x0 + m_transform.y1 * y0;
|
|
int y1 = m_transform.x2 * x0 + m_transform.y2 * y0;
|
|
int x2 = m_transform.x1 * xm + m_transform.y1 * ym;
|
|
int y2 = m_transform.x2 * xm + m_transform.y2 * ym;
|
|
|
|
bBox.SetX( x1 );
|
|
bBox.SetY( y1 );
|
|
bBox.SetWidth( x2 - x1 );
|
|
bBox.SetHeight( y2 - y1 );
|
|
bBox.Normalize();
|
|
|
|
bBox.Offset( m_Pos );
|
|
return bBox;
|
|
}
|
|
|
|
|
|
const EDA_RECT SCH_COMPONENT::GetBoundingBox() const
|
|
{
|
|
EDA_RECT bbox = GetBodyBoundingBox();
|
|
|
|
for( const SCH_FIELD& field : m_Fields )
|
|
bbox.Merge( field.GetBoundingBox() );
|
|
|
|
return bbox;
|
|
}
|
|
|
|
|
|
const EDA_RECT SCH_COMPONENT::GetBoundingBox( bool aIncludeInvisibleText ) const
|
|
{
|
|
EDA_RECT bbox = GetBodyBoundingBox();
|
|
|
|
for( const SCH_FIELD& field : m_Fields )
|
|
{
|
|
if( field.IsVisible() || aIncludeInvisibleText )
|
|
bbox.Merge( field.GetBoundingBox() );
|
|
}
|
|
|
|
return bbox;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, MSG_PANEL_ITEMS& aList )
|
|
{
|
|
wxString msg;
|
|
|
|
SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
|
|
|
|
// part and alias can differ if alias is not the root
|
|
if( m_part )
|
|
{
|
|
if( m_part.get() != dummy() )
|
|
{
|
|
if( schframe )
|
|
{
|
|
aList.push_back( MSG_PANEL_ITEM(
|
|
_( "Reference" ), GetRef( &schframe->GetCurrentSheet() ), DARKCYAN ) );
|
|
}
|
|
|
|
msg = m_part->IsPower() ? _( "Power symbol" ) : _( "Value" );
|
|
|
|
aList.push_back( MSG_PANEL_ITEM( msg, GetField( VALUE )->GetShownText(), DARKCYAN ) );
|
|
|
|
#if 0 // Display component flags, for debug only
|
|
aList.push_back( MSG_PANEL_ITEM( _( "flags" ),
|
|
wxString::Format("%X", GetEditFlags()), BROWN ) );
|
|
#endif
|
|
|
|
// Display component reference in library and library
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName(), BROWN ) );
|
|
|
|
if( !m_part->IsRoot() )
|
|
{
|
|
msg = _( "Missing parent" );
|
|
|
|
std::shared_ptr< LIB_PART > parent = m_part->GetParent().lock();
|
|
|
|
if( parent )
|
|
msg = parent->GetName();
|
|
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Alias of" ), msg, BROWN ) );
|
|
}
|
|
else if( !m_lib_id.GetLibNickname().empty() )
|
|
{
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Library" ), m_lib_id.GetLibNickname(),
|
|
BROWN ) );
|
|
}
|
|
else
|
|
{
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "Undefined!!!" ), RED ) );
|
|
}
|
|
|
|
// Display the current associated footprint, if exists.
|
|
msg = GetFootprint( &schframe->GetCurrentSheet() );
|
|
|
|
if( msg.IsEmpty() )
|
|
msg = _( "<Unknown>" );
|
|
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), msg, DARKRED ) );
|
|
|
|
// Display description of the component, and keywords found in lib
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Description" ), m_part->GetDescription(),
|
|
DARKCYAN ) );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Key words" ), m_part->GetKeyWords(), DARKCYAN ) );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( schframe )
|
|
{
|
|
aList.push_back( MSG_PANEL_ITEM(
|
|
_( "Reference" ), GetRef( &schframe->GetCurrentSheet() ), DARKCYAN ) );
|
|
}
|
|
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Value" ), GetField( VALUE )->GetShownText(),
|
|
DARKCYAN ) );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName(), BROWN ) );
|
|
|
|
wxString libNickname = GetLibId().GetLibNickname();
|
|
|
|
if( libNickname.empty() )
|
|
{
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "No library defined!" ), RED ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Symbol not found in %s!" ), libNickname );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Library" ), msg , RED ) );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
BITMAP_DEF SCH_COMPONENT::GetMenuImage() const
|
|
{
|
|
return add_component_xpm;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::MirrorY( int aYaxis_position )
|
|
{
|
|
int dx = m_Pos.x;
|
|
|
|
SetOrientation( CMP_MIRROR_Y );
|
|
MIRROR( m_Pos.x, aYaxis_position );
|
|
dx -= m_Pos.x; // dx,0 is the move vector for this transform
|
|
|
|
for( SCH_FIELD& field : m_Fields )
|
|
{
|
|
// Move the fields to the new position because the component itself has moved.
|
|
wxPoint pos = field.GetTextPos();
|
|
pos.x -= dx;
|
|
field.SetTextPos( pos );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::MirrorX( int aXaxis_position )
|
|
{
|
|
int dy = m_Pos.y;
|
|
|
|
SetOrientation( CMP_MIRROR_X );
|
|
MIRROR( m_Pos.y, aXaxis_position );
|
|
dy -= m_Pos.y; // dy,0 is the move vector for this transform
|
|
|
|
for( SCH_FIELD& field : m_Fields )
|
|
{
|
|
// Move the fields to the new position because the component itself has moved.
|
|
wxPoint pos = field.GetTextPos();
|
|
pos.y -= dy;
|
|
field.SetTextPos( pos );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::Rotate( wxPoint aPosition )
|
|
{
|
|
wxPoint prev = m_Pos;
|
|
|
|
RotatePoint( &m_Pos, aPosition, 900 );
|
|
|
|
SetOrientation( CMP_ROTATE_COUNTERCLOCKWISE );
|
|
|
|
for( SCH_FIELD& field : m_Fields )
|
|
{
|
|
// Move the fields to the new position because the component itself has moved.
|
|
wxPoint pos = field.GetTextPos();
|
|
pos.x -= prev.x - m_Pos.x;
|
|
pos.y -= prev.y - m_Pos.y;
|
|
field.SetTextPos( pos );
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::Matches( wxFindReplaceData& aSearchData, void* aAuxData )
|
|
{
|
|
wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
|
|
|
|
// Components are searchable via the child field and pin item text.
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::GetEndPoints( std::vector <DANGLING_END_ITEM>& aItemList )
|
|
{
|
|
for( auto& pin : m_pins )
|
|
{
|
|
LIB_PIN* lib_pin = pin->GetLibPin();
|
|
|
|
if( lib_pin->GetUnit() && m_unit && ( m_unit != lib_pin->GetUnit() ) )
|
|
continue;
|
|
|
|
DANGLING_END_ITEM item( PIN_END, lib_pin, GetPinPhysicalPosition( lib_pin ), this );
|
|
aItemList.push_back( item );
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemList,
|
|
const SCH_SHEET_PATH* aPath )
|
|
{
|
|
bool changed = false;
|
|
|
|
for( std::unique_ptr<SCH_PIN>& pin : m_pins )
|
|
{
|
|
bool previousState = pin->IsDangling();
|
|
pin->SetIsDangling( true );
|
|
|
|
wxPoint pos = m_transform.TransformCoordinate( pin->GetLocalPosition() ) + m_Pos;
|
|
|
|
for( DANGLING_END_ITEM& each_item : aItemList )
|
|
{
|
|
// Some people like to stack pins on top of each other in a symbol to indicate
|
|
// internal connection. While technically connected, it is not particularly useful
|
|
// to display them that way, so skip any pins that are in the same symbol as this
|
|
// one.
|
|
if( each_item.GetParent() == this )
|
|
continue;
|
|
|
|
switch( each_item.GetType() )
|
|
{
|
|
case PIN_END:
|
|
case LABEL_END:
|
|
case SHEET_LABEL_END:
|
|
case WIRE_START_END:
|
|
case WIRE_END_END:
|
|
case NO_CONNECT_END:
|
|
case JUNCTION_END:
|
|
|
|
if( pos == each_item.GetPosition() )
|
|
pin->SetIsDangling( false );
|
|
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
|
|
if( !pin->IsDangling() )
|
|
break;
|
|
}
|
|
|
|
changed = ( changed || ( previousState != pin->IsDangling() ) );
|
|
}
|
|
|
|
return changed;
|
|
}
|
|
|
|
|
|
wxPoint SCH_COMPONENT::GetPinPhysicalPosition( const LIB_PIN* Pin ) const
|
|
{
|
|
wxCHECK_MSG( Pin != NULL && Pin->Type() == LIB_PIN_T, wxPoint( 0, 0 ),
|
|
wxT( "Cannot get physical position of pin." ) );
|
|
|
|
return m_transform.TransformCoordinate( Pin->GetPosition() ) + m_Pos;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::GetConnectionPoints( std::vector< wxPoint >& aPoints ) const
|
|
{
|
|
for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
|
|
{
|
|
// Collect only pins attached to the current unit and convert.
|
|
// others are not associated to this component instance
|
|
int pin_unit = pin->GetLibPin()->GetUnit();
|
|
int pin_convert = pin->GetLibPin()->GetConvert();
|
|
|
|
if( pin_unit > 0 && pin_unit != GetUnit() )
|
|
continue;
|
|
|
|
if( pin_convert > 0 && pin_convert != GetConvert() )
|
|
continue;
|
|
|
|
aPoints.push_back( m_transform.TransformCoordinate( pin->GetLocalPosition() ) + m_Pos );
|
|
}
|
|
}
|
|
|
|
|
|
LIB_ITEM* SCH_COMPONENT::GetDrawItem( const wxPoint& aPosition, KICAD_T aType )
|
|
{
|
|
if( m_part )
|
|
{
|
|
// Calculate the position relative to the component.
|
|
wxPoint libPosition = aPosition - m_Pos;
|
|
|
|
return m_part->LocateDrawItem( m_unit, m_convert, aType, libPosition, m_transform );
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
wxString SCH_COMPONENT::GetSelectMenuText( EDA_UNITS aUnits ) const
|
|
{
|
|
return wxString::Format( _( "Symbol %s, %s" ),
|
|
GetLibId().GetLibItemName().wx_str(),
|
|
GetField( REFERENCE )->GetShownText() );
|
|
}
|
|
|
|
|
|
SEARCH_RESULT SCH_COMPONENT::Visit( INSPECTOR aInspector, void* aTestData,
|
|
const KICAD_T aFilterTypes[] )
|
|
{
|
|
KICAD_T stype;
|
|
|
|
for( const KICAD_T* p = aFilterTypes; (stype = *p) != EOT; ++p )
|
|
{
|
|
if( stype == SCH_LOCATE_ANY_T
|
|
|| ( stype == SCH_COMPONENT_T )
|
|
|| ( stype == SCH_COMPONENT_LOCATE_POWER_T && m_part && m_part->IsPower() ) )
|
|
{
|
|
if( SEARCH_RESULT::QUIT == aInspector( this, aTestData ) )
|
|
return SEARCH_RESULT::QUIT;
|
|
}
|
|
|
|
if( stype == SCH_LOCATE_ANY_T || stype == SCH_FIELD_T )
|
|
{
|
|
for( SCH_FIELD& field : m_Fields )
|
|
{
|
|
if( SEARCH_RESULT::QUIT == aInspector( &field, (void*) this ) )
|
|
return SEARCH_RESULT::QUIT;
|
|
}
|
|
}
|
|
|
|
if( stype == SCH_FIELD_LOCATE_REFERENCE_T )
|
|
{
|
|
if( SEARCH_RESULT::QUIT == aInspector( GetField( REFERENCE ), (void*) this ) )
|
|
return SEARCH_RESULT::QUIT;
|
|
}
|
|
|
|
if( stype == SCH_FIELD_LOCATE_VALUE_T
|
|
|| ( stype == SCH_COMPONENT_LOCATE_POWER_T && m_part && m_part->IsPower() ) )
|
|
{
|
|
if( SEARCH_RESULT::QUIT == aInspector( GetField( VALUE ), (void*) this ) )
|
|
return SEARCH_RESULT::QUIT;
|
|
}
|
|
|
|
if( stype == SCH_FIELD_LOCATE_FOOTPRINT_T )
|
|
{
|
|
if( SEARCH_RESULT::QUIT == aInspector( GetField( FOOTPRINT ), (void*) this ) )
|
|
return SEARCH_RESULT::QUIT;
|
|
}
|
|
|
|
if( stype == SCH_FIELD_LOCATE_DATASHEET_T )
|
|
{
|
|
if( SEARCH_RESULT::QUIT == aInspector( GetField( DATASHEET ), (void*) this ) )
|
|
return SEARCH_RESULT::QUIT;
|
|
}
|
|
|
|
if( stype == SCH_LOCATE_ANY_T || stype == SCH_PIN_T )
|
|
{
|
|
for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
|
|
{
|
|
// Collect only pins attached to the current unit and convert.
|
|
// others are not associated to this component instance
|
|
int pin_unit = pin->GetLibPin()->GetUnit();
|
|
int pin_convert = pin->GetLibPin()->GetConvert();
|
|
|
|
if( pin_unit > 0 && pin_unit != GetUnit() )
|
|
continue;
|
|
|
|
if( pin_convert > 0 && pin_convert != GetConvert() )
|
|
continue;
|
|
|
|
if( SEARCH_RESULT::QUIT == aInspector( pin.get(), (void*) this ) )
|
|
return SEARCH_RESULT::QUIT;
|
|
}
|
|
}
|
|
}
|
|
|
|
return SEARCH_RESULT::CONTINUE;
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::operator <( const SCH_ITEM& aItem ) const
|
|
{
|
|
if( Type() != aItem.Type() )
|
|
return Type() < aItem.Type();
|
|
|
|
auto component = static_cast<const SCH_COMPONENT*>( &aItem );
|
|
|
|
EDA_RECT rect = GetBodyBoundingBox();
|
|
|
|
if( rect.GetArea() != component->GetBodyBoundingBox().GetArea() )
|
|
return rect.GetArea() < component->GetBodyBoundingBox().GetArea();
|
|
|
|
if( m_Pos.x != component->m_Pos.x )
|
|
return m_Pos.x < component->m_Pos.x;
|
|
|
|
if( m_Pos.y != component->m_Pos.y )
|
|
return m_Pos.y < component->m_Pos.y;
|
|
|
|
return m_Uuid < aItem.m_Uuid; // Ensure deterministic sort
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::operator==( const SCH_COMPONENT& aComponent ) const
|
|
{
|
|
if( GetFieldCount() != aComponent.GetFieldCount() )
|
|
return false;
|
|
|
|
for( int i = VALUE; i < GetFieldCount(); i++ )
|
|
{
|
|
if( GetField( i )->GetText().Cmp( aComponent.GetField( i )->GetText() ) != 0 )
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::operator!=( const SCH_COMPONENT& aComponent ) const
|
|
{
|
|
return !( *this == aComponent );
|
|
}
|
|
|
|
|
|
SCH_COMPONENT& SCH_COMPONENT::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_COMPONENT* c = (SCH_COMPONENT*) &aItem;
|
|
|
|
m_lib_id = c->m_lib_id;
|
|
|
|
LIB_PART* libSymbol = c->m_part ? new LIB_PART( *c->m_part.get() ) : nullptr;
|
|
|
|
m_part.reset( libSymbol );
|
|
m_Pos = c->m_Pos;
|
|
m_unit = c->m_unit;
|
|
m_convert = c->m_convert;
|
|
m_transform = c->m_transform;
|
|
|
|
m_instanceReferences = c->m_instanceReferences;
|
|
|
|
m_Fields = c->m_Fields; // std::vector's assignment operator
|
|
|
|
// Reparent fields after assignment to new component.
|
|
for( SCH_FIELD& field : m_Fields )
|
|
field.SetParent( this );
|
|
|
|
UpdatePins();
|
|
}
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::HitTest( const wxPoint& aPosition, int aAccuracy ) const
|
|
{
|
|
EDA_RECT bBox = GetBodyBoundingBox();
|
|
bBox.Inflate( aAccuracy );
|
|
|
|
if( bBox.Contains( aPosition ) )
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const
|
|
{
|
|
if( m_Flags & STRUCT_DELETED || m_Flags & SKIP_STRUCT )
|
|
return false;
|
|
|
|
EDA_RECT rect = aRect;
|
|
|
|
rect.Inflate( aAccuracy );
|
|
|
|
if( aContained )
|
|
return rect.Contains( GetBodyBoundingBox() );
|
|
|
|
return rect.Intersects( GetBodyBoundingBox() );
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::doIsConnected( const wxPoint& aPosition ) const
|
|
{
|
|
wxPoint new_pos = m_transform.InverseTransform().TransformCoordinate( aPosition - m_Pos );
|
|
|
|
for( const auto& pin : m_pins )
|
|
{
|
|
// Collect only pins attached to the current unit and convert.
|
|
// others are not associated to this component instance
|
|
int pin_unit = pin->GetLibPin()->GetUnit();
|
|
int pin_convert = pin->GetLibPin()->GetConvert();
|
|
|
|
if( pin_unit > 0 && pin_unit != GetUnit() )
|
|
continue;
|
|
|
|
if( pin_convert > 0 && pin_convert != GetConvert() )
|
|
continue;
|
|
|
|
if( pin->GetLocalPosition() == new_pos )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::IsInNetlist() const
|
|
{
|
|
return m_isInNetlist;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::Plot( PLOTTER* aPlotter )
|
|
{
|
|
if( m_part )
|
|
{
|
|
TRANSFORM temp = GetTransform();
|
|
aPlotter->StartBlock( nullptr );
|
|
|
|
m_part->Plot( aPlotter, GetUnit(), GetConvert(), m_Pos, temp );
|
|
|
|
for( SCH_FIELD field : m_Fields )
|
|
field.Plot( aPlotter );
|
|
|
|
aPlotter->EndBlock( nullptr );
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_COMPONENT::HasBrightenedPins()
|
|
{
|
|
for( const auto& pin : m_pins )
|
|
{
|
|
if( pin->IsBrightened() )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_COMPONENT::ClearBrightenedPins()
|
|
{
|
|
for( auto& pin : m_pins )
|
|
pin->ClearBrightened();
|
|
}
|
|
|
|
|