haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make footprint ID into a generic library ID. 

Rename FPID to LIB_ID as is now used as a generic library identifier and
is no longer specific to footprints.

Remove all mention of footprint from the new LIB_ID doxygen comments and
code.

Rename files fpid.h and fpid.cpp to lib_id.h and lib_id.cpp.

Rename fp_lib_table.keywords file to lib_table.keywords and adjust CMake
build dependencies accordingly.

Update all source files effected by the code and file name changes.

Update .gitignore for file name changes.
This commit is contained in:
Wayne Stambaugh 2016-11-20 18:35:08 -05:00
parent 4d018039aa
commit 64c892ee23
49 changed files with 451 additions and 437 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -6,9 +6,9 @@ common/netlist_keywords.*
common/netlist_lexer.h common/netlist_lexer.h
common/pcb_plot_params_lexer.h common/pcb_plot_params_lexer.h
common/page_layout/page_layout_reader_keywords.cpp common/page_layout/page_layout_reader_keywords.cpp
common/fp_lib_table_keywords.* common/lib_table_keywords.*
common/gal/opengl/shader_src.h common/gal/opengl/shader_src.h
include/fp_lib_table_lexer.h include/lib_table_lexer.h
include/netlist_lexer.h include/netlist_lexer.h
include/page_layout_reader_lexer.h include/page_layout_reader_lexer.h
eeschema/cmp_library_lexer.h eeschema/cmp_library_lexer.h

20
common/CMakeLists.txt
View File

@ -229,8 +229,8 @@ set( COMMON_SRCS
eda_pattern_match.cpp eda_pattern_match.cpp
exceptions.cpp exceptions.cpp
filter_reader.cpp filter_reader.cpp
fpid.cpp lib_id.cpp
fp_lib_table_keywords.cpp lib_table_keywords.cpp
# findkicadhelppath.cpp.notused deprecated, use searchhelpfilefullpath.cpp # findkicadhelppath.cpp.notused deprecated, use searchhelpfilefullpath.cpp
gbr_metadata.cpp gbr_metadata.cpp
gestfich.cpp gestfich.cpp
@ -470,20 +470,20 @@ add_dependencies( pcbcommon pcb_lexer_source_files )
# auto-generate s-expression library table code. # auto-generate s-expression library table code.
make_lexer( make_lexer(
${CMAKE_CURRENT_SOURCE_DIR}/fp_lib_table.keywords ${CMAKE_CURRENT_SOURCE_DIR}/lib_table.keywords
${PROJECT_SOURCE_DIR}/include/fp_lib_table_lexer.h ${PROJECT_SOURCE_DIR}/include/lib_table_lexer.h
${CMAKE_CURRENT_SOURCE_DIR}/fp_lib_table_keywords.cpp ${CMAKE_CURRENT_SOURCE_DIR}/lib_table_keywords.cpp
FP_LIB_TABLE_T LIB_TABLE_T
) )
add_custom_target( add_custom_target(
fp_lib_table_lexer_source_files ALL lib_table_lexer_source_files ALL
DEPENDS DEPENDS
${PROJECT_SOURCE_DIR}/include/fp_lib_table_lexer.h ${PROJECT_SOURCE_DIR}/include/lib_table_lexer.h
${CMAKE_CURRENT_SOURCE_DIR}/fp_lib_table_keywords.cpp ${CMAKE_CURRENT_SOURCE_DIR}/lib_table_keywords.cpp
) )
add_dependencies( common fp_lib_table_lexer_source_files ) add_dependencies( common lib_table_lexer_source_files )
# auto-generate page layout reader s-expression page_layout_reader_lexer.h # auto-generate page layout reader s-expression page_layout_reader_lexer.h
# and title_block_reader_keywords.cpp. # and title_block_reader_keywords.cpp.

8
common/footprint_info.cpp
View File

@ -48,7 +48,7 @@
#include <footprint_info.h> #include <footprint_info.h>
#include <io_mgr.h> #include <io_mgr.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <fpid.h> #include <lib_id.h>
#include <class_module.h> #include <class_module.h>
#include <thread> #include <thread>
#include <html_messagebox.h> #include <html_messagebox.h>
@ -268,14 +268,14 @@ FOOTPRINT_INFO* FOOTPRINT_LIST::GetModuleInfo( const wxString& aFootprintName )
for( FOOTPRINT_INFO& fp : m_list ) for( FOOTPRINT_INFO& fp : m_list )
{ {
FPID fpid; LIB_ID fpid;
wxCHECK_MSG( fpid.Parse( aFootprintName ) < 0, NULL, wxCHECK_MSG( fpid.Parse( aFootprintName ) < 0, NULL,
wxString::Format( wxT( "'%s' is not a valid FPID." ), wxString::Format( wxT( "'%s' is not a valid LIB_ID." ),
GetChars( aFootprintName ) ) ); GetChars( aFootprintName ) ) );
wxString libNickname = fpid.GetLibNickname(); wxString libNickname = fpid.GetLibNickname();
wxString footprintName = fpid.GetFootprintName(); wxString footprintName = fpid.GetLibItemName();
if( libNickname == fp.GetNickname() && footprintName == fp.GetFootprintName() ) if( libNickname == fp.GetNickname() && footprintName == fp.GetFootprintName() )
return &fp; return &fp;

20
common/fp_lib_table.cpp
View File

@ -28,14 +28,14 @@
#include <common.h> #include <common.h>
#include <kiface_i.h> #include <kiface_i.h>
#include <footprint_info.h> #include <footprint_info.h>
#include <fpid.h> #include <lib_id.h>
#include <fp_lib_table_lexer.h> #include <lib_table_lexer.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <class_module.h> #include <class_module.h>
#define OPT_SEP '|' ///< options separator character #define OPT_SEP '|' ///< options separator character
using namespace FP_LIB_TABLE_T; using namespace LIB_TABLE_T;
static const wxChar global_tbl_name[] = wxT( "fp-lib-table" ); static const wxChar global_tbl_name[] = wxT( "fp-lib-table" );
@ -64,7 +64,7 @@ FP_LIB_TABLE::FP_LIB_TABLE( FP_LIB_TABLE* aFallBackTable ) :
} }
void FP_LIB_TABLE::Parse( FP_LIB_TABLE_LEXER* in ) throw() void FP_LIB_TABLE::Parse( LIB_TABLE_LEXER* in ) throw()
{ {
T tok; T tok;
@ -244,11 +244,11 @@ MODULE* FP_LIB_TABLE::FootprintLoad( const wxString& aNickname, const wxString&
if( ret ) if( ret )
{ {
// remove "const"-ness, I really do want to set nickname without // remove "const"-ness, I really do want to set nickname without
// having to copy the FPID and its two strings, twice each. // having to copy the LIB_ID and its two strings, twice each.
FPID& fpid = (FPID&) ret->GetFPID(); LIB_ID& fpid = (LIB_ID&) ret->GetFPID();
// Catch any misbehaving plugin, which should be setting internal footprint name properly: // Catch any misbehaving plugin, which should be setting internal footprint name properly:
wxASSERT( aFootprintName == (wxString) fpid.GetFootprintName() ); wxASSERT( aFootprintName == (wxString) fpid.GetLibItemName() );
// and clearing nickname // and clearing nickname
wxASSERT( !fpid.GetLibNickname().size() ); wxASSERT( !fpid.GetLibNickname().size() );
@ -271,7 +271,7 @@ FP_LIB_TABLE::SAVE_T FP_LIB_TABLE::FootprintSave( const wxString& aNickname,
// Try loading the footprint to see if it already exists, caller wants overwrite // Try loading the footprint to see if it already exists, caller wants overwrite
// protection, which is atypical, not the default. // protection, which is atypical, not the default.
wxString fpname = aFootprint->GetFPID().GetFootprintName(); wxString fpname = aFootprint->GetFPID().GetLibItemName();
std::unique_ptr<MODULE> footprint( row->plugin->FootprintLoad( row->GetFullURI( true ), std::unique_ptr<MODULE> footprint( row->plugin->FootprintLoad( row->GetFullURI( true ),
fpname, row->GetProperties() ) ); fpname, row->GetProperties() ) );
@ -319,11 +319,11 @@ void FP_LIB_TABLE::FootprintLibCreate( const wxString& aNickname )
} }
MODULE* FP_LIB_TABLE::FootprintLoadWithOptionalNickname( const FPID& aFootprintId ) MODULE* FP_LIB_TABLE::FootprintLoadWithOptionalNickname( const LIB_ID& aFootprintId )
throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception ) throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception )
{ {
wxString nickname = aFootprintId.GetLibNickname(); wxString nickname = aFootprintId.GetLibNickname();
wxString fpname = aFootprintId.GetFootprintName(); wxString fpname = aFootprintId.GetLibItemName();
if( nickname.size() ) if( nickname.size() )
{ {

76
common/fpid.cpp → common/lib_id.cpp
View File

@ -2,8 +2,8 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com> * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2012-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors. * Copyright (C) 2010-2016 KiCad Developers, see change_log.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -28,7 +28,7 @@
#include <wx/wx.h> // _() #include <wx/wx.h> // _()
#include <macros.h> // TO_UTF8() #include <macros.h> // TO_UTF8()
#include <fpid.h> #include <lib_id.h>
#include <kicad_string.h> #include <kicad_string.h>
@ -111,15 +111,15 @@ static int okRevision( const std::string& aField )
//----</Policy and field test functions>------------------------------------- //----</Policy and field test functions>-------------------------------------
void FPID::clear() void LIB_ID::clear()
{ {
nickname.clear(); nickname.clear();
footprint.clear(); item_name.clear();
revision.clear(); revision.clear();
} }
int FPID::Parse( const UTF8& aId ) int LIB_ID::Parse( const UTF8& aId )
{ {
clear(); clear();
@ -130,7 +130,7 @@ int FPID::Parse( const UTF8& aId )
int offset; int offset;
//=====<revision>========================================= //=====<revision>=========================================
// in a FPID like discret:R3/rev4 // in a LIB_ID like discret:R3/rev4
if( rev ) if( rev )
{ {
revNdx = rev - buffer; revNdx = rev - buffer;
@ -161,28 +161,27 @@ int FPID::Parse( const UTF8& aId )
partNdx = 0; partNdx = 0;
} }
//=====<footprint name>==================================== //=====<item name>====================================
if( partNdx >= revNdx ) if( partNdx >= revNdx )
return partNdx; // Error: no footprint name. return partNdx; // Error: no library item name.
// Be sure the footprint name is valid. // Be sure the item name is valid.
// Some chars can be found in board file (in old board files // Some chars can be found in legacy files converted files from an other EDA tools.
// or converted files from an other EDA tool
std::string fpname = aId.substr( partNdx, revNdx-partNdx ); std::string fpname = aId.substr( partNdx, revNdx-partNdx );
ReplaceIllegalFileNameChars( &fpname, '_' ); ReplaceIllegalFileNameChars( &fpname, '_' );
SetFootprintName( UTF8( fpname ) ); SetLibItemName( UTF8( fpname ) );
return -1; return -1;
} }
FPID::FPID( const std::string& aId ) throw( PARSE_ERROR ) LIB_ID::LIB_ID( const std::string& aId ) throw( PARSE_ERROR )
{ {
int offset = Parse( aId ); int offset = Parse( aId );
if( offset != -1 ) if( offset != -1 )
{ {
THROW_PARSE_ERROR( _( "Illegal character found in FPID string" ), THROW_PARSE_ERROR( _( "Illegal character found in LIB_ID string" ),
wxString::FromUTF8( aId.c_str() ), wxString::FromUTF8( aId.c_str() ),
aId.c_str(), aId.c_str(),
0, 0,
@ -191,7 +190,7 @@ FPID::FPID( const std::string& aId ) throw( PARSE_ERROR )
} }
FPID::FPID( const wxString& aId ) throw( PARSE_ERROR ) LIB_ID::LIB_ID( const wxString& aId ) throw( PARSE_ERROR )
{ {
UTF8 id = aId; UTF8 id = aId;
@ -199,7 +198,7 @@ FPID::FPID( const wxString& aId ) throw( PARSE_ERROR )
if( offset != -1 ) if( offset != -1 )
{ {
THROW_PARSE_ERROR( _( "Illegal character found in FPID string" ), THROW_PARSE_ERROR( _( "Illegal character found in LIB_ID string" ),
aId, aId,
id.c_str(), id.c_str(),
0, 0,
@ -208,7 +207,7 @@ FPID::FPID( const wxString& aId ) throw( PARSE_ERROR )
} }
int FPID::SetLibNickname( const UTF8& aLogical ) int LIB_ID::SetLibNickname( const UTF8& aLogical )
{ {
int offset = okLogical( aLogical ); int offset = okLogical( aLogical );
@ -221,25 +220,25 @@ int FPID::SetLibNickname( const UTF8& aLogical )
} }
int FPID::SetFootprintName( const UTF8& aFootprintName ) int LIB_ID::SetLibItemName( const UTF8& aLibItemName )
{ {
int separation = int( aFootprintName.find_first_of( "/" ) ); int separation = int( aLibItemName.find_first_of( "/" ) );
if( separation != -1 ) if( separation != -1 )
{ {
footprint = aFootprintName.substr( 0, separation-1 ); item_name = aLibItemName.substr( 0, separation-1 );
return separation; return separation;
} }
else else
{ {
footprint = aFootprintName; item_name = aLibItemName;
} }
return -1; return -1;
} }
int FPID::SetRevision( const UTF8& aRevision ) int LIB_ID::SetRevision( const UTF8& aRevision )
{ {
int offset = okRevision( aRevision ); int offset = okRevision( aRevision );
@ -252,7 +251,7 @@ int FPID::SetRevision( const UTF8& aRevision )
} }
UTF8 FPID::Format() const UTF8 LIB_ID::Format() const
{ {
UTF8 ret; UTF8 ret;
@ -262,7 +261,7 @@ UTF8 FPID::Format() const
ret += ':'; ret += ':';
} }
ret += footprint; ret += item_name;
if( revision.size() ) if( revision.size() )
{ {
@ -274,7 +273,7 @@ UTF8 FPID::Format() const
} }
UTF8 FPID::GetFootprintNameAndRev() const UTF8 LIB_ID::GetLibItemNameAndRev() const
{ {
UTF8 ret; UTF8 ret;
@ -288,10 +287,9 @@ UTF8 FPID::GetFootprintNameAndRev() const
} }
#if 0 // this is broken, it does not output aFootprintName for some reason #if 0 // this is broken, it does not output aLibItemName for some reason
UTF8 FPID::Format( const UTF8& aLogicalLib, const UTF8& aFootprintName, UTF8 LIB_ID::Format( const UTF8& aLogicalLib, const UTF8& aLibItemName, const UTF8& aRevision )
const UTF8& aRevision )
throw( PARSE_ERROR ) throw( PARSE_ERROR )
{ {
UTF8 ret; UTF8 ret;
@ -336,23 +334,23 @@ UTF8 FPID::Format( const UTF8& aLogicalLib, const UTF8& aFootprintName,
#endif #endif
int FPID::compare( const FPID& aFPID ) const int LIB_ID::compare( const LIB_ID& aLibId ) const
{ {
// Don't bother comparing the same object. // Don't bother comparing the same object.
if( this == &aFPID ) if( this == &aLibId )
return 0; return 0;
int retv = nickname.compare( aFPID.nickname ); int retv = nickname.compare( aLibId.nickname );
if( retv != 0 ) if( retv != 0 )
return retv; return retv;
retv = footprint.compare( aFPID.footprint ); retv = item_name.compare( aLibId.item_name );
if( retv != 0 ) if( retv != 0 )
return retv; return retv;
return revision.compare( aFPID.revision ); return revision.compare( aLibId.revision );
} }
@ -360,7 +358,7 @@ int FPID::compare( const FPID& aFPID ) const
// build this with Debug CMAKE_BUILD_TYPE // build this with Debug CMAKE_BUILD_TYPE
void FPID::Test() void LIB_ID::Test()
{ {
static const char* lpids[] = { static const char* lpids[] = {
"smt:R_0805/rev0", "smt:R_0805/rev0",
@ -372,14 +370,14 @@ void FPID::Test()
{ {
// test some round tripping // test some round tripping
FPID lpid( lpids[i] ); // parse LIB_ID lpid( lpids[i] ); // parse
// format // format
printf( "input:'%s' full:'%s' nickname: %s footprint:'%s' rev:'%s'\n", printf( "input:'%s' full:'%s' nickname: %s item_name:'%s' rev:'%s'\n",
lpids[i], lpids[i],
lpid.Format().c_str(), lpid.Format().c_str(),
lpid.GetLibNickname().c_str(), lpid.GetLibNickname().c_str(),
lpid.GetFootprintName().c_str(), lpid.GetLibItemName().c_str(),
lpid.GetRevision().c_str() ); lpid.GetRevision().c_str() );
} }
} }
@ -387,7 +385,7 @@ void FPID::Test()
int main( int argc, char** argv ) int main( int argc, char** argv )
{ {
FPID::Test(); LIB_ID::Test();
return 0; return 0;
} }

0
common/fp_lib_table.keywords → common/lib_table.keywords
View File

8
common/lib_table_base.cpp
View File

@ -32,14 +32,14 @@
#include <common.h> #include <common.h>
#include <macros.h> #include <macros.h>
#include <kiface_i.h> #include <kiface_i.h>
#include <fp_lib_table_lexer.h> #include <lib_table_lexer.h>
#include <lib_table_base.h> #include <lib_table_base.h>
#define OPT_SEP '|' ///< options separator character #define OPT_SEP '|' ///< options separator character
using namespace FP_LIB_TABLE_T; using namespace LIB_TABLE_T;
LIB_TABLE_ROW* new_clone( const LIB_TABLE_ROW& aRow ) LIB_TABLE_ROW* new_clone( const LIB_TABLE_ROW& aRow )
@ -93,7 +93,7 @@ void LIB_TABLE_ROW::Format( OUTPUTFORMATTER* out, int nestLevel ) const
} }
void LIB_TABLE_ROW::Parse( std::unique_ptr< LIB_TABLE_ROW >& aRow, FP_LIB_TABLE_LEXER* in ) void LIB_TABLE_ROW::Parse( std::unique_ptr< LIB_TABLE_ROW >& aRow, LIB_TABLE_LEXER* in )
throw( IO_ERROR, PARSE_ERROR ) throw( IO_ERROR, PARSE_ERROR )
{ {
/* /*
@ -350,7 +350,7 @@ void LIB_TABLE::Load( const wxString& aFileName )
if( wxFileName::IsFileReadable( aFileName ) ) if( wxFileName::IsFileReadable( aFileName ) )
{ {
FILE_LINE_READER reader( aFileName ); FILE_LINE_READER reader( aFileName );
FP_LIB_TABLE_LEXER lexer( &reader ); LIB_TABLE_LEXER lexer( &reader );
Parse( &lexer ); Parse( &lexer );
} }

4
cvpcb/autosel.cpp
View File

@ -1,7 +1,7 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 1992-2015 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -26,7 +26,7 @@
*/ */
// This file handle automatic selection of footprints, from .equ files which give // This file handle automatic selection of footprints, from .equ files which give
// a footprint FPID associated to a component value. // a footprint LIB_ID associated to a component value.
// These associations have this form: // These associations have this form:
// 'FT232BL' 'QFP:LQFP-32_7x7mm_Pitch0.8mm' // 'FT232BL' 'QFP:LQFP-32_7x7mm_Pitch0.8mm'

6
cvpcb/autosel.h
View File

@ -1,7 +1,7 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 1992-2015 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -24,7 +24,7 @@
#ifndef AUTOSEL_H #ifndef AUTOSEL_H
#define AUTOSEL_H #define AUTOSEL_H
// A helper class to handle info read in .equ files, which gives a footprint FPID // A helper class to handle info read in .equ files, which gives a footprint LIB_ID
// corresponding to a component value. // corresponding to a component value.
// Each line is something like: // Each line is something like:
// 'FT232BL' 'QFP:LQFP-32_7x7mm_Pitch0.8mm' // 'FT232BL' 'QFP:LQFP-32_7x7mm_Pitch0.8mm'
@ -35,7 +35,7 @@ class FOOTPRINT_EQUIVALENCE
{ {
public: public:
wxString m_ComponentValue; // The value of a component wxString m_ComponentValue; // The value of a component
wxString m_FootprintFPID; // the footprint FPID corresponding to this value wxString m_FootprintFPID; // the footprint LIB_ID corresponding to this value
FOOTPRINT_EQUIVALENCE() {} FOOTPRINT_EQUIVALENCE() {}
}; };

10
cvpcb/class_DisplayFootprintsFrame.cpp
View File

@ -2,8 +2,8 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2015 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2015-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2007-2015 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2007-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -37,7 +37,7 @@
#include <bitmaps.h> #include <bitmaps.h>
#include <msgpanel.h> #include <msgpanel.h>
#include <wildcards_and_files_ext.h> #include <wildcards_and_files_ext.h>
#include <fpid.h> #include <lib_id.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <pcbcommon.h> #include <pcbcommon.h>
@ -446,7 +446,7 @@ MODULE* DISPLAY_FOOTPRINTS_FRAME::Get_Module( const wxString& aFootprintName )
try try
{ {
FPID fpid; LIB_ID fpid;
if( fpid.Parse( aFootprintName ) >= 0 ) if( fpid.Parse( aFootprintName ) >= 0 )
{ {
@ -456,7 +456,7 @@ MODULE* DISPLAY_FOOTPRINTS_FRAME::Get_Module( const wxString& aFootprintName )
} }
std::string nickname = fpid.GetLibNickname(); std::string nickname = fpid.GetLibNickname();
std::string fpname = fpid.GetFootprintName(); std::string fpname = fpid.GetLibItemName();
wxLogDebug( wxT( "Load footprint <%s> from library <%s>." ), wxLogDebug( wxT( "Load footprint <%s> from library <%s>." ),
fpname.c_str(), nickname.c_str() ); fpname.c_str(), nickname.c_str() );

2
cvpcb/class_footprints_listbox.cpp
View File

@ -162,7 +162,7 @@ void FOOTPRINTS_LISTBOX::SetFootprints( FOOTPRINT_LIST& aList, const wxString& a
&& aComponent->GetNetCount() != aList.GetItem( ii ).GetUniquePadCount() ) && aComponent->GetNetCount() != aList.GetItem( ii ).GetUniquePadCount() )
continue; continue;
// We can search (Using case insensitive search) in full FPID or only // We can search (Using case insensitive search) in full LIB_ID or only
// in the fp name itself. // in the fp name itself.
// After tests, only in the fp name itself looks better. // After tests, only in the fp name itself looks better.
// However, the code to take in account the nickname is just commented, no removed. // However, the code to take in account the nickname is just commented, no removed.

8
cvpcb/cvpcb_mainframe.cpp
View File

@ -381,7 +381,7 @@ void CVPCB_MAINFRAME::DelAssociations( wxCommandEvent& event )
for( unsigned i = 0; i < m_netlist.GetCount(); i++ ) for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
{ {
FPID fpid; LIB_ID fpid;
m_netlist.GetComponent( i )->SetFPID( fpid ); m_netlist.GetComponent( i )->SetFPID( fpid );
SetNewPkg( wxEmptyString ); SetNewPkg( wxEmptyString );
@ -808,8 +808,8 @@ int CVPCB_MAINFRAME::ReadSchematicNetlist( const std::string& aNetlist )
// not the actual name of the footprint. // not the actual name of the footprint.
for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ ) for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ )
{ {
if( m_netlist.GetComponent( ii )->GetFPID().GetFootprintName() == std::string( "$noname" ) ) if( m_netlist.GetComponent( ii )->GetFPID().GetLibItemName() == std::string( "$noname" ) )
m_netlist.GetComponent( ii )->SetFPID( FPID( wxEmptyString ) ); m_netlist.GetComponent( ii )->SetFPID( LIB_ID( wxEmptyString ) );
} }
// Sort components by reference: // Sort components by reference:
@ -956,7 +956,7 @@ DISPLAY_FOOTPRINTS_FRAME* CVPCB_MAINFRAME::GetFootprintViewerFrame()
const wxString CVPCB_MAINFRAME::GetSelectedFootprint() const wxString CVPCB_MAINFRAME::GetSelectedFootprint()
{ {
// returns the FPID of the selected footprint in footprint listview // returns the LIB_ID of the selected footprint in footprint listview
// or a empty string // or a empty string
return m_footprintListBox->GetSelectedFootprint(); return m_footprintListBox->GetSelectedFootprint();
} }

2
cvpcb/cvpcb_mainframe.h
View File

@ -279,7 +279,7 @@ public:
COMPONENT* GetSelectedComponent(); COMPONENT* GetSelectedComponent();
/** /**
* @return the FPID of the selected footprint in footprint listview * @return the LIB_ID of the selected footprint in footprint listview
* or a empty string if no selection * or a empty string if no selection
*/ */
const wxString GetSelectedFootprint(); const wxString GetSelectedFootprint();

26
cvpcb/readwrite_dlgs.cpp
View File

@ -6,8 +6,8 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2015 Jean-Pierre Charras, jean-pierre.charras * Copyright (C) 2015 Jean-Pierre Charras, jean-pierre.charras
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2011-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2011 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -33,7 +33,7 @@
#include <confirm.h> #include <confirm.h>
#include <build_version.h> #include <build_version.h>
#include <macros.h> #include <macros.h>
#include <fpid.h> #include <lib_id.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <reporter.h> #include <reporter.h>
#include <html_messagebox.h> #include <html_messagebox.h>
@ -74,12 +74,12 @@ void CVPCB_MAINFRAME::SetNewPkg( const wxString& aFootprintName )
// Check to see if the component has already a footprint set. // Check to see if the component has already a footprint set.
hasFootprint = !component->GetFPID().empty(); hasFootprint = !component->GetFPID().empty();
FPID fpid; LIB_ID fpid;
if( !aFootprintName.IsEmpty() ) if( !aFootprintName.IsEmpty() )
{ {
wxCHECK_RET( fpid.Parse( aFootprintName ) < 0, wxCHECK_RET( fpid.Parse( aFootprintName ) < 0,
wxString::Format( wxT( "<%s> is not a valid FPID." ), wxString::Format( wxT( "<%s> is not a valid LIB_ID." ),
GetChars( aFootprintName ) ) ); GetChars( aFootprintName ) ) );
} }
@ -116,16 +116,16 @@ void CVPCB_MAINFRAME::SetNewPkg( const wxString& aFootprintName )
} }
/// Return true if the resultant FPID has a certain nickname. The guess /// Return true if the resultant LIB_ID has a certain nickname. The guess
/// is only made if this footprint resides in only one library. /// is only made if this footprint resides in only one library.
/// @return int - 0 on success, 1 on not found, 2 on ambiguous i.e. multiple matches /// @return int - 0 on success, 1 on not found, 2 on ambiguous i.e. multiple matches
static int guessNickname( FP_LIB_TABLE* aTbl, FPID* aFootprintId ) static int guessNickname( FP_LIB_TABLE* aTbl, LIB_ID* aFootprintId )
{ {
if( aFootprintId->GetLibNickname().size() ) if( aFootprintId->GetLibNickname().size() )
return 0; return 0;
wxString nick; wxString nick;
wxString fpname = aFootprintId->GetFootprintName(); wxString fpname = aFootprintId->GetLibItemName();
std::vector<wxString> nicks = aTbl->GetLogicalLibs(); std::vector<wxString> nicks = aTbl->GetLogicalLibs();
@ -194,7 +194,7 @@ bool CVPCB_MAINFRAME::ReadNetListAndLinkFiles( const std::string& aNetlist )
{ {
msg = _( msg = _(
"Some of the assigned footprints are legacy entries (are missing lib nicknames). " "Some of the assigned footprints are legacy entries (are missing lib nicknames). "
"Would you like CvPcb to attempt to convert them to the new required FPID format? " "Would you like CvPcb to attempt to convert them to the new required LIB_ID format? "
"(If you answer no, then these assignments will be cleared out and you will " "(If you answer no, then these assignments will be cleared out and you will "
"have to re-assign these footprints yourself.)" "have to re-assign these footprints yourself.)"
); );
@ -214,7 +214,7 @@ bool CVPCB_MAINFRAME::ReadNetListAndLinkFiles( const std::string& aNetlist )
// get this first here, it's possibly obsoleted if we get it too soon. // get this first here, it's possibly obsoleted if we get it too soon.
FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs(); FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs();
int guess = guessNickname( tbl, (FPID*) &component->GetFPID() ); int guess = guessNickname( tbl, (LIB_ID*) &component->GetFPID() );
switch( guess ) switch( guess )
{ {
@ -228,7 +228,7 @@ bool CVPCB_MAINFRAME::ReadNetListAndLinkFiles( const std::string& aNetlist )
msg += wxString::Format( _( msg += wxString::Format( _(
"Component '%s' footprint '%s' was <b>not found</b> in any library.\n" ), "Component '%s' footprint '%s' was <b>not found</b> in any library.\n" ),
GetChars( component->GetReference() ), GetChars( component->GetReference() ),
GetChars( component->GetFPID().GetFootprintName() ) GetChars( component->GetFPID().GetLibItemName() )
); );
break; break;
@ -236,7 +236,7 @@ bool CVPCB_MAINFRAME::ReadNetListAndLinkFiles( const std::string& aNetlist )
msg += wxString::Format( _( msg += wxString::Format( _(
"Component '%s' footprint '%s' was found in <b>multiple</b> libraries.\n" ), "Component '%s' footprint '%s' was found in <b>multiple</b> libraries.\n" ),
GetChars( component->GetReference() ), GetChars( component->GetReference() ),
GetChars( component->GetFPID().GetFootprintName() ) GetChars( component->GetFPID().GetLibItemName() )
); );
break; break;
} }
@ -281,7 +281,7 @@ bool CVPCB_MAINFRAME::ReadNetListAndLinkFiles( const std::string& aNetlist )
if( component->GetFPID().IsLegacy() ) if( component->GetFPID().IsLegacy() )
{ {
component->SetFPID( FPID() /* empty */ ); component->SetFPID( LIB_ID() /* empty */ );
m_modified = true; m_modified = true;
} }
} }

8
eeschema/class_libentry.h
View File

@ -31,7 +31,7 @@
#define CLASS_LIBENTRY_H #define CLASS_LIBENTRY_H
#include <general.h> #include <general.h>
#include <fpid.h> #include <lib_id.h>
#include <lib_draw_item.h> #include <lib_draw_item.h>
#include <lib_field.h> #include <lib_field.h>
#include <vector> #include <vector>
@ -189,7 +189,7 @@ class LIB_PART : public EDA_ITEM
PART_SPTR m_me; ///< http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared PART_SPTR m_me; ///< http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared
wxString m_name; wxString m_name;
FPID m_libId; LIB_ID m_libId;
int m_pinNameOffset; ///< The offset in mils to draw the pin name. Set to 0 int m_pinNameOffset; ///< The offset in mils to draw the pin name. Set to 0
///< to draw the pin name above the pin. ///< to draw the pin name above the pin.
bool m_unitsLocked; ///< True if part has multiple units and changing bool m_unitsLocked; ///< True if part has multiple units and changing
@ -239,8 +239,8 @@ public:
const wxString& GetName() { return m_name; } const wxString& GetName() { return m_name; }
const FPID& GetFPID() const { return m_libId; } const LIB_ID& GetLibId() const { return m_libId; }
void SetFPID( const FPID& aFPID ) { m_libId = aFPID; } void SetLibId( const LIB_ID& aLibId ) { m_libId = aLibId; }
const wxString GetLibraryName(); const wxString GetLibraryName();

26
eeschema/symbol_lib_table.cpp
View File

@ -27,14 +27,14 @@
#include <common.h> #include <common.h>
#include <kiface_i.h> #include <kiface_i.h>
#include <macros.h> #include <macros.h>
#include <fpid.h> #include <lib_id.h>
#include <fp_lib_table_lexer.h> #include <lib_table_lexer.h>
#include <symbol_lib_table.h> #include <symbol_lib_table.h>
#include <class_libentry.h> #include <class_libentry.h>
#define OPT_SEP '|' ///< options separator character #define OPT_SEP '|' ///< options separator character
using namespace FP_LIB_TABLE_T; using namespace LIB_TABLE_T;
static const wxChar global_tbl_name[] = wxT( "sym-lib-table" ); static const wxChar global_tbl_name[] = wxT( "sym-lib-table" );
@ -63,7 +63,7 @@ SYMBOL_LIB_TABLE::SYMBOL_LIB_TABLE( SYMBOL_LIB_TABLE* aFallBackTable ) :
} }
void SYMBOL_LIB_TABLE::Parse( FP_LIB_TABLE_LEXER* in ) throw() void SYMBOL_LIB_TABLE::Parse( LIB_TABLE_LEXER* in ) throw()
{ {
T tok; T tok;
@ -243,16 +243,16 @@ LIB_ALIAS* SYMBOL_LIB_TABLE::LoadSymbol( const wxString& aNickname, const wxStri
if( ret ) if( ret )
{ {
// remove "const"-ness, I really do want to set nickname without // remove "const"-ness, I really do want to set nickname without
// having to copy the FPID and its two strings, twice each. // having to copy the LIB_ID and its two strings, twice each.
FPID& fpid = (FPID&) ret->GetPart()->GetFPID(); LIB_ID& id = (LIB_ID&) ret->GetPart()->GetLibId();
// Catch any misbehaving plugin, which should be setting internal alias name properly: // Catch any misbehaving plugin, which should be setting internal alias name properly:
wxASSERT( aAliasName == (wxString) fpid.GetFootprintName() ); wxASSERT( aAliasName == (wxString) id.GetLibItemName() );
// and clearing nickname // and clearing nickname
wxASSERT( !fpid.GetLibNickname().size() ); wxASSERT( !id.GetLibNickname().size() );
fpid.SetLibNickname( row->GetNickName() ); id.SetLibNickname( row->GetNickName() );
} }
return ret; return ret;
@ -270,7 +270,7 @@ SYMBOL_LIB_TABLE::SAVE_T SYMBOL_LIB_TABLE::SaveSymbol( const wxString& aNickname
// Try loading the footprint to see if it already exists, caller wants overwrite // Try loading the footprint to see if it already exists, caller wants overwrite
// protection, which is atypical, not the default. // protection, which is atypical, not the default.
wxString name = aSymbol->GetFPID().GetFootprintName(); wxString name = aSymbol->GetLibId().GetLibItemName();
std::unique_ptr< LIB_ALIAS > symbol( row->plugin->LoadSymbol( row->GetFullURI( true ), std::unique_ptr< LIB_ALIAS > symbol( row->plugin->LoadSymbol( row->GetFullURI( true ),
name, name,
@ -328,11 +328,11 @@ void SYMBOL_LIB_TABLE::CreateSymbolLib( const wxString& aNickname )
} }
LIB_ALIAS* SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname( const FPID& aFootprintId ) LIB_ALIAS* SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname( const LIB_ID& aLibId )
throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception ) throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception )
{ {
wxString nickname = aFootprintId.GetLibNickname(); wxString nickname = aLibId.GetLibNickname();
wxString name = aFootprintId.GetFootprintName(); wxString name = aLibId.GetLibItemName();
if( nickname.size() ) if( nickname.size() )
{ {

5
eeschema/symbol_lib_table.h
View File

@ -29,7 +29,6 @@
#include <sch_io_mgr.h> #include <sch_io_mgr.h>
class LIB_PART; class LIB_PART;
class IO_ERROR;
/** /**
* Class SYMBOL_LIB_TABLE_ROW * Class SYMBOL_LIB_TABLE_ROW
@ -102,7 +101,7 @@ class SYMBOL_LIB_TABLE : public LIB_TABLE
{ {
public: public:
virtual void Parse( FP_LIB_TABLE_LEXER* aLexer ) throw() override; virtual void Parse( LIB_TABLE_LEXER* aLexer ) throw() override;
virtual void Format( OUTPUTFORMATTER* out, int nestLevel ) const throw() override; virtual void Format( OUTPUTFORMATTER* out, int nestLevel ) const throw() override;
@ -254,7 +253,7 @@ public:
* is thrown in the case where aId cannot be found. * is thrown in the case where aId cannot be found.
* @throw PARSE_ERROR if @a atId is not parsed OK. * @throw PARSE_ERROR if @a atId is not parsed OK.
*/ */
LIB_ALIAS* LoadSymbolWithOptionalNickname( const FPID& aId ) LIB_ALIAS* LoadSymbolWithOptionalNickname( const LIB_ID& aId )
throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception ); throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception );
/** /**

5
include/fp_lib_table.h
View File

@ -31,7 +31,6 @@
class MODULE; class MODULE;
class FP_TBL_MODEL; class FP_TBL_MODEL;
class IO_ERROR;
/** /**
* Class FP_LIB_TABLE_ROW * Class FP_LIB_TABLE_ROW
@ -104,7 +103,7 @@ class FP_LIB_TABLE : public LIB_TABLE
{ {
public: public:
virtual void Parse( FP_LIB_TABLE_LEXER* aLexer ) throw() override; virtual void Parse( LIB_TABLE_LEXER* aLexer ) throw() override;
virtual void Format( OUTPUTFORMATTER* out, int nestLevel ) const throw() override; virtual void Format( OUTPUTFORMATTER* out, int nestLevel ) const throw() override;
@ -234,7 +233,7 @@ public:
* is thrown in the case where aFootprintName cannot be found. * is thrown in the case where aFootprintName cannot be found.
* @throw PARSE_ERROR if @a aFootprintId is not parsed OK. * @throw PARSE_ERROR if @a aFootprintId is not parsed OK.
*/ */
MODULE* FootprintLoadWithOptionalNickname( const FPID& aFootprintId ) MODULE* FootprintLoadWithOptionalNickname( const LIB_ID& aFootprintId )
throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception ); throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception );
/** /**

198
include/fpid.h
View File

@ -1,198 +0,0 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010-2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2010 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
*/
#ifndef _FPID_H_
#define _FPID_H_
#include <richio.h>
#include <utf8.h>
/**
* Class FPID
* is a Logical Footprint ID and consists of various portions much like a URI.
* It is a container for the separated portions of a logical footprint id so they
* can be accessed individually. The various portions of an FPID are:
* logicalLibraryName (nick name), footprint name, and revision. The logical library
* name and the footprint name are mandatory. The revision is optional and currently is
* not used.
*
* Example FPID string:
* "smt:R_0805/rev0".
*
* <p>
* <ul>
* <li> "smt" is the logical library name used to look up library information saved in the
* #FP_LIB_TABLE.
* <li> "R" is the name of the footprint within the library.
* <li> "rev0" is the revision, which is optional. If missing then its
* / delimiter should also not be present. A revision must begin with
* "rev" and be followed by at least one or more decimal digits.
* </ul>
*
* @author Dick Hollenbeck
*/
class FPID
{
public:
FPID() {}
/**
* Constructor FPID
* takes \a aId string and parses it. A typical FPID string consists of a
* library nickname followed by a footprint name.
* e.g.: "smt:R_0805", or
* e.g.: "mylib:R_0805"
*
* @param aId is a string to be parsed into the FPID object.
*/
FPID( const std::string& aId ) throw( PARSE_ERROR );
FPID( const wxString& aId ) throw( PARSE_ERROR );
/**
* Function Parse
* [re-]stuffs this FPID with the information from @a aId.
*
* @param aId is the string to populate the #FPID object.
* @return int - minus 1 (i.e. -1) means success, >= 0 indicates the character offset into
* aId at which an error was detected.
*/
int Parse( const UTF8& aId );
/**
* Function GetLibNickname
* returns the logical library name portion of a FPID.
*/
const UTF8& GetLibNickname() const
{
return nickname;
}
/**
* Function SetLibNickname
* overrides the logical footprint library name portion of the FPID to @a aNickname.
* @return int - minus 1 (i.e. -1) means success, >= 0 indicates the character offset
* into the parameter at which an error was detected, usually because it
* contained '/' or ':'.
*/
int SetLibNickname( const UTF8& aNickname );
/**
* Function GetFootprintName
* returns the footprint name, i.e. footprintName.
*/
const UTF8& GetFootprintName() const { return footprint; }
/**
* Function SetFootprintName
* overrides the footprint name portion of the FPID to @a aFootprintName
* @return int - minus 1 (i.e. -1) means success, >= 0 indicates the character offset
* into the parameter at which an error was detected, usually because it
* contained '/'.
*/
int SetFootprintName( const UTF8& aFootprintName );
int SetRevision( const UTF8& aRevision );
const UTF8& GetRevision() const { return revision; }
UTF8 GetFootprintNameAndRev() const;
/**
* Function Format
* returns the fully formatted text of the FPID.
*/
UTF8 Format() const;
/**
* Function Format
* returns a wxString in the proper format as an FPID for a combination of
* aLibNickname, aFootprintName, and aRevision.
*
* @throw PARSE_ERROR if any of the pieces are illegal.
static UTF8 Format( const UTF8& aLibNickname, const UTF8& aFootprintName,
const UTF8& aRevision = "" )
throw( PARSE_ERROR );
*/
/**
* Function IsValid
* @return true is the #FPID is valid.
*
* A valid #FPID must have both the footprint library nickname and the footprint name
* defined. The revision field is optional.
*
* @note A return value of true does not indicated that the #FPID is a valid #FP_LIB_TABLE
* entry.
*/
bool IsValid() const { return !nickname.empty() && !footprint.empty(); }
/**
* Function IsLegacy
* @return true if the #FPID only has the #footprint name defined.
*/
bool IsLegacy() const { return nickname.empty() && !footprint.empty() && revision.empty(); }
/**
* Function clear
* clears the contents of the library nickname, footprint name, and revision strings.
*/
void clear();
/**
* Function empty
* @return a boolean true value if the FPID is empty. Otherwise return false.
*/
bool empty() const { return nickname.empty() && footprint.empty() && revision.empty(); }
/**
* Function Compare
* compares the contents of FPID objects by performing a std::string comparison of the
* library nickname, footprint name, and revision strings respectively.
*
* @param aFPID is the FPID to compare against.
* @return -1 if less than \a aFPID, 1 if greater than \a aFPID, and 0 if equal to \a aFPID.
*/
int compare( const FPID& aFPID ) const;
bool operator < ( const FPID& aFPID ) const { return this->compare( aFPID ) < 0; }
bool operator > ( const FPID& aFPID ) const { return this->compare( aFPID ) > 0; }
bool operator ==( const FPID& aFPID ) const { return this->compare( aFPID ) == 0; }
bool operator !=( const FPID& aFPID ) const { return !(*this == aFPID); }
#if defined(DEBUG)
static void Test();
#endif
protected:
UTF8 nickname; ///< The nickname of the footprint library or empty.
UTF8 footprint; ///< The name of the footprint in the logical library.
UTF8 revision; ///< The footprint revision.
};
#endif // _FPID_H_

216
include/lib_id.h Normal file
View File

@ -0,0 +1,216 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010-2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2012-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2010-2016 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
*/
#ifndef _LIB_ID_H_
#define _LIB_ID_H_
#include <richio.h>
#include <utf8.h>
/**
* Class LIB_ID
*
* is a logical library item identifier and consists of various portions much like a URI.
* It consists of of triad of the library nickname, the name of the item in the library,
* and an optional revision of the item. This is a generic library identifier that can be
* used for any type of library that contains multiple named items such as footprint or
* symbol libraries.
*
* Example LIB_ID string:
* "smt:R_0805/rev0".
*
* <p>
* <ul>
* <li> "smt" is the logical library name used to look up library information saved in the
* #LIB_TABLE.
* <li> "R" is the name of the item within the library.
* <li> "rev0" is the revision, which is optional. If missing then its
* / delimiter should also not be present. A revision must begin with
* "rev" and be followed by at least one or more decimal digits.
* </ul>
*
* @author Dick Hollenbeck
*/
class LIB_ID
{
public:
LIB_ID() {}
/**
* Constructor LIB_ID
*
* takes \a aId string and parses it. A typical LIB_ID string consists of a
* library nickname followed by a library item name.
* e.g.: "smt:R_0805", or
* e.g.: "mylib:R_0805", or
* e.g.: "ttl:7400"
*
* @param aId is a string to be parsed into the LIB_ID object.
*/
LIB_ID( const std::string& aId ) throw( PARSE_ERROR );
LIB_ID( const wxString& aId ) throw( PARSE_ERROR );
/**
* Function Parse
*
* [re-]stuffs this LIB_ID with the information from @a aId.
*
* @param aId is the string to populate the #LIB_ID object.
*
* @return int - minus 1 (i.e. -1) means success, >= 0 indicates the character offset into
* aId at which an error was detected.
*/
int Parse( const UTF8& aId );
/**
* Function GetLibNickname
*
* returns the logical library name portion of a LIB_ID.
*/
const UTF8& GetLibNickname() const
{
return nickname;
}
/**
* Function SetLibNickname
*
* overrides the logical library name portion of the LIB_ID to @a aNickname.
*
* @return int - minus 1 (i.e. -1) means success, >= 0 indicates the character offset
* into the parameter at which an error was detected, usually because it
* contained '/' or ':'.
*/
int SetLibNickname( const UTF8& aNickname );
/**
* Function GetLibItemName
*
* @return the library item name, i.e. footprintName.
*/
const UTF8& GetLibItemName() const { return item_name; }
/**
* Function SetLibItemName
*
* overrides the library item name portion of the LIB_ID to @a aLibItemName
*
* @return int - minus 1 (i.e. -1) means success, >= 0 indicates the character offset
* into the parameter at which an error was detected, usually because it
* contained '/'.
*/
int SetLibItemName( const UTF8& aLibItemName );
int SetRevision( const UTF8& aRevision );
const UTF8& GetRevision() const { return revision; }
UTF8 GetLibItemNameAndRev() const;
/**
* Function Format
*
* @return the fully formatted text of the LIB_ID.
*/
UTF8 Format() const;
/**
* Function Format
*
* @return a string in the proper format as an LIB_ID for a combination of
* aLibNickname, aLibItemName, and aRevision.
*
* @throw PARSE_ERROR if any of the pieces are illegal.
static UTF8 Format( const UTF8& aLibNickname, const UTF8& aLibItemName,
const UTF8& aRevision = "" )
throw( PARSE_ERROR );
*/
/**
* Function IsValid
*
* @return true is the #LIB_ID is valid.
*
* A valid #LIB_ID must have both the library nickname and the library item name defined.
* The revision field is optional.
*
* @note A return value of true does not indicated that the #LIB_ID is a valid #LIB_TABLE
* entry.
*/
bool IsValid() const { return !nickname.empty() && !item_name.empty(); }
/**
* Function IsLegacy
*
* @return true if the #LIB_ID only has the #item_name name defined.
*/
bool IsLegacy() const { return nickname.empty() && !item_name.empty() && revision.empty(); }
/**
* Function clear
*
* clears the contents of the library nickname, library entry name, and revision strings.
*/
void clear();
/**
* Function empty
*
* @return a boolean true value if the LIB_ID is empty. Otherwise return false.
*/
bool empty() const { return nickname.empty() && item_name.empty() && revision.empty(); }
/**
* Function Compare
*
* compares the contents of LIB_ID objects by performing a std::string comparison of the
* library nickname, library entry name, and revision strings respectively.
*
* @param aLibId is the LIB_ID to compare against.
*
* @return -1 if less than \a aLibId, 1 if greater than \a aLibId, and 0 if equal to \a aLibId.
*/
int compare( const LIB_ID& aLIB_ID ) const;
bool operator < ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) < 0; }
bool operator > ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) > 0; }
bool operator ==( const LIB_ID& aLibId ) const { return this->compare( aLibId ) == 0; }
bool operator !=( const LIB_ID& aLibId ) const { return !(*this == aLibId); }
#if defined(DEBUG)
static void Test();
#endif
protected:
UTF8 nickname; ///< The nickname of the library or empty.
UTF8 item_name; ///< The name of the entry in the logical library.
UTF8 revision; ///< The revision of the entry.
};
#endif // _LIB_ID_H_

8
include/lib_table_base.h
View File

@ -40,8 +40,8 @@
#define FP_LATE_ENVVAR 1 ///< late=1/early=0 environment variable expansion #define FP_LATE_ENVVAR 1 ///< late=1/early=0 environment variable expansion
class OUTPUTFORMATTER; class OUTPUTFORMATTER;
class FP_LIB_TABLE_LEXER; class LIB_TABLE_LEXER;
class FPID; class LIB_ID;
class LIB_TABLE_ROW; class LIB_TABLE_ROW;
class IO_ERROR; class IO_ERROR;
@ -181,7 +181,7 @@ public:
void Format( OUTPUTFORMATTER* out, int nestLevel ) const void Format( OUTPUTFORMATTER* out, int nestLevel ) const
throw( IO_ERROR, boost::interprocess::lock_exception ); throw( IO_ERROR, boost::interprocess::lock_exception );
static void Parse( std::unique_ptr< LIB_TABLE_ROW >& aRow, FP_LIB_TABLE_LEXER* in ) static void Parse( std::unique_ptr< LIB_TABLE_ROW >& aRow, LIB_TABLE_LEXER* in )
throw( IO_ERROR, PARSE_ERROR ); throw( IO_ERROR, PARSE_ERROR );
LIB_TABLE_ROW* clone() const LIB_TABLE_ROW* clone() const
@ -279,7 +279,7 @@ class LIB_TABLE : public PROJECT::_ELEM
public: public:
virtual void Parse( FP_LIB_TABLE_LEXER* aLexer ) throw() = 0; virtual void Parse( LIB_TABLE_LEXER* aLexer ) throw() = 0;
virtual void Format( OUTPUTFORMATTER* out, int nestLevel ) const throw() = 0; virtual void Format( OUTPUTFORMATTER* out, int nestLevel ) const throw() = 0;

14
include/wxBasePcbFrame.h
View File

@ -2,8 +2,8 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2012 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2012 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2008-2011 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2008-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2011 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -57,7 +57,7 @@ class BOARD_DESIGN_SETTINGS;
class ZONE_SETTINGS; class ZONE_SETTINGS;
class PCB_PLOT_PARAMS; class PCB_PLOT_PARAMS;
class FP_LIB_TABLE; class FP_LIB_TABLE;
class FPID; class LIB_ID;
/** /**
* class PCB_BASE_FRAME * class PCB_BASE_FRAME
@ -89,13 +89,13 @@ protected:
* Function loadFootprint * Function loadFootprint
* attempts to load \a aFootprintId from the footprint library table. * attempts to load \a aFootprintId from the footprint library table.
* *
* @param aFootprintId is the #FPID of component footprint to load. * @param aFootprintId is the #LIB_ID of component footprint to load.
* @return the #MODULE if found or NULL if \a aFootprintId not found in any of the * @return the #MODULE if found or NULL if \a aFootprintId not found in any of the
* libraries in the table returned from #Prj().PcbFootprintLibs(). * libraries in the table returned from #Prj().PcbFootprintLibs().
* @throw IO_ERROR if an I/O error occurs or a #PARSE_ERROR if a file parsing error * @throw IO_ERROR if an I/O error occurs or a #PARSE_ERROR if a file parsing error
* occurs while reading footprint library files. * occurs while reading footprint library files.
*/ */
MODULE* loadFootprint( const FPID& aFootprintId ) MODULE* loadFootprint( const LIB_ID& aFootprintId )
throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception ); throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception );
public: public:
@ -114,11 +114,11 @@ public:
* Function LoadFootprint * Function LoadFootprint
* attempts to load \a aFootprintId from the footprint library table. * attempts to load \a aFootprintId from the footprint library table.
* *
* @param aFootprintId is the #FPID of component footprint to load. * @param aFootprintId is the #LIB_ID of component footprint to load.
* @return the #MODULE if found or NULL if \a aFootprintId not found in any of the * @return the #MODULE if found or NULL if \a aFootprintId not found in any of the
* libraries in table returned from #Prj().PcbFootprintLibs(). * libraries in table returned from #Prj().PcbFootprintLibs().
*/ */
MODULE* LoadFootprint( const FPID& aFootprintId ); MODULE* LoadFootprint( const LIB_ID& aFootprintId );
/** /**
* Function GetBoardBoundingBox * Function GetBoardBoundingBox

6
pcbnew/build_BOM_from_board.cpp
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2009-2014 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr * Copyright (C) 2009-2014 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
* Copyright (C) 1992-2012 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -66,7 +66,7 @@ class cmp
public: public:
wxString m_Ref; wxString m_Ref;
wxString m_Val; wxString m_Val;
FPID m_fpid; LIB_ID m_fpid;
int m_Id; int m_Id;
int m_CmpCount; int m_CmpCount;
}; };
@ -173,7 +173,7 @@ void PCB_EDIT_FRAME::RecreateBOMFileFromBoard( wxCommandEvent& aEvent )
msg << current->m_Id << wxT( ";\"" ); msg << current->m_Id << wxT( ";\"" );
msg << current->m_Ref << wxT( "\";\"" ); msg << current->m_Ref << wxT( "\";\"" );
msg << FROM_UTF8( current->m_fpid.GetFootprintName().c_str() ) << wxT( "\";" ); msg << FROM_UTF8( current->m_fpid.GetLibItemName().c_str() ) << wxT( "\";" );
msg << current->m_CmpCount << wxT( ";\"" ); msg << current->m_CmpCount << wxT( ";\"" );
msg << current->m_Val << wxT( "\";;;\n" ); msg << current->m_Val << wxT( "\";;;\n" );
fprintf( fp_bom, "%s", TO_UTF8( msg ) ); fprintf( fp_bom, "%s", TO_UTF8( msg ) );

10
pcbnew/class_module.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 1992-2015 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -37,7 +37,7 @@
#include <layers_id_colors_and_visibility.h> // ALL_LAYERS definition. #include <layers_id_colors_and_visibility.h> // ALL_LAYERS definition.
#include <class_board_item.h> #include <class_board_item.h>
#include <board_item_container.h> #include <board_item_container.h>
#include <fpid.h> #include <lib_id.h>
#include <class_text_mod.h> #include <class_text_mod.h>
#include <PolyLine.h> #include <PolyLine.h>
@ -144,8 +144,8 @@ public:
double GetOrientationDegrees() const { return m_Orient/10.0; } double GetOrientationDegrees() const { return m_Orient/10.0; }
double GetOrientationRadians() const { return m_Orient*M_PI/1800; } double GetOrientationRadians() const { return m_Orient*M_PI/1800; }
const FPID& GetFPID() const { return m_fpid; } const LIB_ID& GetFPID() const { return m_fpid; }
void SetFPID( const FPID& aFPID ) { m_fpid = aFPID; } void SetFPID( const LIB_ID& aFPID ) { m_fpid = aFPID; }
const wxString& GetDescription() const { return m_Doc; } const wxString& GetDescription() const { return m_Doc; }
void SetDescription( const wxString& aDoc ) { m_Doc = aDoc; } void SetDescription( const wxString& aDoc ) { m_Doc = aDoc; }
@ -650,7 +650,7 @@ private:
wxPoint m_Pos; ///< Position of module on the board in internal units. wxPoint m_Pos; ///< Position of module on the board in internal units.
TEXTE_MODULE* m_Reference; ///< Component reference designator value (U34, R18..) TEXTE_MODULE* m_Reference; ///< Component reference designator value (U34, R18..)
TEXTE_MODULE* m_Value; ///< Component value (74LS00, 22K..) TEXTE_MODULE* m_Value; ///< Component value (74LS00, 22K..)
FPID m_fpid; ///< The #FPID of the MODULE. LIB_ID m_fpid; ///< The #LIB_ID of the MODULE.
int m_Attributs; ///< Flag bits ( see Mod_Attribut ) int m_Attributs; ///< Flag bits ( see Mod_Attribut )
int m_ModuleStatus; ///< For autoplace: flags (LOCKED, AUTOPLACED) int m_ModuleStatus; ///< For autoplace: flags (LOCKED, AUTOPLACED)
EDA_RECT m_BoundaryBox; ///< Bounding box : coordinates on board, real orientation. EDA_RECT m_BoundaryBox; ///< Bounding box : coordinates on board, real orientation.

4
pcbnew/dialogs/dialog_edit_module_for_Modedit.cpp
View File

@ -9,7 +9,7 @@
* *
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2015 Dick Hollenbeck, dick@softplc.com * Copyright (C) 2015 Dick Hollenbeck, dick@softplc.com
* Copyright (C) 2008-2015 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2008-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2004-2016 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2004-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
@ -493,7 +493,7 @@ void DIALOG_MODULE_MODULE_EDITOR::OnOkClick( wxCommandEvent& event )
// Init footprint name in library // Init footprint name in library
if( ! footprintName.IsEmpty() ) if( ! footprintName.IsEmpty() )
m_currentModule->SetFPID( FPID( footprintName ) ); m_currentModule->SetFPID( LIB_ID( footprintName ) );
// Init Fields: // Init Fields:
TEXTE_MODULE& reference = m_currentModule->Reference(); TEXTE_MODULE& reference = m_currentModule->Reference();

4
pcbnew/dialogs/dialog_fp_lib_table.cpp
View File

@ -39,7 +39,7 @@
#include <3d_viewer.h> // for KISYS3DMOD #include <3d_viewer.h> // for KISYS3DMOD
#include <dialog_fp_lib_table_base.h> #include <dialog_fp_lib_table_base.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <fp_lib_table_lexer.h> #include <lib_table_lexer.h>
#include <invoke_pcb_dialog.h> #include <invoke_pcb_dialog.h>
#include <grid_tricks.h> #include <grid_tricks.h>
#include <confirm.h> #include <confirm.h>
@ -240,7 +240,7 @@ protected:
// at column 0 regardless of current cursor column. // at column 0 regardless of current cursor column.
STRING_LINE_READER slr( TO_UTF8( cb_text ), "Clipboard" ); STRING_LINE_READER slr( TO_UTF8( cb_text ), "Clipboard" );
FP_LIB_TABLE_LEXER lexer( &slr ); LIB_TABLE_LEXER lexer( &slr );
FP_LIB_TABLE tmp_tbl; FP_LIB_TABLE tmp_tbl;
bool parsed = true; bool parsed = true;

2
pcbnew/eagle_plugin.cpp
View File

@ -2128,7 +2128,7 @@ MODULE* EAGLE_PLUGIN::makeModule( CPTREE& aPackage, const string& aPkgName ) con
{ {
std::unique_ptr<MODULE> m( new MODULE( m_board ) ); std::unique_ptr<MODULE> m( new MODULE( m_board ) );
m->SetFPID( FPID( aPkgName ) ); m->SetFPID( LIB_ID( aPkgName ) );
opt_string description = aPackage.get_optional<string>( "description" ); opt_string description = aPackage.get_optional<string>( "description" );
if( description ) if( description )

8
pcbnew/exporters/gen_modules_placefile.cpp
View File

@ -4,7 +4,7 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2015 KiCad Developers, see CHANGELOG.TXT for contributors. * Copyright (C) 2015-2016 KiCad Developers, see CHANGELOG.TXT for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -487,7 +487,7 @@ int PCB_EDIT_FRAME::DoGenFootprintsPositionFile( const wxString& aFullFileName,
lenRefText = std::max( lenRefText, int(item.m_Reference.length()) ); lenRefText = std::max( lenRefText, int(item.m_Reference.length()) );
lenValText = std::max( lenValText, int(item.m_Value.length()) ); lenValText = std::max( lenValText, int(item.m_Value.length()) );
lenPkgText = std::max( lenPkgText, int(item.m_Module->GetFPID().GetFootprintName().length()) ); lenPkgText = std::max( lenPkgText, int(item.m_Module->GetFPID().GetLibItemName().length()) );
} }
if( aFullFileName.IsEmpty() ) if( aFullFileName.IsEmpty() )
@ -524,7 +524,7 @@ int PCB_EDIT_FRAME::DoGenFootprintsPositionFile( const wxString& aFullFileName,
line << csv_sep; line << csv_sep;
line << list[ii].m_Value; line << list[ii].m_Value;
line << csv_sep; line << csv_sep;
line << wxString( list[ii].m_Module->GetFPID().GetFootprintName() ); line << wxString( list[ii].m_Module->GetFPID().GetLibItemName() );
line << csv_sep; line << csv_sep;
line << wxString::Format( "%f%c%f%c%f", line << wxString::Format( "%f%c%f%c%f",
@ -579,7 +579,7 @@ int PCB_EDIT_FRAME::DoGenFootprintsPositionFile( const wxString& aFullFileName,
const wxString& ref = list[ii].m_Reference; const wxString& ref = list[ii].m_Reference;
const wxString& val = list[ii].m_Value; const wxString& val = list[ii].m_Value;
const wxString& pkg = list[ii].m_Module->GetFPID().GetFootprintName(); const wxString& pkg = list[ii].m_Module->GetFPID().GetLibItemName();
fprintf(file, "%-*s %-*s %-*s %9.4f %9.4f %8.4f %s\n", fprintf(file, "%-*s %-*s %-*s %9.4f %9.4f %8.4f %s\n",
lenRefText, TO_UTF8( ref ), lenRefText, TO_UTF8( ref ),

2
pcbnew/github/github_plugin.cpp
View File

@ -181,7 +181,7 @@ MODULE* GITHUB_PLUGIN::FootprintLoad( const wxString& aLibraryPath,
if( local ) if( local )
{ {
// It has worked, see <src>/scripts/test_kicad_plugin.py. So this was not firing: // It has worked, see <src>/scripts/test_kicad_plugin.py. So this was not firing:
// wxASSERT( aFootprintName == FROM_UTF8( local->GetFPID().GetFootprintName().c_str() ) ); // wxASSERT( aFootprintName == FROM_UTF8( local->GetFPID().GetLibItemName().c_str() ) );
// Moving it to higher API layer FP_LIB_TABLE::FootprintLoad(). // Moving it to higher API layer FP_LIB_TABLE::FootprintLoad().
return local; return local;

4
pcbnew/gpcb_plugin.cpp
View File

@ -1,7 +1,7 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2012-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
@ -311,7 +311,7 @@ void GPCB_FPL_CACHE::Load()
MODULE* footprint = parseMODULE( &reader ); MODULE* footprint = parseMODULE( &reader );
// The footprint name is the file name without the extension. // The footprint name is the file name without the extension.
footprint->SetFPID( FPID( fn.GetName() ) ); footprint->SetFPID( LIB_ID( fn.GetName() ) );
m_modules.insert( name, new GPCB_FPL_CACHE_ITEM( footprint, fn.GetName() ) ); m_modules.insert( name, new GPCB_FPL_CACHE_ITEM( footprint, fn.GetName() ) );
} while( dir.GetNext( &fpFileName ) ); } while( dir.GetNext( &fpFileName ) );

4
pcbnew/kicad_netlist_reader.cpp
View File

@ -5,7 +5,7 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 1992-2011 Jean-Pierre Charras. * Copyright (C) 1992-2011 Jean-Pierre Charras.
* Copyright (C) 1992-2015 KiCad Developers, see change_log.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see change_log.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -282,7 +282,7 @@ void KICAD_NETLIST_PARSER::parseComponent() throw( IO_ERROR, PARSE_ERROR, boost:
* A component need a reference, value, footprint name and a full time stamp * A component need a reference, value, footprint name and a full time stamp
* The full time stamp is the sheetpath time stamp + the component time stamp * The full time stamp is the sheetpath time stamp + the component time stamp
*/ */
FPID fpid; LIB_ID fpid;
wxString footprint; wxString footprint;
wxString ref; wxString ref;
wxString value; wxString value;

7
pcbnew/kicad_plugin.cpp
View File

@ -300,7 +300,7 @@ void FP_CACHE::Load()
MODULE* footprint = (MODULE*) m_owner->m_parser->Parse(); MODULE* footprint = (MODULE*) m_owner->m_parser->Parse();
// The footprint name is the file name without the extension. // The footprint name is the file name without the extension.
footprint->SetFPID( FPID( fullPath.GetName() ) ); footprint->SetFPID( LIB_ID( fullPath.GetName() ) );
m_modules.insert( name, new FP_CACHE_ITEM( footprint, fullPath ) ); m_modules.insert( name, new FP_CACHE_ITEM( footprint, fullPath ) );
} while( dir.GetNext( &fpFileName ) ); } while( dir.GetNext( &fpFileName ) );
@ -1879,12 +1879,13 @@ void PCB_IO::FootprintSave( const wxString& aLibraryPath, const MODULE* aFootpri
THROW_IO_ERROR( msg ); THROW_IO_ERROR( msg );
} }
std::string footprintName = aFootprint->GetFPID().GetFootprintName(); std::string footprintName = aFootprint->GetFPID().GetLibItemName();
MODULE_MAP& mods = m_cache->GetModules(); MODULE_MAP& mods = m_cache->GetModules();
// Quietly overwrite module and delete module file from path for any by same name. // Quietly overwrite module and delete module file from path for any by same name.
wxFileName fn( aLibraryPath, aFootprint->GetFPID().GetFootprintName(), KiCadFootprintFileExtension ); wxFileName fn( aLibraryPath, aFootprint->GetFPID().GetLibItemName(),
KiCadFootprintFileExtension );
if( !fn.IsOk() ) if( !fn.IsOk() )
{ {

8
pcbnew/legacy_netlist_reader.cpp
View File

@ -6,8 +6,8 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 1992-2011 Jean-Pierre Charras. * Copyright (C) 1992-2011 Jean-Pierre Charras.
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@verizon.net>. * Copyright (C) 2013-2016 Wayne Stambaugh <stambaughw@verizon.net>.
* Copyright (C) 1992-2011 KiCad Developers, see change_log.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see change_log.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -166,10 +166,10 @@ COMPONENT* LEGACY_NETLIST_READER::loadComponent( char* aText )
name = FROM_UTF8( text ).AfterFirst( wxChar( '=' ) ).BeforeLast( wxChar( '}' ) ); name = FROM_UTF8( text ).AfterFirst( wxChar( '=' ) ).BeforeLast( wxChar( '}' ) );
} }
FPID fpid; LIB_ID fpid;
if( !footprintName.IsEmpty() ) if( !footprintName.IsEmpty() )
fpid.SetFootprintName( footprintName ); fpid.SetLibItemName( footprintName );
COMPONENT* component = new COMPONENT( fpid, reference, value, timeStamp ); COMPONENT* component = new COMPONENT( fpid, reference, value, timeStamp );
component->SetName( name ); component->SetName( name );

18
pcbnew/legacy_plugin.cpp
View File

@ -434,7 +434,7 @@ void LEGACY_PLUGIN::loadAllSections( bool doAppend )
{ {
unique_ptr<MODULE> module( new MODULE( m_board ) ); unique_ptr<MODULE> module( new MODULE( m_board ) );
FPID fpid; LIB_ID fpid;
std::string fpName = StrPurge( line + SZ( "$MODULE" ) ); std::string fpName = StrPurge( line + SZ( "$MODULE" ) );
// The footprint names in legacy libraries can contain the '/' and ':' // The footprint names in legacy libraries can contain the '/' and ':'
@ -442,7 +442,7 @@ void LEGACY_PLUGIN::loadAllSections( bool doAppend )
ReplaceIllegalFileNameChars( &fpName ); ReplaceIllegalFileNameChars( &fpName );
if( !fpName.empty() ) if( !fpName.empty() )
fpid = FPID( fpName ); fpid = LIB_ID( fpName );
module->SetFPID( fpid ); module->SetFPID( fpid );
@ -1377,7 +1377,7 @@ void LEGACY_PLUGIN::loadMODULE( MODULE* aModule )
wxString msg = wxString::Format( wxString msg = wxString::Format(
wxT( "Missing '$EndMODULE' for MODULE '%s'" ), wxT( "Missing '$EndMODULE' for MODULE '%s'" ),
GetChars( aModule->GetFPID().GetFootprintName() ) ); GetChars( aModule->GetFPID().GetLibItemName() ) );
THROW_IO_ERROR( msg ); THROW_IO_ERROR( msg );
} }
@ -1432,7 +1432,7 @@ void LEGACY_PLUGIN::loadPAD( MODULE* aModule )
padchar, padchar,
padchar, padchar,
m_reader->LineNumber(), m_reader->LineNumber(),
GetChars( aModule->GetFPID().GetFootprintName() ) GetChars( aModule->GetFPID().GetLibItemName() )
); );
THROW_IO_ERROR( m_error ); THROW_IO_ERROR( m_error );
} }
@ -1638,7 +1638,7 @@ void LEGACY_PLUGIN::loadMODULE_EDGE( MODULE* aModule )
(unsigned char) line[1], (unsigned char) line[1],
(unsigned char) line[1], (unsigned char) line[1],
m_reader->LineNumber(), m_reader->LineNumber(),
GetChars( aModule->GetFPID().GetFootprintName() ) GetChars( aModule->GetFPID().GetLibItemName() )
); );
THROW_IO_ERROR( m_error ); THROW_IO_ERROR( m_error );
} }
@ -3318,11 +3318,11 @@ void LP_CACHE::LoadModules( LINE_READER* aReader )
std::string footprintName = StrPurge( line + SZ( "$MODULE" ) ); std::string footprintName = StrPurge( line + SZ( "$MODULE" ) );
// The footprint names in legacy libraries can contain the '/' and ':' // The footprint names in legacy libraries can contain the '/' and ':'
// characters which will cause the FPID parser to choke. // characters which will cause the LIB_ID parser to choke.
ReplaceIllegalFileNameChars( &footprintName ); ReplaceIllegalFileNameChars( &footprintName );
// set the footprint name first thing, so exceptions can use name. // set the footprint name first thing, so exceptions can use name.
module->SetFPID( FPID( footprintName ) ); module->SetFPID( LIB_ID( footprintName ) );
#if 0 && defined( DEBUG ) #if 0 && defined( DEBUG )
printf( "%s\n", footprintName.c_str() ); printf( "%s\n", footprintName.c_str() );
@ -3339,7 +3339,7 @@ void LP_CACHE::LoadModules( LINE_READER* aReader )
// Not sure why this is asserting on debug builds. The debugger shows the // Not sure why this is asserting on debug builds. The debugger shows the
// strings are the same. If it's not really needed maybe it can be removed. // strings are the same. If it's not really needed maybe it can be removed.
// wxASSERT( footprintName == m->GetFPID().GetFootprintName() ); // wxASSERT( footprintName == m->GetFPID().GetLibItemName() );
/* /*
@ -3386,7 +3386,7 @@ void LP_CACHE::LoadModules( LINE_READER* aReader )
{ {
nameOK = true; nameOK = true;
m->SetFPID( FPID( newName ) ); m->SetFPID( LIB_ID( newName ) );
std::pair<MODULE_ITER, bool> r = m_modules.insert( newName, m ); std::pair<MODULE_ITER, bool> r = m_modules.insert( newName, m );
wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) ); wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );

18
pcbnew/librairi.cpp
View File

@ -339,7 +339,7 @@ void FOOTPRINT_EDIT_FRAME::Export_Module( MODULE* aModule )
if( !aModule ) if( !aModule )
return; return;
fn.SetName( aModule->GetFPID().GetFootprintName() ); fn.SetName( aModule->GetFPID().GetLibItemName() );
wxString wildcard = wxGetTranslation( KiCadFootprintLibFileWildcard ); wxString wildcard = wxGetTranslation( KiCadFootprintLibFileWildcard );
@ -534,8 +534,8 @@ bool FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary()
if( !fpid_txt ) if( !fpid_txt )
return false; return false;
FPID fpid( fpid_txt ); LIB_ID fpid( fpid_txt );
wxString fpname = fpid.GetFootprintName(); wxString fpname = fpid.GetLibItemName();
// Confirmation // Confirmation
wxString msg = wxString::Format( FMT_OK_DELETE, fpname.GetData(), nickname.GetData() ); wxString msg = wxString::Format( FMT_OK_DELETE, fpname.GetData(), nickname.GetData() );
@ -589,7 +589,7 @@ void PCB_EDIT_FRAME::ArchiveModulesOnBoard( bool aStoreInNewLib )
for( MODULE* curr_fp = GetBoard()->m_Modules; curr_fp; curr_fp = curr_fp->Next() ) for( MODULE* curr_fp = GetBoard()->m_Modules; curr_fp; curr_fp = curr_fp->Next() )
{ {
if( !curr_fp->GetFPID().GetFootprintName().empty() ) // Can happen with old boards. if( !curr_fp->GetFPID().GetLibItemName().empty() ) // Can happen with old boards.
tbl->FootprintSave( nickname, curr_fp, false ); tbl->FootprintSave( nickname, curr_fp, false );
} }
} }
@ -614,7 +614,7 @@ void PCB_EDIT_FRAME::ArchiveModulesOnBoard( bool aStoreInNewLib )
{ {
try try
{ {
if( !curr_fp->GetFPID().GetFootprintName().empty() ) // Can happen with old boards. if( !curr_fp->GetFPID().GetLibItemName().empty() ) // Can happen with old boards.
pi->FootprintSave( libPath, curr_fp ); pi->FootprintSave( libPath, curr_fp );
} }
catch( const IO_ERROR& ioe ) catch( const IO_ERROR& ioe )
@ -649,7 +649,7 @@ bool FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary( const wxString& aLibrary,
} }
// Ask what to use as the footprint name in the library // Ask what to use as the footprint name in the library
wxString footprintName = aModule->GetFPID().GetFootprintName(); wxString footprintName = aModule->GetFPID().GetLibItemName();
if( aDisplayDialog ) if( aDisplayDialog )
{ {
@ -676,14 +676,14 @@ bool FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary( const wxString& aLibrary,
return false; return false;
} }
aModule->SetFPID( FPID( footprintName ) ); aModule->SetFPID( LIB_ID( footprintName ) );
} }
// Ensure this footprint has a libname // Ensure this footprint has a libname
if( footprintName.IsEmpty() ) if( footprintName.IsEmpty() )
{ {
footprintName = wxT("noname"); footprintName = wxT("noname");
aModule->SetFPID( FPID( footprintName ) ); aModule->SetFPID( LIB_ID( footprintName ) );
} }
bool module_exists = false; bool module_exists = false;
@ -779,7 +779,7 @@ MODULE* PCB_BASE_FRAME::CreateNewModule( const wxString& aModuleName )
module->SetLastEditTime(); module->SetLastEditTime();
// Update its name in lib // Update its name in lib
module->SetFPID( FPID( moduleName ) ); module->SetFPID( LIB_ID( moduleName ) );
wxPoint default_pos; wxPoint default_pos;
BOARD_DESIGN_SETTINGS& settings = GetDesignSettings(); BOARD_DESIGN_SETTINGS& settings = GetDesignSettings();

18
pcbnew/loadcmp.cpp
View File

@ -3,7 +3,7 @@
* *
* Copyright (C) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr * Copyright (C) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com> * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 1992-2015 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -45,7 +45,7 @@ using namespace std::placeholders;
#include <gr_basic.h> #include <gr_basic.h>
#include <macros.h> #include <macros.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <fpid.h> #include <lib_id.h>
#include <class_board.h> #include <class_board.h>
#include <class_module.h> #include <class_module.h>
@ -182,7 +182,7 @@ MODULE* PCB_BASE_FRAME::LoadModuleFromLibrary( const wxString& aLibrary,
if( dlg.m_GetExtraFunction ) if( dlg.m_GetExtraFunction )
{ {
// SelectFootprintFromLibBrowser() returns the "full" footprint name, i.e. // SelectFootprintFromLibBrowser() returns the "full" footprint name, i.e.
// <lib_name>/<footprint name> or FPID format "lib_name:fp_name:rev#" // <lib_name>/<footprint name> or LIB_ID format "lib_name:fp_name:rev#"
moduleName = SelectFootprintFromLibBrowser(); moduleName = SelectFootprintFromLibBrowser();
} }
else else
@ -221,10 +221,10 @@ MODULE* PCB_BASE_FRAME::LoadModuleFromLibrary( const wxString& aLibrary,
} }
} }
FPID fpid; LIB_ID fpid;
wxCHECK_MSG( fpid.Parse( moduleName ) < 0, NULL, wxCHECK_MSG( fpid.Parse( moduleName ) < 0, NULL,
wxString::Format( wxT( "Could not parse FPID string '%s'." ), wxString::Format( wxT( "Could not parse LIB_ID string '%s'." ),
GetChars( moduleName ) ) ); GetChars( moduleName ) ) );
try try
@ -254,7 +254,7 @@ MODULE* PCB_BASE_FRAME::LoadModuleFromLibrary( const wxString& aLibrary,
else else
{ {
wxCHECK_MSG( fpid.Parse( moduleName ) < 0, NULL, wxCHECK_MSG( fpid.Parse( moduleName ) < 0, NULL,
wxString::Format( wxT( "Could not parse FPID string '%s'." ), wxString::Format( wxT( "Could not parse LIB_ID string '%s'." ),
GetChars( moduleName ) ) ); GetChars( moduleName ) ) );
try try
@ -310,7 +310,7 @@ MODULE* PCB_BASE_FRAME::LoadModuleFromLibrary( const wxString& aLibrary,
} }
MODULE* PCB_BASE_FRAME::LoadFootprint( const FPID& aFootprintId ) MODULE* PCB_BASE_FRAME::LoadFootprint( const LIB_ID& aFootprintId )
{ {
MODULE* module = NULL; MODULE* module = NULL;
@ -328,12 +328,12 @@ MODULE* PCB_BASE_FRAME::LoadFootprint( const FPID& aFootprintId )
} }
MODULE* PCB_BASE_FRAME::loadFootprint( const FPID& aFootprintId ) MODULE* PCB_BASE_FRAME::loadFootprint( const LIB_ID& aFootprintId )
throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception ) throw( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception )
{ {
FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs(); FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs();
wxCHECK_MSG( fptbl, NULL, wxT( "Cannot look up FPID in NULL FP_LIB_TABLE." ) ); wxCHECK_MSG( fptbl, NULL, wxT( "Cannot look up LIB_ID in NULL FP_LIB_TABLE." ) );
MODULE* module = fptbl->FootprintLoadWithOptionalNickname( aFootprintId ); MODULE* module = fptbl->FootprintLoadWithOptionalNickname( aFootprintId );

16
pcbnew/modview_frame.cpp
View File

@ -37,7 +37,7 @@
#include <dialog_helpers.h> #include <dialog_helpers.h>
#include <msgpanel.h> #include <msgpanel.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <fpid.h> #include <lib_id.h>
#include <confirm.h> #include <confirm.h>
#include <class_board.h> #include <class_board.h>
@ -203,10 +203,10 @@ FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME( KIWAY* aKiway, wxWindow* aParent
// If a footprint was previously loaded, reload it // If a footprint was previously loaded, reload it
if( getCurNickname().size() && getCurFootprintName().size() ) if( getCurNickname().size() && getCurFootprintName().size() )
{ {
FPID id; LIB_ID id;
id.SetLibNickname( getCurNickname() ); id.SetLibNickname( getCurNickname() );
id.SetFootprintName( getCurFootprintName() ); id.SetLibItemName( getCurFootprintName() );
GetBoard()->Add( loadFootprint( id ) ); GetBoard()->Add( loadFootprint( id ) );
} }
@ -449,9 +449,9 @@ void FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList( wxCommandEvent& event )
// Delete the current footprint // Delete the current footprint
GetBoard()->m_Modules.DeleteAll(); GetBoard()->m_Modules.DeleteAll();
FPID id; LIB_ID id;
id.SetLibNickname( getCurNickname() ); id.SetLibNickname( getCurNickname() );
id.SetFootprintName( getCurFootprintName() ); id.SetLibItemName( getCurFootprintName() );
try try
{ {
@ -511,10 +511,10 @@ void FOOTPRINT_VIEWER_FRAME::ExportSelectedFootprint( wxCommandEvent& event )
{ {
wxString fp_name = m_footprintList->GetString( ii ); wxString fp_name = m_footprintList->GetString( ii );
FPID fpid; LIB_ID fpid;
fpid.SetLibNickname( getCurNickname() ); fpid.SetLibNickname( getCurNickname() );
fpid.SetFootprintName( fp_name ); fpid.SetLibItemName( fp_name );
DismissModal( true, fpid.Format() ); DismissModal( true, fpid.Format() );
} }
@ -773,7 +773,7 @@ void FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint( wxCommandEvent& event )
delete oldmodule; delete oldmodule;
} }
setCurFootprintName( module->GetFPID().GetFootprintName() ); setCurFootprintName( module->GetFPID().GetLibItemName() );
wxString nickname = module->GetFPID().GetLibNickname(); wxString nickname = module->GetFPID().GetLibNickname();

6
pcbnew/muonde.cpp
View File

@ -3,8 +3,8 @@
* *
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com> * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2015 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2015-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2015 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -288,7 +288,7 @@ MODULE* CreateMicrowaveInductor( PCB_EDIT_FRAME* aPcbFrame, wxString& aErrorMess
MODULE* module = aPcbFrame->CreateNewModule( msg ); MODULE* module = aPcbFrame->CreateNewModule( msg );
// here the module is already in the BOARD, CreateNewModule() does that. // here the module is already in the BOARD, CreateNewModule() does that.
module->SetFPID( FPID( std::string( "mw_inductor" ) ) ); module->SetFPID( LIB_ID( std::string( "mw_inductor" ) ) );
module->SetAttributes( MOD_VIRTUAL | MOD_CMS ); module->SetAttributes( MOD_VIRTUAL | MOD_CMS );
module->ClearFlags(); module->ClearFlags();
module->SetPosition( s_inductor_pattern.m_End ); module->SetPosition( s_inductor_pattern.m_End );

14
pcbnew/netlist.cpp
View File

@ -6,7 +6,7 @@
* *
* Copyright (C) 1992-2013 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 1992-2013 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com> * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2013-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2016 KiCad Developers, see change_log.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see change_log.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
@ -41,7 +41,7 @@ using namespace std::placeholders;
#include <netlist_reader.h> #include <netlist_reader.h>
#include <reporter.h> #include <reporter.h>
#include <wildcards_and_files_ext.h> #include <wildcards_and_files_ext.h>
#include <fpid.h> #include <lib_id.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <class_board.h> #include <class_board.h>
@ -227,7 +227,7 @@ void PCB_EDIT_FRAME::LoadFootprints( NETLIST& aNetlist, REPORTER* aReporter )
throw( IO_ERROR, PARSE_ERROR ) throw( IO_ERROR, PARSE_ERROR )
{ {
wxString msg; wxString msg;
FPID lastFPID; LIB_ID lastFPID;
COMPONENT* component; COMPONENT* component;
MODULE* module = 0; MODULE* module = 0;
MODULE* fpOnBoard; MODULE* fpOnBoard;
@ -244,7 +244,7 @@ void PCB_EDIT_FRAME::LoadFootprints( NETLIST& aNetlist, REPORTER* aReporter )
#if ALLOW_PARTIAL_FPID #if ALLOW_PARTIAL_FPID
// The FPID is ok as long as there is a footprint portion coming // The FPID is ok as long as there is a footprint portion coming
// from eeschema. // from eeschema.
if( !component->GetFPID().GetFootprintName().size() ) if( !component->GetFPID().GetLibItemName().size() )
#else #else
if( component->GetFPID().empty() ) if( component->GetFPID().empty() )
#endif #endif
@ -293,9 +293,9 @@ void PCB_EDIT_FRAME::LoadFootprints( NETLIST& aNetlist, REPORTER* aReporter )
module = NULL; module = NULL;
#if ALLOW_PARTIAL_FPID #if ALLOW_PARTIAL_FPID
// The FPID is ok as long as there is a footprint portion coming // The LIB_ID is ok as long as there is a footprint portion coming
// the library if it's needed. Nickname can be blank. // the library if it's needed. Nickname can be blank.
if( !component->GetFPID().GetFootprintName().size() ) if( !component->GetFPID().GetLibItemName().size() )
#else #else
if( !component->GetFPID().IsValid() ) if( !component->GetFPID().IsValid() )
#endif #endif
@ -326,7 +326,7 @@ void PCB_EDIT_FRAME::LoadFootprints( NETLIST& aNetlist, REPORTER* aReporter )
msg.Printf( _( "Component '%s' footprint '%s' was not found in " msg.Printf( _( "Component '%s' footprint '%s' was not found in "
"any libraries in the footprint library table.\n" ), "any libraries in the footprint library table.\n" ),
GetChars( component->GetReference() ), GetChars( component->GetReference() ),
GetChars( component->GetFPID().GetFootprintName() ) ); GetChars( component->GetFPID().GetLibItemName() ) );
aReporter->Report( msg, REPORTER::RPT_ERROR ); aReporter->Report( msg, REPORTER::RPT_ERROR );
} }

14
pcbnew/netlist_reader.cpp
View File

@ -5,8 +5,8 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 1992-2011 Jean-Pierre Charras. * Copyright (C) 1992-2011 Jean-Pierre Charras.
* Copyright (C) 2013-2015 Wayne Stambaugh <stambaughw@verizon.net>. * Copyright (C) 2013-2016 Wayne Stambaugh <stambaughw@verizon.net>.
* Copyright (C) 1992-2015 KiCad Developers, see change_log.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see change_log.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -174,7 +174,7 @@ bool CMP_READER::Load( NETLIST* aNetlist ) throw( IO_ERROR, PARSE_ERROR )
// assignment list. This is an usual case during the life of a design. // assignment list. This is an usual case during the life of a design.
if( component ) if( component )
{ {
FPID fpid; LIB_ID fpid;
if( !footprint.IsEmpty() && fpid.Parse( footprint ) >= 0 ) if( !footprint.IsEmpty() && fpid.Parse( footprint ) >= 0 )
{ {
@ -186,10 +186,10 @@ bool CMP_READER::Load( NETLIST* aNetlist ) throw( IO_ERROR, PARSE_ERROR )
THROW_IO_ERROR( error ); THROW_IO_ERROR( error );
} }
// For checking purpose, store the existing FPID (if any) in the alternate fpid copy // For checking purpose, store the existing LIB_ID (if any) in the alternate fpid copy
// if this existing FPID differs from the FPID read from the .cmp file. // if this existing LIB_ID differs from the LIB_ID read from the .cmp file.
// CvPcb can ask for user to chose the right FPID. // CvPcb can ask for user to chose the right LIB_ID.
// It happens if the FPID was modified outside CvPcb. // It happens if the LIB_ID was modified outside CvPcb.
if( fpid != component->GetFPID() && !component->GetFPID().empty() ) if( fpid != component->GetFPID() && !component->GetFPID().empty() )
component->SetAltFPID( component->GetFPID() ); component->SetAltFPID( component->GetFPID() );

2
pcbnew/netlist_reader.h
View File

@ -34,7 +34,7 @@
#include <fctsys.h> #include <fctsys.h>
#include <macros.h> #include <macros.h>
#include <fpid.h> #include <lib_id.h>
#include <netlist_lexer.h> // netlist_lexer is common to Eeschema and Pcbnew #include <netlist_lexer.h> // netlist_lexer is common to Eeschema and Pcbnew

4
pcbnew/pcad2kicadpcb_plugin/pcb_module.cpp
View File

@ -3,7 +3,7 @@
* *
* Copyright (C) 2007, 2008 Lubo Racko <developer@lura.sk> * Copyright (C) 2007, 2008 Lubo Racko <developer@lura.sk>
* Copyright (C) 2007, 2008, 2012-2013 Alexander Lunev <al.lunev@yahoo.com> * Copyright (C) 2007, 2008, 2012-2013 Alexander Lunev <al.lunev@yahoo.com>
* Copyright (C) 2012 KiCad Developers, see CHANGELOG.TXT for contributors. * Copyright (C) 2012-2016 KiCad Developers, see CHANGELOG.TXT for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -522,7 +522,7 @@ void PCB_MODULE::AddToBoard()
module->SetTimeStamp( 0 ); module->SetTimeStamp( 0 );
module->SetLastEditTime( 0 ); module->SetLastEditTime( 0 );
module->SetFPID( FPID( m_compRef ) ); module->SetFPID( LIB_ID( m_compRef ) );
module->SetAttributes( MOD_DEFAULT | MOD_CMS ); module->SetAttributes( MOD_DEFAULT | MOD_CMS );

24
pcbnew/pcb_netlist.h
View File

@ -9,8 +9,8 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2012 Jean-Pierre Charras. * Copyright (C) 2012 Jean-Pierre Charras.
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@verizon.net>. * Copyright (C) 2013-2016 Wayne Stambaugh <stambaughw@verizon.net>.
* Copyright (C) 2012-2015 KiCad Developers, see CHANGELOG.TXT for contributors. * Copyright (C) 2012-2016 KiCad Developers, see CHANGELOG.TXT for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -33,7 +33,7 @@
#include <boost/ptr_container/ptr_vector.hpp> #include <boost/ptr_container/ptr_vector.hpp>
#include <wx/arrstr.h> #include <wx/arrstr.h>
#include <fpid.h> #include <lib_id.h>
#include <class_module.h> #include <class_module.h>
@ -95,13 +95,13 @@ class COMPONENT
/// The name of the component library where #m_name was found. /// The name of the component library where #m_name was found.
wxString m_library; wxString m_library;
/// The #FPID of the footprint assigned to the component. /// The #LIB_ID of the footprint assigned to the component.
FPID m_fpid; LIB_ID m_fpid;
/// The alt FPID of the footprint, when there are 2 different assigned footprints, /// The alt LIB_ID of the footprint, when there are 2 different assigned footprints,
/// One from the netlist, the other from the .cmp file. /// One from the netlist, the other from the .cmp file.
/// this one is a copy of the netlist footprint assignment /// this one is a copy of the netlist footprint assignment
FPID m_altFpid; LIB_ID m_altFpid;
/// The #MODULE loaded for #m_fpid. /// The #MODULE loaded for #m_fpid.
std::unique_ptr< MODULE > m_footprint; std::unique_ptr< MODULE > m_footprint;
@ -112,7 +112,7 @@ class COMPONENT
static COMPONENT_NET m_emptyNet; static COMPONENT_NET m_emptyNet;
public: public:
COMPONENT( const FPID& aFPID, COMPONENT( const LIB_ID& aFPID,
const wxString& aReference, const wxString& aReference,
const wxString& aValue, const wxString& aValue,
const wxString& aTimeStamp ) const wxString& aTimeStamp )
@ -149,20 +149,20 @@ public:
const wxString& GetValue() const { return m_value; } const wxString& GetValue() const { return m_value; }
void SetFPID( const FPID& aFPID ) void SetFPID( const LIB_ID& aFPID )
{ {
m_footprintChanged = !m_fpid.empty() && (m_fpid != aFPID); m_footprintChanged = !m_fpid.empty() && (m_fpid != aFPID);
m_fpid = aFPID; m_fpid = aFPID;
} }
void SetAltFPID( const FPID& aFPID ) void SetAltFPID( const LIB_ID& aFPID )
{ {
m_altFpid = aFPID; m_altFpid = aFPID;
} }
const FPID& GetFPID() const { return m_fpid; } const LIB_ID& GetFPID() const { return m_fpid; }
const FPID& GetAltFPID() const { return m_altFpid; } const LIB_ID& GetAltFPID() const { return m_altFpid; }
const wxString& GetTimeStamp() const { return m_timeStamp; } const wxString& GetTimeStamp() const { return m_timeStamp; }

2
pcbnew/pcb_parser.cpp
View File

@ -1743,7 +1743,7 @@ MODULE* PCB_PARSER::parseMODULE_unchecked( wxArrayString* aInitialComments )
wxString name; wxString name;
wxPoint pt; wxPoint pt;
T token; T token;
FPID fpid; LIB_ID fpid;
std::unique_ptr<MODULE> module( new MODULE( m_board ) ); std::unique_ptr<MODULE> module( new MODULE( m_board ) );

1
pcbnew/pcbnew_config.cpp
View File

@ -44,7 +44,6 @@
#include <worksheet.h> #include <worksheet.h>
#include <dialog_hotkeys_editor.h> #include <dialog_hotkeys_editor.h>
#include <fp_lib_table.h> #include <fp_lib_table.h>
#include <fp_lib_table_lexer.h>
#include <worksheet_shape_builder.h> #include <worksheet_shape_builder.h>
#include <class_board.h> #include <class_board.h>

2
pcbnew/python/examples/createFPC40.py
View File

@ -50,7 +50,7 @@ e.SetShape(S_SEGMENT)
module.Add(e) module.Add(e)
# save the PCB to disk # save the PCB to disk
fpid = FPID("FPC"+str(pads)) #the name in library fpid = LIB_ID("FPC"+str(pads)) #the name in library
module.SetFPID( fpid ) module.SetFPID( fpid )
try: try:

2
pcbnew/python/plugins/HelpfulFootprintWizardPlugin.py
View File

@ -333,7 +333,7 @@ class HelpfulFootprintWizardPlugin(pcbnew.FootprintWizardPlugin,
self.module.SetValue(self.GetValue()) self.module.SetValue(self.GetValue())
self.module.SetReference("%s**" % self.GetReferencePrefix()) self.module.SetReference("%s**" % self.GetReferencePrefix())
fpid = pcbnew.FPID(self.module.GetValue()) # the name in library fpid = pcbnew.LIB_ID(self.module.GetValue()) # the name in library
self.module.SetFPID(fpid) self.module.SetFPID(fpid)
self.SetModule3DModel() # add a 3d module if specified self.SetModule3DModel() # add a 3d module if specified

4
pcbnew/swig/pcbnew.i
View File

@ -41,9 +41,9 @@
%include <convert_to_biu.h> %include <convert_to_biu.h>
%{ %{
#include <fpid.h> #include <lib_id.h>
%} %}
%include fpid.h %include lib_id.h
// ignore a couple of items that generate warnings from swig built code // ignore a couple of items that generate warnings from swig built code

10
pcbnew/xchgmod.cpp
View File

@ -7,7 +7,7 @@
* *
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com> * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@verizon.net> * Copyright (C) 2013-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
@ -74,7 +74,7 @@ private:
bool changeSameFootprints( bool aUseValue); bool changeSameFootprints( bool aUseValue);
bool changeAllFootprints(); bool changeAllFootprints();
bool change_1_Module( MODULE* aModule, bool change_1_Module( MODULE* aModule,
const FPID& aNewFootprintFPID, const LIB_ID& aNewFootprintFPID,
bool eShowError ); bool eShowError );
BOARD_COMMIT m_commit; BOARD_COMMIT m_commit;
@ -240,7 +240,7 @@ bool DIALOG_EXCHANGE_MODULE::changeSameFootprints( bool aUseValue )
bool change = false; bool change = false;
wxString newmodulename = m_NewFootprintFPID->GetValue(); wxString newmodulename = m_NewFootprintFPID->GetValue();
wxString value; wxString value;
FPID lib_reference; LIB_ID lib_reference;
bool check_module_value = false; bool check_module_value = false;
int ShowErr = 3; // Post 3 error messages max. int ShowErr = 3; // Post 3 error messages max.
@ -337,7 +337,7 @@ bool DIALOG_EXCHANGE_MODULE::changeAllFootprints()
bool DIALOG_EXCHANGE_MODULE::change_1_Module( MODULE* aModule, bool DIALOG_EXCHANGE_MODULE::change_1_Module( MODULE* aModule,
const FPID& aNewFootprintFPID, const LIB_ID& aNewFootprintFPID,
bool aShowError ) bool aShowError )
{ {
MODULE* newModule; MODULE* newModule;
@ -349,7 +349,7 @@ bool DIALOG_EXCHANGE_MODULE::change_1_Module( MODULE* aModule,
wxBusyCursor dummy; wxBusyCursor dummy;
// Copy parameters from the old module. // Copy parameters from the old module.
FPID oldFootprintFPID = aModule->GetFPID(); LIB_ID oldFootprintFPID = aModule->GetFPID();
// Load module. // Load module.
line.Printf( _( "Change footprint '%s' (from '%s') to '%s'" ), line.Printf( _( "Change footprint '%s' (from '%s') to '%s'" ),