22#include <unordered_set>
23#include <wx/datetime.h>
26#include <boost/algorithm/string.hpp>
53 const wxString& aLibraryPath,
54 const std::map<std::string, UTF8>* aProperties )
56 std::vector<LIB_SYMBOL*> symbols;
60 aSymbolNameList.Add( symbol->GetName() );
65 const wxString& aLibraryPath,
66 const std::map<std::string, UTF8>* aProperties )
68 wxCHECK_RET(
m_libTable,
"Database plugin missing library table handle!" );
82 if( !powerSymbolsOnly || symbol->
IsPower() )
83 aSymbolList.emplace_back( symbol );
89 const wxString& aAliasName,
90 const std::map<std::string, UTF8>* aProperties )
108 std::string tableName =
"";
109 std::string symbolName( aAliasName.ToUTF8() );
111 if( aAliasName.Contains(
'/' ) )
113 tableName = std::string( aAliasName.BeforeFirst(
'/' ).ToUTF8() );
114 symbolName = std::string( aAliasName.AfterFirst(
'/' ).ToUTF8() );
117 std::vector<const DATABASE_LIB_TABLE*> tablesToTry;
121 if( tableIter.
name == tableName )
122 tablesToTry.emplace_back( &tableIter );
125 if( tablesToTry.empty() )
127 wxLogTrace(
traceDatabase, wxT(
"LoadSymbol: table '%s' not found in config" ), tableName );
136 if(
m_conn->SelectOne(
table->table, std::make_pair(
table->key_col, symbolName ),
140 wxLogTrace(
traceDatabase, wxT(
"LoadSymbol: SelectOne (%s, %s) found in %s" ),
145 wxLogTrace(
traceDatabase, wxT(
"LoadSymbol: SelectOne (%s, %s) failed for table %s" ),
150 wxCHECK( foundTable,
nullptr );
162 std::set<wxString> tableNames;
166 if( tableNames.count( tableIter.
name ) )
169 aNames.emplace_back( tableIter.
name );
170 tableNames.insert( tableIter.
name );
184 std::back_inserter( aNames ) );
195 if( aErrorMsg && ( !
m_conn || !
m_conn->IsConnected() ) )
204 long long currentTimestampSeconds = wxDateTime::Now().GetValue().GetValue() / 1000;
214 std::vector<DATABASE_CONNECTION::ROW> results;
218 if( !
m_conn->GetLastError().empty() )
220 wxString msg = wxString::Format(
_(
"Error reading database table %s: %s" ),
233 std::string prefix =
table.name.empty() ?
"" : fmt::format(
"{}/",
table.name );
234 wxString
name( fmt::format(
"{}{}", prefix,
235 std::any_cast<std::string>(
result[
table.key_col] ) ) );
255 wxString msg = wxString::Format(
256 _(
"Could not load database library: settings file %s missing or invalid" ),
265 std::string
path( aSettingsPath.ToUTF8() );
278 wxASSERT_MSG( aSettingsPath ==
m_settings->GetFilename(),
279 "Path changed for database library without re-initializing plugin!" );
283 wxLogTrace(
traceDatabase, wxT(
"ensureSettings: no settings but no valid path!" ) );
290 wxCHECK_RET(
m_settings,
"Call ensureSettings before ensureConnection!" );
296 wxString msg = wxString::Format(
297 _(
"Could not load database library: could not connect to database %s (%s)" ),
307 wxCHECK_RET(
m_settings,
"Call ensureSettings before connect()!" );
314 if(
m_settings->m_Source.connection_string.empty() )
323 std::string cs =
m_settings->m_Source.connection_string;
324 std::string basePath( wxFileName(
m_settings->GetFilename() ).GetPath().ToUTF8() );
328 boost::replace_all( cs,
"${CWD}", basePath );
330 m_conn = std::make_unique<DATABASE_CONNECTION>( cs,
m_settings->m_Source.timeout );
333 if( !
m_conn->IsConnected() )
342 std::set<std::string> columns;
344 columns.insert( boost::to_lower_copy( tableIter.
key_col ) );
345 columns.insert( boost::to_lower_copy( tableIter.
footprints_col ) );
346 columns.insert( boost::to_lower_copy( tableIter.
symbols_col ) );
356 columns.insert( boost::to_lower_copy( field.
column ) );
358 m_conn->CacheTableInfo( tableIter.
table, columns );
370 bool val = std::any_cast<bool>( aVal );
373 catch(
const std::bad_any_cast& )
379 int val = std::any_cast<int>( aVal );
380 return static_cast<bool>( val );
382 catch(
const std::bad_any_cast& )
388 wxString strval( std::any_cast<std::string>( aVal ).c_str(), wxConvUTF8 );
390 if( strval.IsEmpty() )
395 for(
const auto& trueVal : { wxS(
"true" ), wxS(
"yes" ), wxS(
"y" ), wxS(
"1" ) } )
397 if( strval.Matches( trueVal ) )
401 for(
const auto& falseVal : { wxS(
"false" ), wxS(
"no" ), wxS(
"n" ), wxS(
"0" ) } )
403 if( strval.Matches( falseVal ) )
407 catch(
const std::bad_any_cast& )
419 std::unique_ptr<LIB_SYMBOL> symbol =
nullptr;
426 std::string symbolIdStr = std::any_cast<std::string>( aRow.at( aTable.
symbols_col ) );
428 symbolId.
Parse( std::any_cast<std::string>( aRow.at( aTable.
symbols_col ) ) );
431 originalSymbol =
m_libTable->LoadSymbol( symbolId );
435 wxLogTrace(
traceDatabase, wxT(
"loadSymbolFromRow: found original symbol '%s'" ),
437 symbol.reset( originalSymbol->
Duplicate() );
438 symbol->SetSourceLibId( symbolId );
442 wxLogTrace(
traceDatabase, wxT(
"loadSymboFromRow: source symbol id '%s' is invalid, "
443 "will create empty symbol" ), symbolIdStr );
447 wxLogTrace(
traceDatabase, wxT(
"loadSymboFromRow: source symbol '%s' not found, "
448 "will create empty symbol" ), symbolIdStr );
456 symbol.reset(
new LIB_SYMBOL( aSymbolName ) );
460 symbol->SetName( aSymbolName );
463 LIB_ID libId = symbol->GetLibId();
465 symbol->SetLibId( libId );
466 wxArrayString footprintsList;
470 std::string footprints = std::any_cast<std::string>( aRow.at( aTable.
footprints_col ) );
472 wxString footprintsStr = wxString( footprints.c_str(), wxConvUTF8 );
473 wxStringTokenizer tokenizer( footprintsStr,
";\t\r\n", wxTOKEN_STRTOK );
475 while( tokenizer.HasMoreTokens() )
476 footprintsList.Add( tokenizer.GetNextToken() );
478 if( footprintsList.size() > 0 )
479 symbol->GetFootprintField().SetText( footprintsList[0] );
483 wxLogTrace(
traceDatabase, wxT(
"loadSymboFromRow: footprint field %s not found." ),
492 symbol->SetDescription( value );
497 wxString value( std::any_cast<std::string>( aRow.at( aTable.
properties.
keywords ) ).c_str(),
499 symbol->SetKeyWords( value );
508 footprintsList.push_back( value );
511 symbol->SetFPFilters( footprintsList );
520 symbol->SetExcludedFromSim( *val );
524 wxLogTrace(
traceDatabase, wxT(
"loadSymbolFromRow: exclude_from_sim value for %s "
525 "could not be cast to a boolean" ), aSymbolName );
536 symbol->SetExcludedFromBoard( *val );
540 wxLogTrace(
traceDatabase, wxT(
"loadSymbolFromRow: exclude_from_board value for %s "
541 "could not be cast to a boolean" ), aSymbolName );
552 symbol->SetExcludedFromBOM( *val );
556 wxLogTrace(
traceDatabase, wxT(
"loadSymbolFromRow: exclude_from_bom value for %s "
557 "could not be cast to a boolean" ), aSymbolName );
561 std::vector<SCH_FIELD*> fields;
562 symbol->GetFields( fields );
564 std::unordered_map<wxString, SCH_FIELD*> fieldsMap;
567 fieldsMap[field->GetName()] = field;
569 static const wxString c_valueFieldName( wxS(
"Value" ) );
570 static const wxString c_datasheetFieldName( wxS(
"Datasheet" ) );
574 if( !aRow.count( mapping.
column ) )
576 wxLogTrace(
traceDatabase, wxT(
"loadSymbolFromRow: field %s not found in result" ),
585 strValue = std::any_cast<std::string>( aRow.at( mapping.
column ) );
587 catch( std::bad_any_cast& )
591 wxString value(
strValue.c_str(), wxConvUTF8 );
593 if( mapping.
name_wx == c_valueFieldName )
595 SCH_FIELD& field = symbol->GetValueField();
605 else if( mapping.
name_wx == c_datasheetFieldName )
607 SCH_FIELD& field = symbol->GetDatasheetField();
625 if( fieldsMap.count( mapping.
name_wx ) )
627 field = fieldsMap[mapping.
name_wx];
634 fieldsMap[mapping.
name_wx] = field;
647 symbol->AddDrawItem( field,
false );
655 symbol->GetDrawItems().sort();
std::map< std::string, std::any > ROW
virtual void SetVisible(bool aVisible)
A logical library item identifier and consists of various portions much like a URI.
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
bool IsValid() const
Check if this LID_ID is valid.
void SetSubLibraryName(const UTF8 &aName)
Define a library symbol object.
bool IsPower() const override
virtual LIB_SYMBOL * Duplicate() const
Create a copy of a LIB_SYMBOL and assigns unique KIIDs to the copy and its children.
void SetAutoAdded(bool aAutoAdded)
void SetName(const wxString &aName)
void SetText(const wxString &aText) override
void SetNameShown(bool aShown=true)
void EnumerateSymbolLib(wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
std::unique_ptr< DATABASE_CONNECTION > m_conn
Generally will be null if no valid connection is established.
void GetDefaultSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that should be shown by default for this library in the symb...
void ensureSettings(const wxString &aSettingsPath)
bool TestConnection(wxString *aErrorMsg=nullptr)
std::map< wxString, std::unique_ptr< LIB_SYMBOL > > m_nameToSymbolcache
SYMBOL_LIB_TABLE * m_libTable
std::set< wxString > m_defaultShownFields
virtual ~SCH_IO_DATABASE()
void GetSubLibraryNames(std::vector< wxString > &aNames) override
Retrieves a list of sub-libraries in this library.
std::unique_ptr< DATABASE_LIB_SETTINGS > m_settings
static std::optional< bool > boolFromAny(const std::any &aVal)
long long m_cacheTimestamp
void GetAvailableSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that are present on symbols in this library.
std::unique_ptr< LIB_SYMBOL > loadSymbolFromRow(const wxString &aSymbolName, const DATABASE_LIB_TABLE &aTable, const DATABASE_CONNECTION::ROW &aRow)
std::set< wxString > m_customFields
LIB_SYMBOL * LoadSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this...
SCH_IO(const wxString &aName)
static const char * PropPowerSymsOnly
const char *const traceDatabase
#define THROW_IO_ERROR(msg)
macro which captures the "call site" values of FILE_, __FUNCTION & LINE
static std::string strValue(double aValue)
bool visible_in_chooser
Whether the column is shown by default in the chooser.
std::string column
Database column name.
bool inherit_properties
Whether or not to inherit properties from symbol field.
bool visible_on_add
Whether to show the field when placing the symbol.
bool show_name
Whether or not to show the field name as well as its value.
wxString name_wx
KiCad field name (converted)
A database library table will be mapped to a sub-library provided by the database library entry in th...
std::string key_col
Unique key column name (will form part of the LIB_ID)
std::string name
KiCad library nickname (will form part of the LIB_ID)
std::string symbols_col
Column name containing KiCad symbol refs.
std::string footprints_col
Column name containing KiCad footprint refs.
std::vector< DATABASE_FIELD_MAPPING > fields
std::string table
Database table to pull content from.
MAPPABLE_SYMBOL_PROPERTIES properties
std::string footprint_filters
std::string exclude_from_sim
std::string exclude_from_board
std::string exclude_from_bom
@ USER
The field ID hasn't been set yet; field is invalid.
wxString result
Test unit parsing edge cases and error handling.