kicad/pcbnew/netlist_reader/netlist_reader.cpp

207 lines
6.5 KiB
C++
Raw Normal View History

2012-02-01 20:17:43 +00:00
/**
* @file netlist_reader.cpp
2012-02-01 20:17:43 +00:00
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2011 Jean-Pierre Charras.
2021-07-19 23:56:05 +00:00
* Copyright (C) 2013-2016 Wayne Stambaugh <stambaughw@gmail.com>.
* Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
2012-02-01 20:17:43 +00:00
*
* 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 <string_utils.h>
#include <reporter.h>
2012-02-01 20:17:43 +00:00
#include "pcb_netlist.h"
#include "netlist_reader.h"
#include <footprint.h>
2012-02-01 20:17:43 +00:00
#include <wx/regex.h>
2012-02-01 20:17:43 +00:00
NETLIST_READER::~NETLIST_READER()
2012-02-01 20:17:43 +00:00
{
delete m_lineReader;
delete m_footprintReader;
}
2012-02-01 20:17:43 +00:00
NETLIST_READER::NETLIST_FILE_T NETLIST_READER::GuessNetlistFileType( LINE_READER* aLineReader )
{
// Orcad Pcb2 netlist format starts by "( {", followed by an unknown comment,
// depending on the tool which created the file
wxRegEx reOrcad( wxT( "(?i)[ ]*\\([ \t]+{+" ), wxRE_ADVANCED );
wxASSERT( reOrcad.IsValid() );
2021-07-19 23:56:05 +00:00
// Our legacy netlist format starts by "# EESchema Netlist "
wxRegEx reLegacy( wxT( "(?i)#[ \t]+EESchema[ \t]+Netlist[ \t]+" ), wxRE_ADVANCED );
wxASSERT( reLegacy.IsValid() );
2021-07-19 23:56:05 +00:00
// Our new netlist format starts by "(export (version "
wxRegEx reKicad( wxT( "[ ]*\\(export[ ]+" ), wxRE_ADVANCED );
wxASSERT( reKicad.IsValid() );
wxString line;
2012-02-01 20:17:43 +00:00
while( aLineReader->ReadLine() )
{
line = From_UTF8( aLineReader->Line() );
if( reLegacy.Matches( line ) )
return LEGACY;
else if( reKicad.Matches( line ) )
return KICAD;
else if( reOrcad.Matches( line ) )
return ORCAD;
2012-02-01 20:17:43 +00:00
}
return UNKNOWN;
2012-02-01 20:17:43 +00:00
}
NETLIST_READER* NETLIST_READER::GetNetlistReader( NETLIST* aNetlist,
const wxString& aNetlistFileName,
const wxString& aCompFootprintFileName )
2012-02-01 20:17:43 +00:00
{
2021-07-19 23:56:05 +00:00
wxASSERT( aNetlist != nullptr );
2021-07-19 23:56:05 +00:00
std::unique_ptr<FILE_LINE_READER> file_rdr =
std::make_unique<FILE_LINE_READER>( aNetlistFileName );
2012-02-01 20:17:43 +00:00
NETLIST_FILE_T type = GuessNetlistFileType( file_rdr.get() );
file_rdr->Rewind();
2012-02-01 20:17:43 +00:00
// The component footprint link reader is NULL if no file name was specified.
std::unique_ptr<CMP_READER> cmp_rdr( aCompFootprintFileName.IsEmpty() ?
2021-07-19 23:56:05 +00:00
nullptr :
new CMP_READER( new FILE_LINE_READER( aCompFootprintFileName ) ) );
2012-02-01 20:17:43 +00:00
switch( type )
2012-02-01 20:17:43 +00:00
{
case LEGACY:
case ORCAD:
return new LEGACY_NETLIST_READER( file_rdr.release(), aNetlist, cmp_rdr.release() );
case KICAD:
return new KICAD_NETLIST_READER( file_rdr.release(), aNetlist, cmp_rdr.release() );
default: // Unrecognized format:
break;
2012-02-01 20:17:43 +00:00
}
2021-07-19 23:56:05 +00:00
return nullptr;
}
bool CMP_READER::Load( NETLIST* aNetlist )
{
2021-07-19 23:56:05 +00:00
wxCHECK_MSG( aNetlist != nullptr, true, wxT( "No netlist passed to CMP_READER::Load()" ) );
wxString reference; // Stores value read from line like Reference = BUS1;
wxString timestamp; // Stores value read from line like TimeStamp = /32307DE2/AA450F67;
wxString footprint; // Stores value read from line like IdModule = CP6;
2012-02-01 20:17:43 +00:00
wxString buffer;
wxString value;
bool ok = true;
while( m_lineReader->ReadLine() )
2012-02-01 20:17:43 +00:00
{
buffer = From_UTF8( m_lineReader->Line() );
2012-02-01 20:17:43 +00:00
if( !buffer.StartsWith( wxT( "BeginCmp" ) ) )
2012-02-01 20:17:43 +00:00
continue;
// Begin component description.
reference.Empty();
2012-02-01 20:17:43 +00:00
footprint.Empty();
timestamp.Empty();
while( m_lineReader->ReadLine() )
2012-02-01 20:17:43 +00:00
{
buffer = From_UTF8( m_lineReader->Line() );
2012-02-01 20:17:43 +00:00
if( buffer.StartsWith( wxT( "EndCmp" ) ) )
2012-02-01 20:17:43 +00:00
break;
// store string value, stored between '=' and ';' delimiters.
value = buffer.AfterFirst( '=' );
value = value.BeforeLast( ';' );
value.Trim( true );
value.Trim( false );
2012-02-01 20:17:43 +00:00
if( buffer.StartsWith( wxT( "Reference" ) ) )
2012-02-01 20:17:43 +00:00
{
reference = value;
2012-02-01 20:17:43 +00:00
continue;
}
if( buffer.StartsWith( wxT( "IdModule =" ) ) )
2012-02-01 20:17:43 +00:00
{
footprint = value;
continue;
}
if( buffer.StartsWith( wxT( "TimeStamp =" ) ) )
2012-02-01 20:17:43 +00:00
{
timestamp = value;
continue;
}
}
// Find the corresponding item in component list:
COMPONENT* component = aNetlist->GetComponentByReference( reference );
2012-02-01 20:17:43 +00:00
// The corresponding component could no longer existing in the netlist. This
// can happen when it is removed from schematic and still exists in footprint
// assignment list. This is an usual case during the life of a design.
if( component )
{
LIB_ID fpid;
if( !footprint.IsEmpty() && fpid.Parse( footprint, true ) >= 0 )
{
wxString error;
error.Printf( _( "Invalid footprint ID in\nfile: '%s'\nline: %d" ),
2019-08-04 08:33:54 +00:00
m_lineReader->GetSource(), m_lineReader->LineNumber() );
THROW_IO_ERROR( error );
}
// For checking purpose, store the existing LIB_ID (if any) in the alternate fpid copy
// if this existing LIB_ID differs from the LIB_ID read from the .cmp file.
// CvPcb can ask for user to chose the right LIB_ID.
// It happens if the LIB_ID was modified outside CvPcb.
if( fpid != component->GetFPID() && !component->GetFPID().empty() )
component->SetAltFPID( component->GetFPID() );
component->SetFPID( fpid );
}
else
{
ok = false; // can be used to display a warning in Pcbnew.
}
2012-02-01 20:17:43 +00:00
}
return ok;
2012-02-01 20:17:43 +00:00
}