616 lines
17 KiB
C++
616 lines
17 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2010-12 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net>
|
|
* Copyright (C) 2012 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 <wx/config.h> // wxExpandEnvVars()
|
|
#include <wx/filename.h>
|
|
#include <wx/stdpaths.h>
|
|
|
|
#include <set>
|
|
|
|
#include <appl_wxstruct.h>
|
|
#include <pcb_netlist.h>
|
|
#include <reporter.h>
|
|
#include <footprint_info.h>
|
|
#include <wildcards_and_files_ext.h>
|
|
#include <fpid.h>
|
|
#include <fp_lib_table_lexer.h>
|
|
#include <fp_lib_table.h>
|
|
|
|
using namespace FP_LIB_TABLE_T;
|
|
|
|
|
|
FP_LIB_TABLE::FP_LIB_TABLE( FP_LIB_TABLE* aFallBackTable ) :
|
|
fallBack( aFallBackTable )
|
|
{
|
|
// not copying fall back, simply search aFallBackTable separately
|
|
// if "nickName not found".
|
|
}
|
|
|
|
|
|
void FP_LIB_TABLE::Parse( FP_LIB_TABLE_LEXER* in ) throw( IO_ERROR, PARSE_ERROR )
|
|
{
|
|
/*
|
|
(fp_lib_table
|
|
(lib (name NICKNAME)(descr DESCRIPTION)(type TYPE)(full_uri FULL_URI)(options OPTIONS))
|
|
:
|
|
)
|
|
|
|
Elements after (name) are order independent.
|
|
*/
|
|
|
|
T tok;
|
|
|
|
// This table may be nested within a larger s-expression, or not.
|
|
// Allow for parser of that optional containing s-epression to have looked ahead.
|
|
if( in->CurTok() != T_fp_lib_table )
|
|
{
|
|
in->NeedLEFT();
|
|
if( ( tok = in->NextTok() ) != T_fp_lib_table )
|
|
in->Expecting( T_fp_lib_table );
|
|
}
|
|
|
|
while( ( tok = in->NextTok() ) != T_RIGHT )
|
|
{
|
|
ROW row; // reconstructed for each row in input stream.
|
|
|
|
if( tok == T_EOF )
|
|
in->Expecting( T_RIGHT );
|
|
|
|
if( tok != T_LEFT )
|
|
in->Expecting( T_LEFT );
|
|
|
|
// in case there is a "row integrity" error, tell where later.
|
|
int lineNum = in->CurLineNumber();
|
|
int offset = in->CurOffset();
|
|
|
|
if( ( tok = in->NextTok() ) != T_lib )
|
|
in->Expecting( T_lib );
|
|
|
|
// (name NICKNAME)
|
|
in->NeedLEFT();
|
|
|
|
if( ( tok = in->NextTok() ) != T_name )
|
|
in->Expecting( T_name );
|
|
|
|
in->NeedSYMBOLorNUMBER();
|
|
|
|
row.SetNickName( in->FromUTF8() );
|
|
|
|
in->NeedRIGHT();
|
|
|
|
// After (name), remaining (lib) elements are order independent, and in
|
|
// some cases optional.
|
|
bool sawType = false;
|
|
bool sawOpts = false;
|
|
bool sawDesc = false;
|
|
bool sawUri = false;
|
|
|
|
while( ( tok = in->NextTok() ) != T_RIGHT )
|
|
{
|
|
if( tok == T_EOF )
|
|
in->Unexpected( T_EOF );
|
|
|
|
if( tok != T_LEFT )
|
|
in->Expecting( T_LEFT );
|
|
|
|
tok = in->NeedSYMBOLorNUMBER();
|
|
|
|
switch( tok )
|
|
{
|
|
case T_uri:
|
|
if( sawUri )
|
|
in->Duplicate( tok );
|
|
sawUri = true;
|
|
in->NeedSYMBOLorNUMBER();
|
|
row.SetFullURI( in->FromUTF8() );
|
|
break;
|
|
|
|
case T_type:
|
|
if( sawType )
|
|
in->Duplicate( tok );
|
|
sawType = true;
|
|
in->NeedSYMBOLorNUMBER();
|
|
row.SetType( in->FromUTF8() );
|
|
break;
|
|
|
|
case T_options:
|
|
if( sawOpts )
|
|
in->Duplicate( tok );
|
|
sawOpts = true;
|
|
in->NeedSYMBOLorNUMBER();
|
|
row.SetOptions( in->FromUTF8() );
|
|
break;
|
|
|
|
case T_descr:
|
|
if( sawDesc )
|
|
in->Duplicate( tok );
|
|
sawDesc = true;
|
|
in->NeedSYMBOLorNUMBER();
|
|
row.SetDescr( in->FromUTF8() );
|
|
break;
|
|
|
|
default:
|
|
in->Unexpected( tok );
|
|
}
|
|
|
|
in->NeedRIGHT();
|
|
}
|
|
|
|
if( !sawType )
|
|
in->Expecting( T_type );
|
|
|
|
if( !sawUri )
|
|
in->Expecting( T_uri );
|
|
|
|
// all nickNames within this table fragment must be unique, so we do not
|
|
// use doReplace in InsertRow(). (However a fallBack table can have a
|
|
// conflicting nickName and ours will supercede that one since in
|
|
// FindLib() we search this table before any fall back.)
|
|
if( !InsertRow( row ) )
|
|
{
|
|
wxString msg = wxString::Format(
|
|
_( "'%s' is a duplicate footprint library nickName" ),
|
|
GetChars( row.nickName ) );
|
|
THROW_PARSE_ERROR( msg, in->CurSource(), in->CurLine(), lineNum, offset );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void FP_LIB_TABLE::Format( OUTPUTFORMATTER* out, int nestLevel ) const
|
|
throw( IO_ERROR )
|
|
{
|
|
out->Print( nestLevel, "(fp_lib_table\n" );
|
|
|
|
for( ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
|
|
it->Format( out, nestLevel+1 );
|
|
|
|
out->Print( nestLevel, ")\n" );
|
|
}
|
|
|
|
|
|
void FP_LIB_TABLE::ROW::Format( OUTPUTFORMATTER* out, int nestLevel ) const
|
|
throw( IO_ERROR )
|
|
{
|
|
out->Print( nestLevel, "(lib (name %s)(type %s)(uri %s)(options %s)(descr %s))\n",
|
|
out->Quotew( GetNickName() ).c_str(),
|
|
out->Quotew( GetType() ).c_str(),
|
|
out->Quotew( GetFullURI() ).c_str(),
|
|
out->Quotew( GetOptions() ).c_str(),
|
|
out->Quotew( GetDescr() ).c_str()
|
|
);
|
|
}
|
|
|
|
|
|
std::vector<wxString> FP_LIB_TABLE::GetLogicalLibs()
|
|
{
|
|
// Only return unique logical library names. Use std::set::insert() to
|
|
// quietly reject any duplicates, which can happen when encountering a duplicate
|
|
// nickname from one of the fall back table(s).
|
|
|
|
std::set<wxString> unique;
|
|
std::vector<wxString> ret;
|
|
const FP_LIB_TABLE* cur = this;
|
|
|
|
do
|
|
{
|
|
for( ROWS_CITER it = cur->rows.begin(); it!=cur->rows.end(); ++it )
|
|
{
|
|
unique.insert( it->nickName );
|
|
}
|
|
|
|
} while( ( cur = cur->fallBack ) != 0 );
|
|
|
|
// return a sorted, unique set of nicknames in a std::vector<wxString> to caller
|
|
for( std::set<wxString>::const_iterator it = unique.begin(); it!=unique.end(); ++it )
|
|
ret.push_back( *it );
|
|
|
|
return ret;
|
|
}
|
|
|
|
|
|
const FP_LIB_TABLE::ROW* FP_LIB_TABLE::findRow( const wxString& aNickName )
|
|
{
|
|
FP_LIB_TABLE* cur = this;
|
|
|
|
do
|
|
{
|
|
cur->ensureIndex();
|
|
|
|
INDEX_CITER it = cur->nickIndex.find( aNickName );
|
|
|
|
if( it != cur->nickIndex.end() )
|
|
{
|
|
return &cur->rows[it->second]; // found
|
|
}
|
|
|
|
// not found, search fall back table(s), if any
|
|
} while( ( cur = cur->fallBack ) != 0 );
|
|
|
|
return 0; // not found
|
|
}
|
|
|
|
|
|
const FP_LIB_TABLE::ROW* FP_LIB_TABLE::FindRowByURI( const wxString& aURI )
|
|
{
|
|
FP_LIB_TABLE* cur = this;
|
|
|
|
do
|
|
{
|
|
cur->ensureIndex();
|
|
|
|
for( unsigned i = 0; i < cur->rows.size(); i++ )
|
|
{
|
|
wxString uri = ExpandSubstitutions( cur->rows[i].GetFullURI() );
|
|
|
|
if( wxFileName::GetPathSeparator() == wxChar( '\\' ) && uri.Find( wxChar( '/' ) ) >= 0 )
|
|
uri.Replace( wxT( "/" ), wxT( "\\" ) );
|
|
|
|
if( (wxFileName::IsCaseSensitive() && uri == aURI)
|
|
|| (!wxFileName::IsCaseSensitive() && uri.Upper() == aURI.Upper() ) )
|
|
{
|
|
return &cur->rows[i]; // found
|
|
}
|
|
}
|
|
|
|
// not found, search fall back table(s), if any
|
|
} while( ( cur = cur->fallBack ) != 0 );
|
|
|
|
return 0; // not found
|
|
}
|
|
|
|
|
|
bool FP_LIB_TABLE::InsertRow( const ROW& aRow, bool doReplace )
|
|
{
|
|
ensureIndex();
|
|
|
|
INDEX_CITER it = nickIndex.find( aRow.nickName );
|
|
|
|
if( it == nickIndex.end() )
|
|
{
|
|
rows.push_back( aRow );
|
|
nickIndex.insert( INDEX_VALUE( aRow.nickName, rows.size() - 1 ) );
|
|
return true;
|
|
}
|
|
|
|
if( doReplace )
|
|
{
|
|
rows[it->second] = aRow;
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
const FP_LIB_TABLE::ROW* FP_LIB_TABLE::FindRow( const wxString& aLibraryNickName )
|
|
throw( IO_ERROR )
|
|
{
|
|
const ROW* row = findRow( aLibraryNickName );
|
|
|
|
if( !row )
|
|
{
|
|
wxString msg = wxString::Format( _( "lib table contains no logical lib '%s'" ),
|
|
GetChars( aLibraryNickName ) );
|
|
THROW_IO_ERROR( msg );
|
|
}
|
|
|
|
return row;
|
|
}
|
|
|
|
|
|
PLUGIN* FP_LIB_TABLE::PluginFind( const wxString& aLibraryNickName )
|
|
throw( IO_ERROR )
|
|
{
|
|
const ROW* row = FindRow( aLibraryNickName );
|
|
|
|
// row will never be NULL here.
|
|
|
|
PLUGIN* plugin = IO_MGR::PluginFind( row->type );
|
|
|
|
return plugin;
|
|
}
|
|
|
|
|
|
const wxString FP_LIB_TABLE::ExpandSubstitutions( const wxString aString )
|
|
{
|
|
// We reserve the right to do this another way, by providing our own member
|
|
// function.
|
|
return wxExpandEnvVars( aString );
|
|
}
|
|
|
|
|
|
bool FP_LIB_TABLE::IsEmpty() const
|
|
{
|
|
if( fallBack == NULL )
|
|
return rows.empty();
|
|
|
|
return fallBack->IsEmpty() && rows.empty();
|
|
}
|
|
|
|
|
|
bool FP_LIB_TABLE::MissingLegacyLibs( const wxArrayString& aLibNames, wxString* aErrorMsg )
|
|
{
|
|
bool retv = false;
|
|
|
|
for( unsigned i = 0; i < aLibNames.GetCount(); i++ )
|
|
{
|
|
wxFileName fn = wxFileName( wxEmptyString, aLibNames[i], LegacyFootprintLibPathExtension );
|
|
wxString legacyLibPath = wxGetApp().FindLibraryPath( fn );
|
|
|
|
if( legacyLibPath.IsEmpty() )
|
|
continue;
|
|
|
|
if( FindRowByURI( legacyLibPath ) == 0 )
|
|
{
|
|
retv = true;
|
|
|
|
if( aErrorMsg )
|
|
*aErrorMsg += wxT( "\"" ) + legacyLibPath + wxT( "\"\n" );
|
|
}
|
|
}
|
|
|
|
return retv;
|
|
}
|
|
|
|
|
|
bool FP_LIB_TABLE::ConvertFromLegacy( NETLIST& aNetList, const wxArrayString& aLibNames,
|
|
REPORTER* aReporter ) throw( IO_ERROR )
|
|
{
|
|
wxString msg;
|
|
FPID lastFPID;
|
|
COMPONENT* component;
|
|
MODULE* module = 0;
|
|
bool retv = true;
|
|
|
|
if( aNetList.IsEmpty() )
|
|
return true;
|
|
|
|
aNetList.SortByFPID();
|
|
|
|
wxString libPath;
|
|
wxFileName fn;
|
|
|
|
PLUGIN::RELEASER pi( IO_MGR::PluginFind( IO_MGR::LEGACY ) );
|
|
|
|
for( unsigned ii = 0; ii < aNetList.GetCount(); ii++ )
|
|
{
|
|
component = aNetList.GetComponent( ii );
|
|
|
|
// The footprint hasn't been assigned yet so ignore it.
|
|
if( component->GetFPID().empty() )
|
|
continue;
|
|
|
|
if( component->GetFPID() != lastFPID )
|
|
{
|
|
module = NULL;
|
|
|
|
for( unsigned ii = 0; ii < aLibNames.GetCount(); ii++ )
|
|
{
|
|
fn = wxFileName( wxEmptyString, aLibNames[ii], LegacyFootprintLibPathExtension );
|
|
|
|
libPath = wxGetApp().FindLibraryPath( fn );
|
|
|
|
if( !libPath )
|
|
{
|
|
if( aReporter )
|
|
{
|
|
msg.Printf( _( "Cannot find footprint library file \"%s\" in any of the "
|
|
"KiCad legacy library search paths.\n" ),
|
|
GetChars( fn.GetFullPath() ) );
|
|
aReporter->Report( msg );
|
|
}
|
|
|
|
retv = false;
|
|
continue;
|
|
}
|
|
|
|
module = pi->FootprintLoad( libPath,
|
|
FROM_UTF8( component->GetFPID().GetFootprintName().c_str() ) );
|
|
|
|
if( module )
|
|
{
|
|
lastFPID = component->GetFPID();
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if( module == NULL )
|
|
{
|
|
if( aReporter )
|
|
{
|
|
msg.Printf( _( "Component `%s` footprint <%s> was not found in any legacy "
|
|
"library.\n" ),
|
|
GetChars( component->GetReference() ),
|
|
GetChars( FROM_UTF8( component->GetFPID().Format().c_str() ) ) );
|
|
aReporter->Report( msg );
|
|
}
|
|
|
|
// Clear the footprint assignment since the old library lookup method is no
|
|
// longer valid.
|
|
FPID emptyFPID;
|
|
component->SetFPID( emptyFPID );
|
|
retv = false;
|
|
continue;
|
|
}
|
|
else
|
|
{
|
|
wxString libNickname;
|
|
|
|
FP_LIB_TABLE* cur = this;
|
|
|
|
do
|
|
{
|
|
cur->ensureIndex();
|
|
|
|
for( unsigned i = 0; i < cur->rows.size(); i++ )
|
|
{
|
|
wxString uri = ExpandSubstitutions( cur->rows[i].GetFullURI() );
|
|
|
|
if( wxFileName::GetPathSeparator() == wxChar( '\\' )
|
|
&& uri.Find( wxChar( '/' ) ) >= 0 )
|
|
uri.Replace( wxT( "/"), wxT( "\\" ) );
|
|
|
|
if( uri == libPath )
|
|
{
|
|
libNickname = cur->rows[i].GetNickName();
|
|
break;
|
|
}
|
|
}
|
|
} while( ( cur = cur->fallBack ) != 0 && libNickname.IsEmpty() );
|
|
|
|
if( libNickname.IsEmpty() )
|
|
{
|
|
if( aReporter )
|
|
{
|
|
msg.Printf( _( "Component `%s` footprint <%s> legacy library path <%s > "
|
|
"was not found in the footprint library table.\n" ),
|
|
GetChars( component->GetReference() ),
|
|
GetChars( FROM_UTF8( component->GetFPID().Format().c_str() ) ) );
|
|
aReporter->Report( msg );
|
|
}
|
|
|
|
retv = false;
|
|
}
|
|
else
|
|
{
|
|
FPID newFPID = lastFPID;
|
|
|
|
newFPID.SetLibNickname( libNickname );
|
|
|
|
if( !newFPID.IsValid() )
|
|
{
|
|
msg.Printf( _( "Component `%s` FPID <%s> is not valid.\n" ),
|
|
GetChars( component->GetReference() ),
|
|
GetChars( FROM_UTF8( newFPID.Format().c_str() ) ) );
|
|
aReporter->Report( msg );
|
|
retv = false;
|
|
}
|
|
else
|
|
{
|
|
// The footprint name should already be set.
|
|
component->SetFPID( newFPID );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return retv;
|
|
}
|
|
|
|
|
|
bool FP_LIB_TABLE::LoadGlobalTable( FP_LIB_TABLE& aTable ) throw (IO_ERROR, PARSE_ERROR )
|
|
{
|
|
bool tableExists = true;
|
|
wxFileName fn = GetGlobalTableFileName();
|
|
|
|
if( !fn.FileExists() )
|
|
{
|
|
tableExists = false;
|
|
|
|
// Attempt to copy the default global file table from the KiCad template folder to
|
|
// the users home configuration path.
|
|
wxString fileName( wxT( "fp_global_table" ) );
|
|
fileName = wxGetApp().FindLibraryPath( fileName );
|
|
|
|
// The fallback is to create an empty global footprint table for the user to populate.
|
|
if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
|
|
{
|
|
FP_LIB_TABLE emptyTable;
|
|
FILE_OUTPUTFORMATTER sf( fn.GetFullPath() );
|
|
emptyTable.Format( &sf, 0 );
|
|
}
|
|
}
|
|
|
|
FILE_LINE_READER reader( fn.GetFullPath() );
|
|
FP_LIB_TABLE_LEXER lexer( &reader );
|
|
|
|
aTable.Parse( &lexer );
|
|
return tableExists;
|
|
}
|
|
|
|
|
|
wxString FP_LIB_TABLE::GetGlobalTableFileName()
|
|
{
|
|
wxFileName fn;
|
|
|
|
fn.SetPath( wxStandardPaths::Get().GetUserConfigDir() );
|
|
|
|
#if defined( __WINDOWS__ )
|
|
fn.AppendDir( wxT( "kicad" ) );
|
|
#endif
|
|
|
|
fn.SetName( GetFileName() );
|
|
|
|
return fn.GetFullPath();
|
|
}
|
|
|
|
|
|
wxString FP_LIB_TABLE::GetFileName()
|
|
{
|
|
return wxString( wxT( "fp-lib-table" ) );
|
|
}
|
|
|
|
|
|
void FP_LIB_TABLE::Load( const wxFileName& aFileName, FP_LIB_TABLE* aFallBackTable )
|
|
throw( IO_ERROR )
|
|
{
|
|
wxFileName fn = aFileName;
|
|
|
|
fallBack = aFallBackTable;
|
|
|
|
fn.SetName( FP_LIB_TABLE::GetFileName() );
|
|
fn.SetExt( wxEmptyString );
|
|
|
|
if( fn.FileExists() )
|
|
{
|
|
FILE_LINE_READER reader( fn.GetFullPath() );
|
|
FP_LIB_TABLE_LEXER lexer( &reader );
|
|
Parse( &lexer );
|
|
}
|
|
}
|
|
|
|
|
|
#if 0 // don't know that this is needed yet
|
|
MODULE* FP_LIB_TABLE::LookupFootprint( const FP_LIB_ID& aFootprintId )
|
|
throw( IO_ERROR )
|
|
{
|
|
const ROW* row = FindRow( aFootprintId.GetLibraryNickName() );
|
|
|
|
// row will never be NULL here.
|
|
|
|
PLUGIN::RELEASER pi( PluginFind( row->type ) );
|
|
|
|
return pi->FootprintLoad( aLibraryPath->GetFullURI() ),
|
|
aFootprintId.GetFootprintName(),
|
|
|
|
// fetch a PROPERTIES instance on stack here
|
|
row->GetPropertiesFromOptions()
|
|
);
|
|
}
|
|
#endif
|