kicad/eeschema/sch_sheet_pin.cpp

530 lines
12 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2006 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 1992-2011 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
*/
/**
* @file sch_sheet_pin.cpp
* @brief Implementation of the SCH_SHEET_PIN class.
*/
2008-04-15 19:38:19 +00:00
#include <fctsys.h>
#include <gr_basic.h>
#include <class_drawpanel.h>
#include <drawtxt.h>
#include <plot_common.h>
#include <trigo.h>
#include <richio.h>
#include <schframe.h>
#include <general.h>
#include <sch_sheet.h>
#include <kicad_string.h>
2008-04-15 19:38:19 +00:00
SCH_SHEET_PIN::SCH_SHEET_PIN( SCH_SHEET* parent, const wxPoint& pos, const wxString& text ) :
SCH_HIERLABEL( pos, text, SCH_SHEET_PIN_T )
2008-04-15 19:38:19 +00:00
{
SetParent( parent );
2008-04-22 16:38:23 +00:00
wxASSERT( parent );
m_Layer = LAYER_SHEETLABEL;
m_Pos = pos;
if( parent->IsVerticalOrientation() )
SetEdge( SHEET_TOP_SIDE );
else
SetEdge( SHEET_LEFT_SIDE );
m_shape = NET_INPUT;
m_isDangling = true;
m_number = 2;
2008-04-15 19:38:19 +00:00
}
EDA_ITEM* SCH_SHEET_PIN::Clone() const
{
return new SCH_SHEET_PIN( *this );
2008-04-15 19:38:19 +00:00
}
void SCH_SHEET_PIN::Draw( EDA_DRAW_PANEL* aPanel,
wxDC* aDC,
const wxPoint& aOffset,
GR_DRAWMODE aDraw_mode,
EDA_COLOR_T aColor )
{
// The icon selection is handle by the virtual method CreateGraphicShape
// called by ::Draw
SCH_HIERLABEL::Draw( aPanel, aDC, aOffset, aDraw_mode, aColor );
}
2008-04-15 19:38:19 +00:00
void SCH_SHEET_PIN::SwapData( SCH_ITEM* aItem )
{
wxCHECK_RET( aItem->Type() == SCH_SHEET_PIN_T,
wxString::Format( wxT( "SCH_SHEET_PIN object cannot swap data with %s object." ),
GetChars( aItem->GetClass() ) ) );
SCH_SHEET_PIN* pin = ( SCH_SHEET_PIN* ) aItem;
SCH_TEXT::SwapData( (SCH_TEXT*) pin );
int tmp = pin->GetNumber();
pin->SetNumber( GetNumber() );
SetNumber( tmp );
SHEET_SIDE stmp = pin->GetEdge();
pin->SetEdge( GetEdge() );
SetEdge( stmp );
}
bool SCH_SHEET_PIN::operator==( const SCH_SHEET_PIN* aPin ) const
{
return aPin == this;
}
int SCH_SHEET_PIN::GetPenSize() const
{
return GetDefaultLineThickness();
}
void SCH_SHEET_PIN::SetNumber( int aNumber )
{
wxASSERT( aNumber >= 2 );
m_number = aNumber;
}
void SCH_SHEET_PIN::SetEdge( SCH_SHEET_PIN::SHEET_SIDE aEdge )
2008-04-15 19:38:19 +00:00
{
SCH_SHEET* Sheet = GetParent();
// use SHEET_UNDEFINED_SIDE to adjust text orientation without changing edge
switch( aEdge )
{
case SHEET_LEFT_SIDE:
m_edge = aEdge;
m_Pos.x = Sheet->m_pos.x;
SetOrientation( 2 ); /* Orientation horiz inverse */
break;
2008-04-15 19:38:19 +00:00
case SHEET_RIGHT_SIDE:
m_edge = aEdge;
m_Pos.x = Sheet->m_pos.x + Sheet->m_size.x;
SetOrientation( 0 ); /* Orientation horiz normal */
break;
2008-04-15 19:38:19 +00:00
case SHEET_TOP_SIDE:
m_edge = aEdge;
m_Pos.y = Sheet->m_pos.y;
SetOrientation( 3 ); /* Orientation vert BOTTOM */
break;
case SHEET_BOTTOM_SIDE:
m_edge = aEdge;
m_Pos.y = Sheet->m_pos.y + Sheet->m_size.y;
SetOrientation( 1 ); /* Orientation vert UP */
break;
default:
break;
2008-04-15 19:38:19 +00:00
}
2009-05-05 18:25:47 +00:00
}
enum SCH_SHEET_PIN::SHEET_SIDE SCH_SHEET_PIN::GetEdge() const
{
return m_edge;
}
void SCH_SHEET_PIN::ConstrainOnEdge( wxPoint Pos )
2009-05-05 18:25:47 +00:00
{
SCH_SHEET* sheet = GetParent();
2008-04-15 19:38:19 +00:00
if( sheet == NULL )
return;
2008-04-15 19:38:19 +00:00
wxPoint center = sheet->m_pos + ( sheet->m_size / 2 );
if( m_edge == SHEET_LEFT_SIDE || m_edge == SHEET_RIGHT_SIDE )
2008-04-15 19:38:19 +00:00
{
if( Pos.x > center.x )
{
SetEdge( SHEET_RIGHT_SIDE );
}
else
{
SetEdge( SHEET_LEFT_SIDE );
}
2008-04-15 19:38:19 +00:00
m_Pos.y = Pos.y;
if( m_Pos.y < sheet->m_pos.y )
m_Pos.y = sheet->m_pos.y;
if( m_Pos.y > (sheet->m_pos.y + sheet->m_size.y) )
m_Pos.y = sheet->m_pos.y + sheet->m_size.y;
}
else /* vertical sheetpin*/
{
if( Pos.y > center.y )
{
SetEdge( SHEET_BOTTOM_SIDE ); //bottom
}
else
{
SetEdge( SHEET_TOP_SIDE ); //top
}
2008-04-15 19:38:19 +00:00
m_Pos.x = Pos.x;
if( m_Pos.x < sheet->m_pos.x )
m_Pos.x = sheet->m_pos.x;
if( m_Pos.x > (sheet->m_pos.x + sheet->m_size.x) )
m_Pos.x = sheet->m_pos.x + sheet->m_size.x;
2008-04-15 19:38:19 +00:00
}
printf( "centre %d %d, pos %d %d, pinpos %d %d, edge %d\n",
center.x, center.y, Pos.x, Pos.y, m_Pos.x, m_Pos.y, m_edge);
2008-04-15 19:38:19 +00:00
}
bool SCH_SHEET_PIN::Save( FILE* aFile ) const
2008-04-15 19:38:19 +00:00
{
int type = 'U', side = 'L';
if( m_Text.IsEmpty() )
return true;
switch( m_edge )
{
default:
case SHEET_LEFT_SIDE: //pin on left side
side = 'L';
break;
case SHEET_RIGHT_SIDE: //pin on right side
2008-04-15 19:38:19 +00:00
side = 'R';
break;
case SHEET_TOP_SIDE: //pin on top side
side = 'T';
break;
case SHEET_BOTTOM_SIDE: //pin on bottom side
side = 'B';
break;
}
2008-04-15 19:38:19 +00:00
switch( m_shape )
2008-04-15 19:38:19 +00:00
{
case NET_INPUT:
type = 'I'; break;
case NET_OUTPUT:
type = 'O'; break;
case NET_BIDI:
type = 'B'; break;
case NET_TRISTATE:
type = 'T'; break;
case NET_UNSPECIFIED:
type = 'U'; break;
}
if( fprintf( aFile, "F%d %s %c %c %-3d %-3d %-3d\n", m_number,
2011-03-22 18:29:26 +00:00
EscapedUTF8( m_Text ).c_str(), // supplies wrapping quotes
type, side, m_Pos.x, m_Pos.y,
m_Size.x ) == EOF )
2008-04-15 19:38:19 +00:00
{
return false;
}
return true;
}
bool SCH_SHEET_PIN::Load( LINE_READER& aLine, wxString& aErrorMsg )
{
2011-03-22 16:49:44 +00:00
int size;
char number[256];
char name[256];
char connectType[256];
char sheetSide[256];
char* line = aLine.Line();
char* cp;
static const char delims[] = " \t";
// Read coordinates.
// D( printf( "line: \"%s\"\n", line );)
2011-03-22 16:49:44 +00:00
cp = strtok( line, delims );
strncpy( number, cp, sizeof(number) );
number[sizeof(number)-1] = 0;
cp += strlen( number ) + 1;
cp += ReadDelimitedText( name, cp, sizeof(name) );
cp = strtok( cp, delims );
strncpy( connectType, cp, sizeof(connectType) );
connectType[sizeof(connectType)-1] = 0;
cp = strtok( NULL, delims );
strncpy( sheetSide, cp, sizeof(sheetSide) );
sheetSide[sizeof(sheetSide)-1] = 0;
cp += strlen( sheetSide ) + 1;
int r = sscanf( cp, "%d %d %d", &m_Pos.x, &m_Pos.y, &size );
if( r != 3 )
{
aErrorMsg.Printf( wxT( "Eeschema file sheet hierarchical label error at line %d.\n" ),
aLine.LineNumber() );
2011-03-22 16:49:44 +00:00
aErrorMsg << FROM_UTF8( line );
return false;
}
m_Text = FROM_UTF8( name );
if( size == 0 )
size = GetDefaultTextSize();
m_Size.x = m_Size.y = size;
switch( connectType[0] )
{
case 'I':
m_shape = NET_INPUT;
break;
case 'O':
m_shape = NET_OUTPUT;
break;
case 'B':
m_shape = NET_BIDI;
break;
case 'T':
m_shape = NET_TRISTATE;
break;
case 'U':
m_shape = NET_UNSPECIFIED;
break;
}
switch( sheetSide[0] )
{
case 'R' : /* pin on right side */
SetEdge( SHEET_RIGHT_SIDE );
break;
case 'T' : /* pin on top side */
SetEdge( SHEET_TOP_SIDE );
break;
case 'B' : /* pin on bottom side */
SetEdge( SHEET_BOTTOM_SIDE );
break;
case 'L' : /* pin on left side */
default :
SetEdge( SHEET_LEFT_SIDE );
break;
}
return true;
}
bool SCH_SHEET_PIN::Matches( wxFindReplaceData& aSearchData,
void* aAuxData, wxPoint* aFindLocation )
{
wxCHECK_MSG( GetParent() != NULL, false,
wxT( "Sheet pin " ) + m_Text + wxT( " does not have a parent sheet!" ) );
wxLogTrace( traceFindItem, wxT( " child item " ) + GetSelectMenuText() );
if( SCH_ITEM::Matches( m_Text, aSearchData ) )
{
if( aFindLocation )
*aFindLocation = GetBoundingBox().Centre();
return true;
}
return false;
}
void SCH_SHEET_PIN::MirrorX( int aXaxis_position )
{
int p = m_Pos.y - aXaxis_position;
m_Pos.y = aXaxis_position - p;
switch( m_edge )
{
case SHEET_TOP_SIDE:
SetEdge( SHEET_BOTTOM_SIDE );
break;
case SHEET_BOTTOM_SIDE:
SetEdge( SHEET_TOP_SIDE );
break;
default:
break;
}
}
void SCH_SHEET_PIN::MirrorY( int aYaxis_position )
{
int p = m_Pos.x - aYaxis_position;
m_Pos.x = aYaxis_position - p;
switch( m_edge )
{
case SHEET_LEFT_SIDE:
SetEdge( SHEET_RIGHT_SIDE );
break;
case SHEET_RIGHT_SIDE:
SetEdge( SHEET_LEFT_SIDE );
break;
default:
break;
}
}
void SCH_SHEET_PIN::Rotate( wxPoint aPosition )
{
RotatePoint( &m_Pos, aPosition, 900 );
switch( m_edge )
{
case SHEET_LEFT_SIDE: //pin on left side
SetEdge( SHEET_BOTTOM_SIDE );
break;
case SHEET_RIGHT_SIDE: //pin on right side
SetEdge( SHEET_TOP_SIDE );
break;
case SHEET_TOP_SIDE: //pin on top side
SetEdge( SHEET_LEFT_SIDE );
break;
case SHEET_BOTTOM_SIDE: //pin on bottom side
SetEdge( SHEET_RIGHT_SIDE );
break;
default:
break;
}
}
void SCH_SHEET_PIN::CreateGraphicShape( std::vector <wxPoint>& aPoints, const wxPoint& aPos )
{
/* This is the same icon shapes as SCH_HIERLABEL
* but the graphic icon is slightly different in 2 cases:
* for INPUT type the icon is the OUTPUT shape of SCH_HIERLABEL
* for OUTPUT type the icon is the INPUT shape of SCH_HIERLABEL
*/
int tmp = m_shape;
switch( m_shape )
{
case NET_INPUT:
m_shape = NET_OUTPUT;
break;
case NET_OUTPUT:
m_shape = NET_INPUT;
break;
default:
break;
}
SCH_HIERLABEL::CreateGraphicShape( aPoints, aPos );
m_shape = tmp;
}
void SCH_SHEET_PIN::GetEndPoints( std::vector <DANGLING_END_ITEM>& aItemList )
{
2011-12-06 21:02:21 +00:00
DANGLING_END_ITEM item( SHEET_LABEL_END, this, m_Pos );
aItemList.push_back( item );
}
wxString SCH_SHEET_PIN::GetSelectMenuText() const
{
2011-03-26 10:08:50 +00:00
wxString tmp;
tmp.Printf( _( "Hierarchical Sheet Pin %s" ), GetChars( ShortenedShownText() ) );
2011-03-26 10:08:50 +00:00
return tmp;
}
bool SCH_SHEET_PIN::HitTest( const wxPoint& aPoint, int aAccuracy ) const
{
EDA_RECT rect = GetBoundingBox();
rect.Inflate( aAccuracy );
return rect.Contains( aPoint );
}
2008-04-22 16:38:23 +00:00
#if defined(DEBUG)
void SCH_SHEET_PIN::Show( int nestLevel, std::ostream& os ) const
2008-04-22 16:38:23 +00:00
{
// XML output:
wxString s = GetClass();
NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str() << ">"
<< " pin_name=\"" << TO_UTF8( m_Text )
<< '"' << "/>\n" << std::flush;
2008-04-22 16:38:23 +00:00
// NestedSpace( nestLevel, os ) << "</" << s.Lower().mb_str() << ">\n";
}
#endif