PGM_BASE Class Reference

Container for data for KiCad programs. More...

#include <pgm_base.h>

Inheritance diagram for PGM_BASE:

Public Member Functions
	PGM_BASE ()
virtual	~PGM_BASE ()
void	BuildArgvUtf8 ()
	Builds the UTF8 based argv variable. More...
virtual void	MacOpenFile (const wxString &aFileName)=0
	Specific to MacOSX (not used under Linux or Windows). More...
virtual SETTINGS_MANAGER &	GetSettingsManager () const
virtual COMMON_SETTINGS *	GetCommonSettings () const
virtual void	SetTextEditor (const wxString &aFileName)
virtual const wxString &	GetTextEditor (bool aCanShowFileChooser=true)
	Return the path to the preferred text editor application. More...
virtual const wxString	AskUserForPreferredEditor (const wxString &aDefaultEditor=wxEmptyString)
	Shows a dialog that instructs the user to select a new preferred editor. More...
virtual bool	IsKicadEnvVariableDefined () const
virtual const wxString &	GetKicadEnvVariable () const
virtual const wxString &	GetExecutablePath () const
virtual wxLocale *	GetLocale ()
virtual const wxString &	GetPdfBrowserName () const
virtual void	SetPdfBrowserName (const wxString &aFileName)
virtual bool	UseSystemPdfBrowser () const
virtual void	ForceSystemPdfBrowser (bool aFlg)
	Force the use of system PDF browser, even if a preferred PDF browser is set. More...
virtual bool	SetLanguage (wxString &aErrMsg, bool first_time=false)
	Set the dictionary file name for internationalization. More...
bool	SetDefaultLanguage (wxString &aErrMsg)
	Set the default language without reference to any preferences. More...
virtual void	SetLanguageIdentifier (int menu_id)
	Set in .m_language_id member the wxWidgets language identifier ID from the KiCad menu id (internal menu identifier). More...
virtual int	GetSelectedLanguageIdentifier () const
virtual wxString	GetLanguageTag ()
virtual void	SetLanguagePath ()
virtual void	ReadPdfBrowserInfos ()
	Read the PDF browser choice from the common configuration. More...
virtual void	WritePdfBrowserInfos ()
	Save the PDF browser choice to the common configuration. More...
virtual bool	SetLocalEnvVariable (const wxString &aName, const wxString &aValue)
	Sets the environment variable aName to aValue. More...
virtual void	SetLocalEnvVariables ()
	Updates the local environment with the contents of the current ENV_VAR_MAP stored in the COMMON_SETTINGS. More...
virtual ENV_VAR_MAP &	GetLocalEnvVariables () const
virtual wxApp &	App ()
	Returns a bare naked wxApp which may come from wxPython, SINGLE_TOP, or kicad.exe. More...
bool	InitPgm (bool aHeadless=false, bool aSkipPyInit=false, bool aIsUnitTest=false)
	Initialize this program. More...
void	Destroy ()
void	SaveCommonSettings ()
	Save the program (process) settings subset which are stored .kicad_common. More...

Public Attributes
bool	m_Printing
	wxWidgets on MSW tends to crash if you spool up more than one print job at a time. More...
std::vector< void * >	m_ModalDialogs
bool	m_Quitting

Static Public Attributes
static const wxChar	workingDirKey []

Protected Member Functions
void	loadCommonSettings ()
	Loads internal settings from COMMON_SETTINGS. More...
void	setLanguageId (int aId)
	Trap all changes in here, simplifies debugging. More...
bool	setExecutablePath ()
	Find the path to the executable and stores it in PGM_BASE::m_bin_dir. More...

Protected Attributes
std::unique_ptr< SETTINGS_MANAGER >	m_settings_manager
std::unique_ptr< SCRIPTING >	m_python_scripting
wxString	m_bin_dir
wxString	m_kicad_env
	full path to this program More...
wxLocale *	m_locale
	The KICAD system environment variable. More...
int	m_language_id
bool	m_use_system_pdf_browser
wxString	m_pdf_browser
wxString	m_text_editor
	Filename of the app selected for browsing PDFs. More...
char **	m_argvUtf8
int	m_argcUtf8
	argv parameters converted to utf8 form, because wxwidgets has opinions and will return argv as either force converted to ascii in char* or wchar_t only More...

Detailed Description

Container for data for KiCad programs.

The functions are virtual so we can do cross module calls without linking to them. This used to be a wxApp derivative, but that is difficult under wxPython which shapes the wxApp. So now this is a "side-car" (like a motorcycle side-car) object with a back pointer into the wxApp which initializes it.

• OnPgmStart() is virtual, may be overridden, and parallels wxApp::OnInit(), from where it should called.
• OnPgmEnd() is virtual, may be overridden, and parallels wxApp::OnExit(), from where it should be called.

Definition at line 94 of file pgm_base.h.

Constructor & Destructor Documentation

PGM_BASE()

PGM_BASE::PGM_BASE

(

)

Definition at line 124 of file pgm_base.cpp.

{
 m_locale = nullptr;
 m_Printing = false;
 m_Quitting = false;
 m_argcUtf8 = 0;
 m_argvUtf8 = nullptr;
 
 setLanguageId( wxLANGUAGE_DEFAULT );
 
 ForceSystemPdfBrowser( false );
}

References ForceSystemPdfBrowser(), m_argcUtf8, m_argvUtf8, m_locale, m_Printing, m_Quitting, and setLanguageId().

~PGM_BASE()

PGM_BASE::~PGM_BASE ( )

virtual

Definition at line 138 of file pgm_base.cpp.

{
 Destroy();
 
 for( int n = 0; n < m_argcUtf8; n++ )
 {
 free( m_argvUtf8[n] );
 }
 
 delete[] m_argvUtf8;
}

References Destroy(), m_argcUtf8, and m_argvUtf8.

Member Function Documentation

App()

wxApp & PGM_BASE::App ( )

virtual

Returns a bare naked wxApp which may come from wxPython, SINGLE_TOP, or kicad.exe.

This should return what wxGetApp() returns.

Definition at line 163 of file pgm_base.cpp.

{
 wxASSERT( wxTheApp );
 return *wxTheApp;
}

Referenced by BuildArgvUtf8(), InitPgm(), PGM_SINGLE_TOP::MacOpenFile(), PGM_KICAD::MacOpenFile(), PGM_TEST_FRAME::MacOpenFile(), and PGM_KICAD::OnPgmInit().

AskUserForPreferredEditor()

const wxString PGM_BASE::AskUserForPreferredEditor ( const wxString &  aDefaultEditor = wxEmptyString )

virtual

Shows a dialog that instructs the user to select a new preferred editor.

Parameters

aDefaultEditor

Default full path for the default editor this dialog should show by default.

Returns

Returns the full path of the editor, or an empty string if no editor was chosen.

Definition at line 213 of file pgm_base.cpp.

{
 // Create a mask representing the executable files in the current platform
#ifdef __WINDOWS__
 wxString mask( _( "Executable file" ) + wxT( " (*.exe)|*.exe" ) );
#else
 wxString mask( _( "Executable file" ) + wxT( " (*)|*" ) );
#endif
 
 // Extract the path, name and extension from the default editor (even if the editor's
 // name was empty, this method will succeed and return empty strings).
 wxString path, name, ext;
 wxFileName::SplitPath( aDefaultEditor, &path, &name, &ext );
 
 // Show the modal editor and return the file chosen (may be empty if the user cancels
 // the dialog).
 return wxFileSelector( _( "Select Preferred Editor" ), path, name, wxT( "." ) + ext,
 mask, wxFD_OPEN | wxFD_FILE_MUST_EXIST, nullptr );
}

References _, name, and path.

Referenced by GetTextEditor().

BuildArgvUtf8()

void PGM_BASE::BuildArgvUtf8

(

)

Builds the UTF8 based argv variable.

Definition at line 383 of file pgm_base.cpp.

{
 const wxArrayString& argArray = App().argv.GetArguments();
 m_argcUtf8 = argArray.size();
 
 m_argvUtf8 = new char*[m_argcUtf8 + 1];
 for( int n = 0; n < m_argcUtf8; n++ )
 {
 m_argvUtf8[n] = wxStrdup( argArray[n].ToUTF8() );
 }
 
 m_argvUtf8[m_argcUtf8] = NULL; // null terminator at end of argv
}

References App(), m_argcUtf8, and m_argvUtf8.

Destroy()

void PGM_BASE::Destroy

(

)

Definition at line 151 of file pgm_base.cpp.

{
#ifdef KICAD_USE_SENTRY
 sentry_close();
#endif
 
 // unlike a normal destructor, this is designed to be called more than once safely:
 delete m_locale;
 m_locale = nullptr;
}

References m_locale.

Referenced by PGM_KICAD::Destroy(), PGM_SINGLE_TOP::OnPgmExit(), PGM_TEST_FRAME::OnPgmExit(), and ~PGM_BASE().

ForceSystemPdfBrowser()

virtual void PGM_BASE::ForceSystemPdfBrowser ( bool  aFlg )

inlinevirtual

Force the use of system PDF browser, even if a preferred PDF browser is set.

Definition at line 187 of file pgm_base.h.

{ m_use_system_pdf_browser = aFlg; }

References m_use_system_pdf_browser.

Referenced by PGM_BASE().

GetCommonSettings()

COMMON_SETTINGS * PGM_BASE::GetCommonSettings ( ) const

virtual

Definition at line 615 of file pgm_base.cpp.

{
 return m_settings_manager ? m_settings_manager->GetCommonSettings() : nullptr;
}

References m_settings_manager.

Referenced by GetLocalEnvVariables(), InitPgm(), loadCommonSettings(), ReadPdfBrowserInfos(), SaveCommonSettings(), SetLanguage(), SetLocalEnvVariables(), SetTextEditor(), and WritePdfBrowserInfos().

GetExecutablePath()

virtual const wxString & PGM_BASE::GetExecutablePath ( ) const

inlinevirtual

Definition at line 166 of file pgm_base.h.

{ return m_bin_dir; }

References m_bin_dir.

Referenced by PGM_SINGLE_TOP::OnPgmInit(), and SetLanguagePath().

GetKicadEnvVariable()

virtual const wxString & PGM_BASE::GetKicadEnvVariable ( ) const

inlinevirtual

Definition at line 164 of file pgm_base.h.

{ return m_kicad_env; }

References m_kicad_env.

GetLanguageTag()

wxString PGM_BASE::GetLanguageTag ( )

virtual

Returns

the current selected language in rfc3066 format

Definition at line 778 of file pgm_base.cpp.

{
 const wxLanguageInfo* langInfo = wxLocale::GetLanguageInfo( m_language_id );
 
 if( !langInfo )
 return "";
 else
 {
 #if wxCHECK_VERSION( 3, 1, 6 )
 wxString str = langInfo->GetCanonicalWithRegion();
 #else
 wxString str = langInfo->CanonicalName;
 #endif
 str.Replace( "_", "-" );
 
 return str;
 }
}

References m_language_id.

GetLocale()

virtual wxLocale * PGM_BASE::GetLocale ( )

inlinevirtual

Definition at line 168 of file pgm_base.h.

{ return m_locale; }

References m_locale.

GetLocalEnvVariables()

ENV_VAR_MAP & PGM_BASE::GetLocalEnvVariables ( ) const

virtual

Definition at line 856 of file pgm_base.cpp.

{
 return GetCommonSettings()->m_Env.vars;
}

References GetCommonSettings(), COMMON_SETTINGS::m_Env, and COMMON_SETTINGS::ENVIRONMENT::vars.

Referenced by FILENAME_RESOLVER::GetKicadPaths(), and PGM_KICAD::OnPgmInit().

GetPdfBrowserName()

virtual const wxString & PGM_BASE::GetPdfBrowserName ( ) const

inlinevirtual

Definition at line 170 of file pgm_base.h.

{ return m_pdf_browser; }

References m_pdf_browser.

Referenced by WritePdfBrowserInfos().

GetSelectedLanguageIdentifier()

virtual int PGM_BASE::GetSelectedLanguageIdentifier ( ) const

inlinevirtual

Returns

the wxWidgets language identifier Id of the language currently selected.

Definition at line 221 of file pgm_base.h.

{ return m_language_id; }

References m_language_id.

GetSettingsManager()

virtual SETTINGS_MANAGER & PGM_BASE::GetSettingsManager ( ) const

inlinevirtual

Definition at line 135 of file pgm_base.h.

{ return *m_settings_manager; }

References m_settings_manager.

Referenced by InitPgm(), LIB_PIN::LIB_PIN(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), PGM_KICAD::OnPgmInit(), SCH::readSchematicFromFile(), SaveFileAs(), and SetLanguage().

GetTextEditor()

const wxString & PGM_BASE::GetTextEditor ( bool  aCanShowFileChooser = true )

virtual

Return the path to the preferred text editor application.

Parameters

aCanShowFileChooser

If no editor is currently set and this argument is 'true' then this method will show a file chooser dialog asking for the editor's executable.

Returns

Returns the full path of the editor, or an empty string if no editor has been set.

Definition at line 177 of file pgm_base.cpp.

{
 wxString editorname = m_text_editor;
 
 if( !editorname )
 {
 if( !wxGetEnv( wxT( "EDITOR" ), &editorname ) )
 {
 // If there is no EDITOR variable set, try the desktop default
#ifdef __WXMAC__
 editorname = wxT( "/usr/bin/open -e" );
#elif __WXX11__
 editorname = wxT( "/usr/bin/xdg-open" );
#endif
 }
 }
 
 // If we still don't have an editor name show a dialog asking the user to select one
 if( !editorname && aCanShowFileChooser )
 {
 DisplayInfoMessage( nullptr, _( "No default editor found, you must choose one." ) );
 
 editorname = AskUserForPreferredEditor();
 }
 
 // If we finally have a new editor name request it to be copied to m_text_editor and
 // saved to the preferences file.
 if( !editorname.IsEmpty() )
 SetTextEditor( editorname );
 
 // m_text_editor already has the same value that editorname, or empty if no editor was
 // found/chosen.
 return m_text_editor;
}

References _, AskUserForPreferredEditor(), DisplayInfoMessage(), m_text_editor, and SetTextEditor().

InitPgm()

bool PGM_BASE::InitPgm	(	bool	aHeadless = false,
		bool	aSkipPyInit = false,
		bool	aIsUnitTest = false
	)

Initialize this program.

Initialize the process in a KiCad standard way using some generalized techniques:

• Default paths (help, libs, bin) and configuration file names
• Language and locale
• fonts

Note

Do not initialize anything relating to DSOs or projects.

Parameters

aHeadless	If true, run in headless mode (e.g. for unit tests)
aSkipPyInit	If true, do not init python stuff. Useful in application that do not use python, to disable python dependency at run time

Returns

true if success, false if failure and program is to terminate.

Should never happen but boost unit_test isn't playing nicely in some cases

Definition at line 398 of file pgm_base.cpp.

{
#if defined( __WXMAC__ )
 // Set the application locale to the system default
 wxLogNull noLog;
 wxLocale loc;
 loc.Init();
#endif
 
 // Just make sure we init precreate any folders early for later code
 // In particular, the user cache path is the most likely to be hit by startup code
 PATHS::EnsureUserPathsExist();
 
#ifdef KICAD_USE_SENTRY
 sentryInit();
#endif
 wxString pgm_name;
 
 if( App().argc == 0 )
 pgm_name = wxT( "kicad" );
 else
 pgm_name = wxFileName( App().argv[0] ).GetName().Lower();
 
#ifdef KICAD_USE_SENTRY
 sentry_set_tag( "kicad.app", pgm_name.c_str() );
#endif
 
 wxInitAllImageHandlers();
 
 // Without this the wxPropertyGridManager segfaults on Windows.
 if( !wxPGGlobalVars )
 wxPGInitResourceModule();
 
#ifndef __WINDOWS__
 if( wxString( wxGetenv( "HOME" ) ).IsEmpty() )
 {
  DisplayErrorMessage( nullptr, _( "Environment variable HOME is empty. "
 "Unable to continue." ) );
 return false;
 }
#endif
 
 // Init KiCad environment
 // the environment variable KICAD (if exists) gives the kicad path:
 // something like set KICAD=d:\kicad
 bool isDefined = wxGetEnv( wxT( "KICAD" ), &m_kicad_env );
 
 if( isDefined ) // ensure m_kicad_env ends by "/"
 {
 m_kicad_env.Replace( WIN_STRING_DIR_SEP, UNIX_STRING_DIR_SEP );
 
 if( !m_kicad_env.IsEmpty() && m_kicad_env.Last() != '/' )
 m_kicad_env += UNIX_STRING_DIR_SEP;
 }
 
 // Init parameters for configuration
 App().SetVendorName( wxT( "KiCad" ) );
 App().SetAppName( pgm_name );
 
 // Install some image handlers, mainly for help
 if( wxImage::FindHandler( wxBITMAP_TYPE_PNG ) == nullptr )
 wxImage::AddHandler( new wxPNGHandler );
 
 if( wxImage::FindHandler( wxBITMAP_TYPE_GIF ) == nullptr )
 wxImage::AddHandler( new wxGIFHandler );
 
 if( wxImage::FindHandler( wxBITMAP_TYPE_JPEG ) == nullptr )
 wxImage::AddHandler( new wxJPEGHandler );
 
 wxFileSystem::AddHandler( new wxZipFSHandler );
 
 // Analyze the command line & initialize the binary path
 wxString tmp;
 setExecutablePath();
 SetLanguagePath();
 SetDefaultLanguage( tmp );
 
 m_settings_manager = std::make_unique<SETTINGS_MANAGER>( aHeadless );
 
 // Our unit test mocks break if we continue
 // A bug caused InitPgm to terminate early in unit tests and the mocks are...simplistic
 // TODO fix the unit tests so this can be removed
 if( aIsUnitTest )
 return false;
 
 // Something got in the way of settings load: can't continue
 if( !m_settings_manager->IsOK() )
 return false;
 
 // Set up built-in environment variables (and override them from the system environment if set)
 GetCommonSettings()->InitializeEnvironment();
 
 // Load color settings after env is initialized
 m_settings_manager->ReloadColorSettings();
 
 // Load common settings from disk after setting up env vars
 GetSettingsManager().Load( GetCommonSettings() );
 
 // Init user language *before* calling loadSettings, because
 // env vars could be incorrectly initialized on Linux
 // (if the value contains some non ASCII7 chars, the env var is not initialized)
 SetLanguage( tmp, true );
 
 // Now that translations are available, inform the user if the OS is unsupported
 WarnUserIfOperatingSystemUnsupported();
 
 loadCommonSettings();
 
#ifdef KICAD_USE_SENTRY
 sentryPrompt();
#endif
 
 ReadPdfBrowserInfos(); // needs GetCommonSettings()
 
 // Create the python scripting stuff
 // Skip it fot applications that do not use it
 if( !aSkipPyInit )
 m_python_scripting = std::make_unique<SCRIPTING>();
 
 // TODO(JE): Remove this if apps are refactored to not assume Prj() always works
 // Need to create a project early for now (it can have an empty path for the moment)
 GetSettingsManager().LoadProject( "" );
 
 // This sets the maximum tooltip display duration to 10s (up from 5) but only affects
 // Windows as other platforms display tooltips while the mouse is not moving
 if( !aHeadless )
 {
 wxToolTip::Enable( true );
 wxToolTip::SetAutoPop( 10000 );
 }
 
 if( ADVANCED_CFG::GetCfg().m_UpdateUIEventInterval != 0 )
 wxUpdateUIEvent::SetUpdateInterval( ADVANCED_CFG::GetCfg().m_UpdateUIEventInterval );
 
 return true;
}

References _, App(), DisplayErrorMessage(), PATHS::EnsureUserPathsExist(), ADVANCED_CFG::GetCfg(), GetCommonSettings(), GetSettingsManager(), COMMON_SETTINGS::InitializeEnvironment(), SETTINGS_MANAGER::Load(), loadCommonSettings(), SETTINGS_MANAGER::LoadProject(), m_kicad_env, m_python_scripting, m_settings_manager, ReadPdfBrowserInfos(), SetDefaultLanguage(), setExecutablePath(), SetLanguage(), SetLanguagePath(), UNIX_STRING_DIR_SEP, WarnUserIfOperatingSystemUnsupported(), WIN_STRING_DIR_SEP, and wxPGGlobalVars.

Referenced by PGM_KICAD::OnPgmInit().

IsKicadEnvVariableDefined()

virtual bool PGM_BASE::IsKicadEnvVariableDefined ( ) const

inlinevirtual

Definition at line 162 of file pgm_base.h.

{ return !m_kicad_env.IsEmpty(); }

References m_kicad_env.

loadCommonSettings()

void PGM_BASE::loadCommonSettings ( )

protected

Loads internal settings from COMMON_SETTINGS.

Definition at line 579 of file pgm_base.cpp.

{
 m_text_editor = GetCommonSettings()->m_System.text_editor;
 
 for( const std::pair<wxString, ENV_VAR_ITEM> it : GetCommonSettings()->m_Env.vars )
 {
 wxLogTrace( traceEnvVars, wxT( "PGM_BASE::loadSettings: Found entry %s = %s" ),
 it.first, it.second.GetValue() );
 
 // Do not store the env var PROJECT_VAR_NAME ("KIPRJMOD") definition if for some reason
 // it is found in config. (It is reserved and defined as project path)
 if( it.first == PROJECT_VAR_NAME )
 continue;
 
 // Don't set bogus empty entries in the environment
 if( it.first.IsEmpty() )
 continue;
 
 // Do not overwrite vars set by the system environment with values from the settings file
 if( it.second.GetDefinedExternally() )
 continue;
 
 SetLocalEnvVariable( it.first, it.second.GetValue() );
 }
}

References GetCommonSettings(), COMMON_SETTINGS::m_System, m_text_editor, PROJECT_VAR_NAME, SetLocalEnvVariable(), COMMON_SETTINGS::SYSTEM::text_editor, and traceEnvVars.

Referenced by InitPgm().

MacOpenFile()

virtual void PGM_BASE::MacOpenFile ( const wxString &  aFileName )

pure virtual

Specific to MacOSX (not used under Linux or Windows).

MacOSX requires it for file association.

See also

http://wiki.wxwidgets.org/WxMac-specific_topics

Implemented in PGM_SINGLE_TOP, PGM_KICAD, and PGM_TEST_FRAME.

ReadPdfBrowserInfos()

void PGM_BASE::ReadPdfBrowserInfos ( )

virtual

Read the PDF browser choice from the common configuration.

Definition at line 37 of file eda_doc.cpp.

{
 SetPdfBrowserName( GetCommonSettings()->m_System.pdf_viewer_name );
 m_use_system_pdf_browser = GetCommonSettings()->m_System.use_system_pdf_viewer;
}

References GetCommonSettings(), COMMON_SETTINGS::m_System, m_use_system_pdf_browser, SetPdfBrowserName(), and COMMON_SETTINGS::SYSTEM::use_system_pdf_viewer.

Referenced by InitPgm().

SaveCommonSettings()

void PGM_BASE::SaveCommonSettings

(

)

Save the program (process) settings subset which are stored .kicad_common.

Definition at line 606 of file pgm_base.cpp.

{
 // GetCommonSettings() is not initialized until fairly late in the
 // process startup: InitPgm(), so test before using:
 if( GetCommonSettings() )
 GetCommonSettings()->m_System.working_dir = wxGetCwd();
}

References GetCommonSettings(), COMMON_SETTINGS::m_System, and COMMON_SETTINGS::SYSTEM::working_dir.

Referenced by PGM_SINGLE_TOP::OnPgmExit(), and PGM_KICAD::OnPgmExit().

SetDefaultLanguage()

bool PGM_BASE::SetDefaultLanguage

(

wxString &

aErrMsg

)

Set the default language without reference to any preferences.

Can be used to set the language for dialogs that show before preferences are loaded

Parameters

aErrMsg

String to return the error message(s) in

Returns

false if the language could not be set

Definition at line 721 of file pgm_base.cpp.

{
 // Suppress error popups from wxLocale
 wxLogNull doNotLog;
 
 setLanguageId( wxLANGUAGE_DEFAULT );
 
 // dictionary file name without extend (full name is kicad.mo)
 wxString dictionaryName( wxT( "kicad" ) );
 
 delete m_locale;
 m_locale = new wxLocale;
 m_locale->Init();
 
 // Try adding the dictionary if it is not currently loaded
 if( !m_locale->IsLoaded( dictionaryName ) )
 m_locale->AddCatalog( dictionaryName );
 
 // Verify the Kicad dictionary was loaded properly
 // However, for the English language, the dictionary is not mandatory, as
 // all messages are already in English, just restricted to ASCII7 chars,
 // the verification is skipped.
 if( !m_locale->IsLoaded( dictionaryName ) && m_language_id != wxLANGUAGE_ENGLISH )
 {
 wxLogTrace( traceLocale, wxT( "Unable to load dictionary %s.mo in %s" ),
 dictionaryName, m_locale->GetName() );
 
 setLanguageId( wxLANGUAGE_DEFAULT );
 delete m_locale;
 
 m_locale = new wxLocale;
 m_locale->Init();
 
 aErrMsg = _( "The KiCad language file for this language is not installed." );
 return false;
 }
 
 return true;
}

References _, m_language_id, m_locale, setLanguageId(), and traceLocale.

Referenced by InitPgm().

setExecutablePath()

bool PGM_BASE::setExecutablePath ( )

protected

Find the path to the executable and stores it in PGM_BASE::m_bin_dir.

Returns

true if success, else false.

Definition at line 537 of file pgm_base.cpp.

{
 m_bin_dir = wxStandardPaths::Get().GetExecutablePath();
 
#ifdef __WXMAC__
 // On OSX Pgm().GetExecutablePath() will always point to main
 // bundle directory, e.g., /Applications/kicad.app/
 
 wxFileName fn( m_bin_dir );
 
 if( fn.GetName() == wxT( "kicad" ) || fn.GetName() == wxT( "kicad-cli" ) )
 {
 // kicad launcher, so just remove the Contents/MacOS part
 fn.RemoveLastDir();
 fn.RemoveLastDir();
 }
 else
 {
 // standalone binaries live in Contents/Applications/<standalone>.app/Contents/MacOS
 fn.RemoveLastDir();
 fn.RemoveLastDir();
 fn.RemoveLastDir();
 fn.RemoveLastDir();
 fn.RemoveLastDir();
 }
 
 m_bin_dir = fn.GetPath() + wxT( "/" );
#else
 // Use unix notation for paths. I am not sure this is a good idea,
 // but it simplifies compatibility between Windows and Unices.
 // However it is a potential problem in path handling under Windows.
 m_bin_dir.Replace( WIN_STRING_DIR_SEP, UNIX_STRING_DIR_SEP );
 
 // Remove file name form command line:
 while( m_bin_dir.Last() != '/' && !m_bin_dir.IsEmpty() )
 m_bin_dir.RemoveLast();
#endif
 
 return true;
}

References m_bin_dir, UNIX_STRING_DIR_SEP, and WIN_STRING_DIR_SEP.

Referenced by InitPgm().

SetLanguage()

bool PGM_BASE::SetLanguage ( wxString &  aErrMsg, bool  first_time = false  )

virtual

Set the dictionary file name for internationalization.

The files are in kicad/internat/xx or kicad/internat/xx_XX and are named kicad.mo

Parameters

aErrMsg	is the string to return the error message it.
first_time	must be set to true the first time this function is called, false otherwise.

Returns

false if there was an error setting the language.

Definition at line 621 of file pgm_base.cpp.

{
 // Suppress wxWidgets error popups if locale is not found
 wxLogNull doNotLog;
 
 if( first_time )
 {
 setLanguageId( wxLANGUAGE_DEFAULT );
 // First time SetLanguage is called, the user selected language id is set
 // from common user config settings
 wxString languageSel = GetCommonSettings()->m_System.language;
 
 // Search for the current selection
 for( unsigned ii = 0; LanguagesList[ii].m_KI_Lang_Identifier != 0; ii++ )
 {
 if( LanguagesList[ii].m_Lang_Label == languageSel )
 {
 setLanguageId( LanguagesList[ii].m_WX_Lang_Identifier );
 break;
 }
 }
 }
 
 // dictionary file name without extend (full name is kicad.mo)
 wxString dictionaryName( wxT( "kicad" ) );
 
 delete m_locale;
 m_locale = new wxLocale;
 
 // don't use wxLOCALE_LOAD_DEFAULT flag so that Init() doesn't return
 // false just because it failed to load wxstd catalog
 if( !m_locale->Init( m_language_id, wxLOCALE_DONT_LOAD_DEFAULT ) )
 {
 wxLogTrace( traceLocale, wxT( "This language is not supported by the system." ) );
 
 setLanguageId( wxLANGUAGE_DEFAULT );
 delete m_locale;
 
 m_locale = new wxLocale;
 m_locale->Init( wxLANGUAGE_DEFAULT, wxLOCALE_DONT_LOAD_DEFAULT);
 
 aErrMsg = _( "This language is not supported by the operating system." );
 return false;
 }
 else if( !first_time )
 {
 wxLogTrace( traceLocale, wxT( "Search for dictionary %s.mo in %s" ) ,
 dictionaryName, m_locale->GetName() );
 }
 
 if( !first_time )
 {
 // If we are here, the user has selected another language.
 // Therefore the new preferred language name is stored in common config.
 // Do NOT store the wxWidgets language Id, it can change between wxWidgets
 // versions, for a given language
 wxString languageSel;
 
 // Search for the current selection language name
 for( unsigned ii = 0; LanguagesList[ii].m_KI_Lang_Identifier != 0; ii++ )
 {
 if( LanguagesList[ii].m_WX_Lang_Identifier == m_language_id )
 {
 languageSel = LanguagesList[ii].m_Lang_Label;
 break;
 }
 }
 
 COMMON_SETTINGS* cfg = GetCommonSettings();
 cfg->m_System.language = languageSel;
 cfg->SaveToFile( GetSettingsManager().GetPathForSettingsFile( cfg ) );
 }
 
 // Try adding the dictionary if it is not currently loaded
 if( !m_locale->IsLoaded( dictionaryName ) )
 m_locale->AddCatalog( dictionaryName );
 
 // Verify the Kicad dictionary was loaded properly
 // However, for the English language, the dictionary is not mandatory, as
 // all messages are already in English, just restricted to ASCII7 chars,
 // the verification is skipped.
 if( !m_locale->IsLoaded( dictionaryName ) && m_language_id != wxLANGUAGE_ENGLISH )
 {
 wxLogTrace( traceLocale, wxT( "Unable to load dictionary %s.mo in %s" ),
 dictionaryName, m_locale->GetName() );
 
 setLanguageId( wxLANGUAGE_DEFAULT );
 delete m_locale;
 
 m_locale = new wxLocale;
 m_locale->Init( wxLANGUAGE_DEFAULT, wxLOCALE_DONT_LOAD_DEFAULT);
 
 aErrMsg = _( "The KiCad language file for this language is not installed." );
 return false;
 }
 
 return true;
}

References _, GetCommonSettings(), GetSettingsManager(), COMMON_SETTINGS::SYSTEM::language, LanguagesList, LANGUAGE_DESCR::m_KI_Lang_Identifier, LANGUAGE_DESCR::m_Lang_Label, m_language_id, m_locale, COMMON_SETTINGS::m_System, JSON_SETTINGS::SaveToFile(), setLanguageId(), and traceLocale.

Referenced by InitPgm().

setLanguageId()

void PGM_BASE::setLanguageId ( int  aId )

inlineprotected

Trap all changes in here, simplifies debugging.

Definition at line 320 of file pgm_base.h.

{ m_language_id = aId; }

References m_language_id.

Referenced by PGM_BASE(), SetDefaultLanguage(), SetLanguage(), and SetLanguageIdentifier().

SetLanguageIdentifier()

void PGM_BASE::SetLanguageIdentifier ( int  menu_id )

virtual

Set in .m_language_id member the wxWidgets language identifier ID from the KiCad menu id (internal menu identifier).

Parameters

menu_id

The KiCad menuitem id (returned by Menu Event, when clicking on a menu item)

Definition at line 762 of file pgm_base.cpp.

{
 wxLogTrace( traceLocale, wxT( "Select language ID %d from %d possible languages." ),
 menu_id, (int)arrayDim( LanguagesList )-1 );
 
 for( unsigned ii = 0; LanguagesList[ii].m_KI_Lang_Identifier != 0; ii++ )
 {
 if( menu_id == LanguagesList[ii].m_KI_Lang_Identifier )
 {
 setLanguageId( LanguagesList[ii].m_WX_Lang_Identifier );
 break;
 }
 }
}

References arrayDim(), LanguagesList, LANGUAGE_DESCR::m_KI_Lang_Identifier, setLanguageId(), and traceLocale.

SetLanguagePath()

void PGM_BASE::SetLanguagePath ( )

virtual

Definition at line 798 of file pgm_base.cpp.

{
 wxLocale::AddCatalogLookupPathPrefix( PATHS::GetLocaleDataPath() );
 
 if( wxGetEnv( wxT( "KICAD_RUN_FROM_BUILD_DIR" ), nullptr ) )
 {
 wxFileName fn( Pgm().GetExecutablePath() );
 fn.RemoveLastDir();
 fn.AppendDir( wxT( "translation" ) );
 wxLocale::AddCatalogLookupPathPrefix( fn.GetPath() );
 }
}

References GetExecutablePath(), PATHS::GetLocaleDataPath(), and Pgm().

Referenced by InitPgm().

SetLocalEnvVariable()

bool PGM_BASE::SetLocalEnvVariable ( const wxString &  aName, const wxString &  aValue  )

virtual

Sets the environment variable aName to aValue.

This function first checks to see if the environment variable aName is already defined. If it is not defined, then the environment variable aName is set to a value. Otherwise, the environment variable is left unchanged. This allows the user to override environment variables for testing purposes.

Parameters

aName	is a wxString containing the environment variable name.
aValue	is a wxString containing the environment variable value.

Returns

true if the environment variable Name was set to aValue.

Definition at line 812 of file pgm_base.cpp.

{
 wxString env;
 
 if( aName.IsEmpty() )
 {
 wxLogTrace( traceEnvVars,
 wxT( "PGM_BASE::SetLocalEnvVariable: Attempt to set empty variable to value %s" ),
 aValue );
 return false;
 }
 
 // Check to see if the environment variable is already set.
 if( wxGetEnv( aName, &env ) )
 {
 wxLogTrace( traceEnvVars,
 wxT( "PGM_BASE::SetLocalEnvVariable: Environment variable %s already set to %s" ),
 aName, env );
 return env == aValue;
 }
 
 wxLogTrace( traceEnvVars,
 wxT( "PGM_BASE::SetLocalEnvVariable: Setting local environment variable %s to %s" ),
 aName, aValue );
 
 return wxSetEnv( aName, aValue );
}

References traceEnvVars.

Referenced by loadCommonSettings().

SetLocalEnvVariables()

void PGM_BASE::SetLocalEnvVariables ( )

virtual

Updates the local environment with the contents of the current ENV_VAR_MAP stored in the COMMON_SETTINGS.

See also

GetLocalEnvVariables()

Definition at line 841 of file pgm_base.cpp.

{
 // Overwrites externally defined environment variable until the next time the application
 // is run.
 for( const std::pair<wxString, ENV_VAR_ITEM> m_local_env_var : GetCommonSettings()->m_Env.vars )
 {
 wxLogTrace( traceEnvVars,
 wxT( "PGM_BASE::SetLocalEnvVariables: Setting local environment variable %s to %s" ),
 m_local_env_var.first,
 m_local_env_var.second.GetValue() );
 wxSetEnv( m_local_env_var.first, m_local_env_var.second.GetValue() );
 }
}

References GetCommonSettings(), and traceEnvVars.

SetPdfBrowserName()

virtual void PGM_BASE::SetPdfBrowserName ( const wxString &  aFileName )

inlinevirtual

Definition at line 172 of file pgm_base.h.

{ m_pdf_browser = aFileName; }

References m_pdf_browser.

Referenced by ReadPdfBrowserInfos().

SetTextEditor()

void PGM_BASE::SetTextEditor ( const wxString &  aFileName )

virtual

Definition at line 170 of file pgm_base.cpp.

{
 m_text_editor = aFileName;
 GetCommonSettings()->m_System.text_editor = aFileName;
}

References GetCommonSettings(), COMMON_SETTINGS::m_System, m_text_editor, and COMMON_SETTINGS::SYSTEM::text_editor.

Referenced by GetTextEditor().

UseSystemPdfBrowser()

virtual bool PGM_BASE::UseSystemPdfBrowser ( ) const

inlinevirtual

Returns

true if the PDF browser is the default (system) PDF browser and false if the PDF browser is the preferred (selected) browser, else returns false if there is no selected browser.

Definition at line 179 of file pgm_base.h.

 {
 return m_use_system_pdf_browser || m_pdf_browser.IsEmpty();
 }

References m_pdf_browser, and m_use_system_pdf_browser.

WritePdfBrowserInfos()

void PGM_BASE::WritePdfBrowserInfos ( )

virtual

Save the PDF browser choice to the common configuration.

Definition at line 44 of file eda_doc.cpp.

{
 GetCommonSettings()->m_System.pdf_viewer_name = GetPdfBrowserName();
 GetCommonSettings()->m_System.use_system_pdf_viewer = m_use_system_pdf_browser;
}

References GetCommonSettings(), GetPdfBrowserName(), COMMON_SETTINGS::m_System, m_use_system_pdf_browser, COMMON_SETTINGS::SYSTEM::pdf_viewer_name, and COMMON_SETTINGS::SYSTEM::use_system_pdf_viewer.

Member Data Documentation

m_argcUtf8

int PGM_BASE::m_argcUtf8

protected

argv parameters converted to utf8 form, because wxwidgets has opinions and will return argv as either force converted to ascii in char* or wchar_t only

Definition at line 360 of file pgm_base.h.

Referenced by BuildArgvUtf8(), PGM_BASE(), and ~PGM_BASE().

m_argvUtf8

char** PGM_BASE::m_argvUtf8

protected

Definition at line 357 of file pgm_base.h.

Referenced by BuildArgvUtf8(), PGM_BASE(), and ~PGM_BASE().

m_bin_dir

wxString PGM_BASE::m_bin_dir

protected

Definition at line 340 of file pgm_base.h.

Referenced by GetExecutablePath(), and setExecutablePath().

m_kicad_env

wxString PGM_BASE::m_kicad_env

protected

full path to this program

Definition at line 341 of file pgm_base.h.

Referenced by GetKicadEnvVariable(), InitPgm(), and IsKicadEnvVariableDefined().

m_language_id

int PGM_BASE::m_language_id

protected

Definition at line 344 of file pgm_base.h.

Referenced by GetLanguageTag(), GetSelectedLanguageIdentifier(), SetDefaultLanguage(), SetLanguage(), and setLanguageId().

m_locale

wxLocale* PGM_BASE::m_locale

protected

The KICAD system environment variable.

Definition at line 343 of file pgm_base.h.

Referenced by Destroy(), GetLocale(), PGM_BASE(), SetDefaultLanguage(), and SetLanguage().

m_ModalDialogs

std::vector<void*> PGM_BASE::m_ModalDialogs

Definition at line 311 of file pgm_base.h.

Referenced by APP_KICAD::FilterEvent(), and APP_KICAD_CLI::FilterEvent().

m_pdf_browser

wxString PGM_BASE::m_pdf_browser

protected

Definition at line 347 of file pgm_base.h.

Referenced by GetPdfBrowserName(), SetPdfBrowserName(), and UseSystemPdfBrowser().

m_Printing

bool PGM_BASE::m_Printing

wxWidgets on MSW tends to crash if you spool up more than one print job at a time.

Definition at line 309 of file pgm_base.h.

Referenced by BOARD::ComputeBoundingBox(), and PGM_BASE().

m_python_scripting

std::unique_ptr<SCRIPTING> PGM_BASE::m_python_scripting

protected

Definition at line 338 of file pgm_base.h.

Referenced by InitPgm().

m_Quitting

bool PGM_BASE::m_Quitting

Definition at line 313 of file pgm_base.h.

Referenced by PGM_BASE().

m_settings_manager

std::unique_ptr<SETTINGS_MANAGER> PGM_BASE::m_settings_manager

protected

Definition at line 336 of file pgm_base.h.

Referenced by GetCommonSettings(), GetSettingsManager(), InitPgm(), PGM_SINGLE_TOP::OnPgmExit(), and PGM_KICAD::OnPgmExit().

m_text_editor

wxString PGM_BASE::m_text_editor

protected

Filename of the app selected for browsing PDFs.

Definition at line 349 of file pgm_base.h.

Referenced by GetTextEditor(), loadCommonSettings(), and SetTextEditor().

m_use_system_pdf_browser

bool PGM_BASE::m_use_system_pdf_browser

protected

Definition at line 346 of file pgm_base.h.

Referenced by ForceSystemPdfBrowser(), ReadPdfBrowserInfos(), UseSystemPdfBrowser(), and WritePdfBrowserInfos().

workingDirKey

const wxChar PGM_BASE::workingDirKey[]

static

Definition at line 270 of file pgm_base.h.

---

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

• pgm_base.h
• eda_doc.cpp
• pgm_base.cpp