1034 lines
25 KiB
C++
1034 lines
25 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: sch_sheet.cpp
|
|
// Purpose: member functions for SCH_SHEET
|
|
// header = sch_sheet.h
|
|
// Author: jean-pierre Charras
|
|
// Modified by: Wayne Stambaugh
|
|
// Created: 08/02/2006 18:37:02
|
|
// RCS-ID:
|
|
// Copyright:
|
|
// License: License GNU
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#include "fctsys.h"
|
|
#include "gr_basic.h"
|
|
#include "common.h"
|
|
#include "macros.h"
|
|
#include "class_drawpanel.h"
|
|
#include "drawtxt.h"
|
|
#include "trigo.h"
|
|
#include "richio.h"
|
|
#include "class_sch_screen.h"
|
|
#include "wxEeschemaStruct.h"
|
|
|
|
#include "general.h"
|
|
#include "protos.h"
|
|
#include "sch_sheet.h"
|
|
#include "sch_sheet_path.h"
|
|
#include "sch_component.h"
|
|
#include "kicad_string.h"
|
|
|
|
SCH_SHEET::SCH_SHEET( const wxPoint& pos ) :
|
|
SCH_ITEM( NULL, SCH_SHEET_T )
|
|
{
|
|
m_Layer = LAYER_SHEET;
|
|
m_Pos = pos;
|
|
m_TimeStamp = GetTimeStamp();
|
|
m_SheetNameSize = m_FileNameSize = 60;
|
|
m_AssociatedScreen = NULL;
|
|
m_SheetName.Printf( wxT( "Sheet%8.8lX" ), m_TimeStamp );
|
|
m_FileName.Printf( wxT( "file%8.8lX.sch" ), m_TimeStamp );
|
|
}
|
|
|
|
|
|
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;
|
|
m_TimeStamp = aSheet.m_TimeStamp;
|
|
m_SheetNameSize = aSheet.m_SheetNameSize;
|
|
m_FileNameSize = aSheet.m_FileNameSize;
|
|
m_AssociatedScreen = aSheet.m_AssociatedScreen;
|
|
m_SheetName = aSheet.m_SheetName;
|
|
m_FileName = aSheet.m_FileName;
|
|
m_pins = aSheet.m_pins;
|
|
|
|
for( size_t i = 0; i < m_pins.size(); i++ )
|
|
m_pins[i].SetParent( this );
|
|
|
|
if( m_AssociatedScreen )
|
|
m_AssociatedScreen->IncRefCount();
|
|
}
|
|
|
|
|
|
SCH_SHEET::~SCH_SHEET()
|
|
{
|
|
wxLogDebug( wxT( "Destroying sheet " ) + m_SheetName );
|
|
|
|
// also, look at the associated sheet & its reference count
|
|
// perhaps it should be deleted also.
|
|
if( m_AssociatedScreen )
|
|
{
|
|
m_AssociatedScreen->DecRefCount();
|
|
|
|
if( m_AssociatedScreen->GetRefCount() == 0 )
|
|
delete m_AssociatedScreen;
|
|
}
|
|
}
|
|
|
|
|
|
EDA_ITEM* SCH_SHEET::doClone() const
|
|
{
|
|
return new SCH_SHEET( *this );
|
|
}
|
|
|
|
|
|
void SCH_SHEET::SetScreen( SCH_SCREEN* aScreen )
|
|
{
|
|
if( aScreen == m_AssociatedScreen )
|
|
return;
|
|
|
|
if( m_AssociatedScreen != NULL )
|
|
{
|
|
m_AssociatedScreen->DecRefCount();
|
|
|
|
if( m_AssociatedScreen->GetRefCount() == 0 )
|
|
{
|
|
delete m_AssociatedScreen;
|
|
m_AssociatedScreen = NULL;
|
|
}
|
|
}
|
|
|
|
m_AssociatedScreen = aScreen;
|
|
|
|
if( m_AssociatedScreen )
|
|
m_AssociatedScreen->IncRefCount();
|
|
}
|
|
|
|
|
|
int SCH_SHEET::GetScreenCount() const
|
|
{
|
|
if( m_AssociatedScreen == NULL )
|
|
return 0;
|
|
|
|
return m_AssociatedScreen->GetRefCount();
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::Save( FILE* aFile ) const
|
|
{
|
|
if( fprintf( aFile, "$Sheet\n" ) == EOF
|
|
|| fprintf( aFile, "S %-4d %-4d %-4d %-4d\n",
|
|
m_Pos.x, m_Pos.y, m_Size.x, m_Size.y ) == EOF )
|
|
return false;
|
|
|
|
//save the unique timestamp, like other schematic parts.
|
|
if( fprintf( aFile, "U %8.8lX\n", m_TimeStamp ) == EOF )
|
|
return false;
|
|
|
|
/* Save schematic sheetname and filename. */
|
|
if( !m_SheetName.IsEmpty() )
|
|
{
|
|
if( fprintf( aFile, "F0 %s %d\n", EscapedUTF8( m_SheetName ).c_str(),
|
|
m_SheetNameSize ) == EOF )
|
|
return false;
|
|
}
|
|
|
|
if( !m_FileName.IsEmpty() )
|
|
{
|
|
if( fprintf( aFile, "F1 %s %d\n", EscapedUTF8( m_FileName ).c_str(),
|
|
m_FileNameSize ) == EOF )
|
|
return false;
|
|
}
|
|
|
|
/* Save the list of labels in the sheet. */
|
|
|
|
BOOST_FOREACH( const SCH_SHEET_PIN& label, m_pins )
|
|
{
|
|
if( !label.Save( aFile ) )
|
|
return false;
|
|
}
|
|
|
|
if( fprintf( aFile, "$EndSheet\n" ) == EOF )
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::Load( LINE_READER& aLine, wxString& aErrorMsg )
|
|
{
|
|
int fieldNdx, size;
|
|
SCH_SHEET_PIN* sheetPin;
|
|
char* ptcar;
|
|
|
|
m_TimeStamp = GetTimeStamp();
|
|
|
|
// sheets are added to the GetDrawItems() like other schematic components.
|
|
// however, in order to preserve the hierarchy (through m_Parent pointers),
|
|
// a duplicate of the sheet is added to m_SubSheet array.
|
|
// must be a duplicate, references just work for a two-layer structure.
|
|
// this is accomplished through the Sync() function.
|
|
|
|
if( ((char*)aLine)[0] == '$' ) // line should be "$Sheet"
|
|
{
|
|
if( !aLine.ReadLine() )
|
|
{
|
|
aErrorMsg.Printf( wxT( "Read File Errror" ) );
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/* Next line: must be "S xx yy nn mm" with xx, yy = sheet position
|
|
* ( upper left corner ) et nn,mm = sheet size */
|
|
if( ( sscanf( &((char*)aLine)[1], "%d %d %d %d",
|
|
&m_Pos.x, &m_Pos.y, &m_Size.x, &m_Size.y ) != 4 )
|
|
|| ( ((char*)aLine)[0] != 'S' ) )
|
|
{
|
|
aErrorMsg.Printf( wxT( " ** EESchema file sheet struct error at line %d, aborted\n" ),
|
|
aLine.LineNumber() );
|
|
|
|
aErrorMsg << FROM_UTF8( ((char*)aLine) );
|
|
return false;
|
|
}
|
|
|
|
/* Read fields */
|
|
for( ; ; ) /* Analysis of lines "Fn" text. */
|
|
{
|
|
if( !aLine.ReadLine() )
|
|
return false;
|
|
|
|
if( ((char*)aLine)[0] == 'U' )
|
|
{
|
|
sscanf( ((char*)aLine) + 1, "%lX", &m_TimeStamp );
|
|
if( m_TimeStamp == 0 ) // zero is not unique!
|
|
m_TimeStamp = GetTimeStamp();
|
|
continue;
|
|
}
|
|
|
|
if( ((char*)aLine)[0] != 'F' )
|
|
break;
|
|
|
|
sscanf( ((char*)aLine) + 1, "%d", &fieldNdx );
|
|
|
|
/* Read the field:
|
|
* If fieldNdx> = 2: Fn "text" t s posx posy
|
|
* If F0 "text" for SheetName
|
|
* F1 and "text" for filename
|
|
*/
|
|
ptcar = ((char*)aLine);
|
|
while( *ptcar && ( *ptcar != '"' ) )
|
|
ptcar++;
|
|
|
|
if( *ptcar != '"' )
|
|
{
|
|
aErrorMsg.Printf( wxT( "EESchema file sheet label F%d at line %d, aborted\n" ),
|
|
fieldNdx, aLine.LineNumber() );
|
|
aErrorMsg << FROM_UTF8( (char*) aLine );
|
|
return false;
|
|
}
|
|
|
|
wxString sheetName;
|
|
ptcar += ReadDelimitedText( &sheetName, ptcar );
|
|
|
|
if( *ptcar == 0 )
|
|
{
|
|
aErrorMsg.Printf( wxT( "EESchema file sheet field F at line %d, aborted\n" ),
|
|
aLine.LineNumber() );
|
|
aErrorMsg << FROM_UTF8( (char*) aLine );
|
|
return false;
|
|
}
|
|
|
|
if( ( fieldNdx == 0 ) || ( fieldNdx == 1 ) )
|
|
{
|
|
if( sscanf( ptcar, "%d", &size ) != 1 )
|
|
{
|
|
aErrorMsg.Printf( wxT( "EESchema file sheet Label error line %d, aborted\n" ),
|
|
aLine.LineNumber() );
|
|
|
|
aErrorMsg << FROM_UTF8( (char*) aLine );
|
|
}
|
|
if( size == 0 )
|
|
size = DEFAULT_SIZE_TEXT;
|
|
|
|
if( fieldNdx == 0 )
|
|
{
|
|
m_SheetName = sheetName;
|
|
m_SheetNameSize = size;
|
|
}
|
|
else
|
|
{
|
|
SetFileName( sheetName );
|
|
m_FileNameSize = size;
|
|
}
|
|
}
|
|
|
|
if( fieldNdx > 1 )
|
|
{
|
|
sheetPin = new SCH_SHEET_PIN( this );
|
|
|
|
if( !sheetPin->Load( aLine, aErrorMsg ) )
|
|
{
|
|
delete sheetPin;
|
|
sheetPin = NULL;
|
|
return false;
|
|
}
|
|
|
|
AddPin( sheetPin );
|
|
}
|
|
}
|
|
|
|
if( strnicmp( "$End", ((char*)aLine), 4 ) != 0 )
|
|
{
|
|
aErrorMsg.Printf( wxT( "**EESchema file end_sheet struct error at line %d, aborted\n" ),
|
|
aLine.LineNumber() );
|
|
aErrorMsg << FROM_UTF8( ((char*)aLine) );
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::SwapData( SCH_SHEET* copyitem )
|
|
{
|
|
EXCHG( m_Pos, copyitem->m_Pos );
|
|
EXCHG( m_Size, copyitem->m_Size );
|
|
EXCHG( m_SheetName, copyitem->m_SheetName );
|
|
EXCHG( m_SheetNameSize, copyitem->m_SheetNameSize );
|
|
EXCHG( m_FileNameSize, copyitem->m_FileNameSize );
|
|
m_pins.swap( copyitem->m_pins );
|
|
|
|
// Ensure sheet labels have their .m_Parent member pointing really on their
|
|
// parent, after swapping.
|
|
BOOST_FOREACH( SCH_SHEET_PIN& sheetPin, m_pins )
|
|
{
|
|
sheetPin.SetParent( this );
|
|
}
|
|
|
|
BOOST_FOREACH( SCH_SHEET_PIN& sheetPin, copyitem->m_pins )
|
|
{
|
|
sheetPin.SetParent( copyitem );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::AddPin( SCH_SHEET_PIN* aSheetPin )
|
|
{
|
|
wxASSERT( aSheetPin != NULL );
|
|
wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
|
|
|
|
m_pins.push_back( aSheetPin );
|
|
renumberPins();
|
|
}
|
|
|
|
|
|
void SCH_SHEET::RemovePin( SCH_SHEET_PIN* aSheetPin )
|
|
{
|
|
wxASSERT( aSheetPin != NULL );
|
|
wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
|
|
|
|
SCH_SHEET_PINS::iterator i;
|
|
|
|
for( i = m_pins.begin(); i < m_pins.end(); ++i )
|
|
{
|
|
if( *i == aSheetPin )
|
|
{
|
|
m_pins.erase( i );
|
|
renumberPins();
|
|
return;
|
|
}
|
|
}
|
|
|
|
wxLogDebug( wxT( "Fix me: attempt to remove label %s which is not in sheet %s." ),
|
|
GetChars( aSheetPin->m_Text ), GetChars( m_SheetName ) );
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HasPin( const wxString& aName )
|
|
{
|
|
BOOST_FOREACH( SCH_SHEET_PIN pin, m_pins )
|
|
{
|
|
if( pin.m_Text.CmpNoCase( aName ) == 0 )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::IsVerticalOrientation()
|
|
{
|
|
BOOST_FOREACH( SCH_SHEET_PIN pin, m_pins )
|
|
{
|
|
if( pin.GetEdge() > 1 )
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::HasUndefinedPins()
|
|
{
|
|
BOOST_FOREACH( SCH_SHEET_PIN pin, m_pins )
|
|
{
|
|
/* Search the schematic for a hierarchical label corresponding to this sheet label. */
|
|
EDA_ITEM* DrawStruct = m_AssociatedScreen->GetDrawItems();
|
|
SCH_HIERLABEL* HLabel = NULL;
|
|
|
|
for( ; DrawStruct != NULL; DrawStruct = DrawStruct->Next() )
|
|
{
|
|
if( DrawStruct->Type() != SCH_HIERARCHICAL_LABEL_T )
|
|
continue;
|
|
|
|
HLabel = (SCH_HIERLABEL*) DrawStruct;
|
|
|
|
if( pin.m_Text.CmpNoCase( HLabel->m_Text ) == 0 )
|
|
break; // Found!
|
|
|
|
HLabel = NULL;
|
|
}
|
|
|
|
if( HLabel == NULL ) // Corresponding hierarchical label not found.
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Place( SCH_EDIT_FRAME* frame, wxDC* DC )
|
|
{
|
|
/* Place list structures for new sheet. */
|
|
if( IsNew() )
|
|
{
|
|
// fix size and position of the new sheet
|
|
// using the last values set by the m_mouseCaptureCallback function
|
|
frame->DrawPanel->SetMouseCapture( NULL, NULL );
|
|
|
|
if( !frame->EditSheet( this, DC ) )
|
|
{
|
|
frame->GetScreen()->SetCurItem( NULL );
|
|
Draw( frame->DrawPanel, DC, wxPoint( 0, 0 ), g_XorMode );
|
|
delete this;
|
|
return;
|
|
}
|
|
}
|
|
else /* save old text in undo list */
|
|
{
|
|
frame->SaveUndoItemInUndoList( this );
|
|
}
|
|
|
|
SCH_ITEM::Place( frame, DC ); //puts it on the GetDrawItems().
|
|
|
|
if( IsNew() )
|
|
{
|
|
frame->SetSheetNumberAndCount();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Delete sheet labels which do not have corresponding hierarchical label.
|
|
*/
|
|
void SCH_SHEET::CleanupSheet()
|
|
{
|
|
SCH_SHEET_PINS::iterator i = m_pins.begin();
|
|
|
|
while( i != m_pins.end() )
|
|
{
|
|
/* Search the schematic for a hierarchical label corresponding to this sheet label. */
|
|
EDA_ITEM* DrawStruct = m_AssociatedScreen->GetDrawItems();
|
|
SCH_HIERLABEL* HLabel = NULL;
|
|
|
|
for( ; DrawStruct != NULL; DrawStruct = DrawStruct->Next() )
|
|
{
|
|
if( DrawStruct->Type() != SCH_HIERARCHICAL_LABEL_T )
|
|
continue;
|
|
|
|
HLabel = (SCH_HIERLABEL*) DrawStruct;
|
|
|
|
if( i->m_Text.CmpNoCase( HLabel->m_Text ) == 0 )
|
|
break; // Found!
|
|
|
|
HLabel = NULL;
|
|
}
|
|
|
|
if( HLabel == NULL ) // Hlabel not found: delete sheet label.
|
|
m_pins.erase( i );
|
|
else
|
|
++i;
|
|
}
|
|
}
|
|
|
|
|
|
SCH_SHEET_PIN* SCH_SHEET::GetPin( const wxPoint& aPosition )
|
|
{
|
|
BOOST_FOREACH( SCH_SHEET_PIN& pin, m_pins )
|
|
{
|
|
if( pin.HitTest( aPosition ) )
|
|
return &pin;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
int SCH_SHEET::GetPenSize() const
|
|
{
|
|
return g_DrawDefaultLineThickness;
|
|
}
|
|
|
|
|
|
wxPoint SCH_SHEET::GetSheetNamePosition()
|
|
{
|
|
wxPoint pos = m_Pos;
|
|
if( IsVerticalOrientation() )
|
|
{
|
|
pos.x -= 8;
|
|
pos.y += m_Size.y;
|
|
}
|
|
else
|
|
{
|
|
pos.y -= 8;
|
|
}
|
|
|
|
return pos;
|
|
}
|
|
|
|
|
|
wxPoint SCH_SHEET::GetFileNamePosition()
|
|
{
|
|
wxPoint pos = m_Pos;
|
|
if( IsVerticalOrientation() )
|
|
{
|
|
pos.x += m_Size.x+4;
|
|
pos.y += m_Size.y;
|
|
}
|
|
else
|
|
{
|
|
pos.y += m_Size.y + 4;
|
|
}
|
|
|
|
return pos;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC,
|
|
const wxPoint& aOffset, int aDrawMode, int aColor )
|
|
{
|
|
int txtcolor;
|
|
wxString Text;
|
|
int color;
|
|
int name_orientation;
|
|
wxPoint pos_sheetname,pos_filename;
|
|
wxPoint pos = m_Pos + aOffset;
|
|
int lineWidth = GetPenSize();
|
|
|
|
if( aColor >= 0 )
|
|
color = aColor;
|
|
else
|
|
color = ReturnLayerColor( m_Layer );
|
|
|
|
GRSetDrawMode( aDC, aDrawMode );
|
|
|
|
GRRect( &aPanel->m_ClipBox, aDC, pos.x, pos.y,
|
|
pos.x + m_Size.x, pos.y + m_Size.y, lineWidth, color );
|
|
|
|
pos_sheetname = GetSheetNamePosition() + aOffset;
|
|
pos_filename = GetFileNamePosition() + aOffset;
|
|
|
|
if( IsVerticalOrientation() )
|
|
name_orientation = TEXT_ORIENT_VERT;
|
|
else
|
|
name_orientation = TEXT_ORIENT_HORIZ;
|
|
|
|
/* Draw text : SheetName */
|
|
if( aColor > 0 )
|
|
txtcolor = aColor;
|
|
else
|
|
txtcolor = ReturnLayerColor( LAYER_SHEETNAME );
|
|
|
|
Text = wxT( "Sheet: " ) + m_SheetName;
|
|
DrawGraphicText( aPanel, aDC, pos_sheetname,
|
|
(EDA_Colors) txtcolor, Text, name_orientation,
|
|
wxSize( m_SheetNameSize, m_SheetNameSize ),
|
|
GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, lineWidth,
|
|
false, false );
|
|
|
|
/* Draw text : FileName */
|
|
if( aColor >= 0 )
|
|
txtcolor = aColor;
|
|
else
|
|
txtcolor = ReturnLayerColor( LAYER_SHEETFILENAME );
|
|
|
|
Text = wxT( "File: " ) + m_FileName;
|
|
DrawGraphicText( aPanel, aDC, pos_filename,
|
|
(EDA_Colors) txtcolor, Text, name_orientation,
|
|
wxSize( m_FileNameSize, m_FileNameSize ),
|
|
GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_TOP, lineWidth,
|
|
false, false );
|
|
|
|
|
|
/* Draw text : SheetLabel */
|
|
BOOST_FOREACH( SCH_SHEET_PIN& sheetPin, m_pins )
|
|
{
|
|
if( !( sheetPin.m_Flags & IS_MOVED ) )
|
|
sheetPin.Draw( aPanel, aDC, aOffset, aDrawMode, aColor );
|
|
}
|
|
}
|
|
|
|
|
|
EDA_RECT SCH_SHEET::GetBoundingBox() const
|
|
{
|
|
wxPoint end;
|
|
EDA_RECT box( m_Pos, m_Size );
|
|
int lineWidth = GetPenSize();
|
|
|
|
// Determine length of texts
|
|
wxString text = wxT( "Sheet: " ) + m_SheetName;
|
|
int textlen = ReturnGraphicTextWidth( text, m_SheetNameSize, false, lineWidth );
|
|
text = wxT( "File: " ) + m_FileName;
|
|
int textlen2 = ReturnGraphicTextWidth( text, m_FileNameSize, false, lineWidth );
|
|
|
|
// Calculate bounding box X size:
|
|
textlen = MAX( textlen, textlen2 );
|
|
end.x = MAX( m_Size.x, textlen );
|
|
|
|
// Calculate bounding box pos:
|
|
end.y = m_Size.y;
|
|
end += m_Pos;
|
|
|
|
// Move upper and lower limits to include texts:
|
|
box.m_Pos.y -= wxRound( m_SheetNameSize * 1.3 ) + 8;
|
|
end.y += wxRound( m_FileNameSize * 1.3 ) + 8;
|
|
|
|
box.SetEnd( end );
|
|
box.Inflate( lineWidth / 2 );
|
|
|
|
return box;
|
|
}
|
|
|
|
|
|
int SCH_SHEET::ComponentCount()
|
|
{
|
|
int n = 0;
|
|
|
|
if( m_AssociatedScreen )
|
|
{
|
|
EDA_ITEM* bs;
|
|
|
|
for( bs = m_AssociatedScreen->GetDrawItems(); bs != NULL; bs = bs->Next() )
|
|
{
|
|
if( bs->Type() == SCH_COMPONENT_T )
|
|
{
|
|
SCH_COMPONENT* Cmp = (SCH_COMPONENT*) bs;
|
|
|
|
if( Cmp->GetField( VALUE )->m_Text.GetChar( 0 ) != '#' )
|
|
n++;
|
|
}
|
|
|
|
if( bs->Type() == SCH_SHEET_T )
|
|
{
|
|
SCH_SHEET* sheet = (SCH_SHEET*) bs;
|
|
n += sheet->ComponentCount();
|
|
}
|
|
}
|
|
}
|
|
|
|
return n;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::SearchHierarchy( const wxString& aFilename, SCH_SCREEN** aScreen )
|
|
{
|
|
if( m_AssociatedScreen )
|
|
{
|
|
EDA_ITEM* item = m_AssociatedScreen->GetDrawItems();
|
|
|
|
while( item )
|
|
{
|
|
if( item->Type() == SCH_SHEET_T )
|
|
{
|
|
SCH_SHEET* sheet = (SCH_SHEET*) item;
|
|
|
|
if( sheet->m_AssociatedScreen
|
|
&& sheet->m_AssociatedScreen->GetFileName().CmpNoCase( aFilename ) == 0 )
|
|
{
|
|
*aScreen = sheet->m_AssociatedScreen;
|
|
return true;
|
|
}
|
|
|
|
if( sheet->SearchHierarchy( aFilename, aScreen ) )
|
|
return true;
|
|
}
|
|
|
|
item = item->Next();
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::LocatePathOfScreen( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aList )
|
|
{
|
|
if( m_AssociatedScreen )
|
|
{
|
|
aList->Push( this );
|
|
|
|
if( m_AssociatedScreen == aScreen )
|
|
return true;
|
|
|
|
EDA_ITEM* strct = m_AssociatedScreen->GetDrawItems();
|
|
|
|
while( strct )
|
|
{
|
|
if( strct->Type() == SCH_SHEET_T )
|
|
{
|
|
SCH_SHEET* ss = (SCH_SHEET*) strct;
|
|
|
|
if( ss->LocatePathOfScreen( aScreen, aList ) )
|
|
return true;
|
|
}
|
|
|
|
strct = strct->Next();
|
|
}
|
|
|
|
aList->Pop();
|
|
}
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::Load( SCH_EDIT_FRAME* aFrame )
|
|
{
|
|
bool success = true;
|
|
|
|
if( !m_AssociatedScreen )
|
|
{
|
|
SCH_SCREEN* screen = NULL;
|
|
g_RootSheet->SearchHierarchy( m_FileName, &screen );
|
|
|
|
if( screen )
|
|
{
|
|
SetScreen( screen );
|
|
|
|
//do not need to load the sub-sheets - this has already been done.
|
|
}
|
|
else
|
|
{
|
|
SetScreen( new SCH_SCREEN() );
|
|
success = aFrame->LoadOneEEFile( m_AssociatedScreen, m_FileName );
|
|
|
|
if( success )
|
|
{
|
|
EDA_ITEM* bs = m_AssociatedScreen->GetDrawItems();
|
|
|
|
while( bs )
|
|
{
|
|
if( bs->Type() == SCH_SHEET_T )
|
|
{
|
|
SCH_SHEET* sheetstruct = (SCH_SHEET*) bs;
|
|
|
|
if( !sheetstruct->Load( aFrame ) )
|
|
success = false;
|
|
}
|
|
|
|
bs = bs->Next();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return success;
|
|
}
|
|
|
|
|
|
int SCH_SHEET::CountSheets()
|
|
{
|
|
int count = 1; //1 = this!!
|
|
|
|
if( m_AssociatedScreen )
|
|
{
|
|
EDA_ITEM* strct = m_AssociatedScreen->GetDrawItems();
|
|
|
|
for( ; strct; strct = strct->Next() )
|
|
{
|
|
if( strct->Type() == SCH_SHEET_T )
|
|
{
|
|
SCH_SHEET* subsheet = (SCH_SHEET*) strct;
|
|
count += subsheet->CountSheets();
|
|
}
|
|
}
|
|
}
|
|
return count;
|
|
}
|
|
|
|
|
|
wxString SCH_SHEET::GetFileName( void )
|
|
{
|
|
return m_FileName;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::DisplayInfo( EDA_DRAW_FRAME* frame )
|
|
{
|
|
frame->ClearMsgPanel();
|
|
frame->AppendMsgPanel( _( "Sheet name" ), m_SheetName, CYAN );
|
|
frame->AppendMsgPanel( _( "File name" ), m_FileName, BROWN );
|
|
#if 0 // Set to 1 to display the sheet time stamp (mainly for test)
|
|
wxString msg;
|
|
msg.Printf(wxT("%.8X"), m_TimeStamp );
|
|
frame->AppendMsgPanel( _( "Time Stamp" ), msg, BLUE );
|
|
#endif
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Rotate(wxPoint rotationPoint)
|
|
{
|
|
RotatePoint( &m_Pos, rotationPoint, 900 );
|
|
RotatePoint( &m_Size.x, &m_Size.y, 900 );
|
|
|
|
if( m_Size.x < 0 )
|
|
{
|
|
m_Pos.x += m_Size.x;
|
|
NEGATE( m_Size.x );
|
|
}
|
|
|
|
if( m_Size.y < 0 )
|
|
{
|
|
m_Pos.y += m_Size.y;
|
|
NEGATE( m_Size.y );
|
|
}
|
|
|
|
BOOST_FOREACH( SCH_SHEET_PIN& sheetPin, m_pins )
|
|
{
|
|
sheetPin.Rotate( rotationPoint );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Mirror_X( int aXaxis_position )
|
|
{
|
|
m_Pos.y -= aXaxis_position;
|
|
NEGATE( m_Pos.y );
|
|
m_Pos.y += aXaxis_position;
|
|
m_Pos.y -= m_Size.y;
|
|
|
|
BOOST_FOREACH( SCH_SHEET_PIN& sheetPin, m_pins )
|
|
{
|
|
sheetPin.Mirror_X( aXaxis_position );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Mirror_Y( int aYaxis_position )
|
|
{
|
|
m_Pos.x -= aYaxis_position;
|
|
NEGATE( m_Pos.x );
|
|
m_Pos.x += aYaxis_position;
|
|
m_Pos.x -= m_Size.x;
|
|
|
|
BOOST_FOREACH( SCH_SHEET_PIN& label, m_pins )
|
|
{
|
|
label.Mirror_Y( aYaxis_position );
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::Resize( const wxSize& aSize )
|
|
{
|
|
if( aSize == m_Size )
|
|
return;
|
|
|
|
m_Size = aSize;
|
|
|
|
/* Move the sheet labels according to the new sheet size. */
|
|
BOOST_FOREACH( SCH_SHEET_PIN& label, m_pins )
|
|
{
|
|
label.ConstraintOnEdge( label.m_Pos );
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::Matches( wxFindReplaceData& aSearchData, void* aAuxData, wxPoint* aFindLocation )
|
|
{
|
|
if( SCH_ITEM::Matches( m_FileName, aSearchData ) )
|
|
{
|
|
if( aFindLocation )
|
|
*aFindLocation = GetFileNamePosition();
|
|
|
|
return true;
|
|
}
|
|
|
|
if( SCH_ITEM::Matches( m_SheetName, aSearchData ) )
|
|
{
|
|
if( aFindLocation )
|
|
*aFindLocation = GetSheetNamePosition();
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_SHEET::renumberPins()
|
|
{
|
|
int id = 2;
|
|
|
|
BOOST_FOREACH( SCH_SHEET_PIN& pin, m_pins )
|
|
{
|
|
pin.SetNumber( id );
|
|
id++;
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_SHEET::GetEndPoints( std::vector <DANGLING_END_ITEM>& aItemList )
|
|
{
|
|
// Using BOOST_FOREACH here creates problems (bad pointer value to pinsheet).
|
|
// I do not know why.
|
|
for( unsigned ii = 0; ii < GetPins().size(); ii++ )
|
|
{
|
|
SCH_SHEET_PIN &pinsheet = GetPins()[ii];
|
|
|
|
wxCHECK2_MSG( pinsheet.Type() == SCH_SHEET_PIN_T, continue,
|
|
wxT( "Invalid item in schematic sheet pin list. Bad programmer!" ) );
|
|
|
|
pinsheet.GetEndPoints( aItemList );
|
|
}
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::IsDanglingStateChanged( std::vector< DANGLING_END_ITEM >& aItemList )
|
|
{
|
|
bool currentState = IsDangling();
|
|
|
|
BOOST_FOREACH( SCH_SHEET_PIN& pinsheet, GetPins() )
|
|
{
|
|
pinsheet.IsDanglingStateChanged( aItemList );
|
|
}
|
|
|
|
return currentState != IsDangling();
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::IsDangling() const
|
|
{
|
|
// If any hierarchical label in the sheet is dangling, then the sheet is dangling.
|
|
for( size_t i = 0; i < GetPins().size(); i++ )
|
|
{
|
|
if( GetPins()[i].IsDangling() )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::IsSelectStateChanged( const wxRect& aRect )
|
|
{
|
|
bool previousState = IsSelected();
|
|
|
|
EDA_RECT boundingBox = GetBoundingBox();
|
|
|
|
if( aRect.Intersects( boundingBox ) )
|
|
m_Flags |= SELECTED;
|
|
else
|
|
m_Flags &= ~SELECTED;
|
|
|
|
return previousState != IsSelected();
|
|
}
|
|
|
|
|
|
void SCH_SHEET::GetConnectionPoints( vector< wxPoint >& aPoints ) const
|
|
{
|
|
for( size_t i = 0; i < GetPins().size(); i++ )
|
|
aPoints.push_back( GetPins()[i].m_Pos );
|
|
}
|
|
|
|
|
|
SEARCH_RESULT SCH_SHEET::Visit( INSPECTOR* aInspector, const void* aTestData,
|
|
const KICAD_T aFilterTypes[] )
|
|
{
|
|
KICAD_T stype;
|
|
|
|
for( const KICAD_T* p = aFilterTypes; (stype = *p) != EOT; ++p )
|
|
{
|
|
// If caller wants to inspect my type
|
|
if( stype == Type() )
|
|
{
|
|
if( SEARCH_QUIT == aInspector->Inspect( this, aTestData ) )
|
|
return SEARCH_QUIT;
|
|
}
|
|
else if( stype == SCH_SHEET_PIN_T )
|
|
{
|
|
// Test the bounding boxes of sheet labels.
|
|
for( size_t i = 0; i < m_pins.size(); i++ )
|
|
{
|
|
if( SEARCH_QUIT == aInspector->Inspect( &m_pins[ i ], aTestData ) )
|
|
return SEARCH_QUIT;
|
|
}
|
|
}
|
|
}
|
|
|
|
return SEARCH_CONTINUE;
|
|
}
|
|
|
|
|
|
wxString SCH_SHEET::GetSelectMenuText() const
|
|
{
|
|
wxString tmp;
|
|
tmp.Printf( _( "Hierarchical Sheet " ), GetChars( m_SheetName ) );
|
|
return tmp;
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::doHitTest( const wxPoint& aPoint, int aAccuracy ) const
|
|
{
|
|
EDA_RECT rect = GetBoundingBox();
|
|
|
|
rect.Inflate( aAccuracy );
|
|
|
|
return rect.Contains( aPoint );
|
|
}
|
|
|
|
|
|
bool SCH_SHEET::doHitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const
|
|
{
|
|
EDA_RECT rect = aRect;
|
|
|
|
rect.Inflate( aAccuracy );
|
|
|
|
if( aContained )
|
|
return rect.Contains( GetBoundingBox() );
|
|
|
|
return rect.Intersects( GetBoundingBox() );
|
|
}
|
|
|
|
|
|
#if defined(DEBUG)
|
|
|
|
void SCH_SHEET::Show( int nestLevel, std::ostream& os )
|
|
{
|
|
// XML output:
|
|
wxString s = GetClass();
|
|
|
|
NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str() << ">" << " sheet_name=\""
|
|
<< TO_UTF8( m_SheetName ) << '"' << ">\n";
|
|
|
|
// show all the pins, and check the linked list integrity
|
|
BOOST_FOREACH( SCH_SHEET_PIN& label, m_pins )
|
|
{
|
|
label.Show( nestLevel + 1, os );
|
|
}
|
|
|
|
NestedSpace( nestLevel, os ) << "</" << s.Lower().mb_str() << ">\n" << std::flush;
|
|
}
|
|
|
|
#endif
|