437 lines
12 KiB
C++
437 lines
12 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2009 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 2009 Jean-Pierre Charras, jean-pierre.charras@inpg.fr
|
|
* Copyright (C) 2009 KiCad Developers, see change_log.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 "common.h"
|
|
#include "kicad_string.h"
|
|
#include "pcbnew.h"
|
|
#include "richio.h"
|
|
#include "macros.h"
|
|
|
|
#include "class_board.h"
|
|
#include "class_netclass.h"
|
|
|
|
|
|
// Current design settings (used also to read configs):
|
|
extern BOARD_DESIGN_SETTINGS boardDesignSettings;
|
|
|
|
// This will get mapped to "kicad_default" in the specctra_export.
|
|
const wxString NETCLASS::Default = wxT("Default");
|
|
// Initial values for netclass initialization
|
|
int NETCLASS::DEFAULT_CLEARANCE = 100; // track to track and track to pads clearance
|
|
int NETCLASS::DEFAULT_VIA_DRILL = 250; // default via drill
|
|
int NETCLASS::DEFAULT_UVIA_DRILL = 50; // micro via drill
|
|
|
|
|
|
NETCLASS::NETCLASS( BOARD* aParent, const wxString& aName, const NETCLASS* initialParameters ) :
|
|
m_Parent( aParent ),
|
|
m_Name( aName )
|
|
{
|
|
// use initialParameters if not NULL, else set the initial
|
|
// parameters from boardDesignSettings (try to change this)
|
|
SetParams( initialParameters );
|
|
}
|
|
|
|
|
|
void NETCLASS::SetParams( const NETCLASS* defaults )
|
|
{
|
|
if( defaults )
|
|
{
|
|
SetClearance( defaults->GetClearance() );
|
|
SetTrackWidth( defaults->GetTrackWidth() );
|
|
SetViaDiameter( defaults->GetViaDiameter() );
|
|
SetViaDrill( defaults->GetViaDrill() );
|
|
SetuViaDiameter( defaults->GetuViaDiameter() );
|
|
SetuViaDrill( defaults->GetuViaDrill() );
|
|
}
|
|
else
|
|
{ // We should use m_Parent->GetBoardDesignSettings()
|
|
// But when the NETCLASSES constructor is called
|
|
// (it call NETCLASS constructor), the m_Parent constructor (see BOARD::BOARD)
|
|
// is not run, and GetBoardDesignSettings() return a bad value
|
|
// TODO: see how change that.
|
|
const BOARD_DESIGN_SETTINGS& g = boardDesignSettings;
|
|
|
|
SetTrackWidth( g.m_TrackMinWidth );
|
|
SetViaDiameter( g.m_ViasMinSize );
|
|
SetuViaDiameter(g.m_MicroViasMinSize );
|
|
// Use default values for next parameters:
|
|
SetClearance( DEFAULT_CLEARANCE );
|
|
SetViaDrill( DEFAULT_VIA_DRILL );
|
|
SetuViaDrill( DEFAULT_UVIA_DRILL );
|
|
}
|
|
}
|
|
|
|
|
|
NETCLASS::~NETCLASS()
|
|
{
|
|
}
|
|
|
|
|
|
NETCLASSES::NETCLASSES( BOARD* aParent ) :
|
|
m_Parent( aParent ),
|
|
m_Default( aParent, NETCLASS::Default )
|
|
{
|
|
}
|
|
|
|
|
|
NETCLASSES::~NETCLASSES()
|
|
{
|
|
Clear();
|
|
}
|
|
|
|
|
|
void NETCLASSES::Clear()
|
|
{
|
|
// Although std::map<> will destroy the items that it contains, in this
|
|
// case we have NETCLASS* (pointers) and "destroying" a pointer does not
|
|
// delete the object that the pointer points to.
|
|
|
|
// this NETCLASSES is owner of its NETCLASS pointers,
|
|
// so delete NETCLASSes pointed to by them.
|
|
for( iterator i = begin(); i!=end(); )
|
|
{
|
|
// http://www.sgi.com/tech/stl/Map.html says:
|
|
// "Erasing an element from a map also does not invalidate any iterators,
|
|
// except, of course, for iterators that actually point to the element that
|
|
// is being erased."
|
|
|
|
iterator e = i++; // copy, then advance.
|
|
|
|
delete e->second; // delete the NETCLASS, which 'second' points to.
|
|
|
|
m_NetClasses.erase( e );
|
|
}
|
|
}
|
|
|
|
|
|
bool NETCLASSES::Add( NETCLASS* aNetClass )
|
|
{
|
|
const wxString& name = aNetClass->GetName();
|
|
|
|
if( name == NETCLASS::Default )
|
|
{
|
|
// invoke operator=(), which is currently generated by compiler.
|
|
m_Default = *aNetClass;
|
|
|
|
delete aNetClass; // we own aNetClass, must delete it since we copied it.
|
|
|
|
return true;
|
|
}
|
|
|
|
// Test for an existing netclass:
|
|
if( !Find( name ) )
|
|
{
|
|
// name not found, take ownership
|
|
m_NetClasses[name] = aNetClass;
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
// name already exists
|
|
// do not "take ownership" and return false telling caller such.
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
NETCLASS* NETCLASSES::Remove( const wxString& aNetName )
|
|
{
|
|
NETCLASSMAP::iterator found = m_NetClasses.find( aNetName );
|
|
|
|
if( found != m_NetClasses.end() )
|
|
{
|
|
NETCLASS* netclass = found->second;
|
|
m_NetClasses.erase( found );
|
|
return netclass;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
NETCLASS* NETCLASSES::Find( const wxString& aName ) const
|
|
{
|
|
if( aName == NETCLASS::Default )
|
|
return (NETCLASS*) &m_Default;
|
|
|
|
NETCLASSMAP::const_iterator found = m_NetClasses.find( aName );
|
|
|
|
if( found == m_NetClasses.end() )
|
|
return NULL;
|
|
else
|
|
return found->second;
|
|
}
|
|
|
|
|
|
void BOARD::SynchronizeNetsAndNetClasses()
|
|
{
|
|
// D(printf("start\n");) // simple performance/timing indicator.
|
|
|
|
// set all NETs to the default NETCLASS, then later override some
|
|
// as we go through the NETCLASSes.
|
|
|
|
int count = m_NetInfo->GetCount();
|
|
for( int i=0; i<count; ++i )
|
|
{
|
|
NETINFO_ITEM* net = FindNet( i );
|
|
if( net )
|
|
net->SetClass( m_NetClasses.GetDefault() );
|
|
}
|
|
|
|
// Add netclass name and pointer to nets. If a net is in more than one netclass,
|
|
// set the net's name and pointer to only the first netclass. Subsequent
|
|
// and therefore bogus netclass memberships will be deleted in logic below this loop.
|
|
for( NETCLASSES::iterator clazz=m_NetClasses.begin(); clazz!=m_NetClasses.end(); ++clazz )
|
|
{
|
|
NETCLASS* netclass = clazz->second;
|
|
|
|
for( NETCLASS::iterator member = netclass->begin(); member!=netclass->end(); ++member )
|
|
{
|
|
const wxString& netname = *member;
|
|
|
|
// although this overall function seems to be adequately fast,
|
|
// FindNet( wxString ) uses now a fast binary search and is fast
|
|
// event for large net lists
|
|
NETINFO_ITEM* net = FindNet( netname );
|
|
|
|
if( net && net->GetClassName() == NETCLASS::Default )
|
|
{
|
|
net->SetClass( netclass );
|
|
}
|
|
}
|
|
}
|
|
|
|
// Finally, make sure that every NET is in a NETCLASS, even if that
|
|
// means the Default NETCLASS. And make sure that all NETCLASSes do not
|
|
// contain netnames that do not exist, by deleting all netnames from
|
|
// every netclass and re-adding them.
|
|
|
|
for( NETCLASSES::iterator clazz=m_NetClasses.begin(); clazz!=m_NetClasses.end(); ++clazz )
|
|
{
|
|
NETCLASS* netclass = clazz->second;
|
|
|
|
netclass->Clear();
|
|
}
|
|
|
|
m_NetClasses.GetDefault()->Clear();
|
|
|
|
for( int i=0; i<count; ++i )
|
|
{
|
|
NETINFO_ITEM* net = FindNet( i );
|
|
if( net )
|
|
{
|
|
const wxString& classname = net->GetClassName();
|
|
|
|
// because of the std:map<> this should be fast, and because of
|
|
// prior logic, netclass should not be NULL.
|
|
NETCLASS* netclass = m_NetClasses.Find( classname );
|
|
|
|
wxASSERT( netclass );
|
|
|
|
netclass->Add( net->GetNetname() );
|
|
}
|
|
}
|
|
|
|
// D(printf("stop\n");)
|
|
}
|
|
|
|
|
|
bool NETCLASSES::Save( FILE* aFile ) const
|
|
{
|
|
bool result;
|
|
|
|
// save the default first.
|
|
result = m_Default.Save( aFile );
|
|
|
|
if( result )
|
|
{
|
|
// the rest will be alphabetical in the *.brd file.
|
|
for( const_iterator i = begin(); i!=end(); ++i )
|
|
{
|
|
NETCLASS* netclass = i->second;
|
|
|
|
result = netclass->Save( aFile );
|
|
if( !result )
|
|
break;
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
bool NETCLASS::Save( FILE* aFile ) const
|
|
{
|
|
bool result = true;
|
|
|
|
fprintf( aFile, "$NCLASS\n" );
|
|
fprintf( aFile, "Name %s\n", EscapedUTF8( m_Name ).c_str() );
|
|
fprintf( aFile, "Desc %s\n", EscapedUTF8( GetDescription() ).c_str() );
|
|
|
|
// Write parameters
|
|
|
|
fprintf( aFile, "Clearance %d\n", GetClearance() );
|
|
fprintf( aFile, "TrackWidth %d\n", GetTrackWidth() );
|
|
|
|
fprintf( aFile, "ViaDia %d\n", GetViaDiameter() );
|
|
fprintf( aFile, "ViaDrill %d\n", GetViaDrill() );
|
|
|
|
fprintf( aFile, "uViaDia %d\n", GetuViaDiameter() );
|
|
fprintf( aFile, "uViaDrill %d\n", GetuViaDrill() );
|
|
|
|
// Write members:
|
|
for( const_iterator i = begin(); i!=end(); ++i )
|
|
fprintf( aFile, "AddNet %s\n", EscapedUTF8( *i ).c_str() );
|
|
|
|
fprintf( aFile, "$EndNCLASS\n" );
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
#if defined(DEBUG)
|
|
|
|
void NETCLASS::Show( int nestLevel, std::ostream& os )
|
|
{
|
|
// for now, make it look like XML:
|
|
//NestedSpace( nestLevel, os )
|
|
|
|
os << '<' << GetClass().Lower().mb_str() << ">\n";
|
|
|
|
for( const_iterator i = begin(); i!=end(); ++i )
|
|
{
|
|
// NestedSpace( nestLevel+1, os ) << *i;
|
|
os << TO_UTF8( *i );
|
|
}
|
|
|
|
// NestedSpace( nestLevel, os )
|
|
os << "</" << GetClass().Lower().mb_str() << ">\n";
|
|
}
|
|
|
|
#endif
|
|
|
|
bool NETCLASS::ReadDescr( LINE_READER* aReader )
|
|
{
|
|
bool result = false;
|
|
char* line;
|
|
char buf[1024];
|
|
wxString netname;
|
|
|
|
while( aReader->ReadLine() )
|
|
{
|
|
line = aReader->Line();
|
|
if( strnicmp( line, "AddNet", 6 ) == 0 )
|
|
{
|
|
ReadDelimitedText( buf, line + 6, sizeof(buf) );
|
|
netname = FROM_UTF8( buf );
|
|
Add( netname );
|
|
continue;
|
|
}
|
|
|
|
if( strnicmp( line, "$endNCLASS", sizeof( "$endNCLASS" ) - 1 ) == 0 )
|
|
{
|
|
result = true;
|
|
break;
|
|
}
|
|
|
|
if( strnicmp( line, "Clearance", 9 ) == 0 )
|
|
{
|
|
SetClearance( atoi( line + 9 ) );
|
|
continue;
|
|
}
|
|
if( strnicmp( line, "TrackWidth", 10 ) == 0 )
|
|
{
|
|
SetTrackWidth( atoi( line + 10 ) );
|
|
continue;
|
|
}
|
|
if( strnicmp( line, "ViaDia", 6 ) == 0 )
|
|
{
|
|
SetViaDiameter( atoi( line + 6 ) );
|
|
continue;
|
|
}
|
|
if( strnicmp( line, "ViaDrill", 8 ) == 0 )
|
|
{
|
|
SetViaDrill( atoi( line + 8 ) );
|
|
continue;
|
|
}
|
|
|
|
if( strnicmp( line, "uViaDia", 7 ) == 0 )
|
|
{
|
|
SetuViaDiameter( atoi( line + 7 ) );
|
|
continue;
|
|
}
|
|
if( strnicmp( line, "uViaDrill", 9 ) == 0 )
|
|
{
|
|
SetuViaDrill( atoi( line + 9 ) );
|
|
continue;
|
|
}
|
|
|
|
if( strnicmp( line, "Name", 4 ) == 0 )
|
|
{
|
|
ReadDelimitedText( buf, line + 4, sizeof(buf) );
|
|
m_Name = FROM_UTF8( buf );
|
|
continue;
|
|
}
|
|
if( strnicmp( line, "Desc", 4 ) == 0 )
|
|
{
|
|
ReadDelimitedText( buf, line + 4, sizeof(buf) );
|
|
SetDescription( FROM_UTF8( buf ) );
|
|
continue;
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
int NETCLASS::GetTrackMinWidth() const
|
|
{
|
|
return m_Parent->GetBoardDesignSettings()->m_TrackMinWidth;
|
|
}
|
|
|
|
int NETCLASS::GetViaMinDiameter() const
|
|
{
|
|
return m_Parent->GetBoardDesignSettings()->m_ViasMinSize;
|
|
}
|
|
|
|
int NETCLASS::GetViaMinDrill() const
|
|
{
|
|
return m_Parent->GetBoardDesignSettings()->m_ViasMinDrill;
|
|
}
|
|
|
|
int NETCLASS::GetuViaMinDiameter() const
|
|
{
|
|
return m_Parent->GetBoardDesignSettings()->m_MicroViasMinSize;
|
|
}
|
|
|
|
int NETCLASS::GetuViaMinDrill() const
|
|
{
|
|
return m_Parent->GetBoardDesignSettings()->m_MicroViasMinDrill;
|
|
}
|
|
|
|
|