KiCad PCB EDA Suite
LOCALE_IO Class Reference

Instantiate the current locale within a scope in which you are expecting exceptions to be thrown. More...

#include <common.h>

Public Member Functions

 LOCALE_IO ()
 
 ~LOCALE_IO ()
 

Private Attributes

std::string m_user_locale
 
wxLocale * m_wxLocale
 

Static Private Attributes

static std::atomic< unsigned int > m_c_count
 

Detailed Description

Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.

The constructor sets a "C" language locale option, to read/print files with floating point numbers. The destructor insures that the default locale is restored if an exception is thrown or not.

Definition at line 202 of file common.h.

Constructor & Destructor Documentation

◆ LOCALE_IO()

LOCALE_IO::LOCALE_IO ( )

Definition at line 222 of file common.cpp.

222  : m_wxLocale( nullptr )
223 {
224  // use thread safe, atomic operation
225  if( m_c_count++ == 0 )
226  {
227 #if USE_WXLOCALE
228  m_wxLocale = new wxLocale( "C", "C", "C", false );
229 #else
230  // Store the user locale name, to restore this locale later, in dtor
231  m_user_locale = setlocale( LC_NUMERIC, nullptr );
232 #if defined( _WIN32 ) && defined( DEBUG )
233  // Disable wxWidgets alerts
234  wxSetAssertHandler( KiAssertFilter );
235 #endif
236  // Switch the locale to C locale, to read/write files with fp numbers
237  setlocale( LC_NUMERIC, "C" );
238 #endif
239  }
240 }
wxLocale * m_wxLocale
Definition: common.h:215
static std::atomic< unsigned int > m_c_count
Definition: common.h:210
std::string m_user_locale
Definition: common.h:214

References m_c_count, m_user_locale, and m_wxLocale.

◆ ~LOCALE_IO()

LOCALE_IO::~LOCALE_IO ( )

Definition at line 243 of file common.cpp.

244 {
245  // use thread safe, atomic operation
246  if( --m_c_count == 0 )
247  {
248  // revert to the user locale
249 #if USE_WXLOCALE
250  delete m_wxLocale; // Deleting m_wxLocale restored previous locale
251  m_wxLocale = nullptr;
252 #else
253  setlocale( LC_NUMERIC, m_user_locale.c_str() );
254 #if defined( _WIN32 ) && defined( DEBUG )
255  // Enable wxWidgets alerts
256  wxSetDefaultAssertHandler();
257 #endif
258 #endif
259  }
260 }
wxLocale * m_wxLocale
Definition: common.h:215
static std::atomic< unsigned int > m_c_count
Definition: common.h:210
std::string m_user_locale
Definition: common.h:214

References m_c_count, m_user_locale, and m_wxLocale.

Member Data Documentation

◆ m_c_count

std::atomic< unsigned int > LOCALE_IO::m_c_count
staticprivate

Definition at line 210 of file common.h.

Referenced by LOCALE_IO(), and ~LOCALE_IO().

◆ m_user_locale

std::string LOCALE_IO::m_user_locale
private

Definition at line 214 of file common.h.

Referenced by LOCALE_IO(), and ~LOCALE_IO().

◆ m_wxLocale

wxLocale* LOCALE_IO::m_wxLocale
private

Definition at line 215 of file common.h.

Referenced by LOCALE_IO(), and ~LOCALE_IO().


The documentation for this class was generated from the following files: