kicad/eeschema/sch_sheet.cpp

1233 lines
30 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 Jean-Pierre Charras, jp.charras at wanadoo.fr
* 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.cpp
* @brief Implementation of SCH_SHEET class.
*/
#include <fctsys.h>
#include <class_drawpanel.h>
#include <drawtxt.h>
#include <trigo.h>
#include <richio.h>
#include <wxEeschemaStruct.h>
#include <plot_common.h>
#include <kicad_string.h>
#include <msgpanel.h>
#include <sch_sheet.h>
#include <sch_sheet_path.h>
#include <sch_component.h>
#include <class_netlist_object.h>
SCH_SHEET::SCH_SHEET( const wxPoint& pos ) :
SCH_ITEM( NULL, SCH_SHEET_T )
{
m_Layer = LAYER_SHEET;
m_pos = pos;
m_size = wxSize( MIN_SHEET_WIDTH, MIN_SHEET_HEIGHT );
2011-12-12 08:37:05 +00:00
SetTimeStamp( GetNewTimeStamp() );
m_sheetNameSize = GetDefaultTextSize();
m_fileNameSize = GetDefaultTextSize();
m_screen = NULL;
m_name.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;
2011-12-12 08:37:05 +00:00
SetTimeStamp( aSheet.m_TimeStamp );
m_sheetNameSize = aSheet.m_sheetNameSize;
m_fileNameSize = aSheet.m_fileNameSize;
m_screen = aSheet.m_screen;
m_name = aSheet.m_name;
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_screen )
m_screen->IncRefCount();
}
SCH_SHEET::~SCH_SHEET()
{
// wxLogDebug( wxT( "Destroying sheet " ) + m_name );
// also, look at the associated sheet & its reference count
// perhaps it should be deleted also.
if( m_screen )
2008-02-26 19:19:54 +00:00
{
m_screen->DecRefCount();
if( m_screen->GetRefCount() == 0 )
delete m_screen;
2008-02-26 19:19:54 +00:00
}
}
2008-02-26 19:19:54 +00:00
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 != NULL )
{
m_screen->DecRefCount();
if( m_screen->GetRefCount() == 0 )
{
delete m_screen;
m_screen = NULL;
}
}
m_screen = aScreen;
if( m_screen )
m_screen->IncRefCount();
}
int SCH_SHEET::GetScreenCount() const
{
if( m_screen == NULL )
return 0;
return m_screen->GetRefCount();
}
bool SCH_SHEET::Save( FILE* aFile ) const
2008-04-12 18:39:20 +00:00
{
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;
2008-04-12 18:39:20 +00:00
//save the unique timestamp, like other schematic parts.
if( fprintf( aFile, "U %8.8lX\n", m_TimeStamp ) == EOF )
return false;
2008-04-12 18:39:20 +00:00
/* Save schematic sheetname and filename. */
if( !m_name.IsEmpty() )
2008-04-12 18:39:20 +00:00
{
if( fprintf( aFile, "F0 %s %d\n", EscapedUTF8( m_name ).c_str(),
m_sheetNameSize ) == EOF )
return false;
2008-04-12 18:39:20 +00:00
}
if( !m_fileName.IsEmpty() )
2008-04-12 18:39:20 +00:00
{
if( fprintf( aFile, "F1 %s %d\n", EscapedUTF8( m_fileName ).c_str(),
m_fileNameSize ) == EOF )
return false;
2008-04-12 18:39:20 +00:00
}
/* Save the list of labels in the sheet. */
BOOST_FOREACH( const SCH_SHEET_PIN& label, m_pins )
2008-04-12 18:39:20 +00:00
{
if( !label.Save( aFile ) )
return false;
2008-04-12 18:39:20 +00:00
}
if( fprintf( aFile, "$EndSheet\n" ) == EOF )
return false;
return true;
2008-04-12 18:39:20 +00:00
}
2008-04-15 19:38:19 +00:00
bool SCH_SHEET::Load( LINE_READER& aLine, wxString& aErrorMsg )
{
2011-03-25 20:07:27 +00:00
int fieldNdx, size;
SCH_SHEET_PIN* sheetPin;
char* ptcar;
2011-12-12 08:37:05 +00:00
SetTimeStamp( GetNewTimeStamp() );
// 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 Error" ) );
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!
2011-12-12 08:37:05 +00:00
SetTimeStamp( GetNewTimeStamp() );
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;
}
2011-03-25 20:07:27 +00:00
wxString sheetName;
ptcar += ReadDelimitedText( &sheetName, ptcar );
2011-03-25 20:07:27 +00:00
if( *ptcar == 0 )
{
aErrorMsg.Printf( wxT( "Eeschema file sheet field F at line %d, aborted\n" ),
2011-03-25 20:07:27 +00:00
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 = GetDefaultTextSize();
if( fieldNdx == 0 )
{
m_name = sheetName;
m_sheetNameSize = size;
}
else
{
2011-03-25 20:07:27 +00:00
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_ITEM* aItem )
{
wxCHECK_RET( aItem->Type() == SCH_SHEET_T,
wxString::Format( wxT( "SCH_SHEET object cannot swap data with %s object." ),
GetChars( aItem->GetClass() ) ) );
SCH_SHEET* sheet = ( SCH_SHEET* ) aItem;
EXCHG( m_pos, sheet->m_pos );
EXCHG( m_size, sheet->m_size );
EXCHG( m_name, sheet->m_name );
EXCHG( m_sheetNameSize, sheet->m_sheetNameSize );
EXCHG( m_fileNameSize, sheet->m_fileNameSize );
m_pins.swap( sheet->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, sheet->m_pins )
{
sheetPin.SetParent( sheet );
}
}
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;
}
}
2008-04-15 19:38:19 +00:00
wxLogDebug( wxT( "Fix me: attempt to remove label %s which is not in sheet %s." ),
GetChars( aSheetPin->GetShownText() ), GetChars( m_name ) );
}
bool SCH_SHEET::HasPin( const wxString& aName )
{
BOOST_FOREACH( SCH_SHEET_PIN pin, m_pins )
{
if( pin.GetText().CmpNoCase( aName ) == 0 )
return true;
}
return false;
}
bool SCH_SHEET::IsVerticalOrientation() const
{
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_screen->GetDrawItems();
const SCH_HIERLABEL* HLabel = NULL;
for( ; DrawStruct != NULL; DrawStruct = DrawStruct->Next() )
{
if( DrawStruct->Type() != SCH_HIERARCHICAL_LABEL_T )
continue;
HLabel = static_cast<SCH_HIERLABEL*>( DrawStruct );
if( pin.GetText().CmpNoCase( HLabel->GetText() ) == 0 )
break; // Found!
HLabel = NULL;
}
if( HLabel == NULL ) // Corresponding hierarchical label not found.
return true;
}
return false;
}
2008-02-26 19:19:54 +00:00
int SCH_SHEET::GetMinWidth() const
{
int width = MIN_SHEET_WIDTH;
for( size_t i = 0; i < m_pins.size(); i++ )
{
int edge = m_pins[i].GetEdge();
// Make sure pin is on right or left side of sheet.
if( edge >= 2 )
continue;
EDA_RECT rect = m_pins[i].GetBoundingBox();
if( width < rect.GetWidth() )
width = rect.GetWidth();
for( size_t j = 0; j < m_pins.size(); j++ )
{
if( (i == j) || (m_pins[i].GetPosition().y != m_pins[j].GetPosition().y) )
continue;
if( width < rect.GetWidth() + m_pins[j].GetBoundingBox().GetWidth() )
{
width = rect.GetWidth() + m_pins[j].GetBoundingBox().GetWidth();
break;
}
}
}
return width;
}
int SCH_SHEET::GetMinHeight() const
{
int height = MIN_SHEET_HEIGHT;
for( size_t i = 0; i < m_pins.size(); i++ )
{
int pinY = m_pins[i].GetPosition().y - m_pos.y;
if( pinY > height )
height = pinY;
}
return height;
}
/**
* Delete sheet labels which do not have corresponding hierarchical label.
*/
void SCH_SHEET::CleanupSheet()
{
SCH_SHEET_PINS::iterator i = m_pins.begin();
2008-02-26 19:19:54 +00:00
while( i != m_pins.end() )
2008-02-26 19:19:54 +00:00
{
/* Search the schematic for a hierarchical label corresponding to this sheet label. */
EDA_ITEM* DrawStruct = m_screen->GetDrawItems();
const SCH_HIERLABEL* HLabel = NULL;
for( ; DrawStruct != NULL; DrawStruct = DrawStruct->Next() )
2008-02-26 19:19:54 +00:00
{
if( DrawStruct->Type() != SCH_HIERARCHICAL_LABEL_T )
2008-02-26 19:19:54 +00:00
continue;
HLabel = static_cast<SCH_HIERLABEL*>( DrawStruct );
if( i->GetText().CmpNoCase( HLabel->GetText() ) == 0 )
break; // Found!
2008-02-26 19:19:54 +00:00
HLabel = NULL;
}
if( HLabel == NULL ) // Hlabel not found: delete sheet label.
m_pins.erase( i );
else
++i;
2008-02-26 19:19:54 +00:00
}
}
SCH_SHEET_PIN* SCH_SHEET::GetPin( const wxPoint& aPosition )
{
BOOST_FOREACH( SCH_SHEET_PIN& pin, m_pins )
{
if( pin.HitTest( aPosition, 0 ) )
return &pin;
}
return NULL;
}
2008-02-26 19:19:54 +00:00
int SCH_SHEET::GetPenSize() const
{
return GetDefaultLineThickness();
}
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;
int margin = GetPenSize() + 4;
if( IsVerticalOrientation() )
{
pos.x += m_size.x + margin;
pos.y += m_size.y;
}
else
{
pos.y += m_size.y + margin;
}
return pos;
}
void SCH_SHEET::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC,
const wxPoint& aOffset, GR_DRAWMODE aDrawMode, EDA_COLOR_T aColor )
{
EDA_COLOR_T txtcolor;
wxString Text;
EDA_COLOR_T color;
int name_orientation;
wxPoint pos_sheetname,pos_filename;
wxPoint pos = m_pos + aOffset;
int lineWidth = GetPenSize();
EDA_RECT* clipbox = aPanel? aPanel->GetClipBox() : NULL;
if( aColor >= 0 )
color = aColor;
else
color = GetLayerColor( m_Layer );
GRSetDrawMode( aDC, aDrawMode );
GRRect( 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 = GetLayerColor( LAYER_SHEETNAME );
Text = wxT( "Sheet: " ) + m_name;
DrawGraphicText( clipbox, aDC, pos_sheetname,
(EDA_COLOR_T) txtcolor, Text, name_orientation,
wxSize( m_sheetNameSize, m_sheetNameSize ),
GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, lineWidth,
2010-11-20 19:53:00 +00:00
false, false );
/* Draw text : FileName */
if( aColor >= 0 )
txtcolor = aColor;
else
txtcolor = GetLayerColor( LAYER_SHEETFILENAME );
Text = wxT( "File: " ) + m_fileName;
DrawGraphicText( clipbox, aDC, pos_filename,
(EDA_COLOR_T) txtcolor, Text, name_orientation,
wxSize( m_fileNameSize, m_fileNameSize ),
GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_TOP, lineWidth,
2010-11-20 19:53:00 +00:00
false, false );
/* Draw text : SheetLabel */
BOOST_FOREACH( SCH_SHEET_PIN& sheetPin, m_pins )
{
if( !sheetPin.IsMoving() )
sheetPin.Draw( aPanel, aDC, aOffset, aDrawMode, aColor );
}
}
2008-04-15 19:38:19 +00:00
const EDA_RECT SCH_SHEET::GetBoundingBox() const
{
wxPoint end;
EDA_RECT box( m_pos, m_size );
int lineWidth = GetPenSize();
2008-04-15 19:38:19 +00:00
// Determine length of texts
wxString text = wxT( "Sheet: " ) + m_name;
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
int textlen = GraphicTextWidth( text, m_sheetNameSize, false, lineWidth );
text = wxT( "File: " ) + m_fileName;
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
int textlen2 = GraphicTextWidth( text, m_fileNameSize, false, lineWidth );
2008-04-15 19:38:19 +00:00
// Calculate bounding box X size:
textlen = std::max( textlen, textlen2 );
end.x = std::max( m_size.x, textlen );
2008-04-15 19:38:19 +00:00
// Calculate bounding box pos:
end.y = m_size.y;
end += m_pos;
// Move upper and lower limits to include texts:
// Dick Hollenbeck's KiROUND R&D // This provides better project control over rounding to int from double // than wxRound() did. This scheme provides better logging in Debug builds // and it provides for compile time calculation of constants. #include <stdio.h> #include <assert.h> #include <limits.h> //-----<KiROUND KIT>------------------------------------------------------------ /** * KiROUND * rounds a floating point number to an int using * "round halfway cases away from zero". * In Debug build an assert fires if will not fit into an int. */ #if defined( DEBUG ) // DEBUG: a macro to capture line and file, then calls this inline static inline int KiRound( double v, int line, const char* filename ) { v = v < 0 ? v - 0.5 : v + 0.5; if( v > INT_MAX + 0.5 ) { printf( "%s: in file %s on line %d, val: %.16g too ' > 0 ' for int\n", __FUNCTION__, filename, line, v ); } else if( v < INT_MIN - 0.5 ) { printf( "%s: in file %s on line %d, val: %.16g too ' < 0 ' for int\n", __FUNCTION__, filename, line, v ); } return int( v ); } #define KiROUND( v ) KiRound( v, __LINE__, __FILE__ ) #else // RELEASE: a macro so compile can pre-compute constants. #define KiROUND( v ) int( (v) < 0 ? (v) - 0.5 : (v) + 0.5 ) #endif //-----</KiROUND KIT>----------------------------------------------------------- // Only a macro is compile time calculated, an inline function causes a static constructor // in a situation like this. // Therefore the Release build is best done with a MACRO not an inline function. int Computed = KiROUND( 14.3 * 8 ); int main( int argc, char** argv ) { for( double d = double(INT_MAX)-1; d < double(INT_MAX)+8; d += 2.0 ) { int i = KiROUND( d ); printf( "t: %d %.16g\n", i, d ); } return 0; }
2012-04-19 06:55:45 +00:00
box.SetY( box.GetY() - ( KiROUND( m_sheetNameSize * 1.3 ) + 8 ) );
end.y += KiROUND( m_fileNameSize * 1.3 ) + 8;
box.SetEnd( end );
box.Inflate( lineWidth / 2 );
return box;
}
2008-02-26 19:19:54 +00:00
int SCH_SHEET::ComponentCount()
{
2008-02-26 19:19:54 +00:00
int n = 0;
if( m_screen )
2008-02-26 19:19:54 +00:00
{
EDA_ITEM* bs;
for( bs = m_screen->GetDrawItems(); bs != NULL; bs = bs->Next() )
2008-02-26 19:19:54 +00:00
{
if( bs->Type() == SCH_COMPONENT_T )
2008-02-26 19:19:54 +00:00
{
2008-03-20 01:50:21 +00:00
SCH_COMPONENT* Cmp = (SCH_COMPONENT*) bs;
if( Cmp->GetField( VALUE )->GetText().GetChar( 0 ) != '#' )
2008-02-26 19:19:54 +00:00
n++;
}
if( bs->Type() == SCH_SHEET_T )
2008-02-26 19:19:54 +00:00
{
SCH_SHEET* sheet = (SCH_SHEET*) bs;
2008-02-26 19:19:54 +00:00
n += sheet->ComponentCount();
}
}
}
2008-02-26 19:19:54 +00:00
return n;
}
2008-02-26 19:19:54 +00:00
bool SCH_SHEET::SearchHierarchy( const wxString& aFilename, SCH_SCREEN** aScreen )
{
if( m_screen )
2008-02-26 19:19:54 +00:00
{
EDA_ITEM* item = m_screen->GetDrawItems();
while( item )
2008-02-26 19:19:54 +00:00
{
if( item->Type() == SCH_SHEET_T )
2008-02-26 19:19:54 +00:00
{
SCH_SHEET* sheet = (SCH_SHEET*) item;
if( sheet->m_screen
&& sheet->m_screen->GetFileName().CmpNoCase( aFilename ) == 0 )
2008-02-26 19:19:54 +00:00
{
*aScreen = sheet->m_screen;
2008-02-26 19:19:54 +00:00
return true;
}
if( sheet->SearchHierarchy( aFilename, aScreen ) )
2008-02-26 19:19:54 +00:00
return true;
}
item = item->Next();
2008-02-26 19:19:54 +00:00
}
}
2008-02-26 19:19:54 +00:00
return false;
}
2008-02-26 19:19:54 +00:00
bool SCH_SHEET::LocatePathOfScreen( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aList )
{
if( m_screen )
2008-02-26 19:19:54 +00:00
{
aList->Push( this );
if( m_screen == aScreen )
2008-02-26 19:19:54 +00:00
return true;
EDA_ITEM* strct = m_screen->GetDrawItems();
2008-02-26 19:19:54 +00:00
while( strct )
{
if( strct->Type() == SCH_SHEET_T )
2008-02-26 19:19:54 +00:00
{
SCH_SHEET* ss = (SCH_SHEET*) strct;
if( ss->LocatePathOfScreen( aScreen, aList ) )
2008-02-26 19:19:54 +00:00
return true;
}
strct = strct->Next();
2008-02-26 19:19:54 +00:00
}
aList->Pop();
2008-02-26 19:19:54 +00:00
}
return false;
}
2008-02-26 19:19:54 +00:00
bool SCH_SHEET::Load( SCH_EDIT_FRAME* aFrame )
{
bool success = true;
if( !m_screen )
2008-02-26 19:19:54 +00:00
{
SCH_SCREEN* screen = NULL;
g_RootSheet->SearchHierarchy( m_fileName, &screen );
2008-02-26 19:19:54 +00:00
if( screen )
{
SetScreen( screen );
2008-02-26 19:19:54 +00:00
//do not need to load the sub-sheets - this has already been done.
}
else
{
SetScreen( new SCH_SCREEN( &aFrame->Kiway() ) );
success = aFrame->LoadOneEEFile( m_screen, m_fileName );
if( success )
{
EDA_ITEM* bs = m_screen->GetDrawItems();
while( bs )
{
if( bs->Type() == SCH_SHEET_T )
{
SCH_SHEET* sheetstruct = (SCH_SHEET*) bs;
if( !sheetstruct->Load( aFrame ) )
success = false;
}
bs = bs->Next();
}
}
2008-02-26 19:19:54 +00:00
}
}
return success;
}
2008-02-26 19:19:54 +00:00
int SCH_SHEET::CountSheets()
{
2008-02-26 19:19:54 +00:00
int count = 1; //1 = this!!
if( m_screen )
2008-02-26 19:19:54 +00:00
{
EDA_ITEM* strct = m_screen->GetDrawItems();
for( ; strct; strct = strct->Next() )
2008-02-26 19:19:54 +00:00
{
if( strct->Type() == SCH_SHEET_T )
2008-02-26 19:19:54 +00:00
{
SCH_SHEET* subsheet = (SCH_SHEET*) strct;
count += subsheet->CountSheets();
2008-02-26 19:19:54 +00:00
}
}
}
return count;
}
wxString SCH_SHEET::GetFileName( void ) const
{
return m_fileName;
}
void SCH_SHEET::GetMsgPanelInfo( MSG_PANEL_ITEMS& aList )
{
aList.push_back( MSG_PANEL_ITEM( _( "Sheet Name" ), m_name, CYAN ) );
aList.push_back( MSG_PANEL_ITEM( _( "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 );
aList.push_back( MSG_PANEL_ITEM( _( "Time Stamp" ), msg, BLUE ) );
#endif
}
void SCH_SHEET::Rotate(wxPoint aPosition)
{
RotatePoint( &m_pos, aPosition, 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( aPosition );
}
}
void SCH_SHEET::MirrorX( 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.MirrorX( aXaxis_position );
}
}
void SCH_SHEET::MirrorY( 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.MirrorY( 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.ConstrainOnEdge( label.GetPosition() );
}
}
bool SCH_SHEET::Matches( wxFindReplaceData& aSearchData, void* aAuxData, wxPoint* aFindLocation )
{
wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText() );
// Ignore the sheet file name if searching to replace.
if( !(aSearchData.GetFlags() & FR_SEARCH_REPLACE)
&& SCH_ITEM::Matches( m_fileName, aSearchData ) )
{
if( aFindLocation )
*aFindLocation = GetFileNamePosition();
return true;
}
if( SCH_ITEM::Matches( m_name, aSearchData ) )
{
if( aFindLocation )
*aFindLocation = GetSheetNamePosition();
return true;
}
return false;
}
bool SCH_SHEET::Replace( wxFindReplaceData& aSearchData, void* aAuxData )
{
return EDA_ITEM::Replace( aSearchData, m_name );
}
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 )
{
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 ) )
2013-03-30 19:55:26 +00:00
SetFlags( SELECTED );
else
2013-03-30 19:55:26 +00:00
ClearFlags( SELECTED );
return previousState != IsSelected();
}
void SCH_SHEET::GetConnectionPoints( std::vector< wxPoint >& aPoints ) const
{
for( size_t i = 0; i < GetPins().size(); i++ )
aPoints.push_back( GetPins()[i].GetPosition() );
}
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, NULL ) )
return SEARCH_QUIT;
}
else if( stype == SCH_SHEET_PIN_T )
{
// Test the sheet labels.
for( size_t i = 0; i < m_pins.size(); i++ )
{
if( SEARCH_QUIT == aInspector->Inspect( &m_pins[ i ], (void*) this ) )
return SEARCH_QUIT;
}
}
}
return SEARCH_CONTINUE;
}
wxString SCH_SHEET::GetSelectMenuText() const
{
2011-03-26 10:08:50 +00:00
wxString tmp;
tmp.Printf( _( "Hierarchical Sheet %s" ), GetChars( m_name ) );
2011-03-26 10:08:50 +00:00
return tmp;
}
bool SCH_SHEET::HitTest( const wxPoint& aPosition, int aAccuracy ) const
{
EDA_RECT rect = GetBoundingBox();
rect.Inflate( aAccuracy );
return rect.Contains( aPosition );
}
bool SCH_SHEET::HitTest( 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() );
}
wxPoint SCH_SHEET::GetResizePosition() const
{
return wxPoint( m_pos.x + m_size.GetWidth(), m_pos.y + m_size.GetHeight() );
}
void SCH_SHEET::GetNetListItem( NETLIST_OBJECT_LIST& aNetListItems,
SCH_SHEET_PATH* aSheetPath )
{
SCH_SHEET_PATH sheetPath = *aSheetPath;
sheetPath.Push( this );
for( size_t i = 0; i < m_pins.size(); i++ )
{
NETLIST_OBJECT* item = new NETLIST_OBJECT();
item->m_SheetPathInclude = sheetPath;
item->m_SheetPath = *aSheetPath;
item->m_Comp = &m_pins[i];
item->m_Link = this;
item->m_Type = NET_SHEETLABEL;
item->m_ElectricalType = m_pins[i].GetShape();
item->m_Label = m_pins[i].GetText();
item->m_Start = item->m_End = m_pins[i].GetPosition();
aNetListItems.push_back( item );
if( IsBusLabel( m_pins[i].GetText() ) )
item->ConvertBusToNetListItems( aNetListItems );
}
}
void SCH_SHEET::Plot( PLOTTER* aPlotter )
{
EDA_COLOR_T txtcolor = UNSPECIFIED_COLOR;
wxSize size;
wxString Text;
int name_orientation;
wxPoint pos_sheetname, pos_filename;
wxPoint pos;
aPlotter->SetColor( GetLayerColor( GetLayer() ) );
int thickness = GetPenSize();
aPlotter->SetCurrentLineWidth( thickness );
aPlotter->MoveTo( m_pos );
pos = m_pos;
pos.x += m_size.x;
aPlotter->LineTo( pos );
pos.y += m_size.y;
aPlotter->LineTo( pos );
pos = m_pos;
pos.y += m_size.y;
aPlotter->LineTo( pos );
aPlotter->FinishTo( m_pos );
if( IsVerticalOrientation() )
{
pos_sheetname = wxPoint( m_pos.x - 8, m_pos.y + m_size.y );
pos_filename = wxPoint( m_pos.x + m_size.x + 4, m_pos.y + m_size.y );
name_orientation = TEXT_ORIENT_VERT;
}
else
{
pos_sheetname = wxPoint( m_pos.x, m_pos.y - 4 );
pos_filename = wxPoint( m_pos.x, m_pos.y + m_size.y + 4 );
name_orientation = TEXT_ORIENT_HORIZ;
}
/* Draw texts: SheetName */
Text = m_name;
size = wxSize( m_sheetNameSize, m_sheetNameSize );
//pos = m_pos; pos.y -= 4;
thickness = GetDefaultLineThickness();
thickness = Clamp_Text_PenSize( thickness, size, false );
aPlotter->SetColor( GetLayerColor( LAYER_SHEETNAME ) );
bool italic = false;
aPlotter->Text( pos_sheetname, txtcolor, Text, name_orientation, size,
GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM,
thickness, italic, false );
/*Draw texts : FileName */
Text = GetFileName();
size = wxSize( m_fileNameSize, m_fileNameSize );
thickness = GetDefaultLineThickness();
thickness = Clamp_Text_PenSize( thickness, size, false );
aPlotter->SetColor( GetLayerColor( LAYER_SHEETFILENAME ) );
aPlotter->Text( pos_filename, txtcolor, Text, name_orientation, size,
GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_TOP,
thickness, italic, false );
aPlotter->SetColor( GetLayerColor( GetLayer() ) );
/* Draw texts : SheetLabel */
for( size_t i = 0; i < m_pins.size(); i++ )
{
m_pins[i].Plot( aPlotter );
}
}
SCH_ITEM& SCH_SHEET::operator=( const SCH_ITEM& aItem )
{
wxLogDebug( wxT( "Sheet assignment operator." ) );
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_name = sheet->m_name;
m_sheetNameSize = sheet->m_sheetNameSize;
m_fileNameSize = sheet->m_fileNameSize;
m_pins = sheet->m_pins;
// Ensure sheet labels have their #m_Parent member pointing really on their
// parent, after assigning.
BOOST_FOREACH( SCH_SHEET_PIN& sheetPin, m_pins )
{
sheetPin.SetParent( this );
}
}
return *this;
}
2008-04-22 16:38:23 +00:00
#if defined(DEBUG)
void SCH_SHEET::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() << ">" << " sheet_name=\""
<< TO_UTF8( m_name ) << '"' << ">\n";
2008-04-22 16:38:23 +00:00
// show all the pins, and check the linked list integrity
BOOST_FOREACH( const SCH_SHEET_PIN& label, m_pins )
2008-04-22 16:38:23 +00:00
{
label.Show( nestLevel + 1, os );
2008-04-22 16:38:23 +00:00
}
NestedSpace( nestLevel, os ) << "</" << s.Lower().mb_str() << ">\n" << std::flush;
}
2008-02-26 19:19:54 +00:00
#endif