realAscot/kicad-source
1
0
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-09-13 17:53:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Kicad SEXPR should no longer need LOCALE_IO.

Browse Source
This commit is contained in:
Jeff Young 2025-07-13 21:52:06 +01:00
parent 5d4eb2cce6
commit a7e2878e6b
21 changed files with 59 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
common/design_block_info.cpp
View File

@ -96,16 +96,6 @@ bool DESIGN_BLOCK_INFO::InLibrary( const wxString& aLibrary ) const
}
void DESIGN_BLOCK_INFO::ensure_loaded()
{
// Lazy-loading. MUST NOT be called from multi-threaded environment.
LOCALE_IO toggle_locale;
if( !m_loaded )
load();
}
bool operator<( const DESIGN_BLOCK_INFO& lhs, const DESIGN_BLOCK_INFO& rhs )
{
int retv = StrNumCmp( lhs.m_nickname, rhs.m_nickname, false );

9
common/design_block_info.h
View File

@ -42,6 +42,7 @@ class DESIGN_BLOCK_LIST_IMPL;
class PROGRESS_REPORTER;
class wxTopLevelWindow;
class KIWAY;
class LOCALE_IO;
class wxTextFile;
@ -106,10 +107,14 @@ public:
friend bool operator<( const DESIGN_BLOCK_INFO& lhs, const DESIGN_BLOCK_INFO& rhs );
protected:
void ensure_loaded();
void ensure_loaded()
{
if( !m_loaded )
load();
}
/// lazily load stuff not filled in by constructor. This may throw IO_ERRORS.
virtual void load(){};
virtual void load( const LOCALE_IO* locale = nullptr ) {};
protected:
DESIGN_BLOCK_LIST* m_owner; ///< provides access to DESIGN_BLOCK_LIB_TABLE

10
common/design_block_info_impl.cpp
View File

@ -35,14 +35,14 @@
#include <wx/wfstream.h>
void DESIGN_BLOCK_INFO_IMPL::load()
void DESIGN_BLOCK_INFO_IMPL::load( const LOCALE_IO* locale )
{
DESIGN_BLOCK_LIB_TABLE* dbtable = m_owner->GetTable();
wxASSERT( dbtable );
std::unique_ptr<const DESIGN_BLOCK> design_block( dbtable->GetEnumeratedDesignBlock( m_nickname, m_dbname,
true ) );
locale ) );
if( design_block )
{
@ -164,7 +164,7 @@ void DESIGN_BLOCK_LIST_IMPL::loadDesignBlocks()
std::vector<std::future<size_t>> returns( num_elements );
auto db_thread =
[ this, &queue_parsed ]() -> size_t
[ this, &queue_parsed, &toggle_locale ]() -> size_t
{
wxString nickname;
@ -176,7 +176,7 @@ void DESIGN_BLOCK_LIST_IMPL::loadDesignBlocks()
CatchErrors(
[&]()
{
m_lib_table->DesignBlockEnumerate( dbnames, nickname, false, true );
m_lib_table->DesignBlockEnumerate( dbnames, nickname, false, &toggle_locale );
} );
for( wxString dbname : dbnames )
@ -184,7 +184,7 @@ void DESIGN_BLOCK_LIST_IMPL::loadDesignBlocks()
CatchErrors(
[&]()
{
auto* dbinfo = new DESIGN_BLOCK_INFO_IMPL( this, nickname, dbname );
auto* dbinfo = new DESIGN_BLOCK_INFO_IMPL( this, nickname, dbname, &toggle_locale );
queue_parsed.move_push( std::unique_ptr<DESIGN_BLOCK_INFO>( dbinfo ) );
} );

6
common/design_block_info_impl.h
View File

@ -36,7 +36,7 @@ class KICOMMON_API DESIGN_BLOCK_INFO_IMPL : public DESIGN_BLOCK_INFO
{
public:
DESIGN_BLOCK_INFO_IMPL( DESIGN_BLOCK_LIST* aOwner, const wxString& aNickname,
const wxString& aDesignBlockName )
const wxString& aDesignBlockName, const LOCALE_IO* aLocale )
{
m_nickname = aNickname;
m_dbname = aDesignBlockName;
@ -44,7 +44,7 @@ public:
m_owner = aOwner;
m_loaded = false;
load();
load( aLocale );
}
// A constructor for cached items
@ -73,7 +73,7 @@ public:
}
protected:
virtual void load() override;
virtual void load( const LOCALE_IO* aLocale = nullptr ) override;
};

8
common/design_block_lib_table.cpp
View File

@ -334,12 +334,12 @@ long long DESIGN_BLOCK_LIB_TABLE::GenerateTimestamp( const wxString* aNickname )
void DESIGN_BLOCK_LIB_TABLE::DesignBlockEnumerate( wxArrayString& aDesignBlockNames, const wxString& aNickname,
bool aBestEfforts, bool aThreadSafe )
bool aBestEfforts, const LOCALE_IO* aLocale )
{
const DESIGN_BLOCK_LIB_TABLE_ROW* row = FindRow( aNickname, true );
wxASSERT( row->plugin );
if( !aThreadSafe )
if( !aLocale )
{
LOCALE_IO toggle_locale;
@ -402,12 +402,12 @@ static void setLibNickname( DESIGN_BLOCK* aModule, const wxString& aNickname,
const DESIGN_BLOCK*
DESIGN_BLOCK_LIB_TABLE::GetEnumeratedDesignBlock( const wxString& aNickname,
const wxString& aDesignBlockName,
bool aThreadSafe )
const LOCALE_IO* aLocale )
{
const DESIGN_BLOCK_LIB_TABLE_ROW* row = FindRow( aNickname, true );
wxASSERT( row->plugin );
if( !aThreadSafe )
if( !aLocale )
{
LOCALE_IO toggle_locale;

2
common/design_block_tree_model_adapter.cpp
View File

@ -141,7 +141,7 @@ wxString DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo( LIB_ID const& aLibId, in
try
{
db = m_libs->GetEnumeratedDesignBlock( aLibId.GetLibNickname(), aLibId.GetLibItemName(), false );
db = m_libs->GetEnumeratedDesignBlock( aLibId.GetLibNickname(), aLibId.GetLibItemName() );
}
catch( const IO_ERROR& ioe )
{

10
common/footprint_info.cpp
View File

@ -98,16 +98,6 @@ bool FOOTPRINT_INFO::InLibrary( const wxString& aLibrary ) const
}
void FOOTPRINT_INFO::ensure_loaded()
{
// Lazy-loading. MUST NOT be called from multi-threaded environment.
LOCALE_IO toggle_locale;
if( !m_loaded )
load();
}
bool operator<( const FOOTPRINT_INFO& lhs, const FOOTPRINT_INFO& rhs )
{
int retv = StrNumCmp( lhs.m_nickname, rhs.m_nickname, false );

8
common/fp_lib_table.cpp
View File

@ -308,12 +308,12 @@ long long FP_LIB_TABLE::GenerateTimestamp( const wxString* aNickname )
void FP_LIB_TABLE::FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aNickname,
bool aBestEfforts, bool aThreadSafe )
bool aBestEfforts, const LOCALE_IO* aLocale )
{
const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
wxASSERT( row->plugin );
if( !aThreadSafe )
if( !aLocale )
{
LOCALE_IO toggle_locale;
@ -375,12 +375,12 @@ static void setLibNickname( FOOTPRINT* aModule, const wxString& aNickname,
const FOOTPRINT* FP_LIB_TABLE::GetEnumeratedFootprint( const wxString& aNickname,
const wxString& aFootprintName,
bool aThreadSafe )
const LOCALE_IO* aLocale )
{
const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
wxASSERT( row->plugin );
if( !aThreadSafe )
if( !aLocale )
{
LOCALE_IO toggle_locale;

2
cvpcb/display_footprints_frame.cpp
View File

@ -304,7 +304,7 @@ FOOTPRINT* DISPLAY_FOOTPRINTS_FRAME::GetFootprint( const wxString& aFootprintNam
try
{
if( const FOOTPRINT* fp = fpTable->GetEnumeratedFootprint( libNickname, fpName, false ) )
if( const FOOTPRINT* fp = fpTable->GetEnumeratedFootprint( libNickname, fpName ) )
footprint = static_cast<FOOTPRINT*>( fp->Duplicate( IGNORE_PARENT_GROUP ) );
}
catch( const IO_ERROR& ioe )

2
cvpcb/readwrite_dlgs.cpp
View File

@ -58,7 +58,7 @@ static int guessNickname( FP_LIB_TABLE* aTbl, LIB_ID* aFootprintId )
{
wxArrayString fpnames;
aTbl->FootprintEnumerate( fpnames, nicks[libNdx], true, false );
aTbl->FootprintEnumerate( fpnames, nicks[libNdx], true );
for( unsigned nameNdx = 0; nameNdx < fpnames.size(); ++nameNdx )
{

12
include/design_block_lib_table.h
View File

@ -158,13 +158,13 @@ public:
* \a aNickname.
* @param aNickname is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
* @param aBestEfforts if true, don't throw on errors.
* @param aThreadSafe if true, do not set LOCALE_IO (which is global). Caller is responsible
* for setting it up correctly.
* @param aLocale a previously set-up locale. Currently required for multi-threading, as LOCALE_IO
* uses global storage.
*
* @throw IO_ERROR if the library cannot be found, or design block cannot be loaded.
*/
void DesignBlockEnumerate( wxArrayString& aDesignBlockNames, const wxString& aNickname,
bool aBestEfforts, bool aThreadSafe );
bool aBestEfforts, const LOCALE_IO* aLocale = nullptr );
/**
* Generate a hashed timestamp representing the last-mod-times of the library indicated
@ -197,13 +197,13 @@ public:
* A version of #DesignBlockLoad() for use after #DesignBlockEnumerate() for more efficient
* cache management.
*
* @param aThreadSafe if true, do not set LOCALE_IO (which is global). Caller is responsible
* for setting it up correctly.
* @param aLocale a previously set-up locale. Currently required for multi-threading, as LOCALE_IO
* uses global storage.
*
* The return value is const to allow it to return a reference to a cached item.
*/
const DESIGN_BLOCK* GetEnumeratedDesignBlock( const wxString& aNickname, const wxString& aDesignBlockName,
bool aThreadSafe );
const LOCALE_IO* aLocale = nullptr );
/**
* The set of return values from DesignBlockSave() below.
*/

9
include/footprint_info.h
View File

@ -46,6 +46,7 @@ class FOOTPRINT_LIST_IMPL;
class PROGRESS_REPORTER;
class wxTopLevelWindow;
class KIWAY;
class LOCALE_IO;
class wxTextFile;
@ -127,10 +128,14 @@ public:
friend bool operator<( const FOOTPRINT_INFO& lhs, const FOOTPRINT_INFO& rhs );
protected:
void ensure_loaded();
void ensure_loaded()
{
if( !m_loaded )
load();
}
/// lazily load stuff not filled in by constructor. This may throw IO_ERRORS.
virtual void load() { };
virtual void load( const LOCALE_IO* aLocale = nullptr ) { };
FOOTPRINT_LIST* m_owner; ///< provides access to FP_LIB_TABLE

13
include/fp_lib_table.h
View File

@ -32,6 +32,7 @@
class FOOTPRINT;
class FP_LIB_TABLE_GRID;
class PCB_IO;
class LOCALE_IO;
/**
@ -143,13 +144,13 @@ public:
* @param aFootprintNames is the list to fill with the footprint names found in \a aNickname
* @param aNickname is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
* @param aBestEfforts if true, don't throw on errors.
* @param aThreadSafe if true, do not set LOCALE_IO (which is global). Caller is responsible
* for setting it up correctly.
* @param aLocale a previously set-up locale. Currently required for multi-threading, as LOCALE_IO
* uses global storage.
*
* @throw IO_ERROR if the library cannot be found, or footprint cannot be loaded.
*/
void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aNickname,
bool aBestEfforts, bool aThreadSafe );
bool aBestEfforts, const LOCALE_IO* aLocale = nullptr );
/**
* Generate a hashed timestamp representing the last-mod-times of the library indicated
@ -182,14 +183,14 @@ public:
* A version of #FootprintLoad() for use after #FootprintEnumerate() for more efficient
* cache management.
*
* @param aThreadSafe if true, do not set LOCALE_IO (which is global). Caller is responsible
* for setting it up correctly.
* @param aLocale a previously set-up locale. Currently required for multi-threading, as LOCALE_IO
* uses global storage.
*
* The return value is const to allow it to return a reference to a cached item.
*/
const FOOTPRINT* GetEnumeratedFootprint( const wxString& aNickname,
const wxString& aFootprintName,
bool aThreadSafe );
const LOCALE_IO* aLocale = nullptr );
/**
* The set of return values from FootprintSave() below.
*/

2
pcbnew/files.cpp
View File

@ -75,7 +75,6 @@
#include <widgets/filedlg_import_non_kicad.h>
#include <widgets/wx_html_report_box.h>
#include <wx_filename.h> // For ::ResolvePossibleSymlinks()
#include <locale_io.h>
#include <kiplatform/io.h>
#include <wx/stdpaths.h>
@ -840,7 +839,6 @@ bool PCB_EDIT_FRAME::OpenProjectFiles( const std::vector<wxString>& aFileSet, in
// which prompts the user to continue with overwrite or abort)
if( newLibPath.Length() > 0 )
{
LOCALE_IO toggle_locale;
IO_RELEASER<PCB_IO> piSexpr( PCB_IO_MGR::PluginFind( PCB_IO_MGR::KICAD_SEXP ) );
for( FOOTPRINT* footprint : loadedFootprints )

10
pcbnew/footprint_info_impl.cpp
View File

@ -41,13 +41,13 @@
#include <wx/wfstream.h>
void FOOTPRINT_INFO_IMPL::load()
void FOOTPRINT_INFO_IMPL::load( const LOCALE_IO* aLocale )
{
FP_LIB_TABLE* fptable = m_owner->GetTable();
wxASSERT( fptable );
const FOOTPRINT* footprint = fptable->GetEnumeratedFootprint( m_nickname, m_fpname, true );
const FOOTPRINT* footprint = fptable->GetEnumeratedFootprint( m_nickname, m_fpname, aLocale );
if( footprint == nullptr ) // Should happen only with malformed/broken libraries
{
@ -180,7 +180,7 @@ void FOOTPRINT_LIST_IMPL::loadFootprints()
std::vector<std::future<size_t>> returns( num_elements );
auto fp_thread =
[ this, &queue_parsed ]() -> size_t
[ this, &queue_parsed, &toggle_locale ]() -> size_t
{
wxString nickname;
@ -192,7 +192,7 @@ void FOOTPRINT_LIST_IMPL::loadFootprints()
CatchErrors(
[&]()
{
m_lib_table->FootprintEnumerate( fpnames, nickname, false, true );
m_lib_table->FootprintEnumerate( fpnames, nickname, false, &toggle_locale );
} );
for( wxString fpname : fpnames )
@ -200,7 +200,7 @@ void FOOTPRINT_LIST_IMPL::loadFootprints()
CatchErrors(
[&]()
{
auto* fpinfo = new FOOTPRINT_INFO_IMPL( this, nickname, fpname );
auto* fpinfo = new FOOTPRINT_INFO_IMPL( this, nickname, fpname, &toggle_locale );
queue_parsed.move_push( std::unique_ptr<FOOTPRINT_INFO>( fpinfo ) );
} );

8
pcbnew/footprint_info_impl.h
View File

@ -34,8 +34,8 @@ class LOCALE_IO;
class FOOTPRINT_INFO_IMPL : public FOOTPRINT_INFO
{
public:
FOOTPRINT_INFO_IMPL( FOOTPRINT_LIST* aOwner, const wxString& aNickname,
const wxString& aFootprintName )
FOOTPRINT_INFO_IMPL( FOOTPRINT_LIST* aOwner, const wxString& aNickname, const wxString& aFootprintName,
const LOCALE_IO* aLocale )
{
m_nickname = aNickname;
m_fpname = aFootprintName;
@ -45,7 +45,7 @@ public:
m_owner = aOwner;
m_loaded = false;
load();
load( aLocale );
}
// A constructor for cached items
@ -77,7 +77,7 @@ public:
}
protected:
virtual void load() override;
virtual void load( const LOCALE_IO* aLocale ) override;
};

4
pcbnew/footprint_libraries_utils.cpp
View File

@ -51,7 +51,6 @@
#include <footprint_editor_settings.h>
#include <footprint_viewer_frame.h>
#include <io/kicad/kicad_io_utils.h>
#include <locale_io.h>
#include <view/view_controls.h>
#include <wx/choicdlg.h>
#include <wx/filedlg.h>
@ -692,7 +691,6 @@ void PCB_EDIT_FRAME::ExportFootprintsToLibrary( bool aStoreInNewLib, const wxStr
libNickname = row->GetNickName();
}
LOCALE_IO toggle_locale;
PCB_IO_MGR::PCB_FILE_T piType = PCB_IO_MGR::KICAD_SEXP;
IO_RELEASER<PCB_IO> pi( PCB_IO_MGR::PluginFind( piType ) );
std::map<std::string, UTF8> options { { "skip_cache_validation", "1" } }; // Skip cache validation -- we just created it
@ -1267,7 +1265,7 @@ FOOTPRINT* PCB_BASE_FRAME::CreateNewFootprint( wxString aFootprintName, const wx
// Try to infer the footprint attributes from an existing footprint in the library
try
{
tbl->FootprintEnumerate( fpnames, aLibName, true, false );
tbl->FootprintEnumerate( fpnames, aLibName, true, nullptr );
if( !fpnames.empty() )
footprintAttrs = tbl->FootprintLoad( aLibName, fpnames.Last() )->GetAttributes();

3
pcbnew/footprint_preview_panel.cpp
View File

@ -177,8 +177,7 @@ bool FOOTPRINT_PREVIEW_PANEL::DisplayFootprint( const LIB_ID& aFPID )
try
{
const FOOTPRINT* fp = fptbl->GetEnumeratedFootprint( aFPID.GetLibNickname(), aFPID.GetLibItemName(),
false );
const FOOTPRINT* fp = fptbl->GetEnumeratedFootprint( aFPID.GetLibNickname(), aFPID.GetLibItemName() );
if( fp )
m_currentFootprint.reset( static_cast<FOOTPRINT*>( fp->Duplicate( IGNORE_PARENT_GROUP ) ) );

3
pcbnew/generate_footprint_info.cpp
View File

@ -122,8 +122,7 @@ public:
try
{
m_footprint = m_fp_lib_table->GetEnumeratedFootprint( m_lib_id.GetLibNickname(),
m_lib_id.GetLibItemName(),
false );
m_lib_id.GetLibItemName() );
}
catch( const IO_ERROR& ioe )
{

2
pcbnew/python/scripting/pcbnew_scripting_helpers.cpp
View File

@ -392,7 +392,7 @@ wxArrayString GetFootprints( const wxString& aNickName )
if( !tbl )
return footprintNames;
tbl->FootprintEnumerate( footprintNames, aNickName, true, false );
tbl->FootprintEnumerate( footprintNames, aNickName, true );
return footprintNames;
}

2
qa/pcbnew_utils/board_file_utils.cpp
View File

@ -27,7 +27,6 @@
#include <pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h>
#include <pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.h>
#include <richio.h>
#include <locale_io.h>
#include <board.h>
#include <footprint.h>
@ -148,7 +147,6 @@ std::unique_ptr<FOOTPRINT> ReadFootprintFromFileOrStream( const std::string& aFi
void DumpFootprintToFile( const FOOTPRINT& aFootprint, const std::string& aLibraryPath )
{
LOCALE_IO toggle_locale;
PCB_IO_KICAD_SEXPR io;
io.FootprintSave( aLibraryPath, &aFootprint, nullptr );
}