2016-11-20 18:33:07 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2021-01-10 22:55:30 +00:00
|
|
|
* Copyright (C) 2016 Wayne Stambaugh <stambaughw@gmail.com>
|
2022-12-08 23:56:55 +00:00
|
|
|
* Copyright (C) 2022 CERN
|
2023-04-27 10:54:18 +00:00
|
|
|
* Copyright (C) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors.
|
2016-11-20 18:33:07 +00:00
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, you may find one here:
|
|
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
2016-11-20 23:35:08 +00:00
|
|
|
#include <lib_id.h>
|
|
|
|
#include <lib_table_lexer.h>
|
2023-09-23 23:53:22 +00:00
|
|
|
#include <paths.h>
|
2019-01-26 21:19:02 +00:00
|
|
|
#include <pgm_base.h>
|
|
|
|
#include <search_stack.h>
|
2022-05-14 18:23:43 +00:00
|
|
|
#include <settings/kicad_settings.h>
|
2020-01-13 01:44:19 +00:00
|
|
|
#include <settings/settings_manager.h>
|
2019-01-26 21:19:02 +00:00
|
|
|
#include <systemdirsappend.h>
|
2016-11-20 18:33:07 +00:00
|
|
|
#include <symbol_lib_table.h>
|
2021-02-24 13:48:02 +00:00
|
|
|
#include <lib_symbol.h>
|
2023-12-24 00:31:24 +00:00
|
|
|
#include <sch_io/database/sch_io_database.h>
|
2023-02-26 23:39:31 +00:00
|
|
|
#include <dialogs/dialog_database_lib_settings.h>
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2022-05-14 18:23:43 +00:00
|
|
|
#include <wx/dir.h>
|
2022-12-08 23:56:55 +00:00
|
|
|
#include "sim/sim_model.h"
|
2022-05-14 18:23:43 +00:00
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
#define OPT_SEP '|' ///< options separator character
|
|
|
|
|
2016-11-20 23:35:08 +00:00
|
|
|
using namespace LIB_TABLE_T;
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
|
2017-03-05 22:31:31 +00:00
|
|
|
static const wxString global_tbl_name( "sym-lib-table" );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
|
2017-09-02 18:12:50 +00:00
|
|
|
const char* SYMBOL_LIB_TABLE::PropPowerSymsOnly = "pwr_sym_only";
|
|
|
|
const char* SYMBOL_LIB_TABLE::PropNonPowerSymsOnly = "non_pwr_sym_only";
|
2017-09-01 20:42:20 +00:00
|
|
|
int SYMBOL_LIB_TABLE::m_modifyHash = 1; // starts at 1 and goes up
|
|
|
|
|
|
|
|
|
2017-03-05 22:31:31 +00:00
|
|
|
/// The global symbol library table. This is not dynamically allocated because
|
|
|
|
/// in a multiple project environment we must keep its address constant (since it is
|
|
|
|
/// the fallback table for multiple projects).
|
|
|
|
SYMBOL_LIB_TABLE g_symbolLibraryTable;
|
2016-11-24 17:57:53 +00:00
|
|
|
|
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
bool SYMBOL_LIB_TABLE_ROW::operator==( const SYMBOL_LIB_TABLE_ROW& aRow ) const
|
|
|
|
{
|
|
|
|
return LIB_TABLE_ROW::operator == ( aRow ) && type == aRow.type;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void SYMBOL_LIB_TABLE_ROW::SetType( const wxString& aType )
|
|
|
|
{
|
|
|
|
type = SCH_IO_MGR::EnumFromStr( aType );
|
|
|
|
|
2023-08-26 19:28:53 +00:00
|
|
|
if( type == SCH_IO_MGR::SCH_FILE_UNKNOWN )
|
|
|
|
type = SCH_IO_MGR::SCH_KICAD;
|
2020-07-17 17:32:16 +00:00
|
|
|
|
|
|
|
plugin.release();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool SYMBOL_LIB_TABLE_ROW::Refresh()
|
|
|
|
{
|
|
|
|
if( !plugin )
|
|
|
|
{
|
|
|
|
wxArrayString dummyList;
|
|
|
|
|
|
|
|
plugin.set( SCH_IO_MGR::FindPlugin( type ) );
|
2020-08-29 23:19:05 +00:00
|
|
|
SetLoaded( false );
|
2022-05-29 19:29:32 +00:00
|
|
|
plugin->SetLibTable( static_cast<SYMBOL_LIB_TABLE*>( GetParent() ) );
|
2020-07-17 17:32:16 +00:00
|
|
|
plugin->EnumerateSymbolLib( dummyList, GetFullURI( true ), GetProperties() );
|
2020-08-29 23:19:05 +00:00
|
|
|
SetLoaded( true );
|
2020-07-17 17:32:16 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2022-08-27 03:52:56 +00:00
|
|
|
void SYMBOL_LIB_TABLE_ROW::GetSubLibraryNames( std::vector<wxString>& aNames ) const
|
|
|
|
{
|
|
|
|
if( !plugin )
|
|
|
|
return;
|
|
|
|
|
|
|
|
plugin->GetSubLibraryNames( aNames );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2023-02-26 23:39:31 +00:00
|
|
|
void SYMBOL_LIB_TABLE_ROW::ShowSettingsDialog( wxWindow* aParent ) const
|
|
|
|
{
|
|
|
|
wxCHECK( plugin, /* void */ );
|
|
|
|
|
|
|
|
if( type != SCH_IO_MGR::SCH_DATABASE )
|
|
|
|
return;
|
|
|
|
|
|
|
|
DIALOG_DATABASE_LIB_SETTINGS dlg( aParent,
|
2023-12-24 00:31:24 +00:00
|
|
|
static_cast<SCH_IO_DATABASE*>( ( SCH_IO* )plugin ) );
|
2023-02-26 23:39:31 +00:00
|
|
|
dlg.ShowModal();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
SYMBOL_LIB_TABLE::SYMBOL_LIB_TABLE( SYMBOL_LIB_TABLE* aFallBackTable ) :
|
|
|
|
LIB_TABLE( aFallBackTable )
|
|
|
|
{
|
|
|
|
// not copying fall back, simply search aFallBackTable separately
|
|
|
|
// if "nickName not found".
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-03-05 22:31:31 +00:00
|
|
|
SYMBOL_LIB_TABLE& SYMBOL_LIB_TABLE::GetGlobalLibTable()
|
|
|
|
{
|
|
|
|
return g_symbolLibraryTable;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-01-27 15:56:36 +00:00
|
|
|
void SYMBOL_LIB_TABLE::Parse( LIB_TABLE_LEXER* in )
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2017-07-13 14:04:16 +00:00
|
|
|
T tok;
|
|
|
|
wxString errMsg; // to collect error messages
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
// This table may be nested within a larger s-expression, or not.
|
|
|
|
// Allow for parser of that optional containing s-epression to have looked ahead.
|
|
|
|
if( in->CurTok() != T_sym_lib_table )
|
|
|
|
{
|
|
|
|
in->NeedLEFT();
|
2021-06-10 18:51:46 +00:00
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
if( ( tok = in->NextTok() ) != T_sym_lib_table )
|
|
|
|
in->Expecting( T_sym_lib_table );
|
|
|
|
}
|
|
|
|
|
|
|
|
while( ( tok = in->NextTok() ) != T_RIGHT )
|
|
|
|
{
|
2020-10-26 23:49:11 +00:00
|
|
|
std::unique_ptr< SYMBOL_LIB_TABLE_ROW > row = std::make_unique<SYMBOL_LIB_TABLE_ROW>();
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
if( tok == T_EOF )
|
|
|
|
in->Expecting( T_RIGHT );
|
|
|
|
|
|
|
|
if( tok != T_LEFT )
|
|
|
|
in->Expecting( T_LEFT );
|
|
|
|
|
|
|
|
// in case there is a "row integrity" error, tell where later.
|
|
|
|
int lineNum = in->CurLineNumber();
|
2023-01-23 17:42:27 +00:00
|
|
|
tok = in->NextTok();
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2023-01-23 17:42:27 +00:00
|
|
|
// Optionally parse the current version number
|
|
|
|
if( tok == T_version )
|
|
|
|
{
|
|
|
|
in->NeedNUMBER( "version" );
|
|
|
|
m_version = std::stoi( in->CurText() );
|
|
|
|
in->NeedRIGHT();
|
2023-01-24 23:37:58 +00:00
|
|
|
continue;
|
2023-01-23 17:42:27 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if( tok != T_lib )
|
2016-11-20 18:33:07 +00:00
|
|
|
in->Expecting( T_lib );
|
|
|
|
|
|
|
|
// (name NICKNAME)
|
|
|
|
in->NeedLEFT();
|
|
|
|
|
|
|
|
if( ( tok = in->NextTok() ) != T_name )
|
|
|
|
in->Expecting( T_name );
|
|
|
|
|
|
|
|
in->NeedSYMBOLorNUMBER();
|
|
|
|
|
|
|
|
row->SetNickName( in->FromUTF8() );
|
|
|
|
|
|
|
|
in->NeedRIGHT();
|
|
|
|
|
|
|
|
// After (name), remaining (lib) elements are order independent, and in
|
|
|
|
// some cases optional.
|
2017-11-15 05:48:31 +00:00
|
|
|
bool sawType = false;
|
|
|
|
bool sawOpts = false;
|
|
|
|
bool sawDesc = false;
|
|
|
|
bool sawUri = false;
|
|
|
|
bool sawDisabled = false;
|
2022-08-27 00:18:16 +00:00
|
|
|
bool sawHidden = false;
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
while( ( tok = in->NextTok() ) != T_RIGHT )
|
|
|
|
{
|
|
|
|
if( tok == T_EOF )
|
|
|
|
in->Unexpected( T_EOF );
|
|
|
|
|
|
|
|
if( tok != T_LEFT )
|
|
|
|
in->Expecting( T_LEFT );
|
|
|
|
|
|
|
|
tok = in->NeedSYMBOLorNUMBER();
|
|
|
|
|
|
|
|
switch( tok )
|
|
|
|
{
|
|
|
|
case T_uri:
|
|
|
|
if( sawUri )
|
|
|
|
in->Duplicate( tok );
|
|
|
|
sawUri = true;
|
|
|
|
in->NeedSYMBOLorNUMBER();
|
|
|
|
row->SetFullURI( in->FromUTF8() );
|
|
|
|
break;
|
|
|
|
|
|
|
|
case T_type:
|
|
|
|
if( sawType )
|
|
|
|
in->Duplicate( tok );
|
|
|
|
sawType = true;
|
|
|
|
in->NeedSYMBOLorNUMBER();
|
|
|
|
row->SetType( in->FromUTF8() );
|
|
|
|
break;
|
|
|
|
|
|
|
|
case T_options:
|
|
|
|
if( sawOpts )
|
|
|
|
in->Duplicate( tok );
|
|
|
|
sawOpts = true;
|
|
|
|
in->NeedSYMBOLorNUMBER();
|
|
|
|
row->SetOptions( in->FromUTF8() );
|
|
|
|
break;
|
|
|
|
|
|
|
|
case T_descr:
|
|
|
|
if( sawDesc )
|
|
|
|
in->Duplicate( tok );
|
|
|
|
sawDesc = true;
|
|
|
|
in->NeedSYMBOLorNUMBER();
|
|
|
|
row->SetDescr( in->FromUTF8() );
|
|
|
|
break;
|
|
|
|
|
2017-11-15 05:48:31 +00:00
|
|
|
case T_disabled:
|
|
|
|
if( sawDisabled )
|
|
|
|
in->Duplicate( tok );
|
|
|
|
sawDisabled = true;
|
|
|
|
row->SetEnabled( false );
|
|
|
|
break;
|
|
|
|
|
2022-08-27 00:18:16 +00:00
|
|
|
case T_hidden:
|
|
|
|
if( sawHidden )
|
|
|
|
in->Duplicate( tok );
|
|
|
|
sawHidden = true;
|
|
|
|
row->SetVisible( false );
|
|
|
|
break;
|
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
default:
|
|
|
|
in->Unexpected( tok );
|
|
|
|
}
|
|
|
|
|
|
|
|
in->NeedRIGHT();
|
|
|
|
}
|
|
|
|
|
|
|
|
if( !sawType )
|
|
|
|
in->Expecting( T_type );
|
|
|
|
|
|
|
|
if( !sawUri )
|
|
|
|
in->Expecting( T_uri );
|
|
|
|
|
|
|
|
// all nickNames within this table fragment must be unique, so we do not
|
|
|
|
// use doReplace in InsertRow(). (However a fallBack table can have a
|
|
|
|
// conflicting nickName and ours will supercede that one since in
|
|
|
|
// FindLib() we search this table before any fall back.)
|
2017-07-12 16:41:10 +00:00
|
|
|
wxString nickname = row->GetNickName(); // store it to be able to used it
|
|
|
|
// after row deletion if an error occurs
|
2017-07-13 14:04:16 +00:00
|
|
|
LIB_TABLE_ROW* tmp = row.release();
|
|
|
|
|
|
|
|
if( !InsertRow( tmp ) )
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2017-07-13 14:04:16 +00:00
|
|
|
delete tmp; // The table did not take ownership of the row.
|
|
|
|
|
2020-12-18 00:25:51 +00:00
|
|
|
wxString msg = wxString::Format( _( "Duplicate library nickname '%s' found in symbol "
|
|
|
|
"library table file line %d" ),
|
|
|
|
nickname,
|
|
|
|
lineNum );
|
2017-07-13 14:04:16 +00:00
|
|
|
|
|
|
|
if( !errMsg.IsEmpty() )
|
|
|
|
errMsg << '\n';
|
|
|
|
|
|
|
|
errMsg << msg;
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
}
|
2017-07-13 14:04:16 +00:00
|
|
|
|
|
|
|
if( !errMsg.IsEmpty() )
|
|
|
|
THROW_IO_ERROR( errMsg );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-03-14 22:54:40 +00:00
|
|
|
void SYMBOL_LIB_TABLE::Format( OUTPUTFORMATTER* aOutput, int aIndentLevel ) const
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2017-03-14 22:54:40 +00:00
|
|
|
aOutput->Print( aIndentLevel, "(sym_lib_table\n" );
|
2023-01-23 17:42:27 +00:00
|
|
|
aOutput->Print( aIndentLevel + 1, "(version %d)\n", m_version );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2023-08-06 04:56:51 +00:00
|
|
|
for( const LIB_TABLE_ROW& row : m_rows )
|
|
|
|
row.Format( aOutput, aIndentLevel + 1 );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2017-03-14 22:54:40 +00:00
|
|
|
aOutput->Print( aIndentLevel, ")\n" );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-09-01 20:42:20 +00:00
|
|
|
int SYMBOL_LIB_TABLE::GetModifyHash()
|
|
|
|
{
|
|
|
|
int hash = 0;
|
|
|
|
std::vector< wxString > libNames = GetLogicalLibs();
|
|
|
|
|
2017-09-24 18:11:58 +00:00
|
|
|
for( const auto& libName : libNames )
|
2017-09-01 20:42:20 +00:00
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
const SYMBOL_LIB_TABLE_ROW* row = FindRow( libName, true );
|
2017-09-01 20:42:20 +00:00
|
|
|
|
2017-11-11 23:56:07 +00:00
|
|
|
if( !row || !row->plugin )
|
|
|
|
{
|
|
|
|
wxFAIL;
|
|
|
|
continue;
|
|
|
|
}
|
2017-09-01 20:42:20 +00:00
|
|
|
|
|
|
|
hash += row->plugin->GetModifyHash();
|
|
|
|
}
|
|
|
|
|
|
|
|
hash += m_modifyHash;
|
|
|
|
|
|
|
|
return hash;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-09-02 18:12:50 +00:00
|
|
|
void SYMBOL_LIB_TABLE::EnumerateSymbolLib( const wxString& aNickname, wxArrayString& aAliasNames,
|
|
|
|
bool aPowerSymbolsOnly )
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2017-11-11 23:56:07 +00:00
|
|
|
wxCHECK( row && row->plugin, /* void */ );
|
2017-09-02 18:12:50 +00:00
|
|
|
|
|
|
|
wxString options = row->GetOptions();
|
|
|
|
|
|
|
|
if( aPowerSymbolsOnly )
|
|
|
|
row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
|
|
|
|
|
2020-08-29 23:19:05 +00:00
|
|
|
row->SetLoaded( false );
|
2016-11-20 18:33:07 +00:00
|
|
|
row->plugin->EnumerateSymbolLib( aAliasNames, row->GetFullURI( true ), row->GetProperties() );
|
2020-08-29 23:19:05 +00:00
|
|
|
row->SetLoaded( true );
|
2017-09-02 18:12:50 +00:00
|
|
|
|
|
|
|
if( aPowerSymbolsOnly )
|
|
|
|
row->SetOptions( options );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2021-01-10 22:55:30 +00:00
|
|
|
SYMBOL_LIB_TABLE_ROW* SYMBOL_LIB_TABLE::FindRow( const wxString& aNickname, bool aCheckIfEnabled )
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
SYMBOL_LIB_TABLE_ROW* row =
|
|
|
|
dynamic_cast< SYMBOL_LIB_TABLE_ROW* >( findRow( aNickname, aCheckIfEnabled ) );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
if( !row )
|
2020-01-11 16:26:44 +00:00
|
|
|
return nullptr;
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
// We've been 'lazy' up until now, but it cannot be deferred any longer,
|
|
|
|
// instantiate a PLUGIN of the proper kind if it is not already in this
|
|
|
|
// SYMBOL_LIB_TABLE_ROW.
|
|
|
|
if( !row->plugin )
|
2022-05-29 19:29:32 +00:00
|
|
|
{
|
2016-11-20 18:33:07 +00:00
|
|
|
row->setPlugin( SCH_IO_MGR::FindPlugin( row->type ) );
|
2022-05-29 19:29:32 +00:00
|
|
|
row->plugin->SetLibTable( this );
|
|
|
|
}
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
return row;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2021-06-10 18:51:46 +00:00
|
|
|
void SYMBOL_LIB_TABLE::LoadSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList,
|
2018-01-24 23:29:45 +00:00
|
|
|
const wxString& aNickname, bool aPowerSymbolsOnly )
|
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2023-08-06 04:56:51 +00:00
|
|
|
|
|
|
|
if( !row || !row->plugin )
|
|
|
|
return;
|
2018-01-24 23:29:45 +00:00
|
|
|
|
2022-08-27 22:47:32 +00:00
|
|
|
std::lock_guard<std::mutex> lock( row->GetMutex() );
|
|
|
|
|
2018-01-24 23:29:45 +00:00
|
|
|
wxString options = row->GetOptions();
|
|
|
|
|
|
|
|
if( aPowerSymbolsOnly )
|
2022-12-10 21:04:27 +00:00
|
|
|
row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
|
2018-01-24 23:29:45 +00:00
|
|
|
|
2020-08-29 23:19:05 +00:00
|
|
|
row->SetLoaded( false );
|
2022-12-10 21:04:27 +00:00
|
|
|
row->plugin->SetLibTable( this );
|
2019-11-06 19:15:42 +00:00
|
|
|
row->plugin->EnumerateSymbolLib( aSymbolList, row->GetFullURI( true ), row->GetProperties() );
|
2020-08-29 23:19:05 +00:00
|
|
|
row->SetLoaded( true );
|
2018-01-24 23:29:45 +00:00
|
|
|
|
|
|
|
if( aPowerSymbolsOnly )
|
|
|
|
row->SetOptions( options );
|
|
|
|
|
|
|
|
// The library cannot know its own name, because it might have been renamed or moved.
|
|
|
|
// Therefore footprints cannot know their own library nickname when residing in
|
|
|
|
// a symbol library.
|
|
|
|
// Only at this API layer can we tell the symbol about its actual library nickname.
|
2021-06-10 18:51:46 +00:00
|
|
|
for( LIB_SYMBOL* symbol : aSymbolList )
|
2018-01-24 23:29:45 +00:00
|
|
|
{
|
2021-06-10 18:51:46 +00:00
|
|
|
LIB_ID id = symbol->GetLibId();
|
2018-01-24 23:29:45 +00:00
|
|
|
|
|
|
|
id.SetLibNickname( row->GetNickName() );
|
2021-06-10 18:51:46 +00:00
|
|
|
symbol->SetLibId( id );
|
2018-01-24 23:29:45 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2021-06-10 18:51:46 +00:00
|
|
|
LIB_SYMBOL* SYMBOL_LIB_TABLE::LoadSymbol( const wxString& aNickname, const wxString& aSymbolName )
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2020-07-06 21:25:07 +00:00
|
|
|
|
2022-08-27 22:47:32 +00:00
|
|
|
if( !row || !row->plugin )
|
|
|
|
return nullptr;
|
|
|
|
|
|
|
|
// If another thread is loading this library at the moment; continue
|
|
|
|
std::unique_lock<std::mutex> lock( row->GetMutex(), std::try_to_lock );
|
|
|
|
|
|
|
|
if( !lock.owns_lock() )
|
2020-07-06 21:25:07 +00:00
|
|
|
return nullptr;
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2021-06-10 18:51:46 +00:00
|
|
|
LIB_SYMBOL* symbol = row->plugin->LoadSymbol( row->GetFullURI( true ), aSymbolName,
|
|
|
|
row->GetProperties() );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2021-06-10 18:51:46 +00:00
|
|
|
if( symbol )
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2022-12-08 23:56:55 +00:00
|
|
|
// The library cannot know its own name, because it might have been renamed or moved.
|
|
|
|
// Therefore footprints cannot know their own library nickname when residing in
|
|
|
|
// a symbol library.
|
|
|
|
// Only at this API layer can we tell the symbol about its actual library nickname.
|
2021-06-10 18:51:46 +00:00
|
|
|
LIB_ID id = symbol->GetLibId();
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2017-07-24 19:02:59 +00:00
|
|
|
id.SetLibNickname( row->GetNickName() );
|
2021-06-10 18:51:46 +00:00
|
|
|
symbol->SetLibId( id );
|
2022-12-08 23:56:55 +00:00
|
|
|
|
2022-12-14 13:00:25 +00:00
|
|
|
SIM_MODEL::MigrateSimModel<LIB_SYMBOL, LIB_FIELD>( *symbol, nullptr );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
2021-06-10 18:51:46 +00:00
|
|
|
return symbol;
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
SYMBOL_LIB_TABLE::SAVE_T SYMBOL_LIB_TABLE::SaveSymbol( const wxString& aNickname,
|
2021-06-10 18:51:46 +00:00
|
|
|
const LIB_SYMBOL* aSymbol, bool aOverwrite )
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2017-11-11 23:56:07 +00:00
|
|
|
wxCHECK( row && row->plugin, SAVE_SKIPPED );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2023-12-27 00:25:41 +00:00
|
|
|
if( !row->plugin->IsLibraryWritable( row->GetFullURI( true ) ) )
|
2021-01-31 19:29:58 +00:00
|
|
|
return SAVE_SKIPPED;
|
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
if( !aOverwrite )
|
|
|
|
{
|
|
|
|
// Try loading the footprint to see if it already exists, caller wants overwrite
|
|
|
|
// protection, which is atypical, not the default.
|
|
|
|
|
2017-07-24 19:02:59 +00:00
|
|
|
wxString name = aSymbol->GetLibId().GetLibItemName();
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2021-09-23 15:44:39 +00:00
|
|
|
std::unique_ptr<LIB_SYMBOL> symbol( row->plugin->LoadSymbol( row->GetFullURI( true ),
|
|
|
|
name, row->GetProperties() ) );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
if( symbol.get() )
|
|
|
|
return SAVE_SKIPPED;
|
|
|
|
}
|
|
|
|
|
2021-01-31 19:29:58 +00:00
|
|
|
try
|
|
|
|
{
|
|
|
|
row->plugin->SaveSymbol( row->GetFullURI( true ), aSymbol, row->GetProperties() );
|
|
|
|
}
|
2021-02-20 16:50:10 +00:00
|
|
|
catch( const IO_ERROR& )
|
2021-01-31 19:29:58 +00:00
|
|
|
{
|
|
|
|
return SAVE_SKIPPED;
|
|
|
|
}
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
return SAVE_OK;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void SYMBOL_LIB_TABLE::DeleteSymbol( const wxString& aNickname, const wxString& aSymbolName )
|
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2017-11-11 23:56:07 +00:00
|
|
|
wxCHECK( row && row->plugin, /* void */ );
|
2021-09-23 15:44:39 +00:00
|
|
|
return row->plugin->DeleteSymbol( row->GetFullURI( true ), aSymbolName, row->GetProperties() );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool SYMBOL_LIB_TABLE::IsSymbolLibWritable( const wxString& aNickname )
|
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2017-11-11 23:56:07 +00:00
|
|
|
wxCHECK( row && row->plugin, false );
|
2023-12-27 00:25:41 +00:00
|
|
|
return row->plugin->IsLibraryWritable( row->GetFullURI( true ) );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
2020-08-29 23:19:05 +00:00
|
|
|
bool SYMBOL_LIB_TABLE::IsSymbolLibLoaded( const wxString& aNickname )
|
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2020-08-29 23:19:05 +00:00
|
|
|
wxCHECK( row, false );
|
|
|
|
return row->GetIsLoaded();
|
|
|
|
}
|
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
void SYMBOL_LIB_TABLE::DeleteSymbolLib( const wxString& aNickname )
|
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2017-11-11 23:56:07 +00:00
|
|
|
wxCHECK( row && row->plugin, /* void */ );
|
2023-12-27 00:25:41 +00:00
|
|
|
row->plugin->DeleteLibrary( row->GetFullURI( true ), row->GetProperties() );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void SYMBOL_LIB_TABLE::CreateSymbolLib( const wxString& aNickname )
|
|
|
|
{
|
2021-01-10 22:55:30 +00:00
|
|
|
const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
|
2017-11-11 23:56:07 +00:00
|
|
|
wxCHECK( row && row->plugin, /* void */ );
|
2023-12-27 00:25:41 +00:00
|
|
|
row->plugin->CreateLibrary( row->GetFullURI( true ), row->GetProperties() );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2021-06-10 18:51:46 +00:00
|
|
|
LIB_SYMBOL* SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname( const LIB_ID& aLibId )
|
2016-11-20 18:33:07 +00:00
|
|
|
{
|
2017-07-24 19:02:59 +00:00
|
|
|
wxString nickname = aLibId.GetLibNickname();
|
|
|
|
wxString name = aLibId.GetLibItemName();
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
if( nickname.size() )
|
|
|
|
{
|
|
|
|
return LoadSymbol( nickname, name );
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2021-09-23 15:44:39 +00:00
|
|
|
// nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
|
2016-11-20 18:33:07 +00:00
|
|
|
std::vector<wxString> nicks = GetLogicalLibs();
|
|
|
|
|
|
|
|
// Search each library going through libraries alphabetically.
|
|
|
|
for( unsigned i = 0; i < nicks.size(); ++i )
|
|
|
|
{
|
|
|
|
// FootprintLoad() returns NULL on not found, does not throw exception
|
|
|
|
// unless there's an IO_ERROR.
|
2021-06-10 18:51:46 +00:00
|
|
|
LIB_SYMBOL* ret = LoadSymbol( nicks[i], name );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
|
|
|
if( ret )
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2019-11-06 19:15:42 +00:00
|
|
|
return nullptr;
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
const wxString SYMBOL_LIB_TABLE::GlobalPathEnvVariableName()
|
|
|
|
{
|
2023-01-22 18:38:02 +00:00
|
|
|
return "KICAD7_SYMBOL_DIR";
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2022-05-14 18:23:43 +00:00
|
|
|
class PCM_SYM_LIB_TRAVERSER final : public wxDirTraverser
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit PCM_SYM_LIB_TRAVERSER( const wxString& aPath, SYMBOL_LIB_TABLE& aTable,
|
|
|
|
const wxString& aPrefix ) :
|
2022-09-23 16:30:42 +00:00
|
|
|
m_lib_table( aTable ),
|
2022-05-14 18:23:43 +00:00
|
|
|
m_path_prefix( aPath ),
|
2022-09-23 16:30:42 +00:00
|
|
|
m_lib_prefix( aPrefix )
|
2022-05-14 18:23:43 +00:00
|
|
|
{
|
|
|
|
wxFileName f( aPath, "" );
|
|
|
|
m_prefix_dir_count = f.GetDirCount();
|
|
|
|
}
|
|
|
|
|
|
|
|
wxDirTraverseResult OnFile( const wxString& aFilePath ) override
|
|
|
|
{
|
|
|
|
wxFileName file = wxFileName::FileName( aFilePath );
|
|
|
|
|
|
|
|
// consider a file to be a lib if it's name ends with .kicad_sym and
|
2023-01-22 18:38:02 +00:00
|
|
|
// it is under $KICAD7_3RD_PARTY/symbols/<pkgid>/ i.e. has nested level of at least +2
|
2022-05-14 18:23:43 +00:00
|
|
|
if( file.GetExt() == wxT( "kicad_sym" ) && file.GetDirCount() >= m_prefix_dir_count + 2 )
|
|
|
|
{
|
|
|
|
wxArrayString parts = file.GetDirs();
|
|
|
|
parts.RemoveAt( 0, m_prefix_dir_count );
|
2023-01-22 18:38:02 +00:00
|
|
|
parts.Insert( "${KICAD7_3RD_PARTY}", 0 );
|
2022-05-14 18:23:43 +00:00
|
|
|
parts.Add( file.GetFullName() );
|
|
|
|
|
|
|
|
wxString libPath = wxJoin( parts, '/' );
|
|
|
|
|
|
|
|
if( !m_lib_table.HasLibraryWithPath( libPath ) )
|
|
|
|
{
|
|
|
|
wxString name = parts.Last().substr( 0, parts.Last().length() - 10 );
|
|
|
|
wxString nickname = wxString::Format( "%s%s", m_lib_prefix, name );
|
|
|
|
|
|
|
|
if( m_lib_table.HasLibrary( nickname ) )
|
|
|
|
{
|
|
|
|
int increment = 1;
|
|
|
|
do
|
|
|
|
{
|
|
|
|
nickname = wxString::Format( "%s%s_%d", m_lib_prefix, name, increment );
|
|
|
|
increment++;
|
|
|
|
} while( m_lib_table.HasLibrary( nickname ) );
|
|
|
|
}
|
|
|
|
|
|
|
|
m_lib_table.InsertRow(
|
|
|
|
new SYMBOL_LIB_TABLE_ROW( nickname, libPath, wxT( "KiCad" ), wxEmptyString,
|
|
|
|
_( "Added by Plugin and Content Manager" ) ) );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return wxDIR_CONTINUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
wxDirTraverseResult OnDir( const wxString& dirPath ) override { return wxDIR_CONTINUE; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
SYMBOL_LIB_TABLE& m_lib_table;
|
|
|
|
wxString m_path_prefix;
|
|
|
|
wxString m_lib_prefix;
|
|
|
|
size_t m_prefix_dir_count;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
bool SYMBOL_LIB_TABLE::LoadGlobalTable( SYMBOL_LIB_TABLE& aTable )
|
|
|
|
{
|
|
|
|
bool tableExists = true;
|
|
|
|
wxFileName fn = GetGlobalTableFileName();
|
|
|
|
|
|
|
|
if( !fn.FileExists() )
|
|
|
|
{
|
|
|
|
tableExists = false;
|
|
|
|
|
|
|
|
if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
|
|
|
|
{
|
2021-06-27 23:26:54 +00:00
|
|
|
THROW_IO_ERROR( wxString::Format( _( "Cannot create global library table path '%s'." ),
|
|
|
|
fn.GetPath() ) );
|
2016-11-20 18:33:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Attempt to copy the default global file table from the KiCad
|
|
|
|
// template folder to the user's home configuration path.
|
2019-01-26 21:19:02 +00:00
|
|
|
SEARCH_STACK ss;
|
|
|
|
|
|
|
|
SystemDirsAppend( &ss );
|
|
|
|
|
|
|
|
wxString templatePath =
|
2023-01-22 18:38:02 +00:00
|
|
|
Pgm().GetLocalEnvVariables().at( wxT( "KICAD7_TEMPLATE_DIR" ) ).GetValue();
|
2019-01-26 21:19:02 +00:00
|
|
|
|
|
|
|
if( !templatePath.IsEmpty() )
|
|
|
|
ss.AddPaths( templatePath, 0 );
|
|
|
|
|
|
|
|
wxString fileName = ss.FindValidPath( global_tbl_name );
|
2016-11-20 18:33:07 +00:00
|
|
|
|
2016-11-24 17:57:53 +00:00
|
|
|
// The fallback is to create an empty global symbol table for the user to populate.
|
2016-11-20 18:33:07 +00:00
|
|
|
if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
|
|
|
|
{
|
|
|
|
SYMBOL_LIB_TABLE emptyTable;
|
|
|
|
|
|
|
|
emptyTable.Save( fn.GetFullPath() );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-01-19 00:14:31 +00:00
|
|
|
aTable.Clear();
|
2016-11-20 18:33:07 +00:00
|
|
|
aTable.Load( fn.GetFullPath() );
|
|
|
|
|
2022-05-14 18:23:43 +00:00
|
|
|
SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
|
|
|
|
KICAD_SETTINGS* settings = mgr.GetAppSettings<KICAD_SETTINGS>();
|
|
|
|
|
2023-06-03 11:28:03 +00:00
|
|
|
wxCHECK( settings, false );
|
|
|
|
|
2023-01-22 18:38:02 +00:00
|
|
|
wxString packagesPath = Pgm().GetLocalEnvVariables().at( wxT( "KICAD7_3RD_PARTY" ) ).GetValue();
|
2022-05-14 18:23:43 +00:00
|
|
|
|
|
|
|
if( settings->m_PcmLibAutoAdd )
|
|
|
|
{
|
|
|
|
// Scan for libraries in PCM packages directory
|
|
|
|
wxFileName d( packagesPath, "" );
|
|
|
|
d.AppendDir( "symbols" );
|
|
|
|
|
|
|
|
if( d.DirExists() )
|
|
|
|
{
|
|
|
|
PCM_SYM_LIB_TRAVERSER traverser( packagesPath, aTable, settings->m_PcmLibPrefix );
|
|
|
|
wxDir dir( d.GetPath() );
|
|
|
|
|
|
|
|
dir.Traverse( traverser );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if( settings->m_PcmLibAutoRemove )
|
|
|
|
{
|
|
|
|
// Remove PCM libraries that no longer exist
|
|
|
|
std::vector<wxString> to_remove;
|
|
|
|
|
|
|
|
for( size_t i = 0; i < aTable.GetCount(); i++ )
|
|
|
|
{
|
|
|
|
LIB_TABLE_ROW& row = aTable.At( i );
|
|
|
|
wxString path = row.GetFullURI( true );
|
|
|
|
|
|
|
|
if( path.StartsWith( packagesPath ) && !wxFile::Exists( path ) )
|
|
|
|
to_remove.push_back( row.GetNickName() );
|
|
|
|
}
|
|
|
|
|
|
|
|
for( const wxString& nickName : to_remove )
|
2023-06-03 11:28:03 +00:00
|
|
|
{
|
|
|
|
SYMBOL_LIB_TABLE_ROW* row = aTable.FindRow( nickName );
|
|
|
|
|
|
|
|
wxCHECK2( row, continue );
|
|
|
|
|
|
|
|
aTable.RemoveRow( row );
|
|
|
|
}
|
2022-05-14 18:23:43 +00:00
|
|
|
}
|
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
return tableExists;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2023-04-27 10:54:18 +00:00
|
|
|
bool SYMBOL_LIB_TABLE::operator==( const SYMBOL_LIB_TABLE& aOther ) const
|
|
|
|
{
|
|
|
|
if( m_rows.size() != aOther.m_rows.size() )
|
|
|
|
return false;
|
|
|
|
|
|
|
|
unsigned i;
|
|
|
|
|
|
|
|
for( i = 0; i < m_rows.size(); ++i )
|
|
|
|
{
|
|
|
|
const SYMBOL_LIB_TABLE_ROW& curr = static_cast<const SYMBOL_LIB_TABLE_ROW&>( m_rows[i] );
|
|
|
|
const SYMBOL_LIB_TABLE_ROW& curr_other = static_cast<const SYMBOL_LIB_TABLE_ROW&>( aOther.m_rows[i] );
|
|
|
|
|
|
|
|
if( curr != curr_other )
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2016-11-20 18:33:07 +00:00
|
|
|
wxString SYMBOL_LIB_TABLE::GetGlobalTableFileName()
|
|
|
|
{
|
|
|
|
wxFileName fn;
|
|
|
|
|
2023-09-23 23:53:22 +00:00
|
|
|
fn.SetPath( PATHS::GetUserSettingsPath() );
|
2016-11-20 18:33:07 +00:00
|
|
|
fn.SetName( global_tbl_name );
|
|
|
|
|
|
|
|
return fn.GetFullPath();
|
|
|
|
}
|
2017-03-05 22:31:31 +00:00
|
|
|
|
|
|
|
|
|
|
|
const wxString& SYMBOL_LIB_TABLE::GetSymbolLibTableFileName()
|
|
|
|
{
|
|
|
|
return global_tbl_name;
|
|
|
|
}
|