33#include <wx/html/htmlwin.h>
36#include <wx/filename.h>
38#include <wx/propgrid/propgrid.h>
39#include <wx/snglinst.h>
40#include <wx/stdpaths.h>
42#include <wx/filedlg.h>
44#include <wx/tooltip.h>
62#include <python_scripting.h>
75#include <python_manager.h>
103 wxT(
"Español (Latinoamericano)" ),
true },
118 wxT(
"Português (Brasil)" ),
true },
131 wxT(
"简体中文" ),
true },
133 wxT(
"繁體中文" ),
true },
137#define _(s) wxGetTranslation((s))
185 wxASSERT( wxTheApp );
203 if( !wxGetEnv( wxT(
"EDITOR" ), &editorname ) )
207 editorname = wxT(
"/usr/bin/open -e" );
209 editorname = wxT(
"/usr/bin/xdg-open" );
215 if( !editorname && aCanShowFileChooser )
224 if( !editorname.IsEmpty() )
237 wxString mask(
_(
"Executable file" ) + wxT(
" (*.exe)|*.exe" ) );
239 wxString mask(
_(
"Executable file" ) + wxT(
" (*)|*" ) );
245 wxFileName::SplitPath( aDefaultEditor, &
path, &
name, &ext );
249 return wxFileSelector(
_(
"Select Preferred Editor" ),
path,
name, wxT(
"." ) + ext,
250 mask, wxFD_OPEN | wxFD_FILE_MUST_EXIST,
nullptr );
254#ifdef KICAD_USE_SENTRY
255void PGM_BASE::sentryPrompt()
263 && !
m_settings_manager->GetCommonSettings()->m_DoNotShowAgain.data_collection_prompt )
265 wxMessageDialog optIn = wxMessageDialog(
267 _(
"KiCad can anonymously report crashes and special event data to developers in order to "
268 "aid identifying critical bugs and help profile functionality to guide improvements. \n"
269 "If you choose to voluntarily participate, KiCad will automatically send said reports "
270 "when crashes or events occur. \n"
271 "Your design files such as schematic and PCB are not shared in this process." ),
272 _(
"Data Collection Opt In" ), wxYES_NO | wxCENTRE );
274 optIn.SetYesNoLabels(
_(
"Opt In" ),
_(
"Decline" ) );
275 int result = optIn.ShowModal();
277 if( result == wxID_YES )
286 m_settings_manager->GetCommonSettings()->m_DoNotShowAgain.data_collection_prompt =
true;
294 const wxArrayString& argArray =
App().argv.GetArguments();
300 m_argvUtf8[n] = wxStrdup( argArray[n].ToUTF8() );
319 NULL, -1, wxDefaultPosition, wxDefaultSize,
320 wxBORDER_NONE | wxSTAY_ON_TOP );
339#if defined( __WXMAC__ )
360 if(
App().argc == 0 )
361 pgm_name = wxT(
"kicad" );
363 pgm_name = wxFileName(
App().argv[0] ).GetName().Lower();
367 wxInitAllImageHandlers();
371 wxPGInitResourceModule();
374 if( wxString( wxGetenv(
"HOME" ) ).IsEmpty() )
377 "Unable to continue." ) );
388 wxChmod( instanceCheckerDir,
389 wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | wxPOSIX_USER_EXECUTE |
390 wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | wxPOSIX_GROUP_EXECUTE |
391 wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE | wxPOSIX_OTHERS_EXECUTE );
393 wxString instanceCheckerName = wxString::Format( wxS(
"%s-%s" ), pgm_name,
397 m_pgm_checker->Create( instanceCheckerName, instanceCheckerDir );
402 bool isDefined = wxGetEnv( wxT(
"KICAD" ), &
m_kicad_env );
413 App().SetVendorName( wxT(
"KiCad" ) );
414 App().SetAppName( pgm_name );
417 if( wxImage::FindHandler( wxBITMAP_TYPE_PNG ) ==
nullptr )
418 wxImage::AddHandler(
new wxPNGHandler );
420 if( wxImage::FindHandler( wxBITMAP_TYPE_GIF ) ==
nullptr )
421 wxImage::AddHandler(
new wxGIFHandler );
423 if( wxImage::FindHandler( wxBITMAP_TYPE_JPEG ) ==
nullptr )
424 wxImage::AddHandler(
new wxJPEGHandler );
426 wxFileSystem::AddHandler(
new wxZipFSHandler );
434 if( !wxGetEnv(
"FONTCONFIG_PATH", NULL ) )
440 wxSetEnv(
"FONTCONFIG_PATH", PATHS::GetWindowsFontConfigDir() );
449 m_plugin_manager = std::make_unique<API_PLUGIN_MANAGER>( &
App() );
488#ifdef KICAD_USE_SENTRY
507 m_plugin_manager->ReloadPlugins();
514 wxToolTip::Enable(
true );
515 wxToolTip::SetAutoPop( 10000 );
533 for(
const std::pair<wxString, ENV_VAR_ITEM> it :
GetCommonSettings()->m_Env.vars )
535 wxLogTrace(
traceEnvVars, wxT(
"PGM_BASE::loadSettings: Found entry %s = %s" ),
536 it.first, it.second.GetValue() );
544 if( it.first.IsEmpty() )
548 if( it.second.GetDefinedExternally() )
596 wxString dictionaryName( wxT(
"kicad" ) );
605 wxLogTrace(
traceLocale, wxT(
"This language is not supported by the system." ) );
611 m_locale->Init( wxLANGUAGE_DEFAULT );
613 aErrMsg =
_(
"This language is not supported by the operating system." );
616 else if( !first_time )
618 wxLogTrace(
traceLocale, wxT(
"Search for dictionary %s.mo in %s" ) ,
619 dictionaryName,
m_locale->GetName() );
628 wxString languageSel;
646 if( !
m_locale->IsLoaded( dictionaryName ) )
647 m_locale->AddCatalog( dictionaryName );
655 wxLogTrace(
traceLocale, wxT(
"Unable to load dictionary %s.mo in %s" ),
656 dictionaryName,
m_locale->GetName() );
662 m_locale->Init( wxLANGUAGE_DEFAULT );
664 aErrMsg =
_(
"The KiCad language file for this language is not installed." );
680 wxString dictionaryName( wxT(
"kicad" ) );
687 if( !
m_locale->IsLoaded( dictionaryName ) )
688 m_locale->AddCatalog( dictionaryName );
696 wxLogTrace(
traceLocale, wxT(
"Unable to load dictionary %s.mo in %s" ),
697 dictionaryName,
m_locale->GetName() );
705 aErrMsg =
_(
"The KiCad language file for this language is not installed." );
715 wxLogTrace(
traceLocale, wxT(
"Select language ID %d from %d possible languages." ),
731 const wxLanguageInfo* langInfo = wxLocale::GetLanguageInfo(
m_language_id );
739 wxString str = langInfo->GetCanonicalWithRegion();
740 str.Replace(
"_",
"-" );
750 wxLocale::AddCatalogLookupPathPrefix( PATHS::GetWindowsBaseSharePath() + wxT(
"locale" ) );
754 if( wxGetEnv( wxT(
"KICAD_RUN_FROM_BUILD_DIR" ),
nullptr ) )
758 fn.AppendDir( wxT(
"translation" ) );
759 wxLocale::AddCatalogLookupPathPrefix( fn.GetPath() );
768 if( aName.IsEmpty() )
771 wxT(
"PGM_BASE::SetLocalEnvVariable: Attempt to set empty variable to "
778 if( wxGetEnv( aName, &env ) )
781 wxT(
"PGM_BASE::SetLocalEnvVariable: Environment variable %s already set "
784 return env == aValue;
788 wxT(
"PGM_BASE::SetLocalEnvVariable: Setting local environment variable %s to %s" ),
791 return wxSetEnv( aName, aValue );
799 for(
const std::pair<wxString, ENV_VAR_ITEM> m_local_env_var :
GetCommonSettings()->m_Env.vars )
802 wxT(
"PGM_BASE::SetLocalEnvVariables: Setting local environment variable %s "
804 m_local_env_var.first,
805 m_local_env_var.second.GetValue() );
806 wxSetEnv( m_local_env_var.first, m_local_env_var.second.GetValue() );
822 return wxTheApp->IsGUI();
831 std::rethrow_exception( aPtr );
835 wxLogError( ioe.
What() );
837 catch(
const std::exception& e )
841 wxLogError( wxT(
"Unhandled exception class: %s what: %s" ),
846 wxLogError( wxT(
"Unhandled exception of unknown type" ) );
852 const wxString& aCond,
const wxString& aMsg )
859 assertStr = wxString::Format(
"Assertion failed at %s:%d in %s: %s - %s", aFile, aLine,
860 aFunc, aCond, aMsg );
864 assertStr = wxString::Format(
"Assertion failed at %s:%d in %s: %s", aFile, aLine, aFunc,
869 wxLogError( assertStr );
872#ifdef KICAD_USE_SENTRY
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
void LogAssert(const ASSERT_CACHE_KEY &aKey, const wxString &aMsg)
void SetSentryOptIn(bool aOptIn)
void LogException(const wxString &aMsg)
void AddTag(const wxString &aKey, const wxString &aValue)
static SENTRY * Instance()
void InitializeEnvironment()
Creates the built-in environment variables and sets their default values.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
Calls Store() and then writes the contents of the JSON document to a file.
static void Cleanup()
Call curl_global_cleanup for the application.
static void Init()
Call curl_global_init for the application.
void Load()
Load notifications stored from disk.
static wxString GetInstanceCheckerPath()
Gets the path used for wxSingleInstanceChecker lock files.
static void EnsureUserPathsExist()
Ensures/creates user default paths.
static bool EnsurePathExists(const wxString &aPath, bool aPathToFile=false)
Attempts to create a given path if it does not exist.
static wxString GetLocaleDataPath()
Gets the locales translation data path.
static const wxString & GetExecutablePath()
Container for data for KiCad programs.
virtual COMMON_SETTINGS * GetCommonSettings() const
virtual wxApp & App()
Return a bare naked wxApp which may come from wxPython, SINGLE_TOP, or kicad.exe.
std::unique_ptr< NOTIFICATIONS_MANAGER > m_notifications_manager
virtual ENV_VAR_MAP & GetLocalEnvVariables() const
bool m_Printing
wxWidgets on MSW tends to crash if you spool up more than one print job at a time.
void setLanguageId(int aId)
Trap all changes in here, simplifies debugging.
std::unique_ptr< SETTINGS_MANAGER > m_settings_manager
void loadCommonSettings()
Load internal settings from COMMON_SETTINGS.
virtual void SetPdfBrowserName(const wxString &aFileName)
wxSplashScreen * m_splash
bool InitPgm(bool aHeadless=false, bool aSkipPyInit=false, bool aIsUnitTest=false)
Initialize this program.
char ** m_argvUtf8
argv parameters converted to utf8 form because wxWidgets has opinions.
virtual void ReadPdfBrowserInfos()
Read the PDF browser choice from the common configuration.
bool IsGUI()
Determine if the application is running with a GUI.
bool m_use_system_pdf_browser
virtual NOTIFICATIONS_MANAGER & GetNotificationsManager() const
void BuildArgvUtf8()
Builds the UTF8 based argv variable.
virtual const wxString & GetPdfBrowserName() const
virtual void SetTextEditor(const wxString &aFileName)
std::unique_ptr< wxSingleInstanceChecker > m_pgm_checker
Check if there is another copy of Kicad running at the same time.
virtual bool SetLocalEnvVariable(const wxString &aName, const wxString &aValue)
Set the environment variable aName to aValue.
wxString m_kicad_env
The KICAD system environment variable.
virtual void ForceSystemPdfBrowser(bool aFlg)
Force the use of system PDF browser, even if a preferred PDF browser is set.
virtual void SetLocalEnvVariables()
Update the local environment with the contents of the current ENV_VAR_MAP stored in the COMMON_SETTIN...
virtual void SetLanguagePath()
bool SetDefaultLanguage(wxString &aErrMsg)
Set the default language without reference to any preferences.
std::unique_ptr< SCRIPTING > m_python_scripting
virtual void SetLanguageIdentifier(int menu_id)
Set in .m_language_id member the wxWidgets language identifier ID from the KiCad menu id (internal me...
std::unique_ptr< BACKGROUND_JOBS_MONITOR > m_background_jobs_monitor
void HandleException(std::exception_ptr aPtr)
A exception handler to be used at the top level if exceptions bubble up that for.
void HandleAssert(const wxString &aFile, int aLine, const wxString &aFunc, const wxString &aCond, const wxString &aMsg)
A common assert handler to be used between single_top and kicad.
virtual wxString GetLanguageTag()
virtual const wxString & GetTextEditor(bool aCanShowFileChooser=true)
Return the path to the preferred text editor application.
virtual const wxString & GetExecutablePath() const
virtual SETTINGS_MANAGER & GetSettingsManager() const
virtual void WritePdfBrowserInfos()
Save the PDF browser choice to the common configuration.
void SaveCommonSettings()
Save the program (process) settings subset which are stored .kicad_common.
bool m_PropertyGridInitialized
KICAD_SINGLETON m_singleton
virtual const wxString AskUserForPreferredEditor(const wxString &aDefaultEditor=wxEmptyString)
Show a dialog that instructs the user to select a new preferred editor.
virtual bool SetLanguage(wxString &aErrMsg, bool first_time=false)
Set the dictionary file name for internationalization.
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Load a project or sets up a new project with a specified path.
bool WarnUserIfOperatingSystemUnsupported()
Checks if the operating system is explicitly unsupported and displays a disclaimer message box.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
#define WIN_STRING_DIR_SEP
#define UNIX_STRING_DIR_SEP
const wxChar *const traceLocale
Flag to enable locale debug output.
const wxChar *const traceEnvVars
Flag to enable debug output of environment variable operations.
@ ID_LANGUAGE_NORWEGIAN_BOKMAL
@ ID_LANGUAGE_CHINESE_SIMPLIFIED
@ ID_LANGUAGE_PORTUGUESE_BRAZILIAN
@ ID_LANGUAGE_SPANISH_MEXICAN
@ ID_LANGUAGE_CHINESE_TRADITIONAL
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
This file contains miscellaneous commonly used macros and functions.
void SetPgm(PGM_BASE *pgm)
static PGM_BASE * process
PGM_BASE & Pgm()
The global program "get" accessor.
PGM_BASE * PgmOrNull()
Return a reference that can be nullptr when running a shared lib from a script, not from a kicad app.
LANGUAGE_DESCR LanguagesList[]
An array containing all the languages that KiCad supports.
#define _(s)
Current list of languages supported by KiCad.
KICOMMON_API LANGUAGE_DESCR LanguagesList[]
An array containing all the languages that KiCad supports.
KICOMMON_API PGM_BASE & Pgm()
The global program "get" accessor.
#define POLICY_KEY_DATACOLLECTION
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
APIIMPORT wxPGGlobalVarsClass * wxPGGlobalVars
wxString From_UTF8(const char *cstring)
This struct represents a key being used for the std::set that deduplicates asserts during this runnin...
wxString python_interpreter
bool use_system_pdf_viewer
A small class to handle the list of existing translations.
int m_KI_Lang_Identifier
KiCad identifier used in menu selection (See id.h)
wxString m_Lang_Label
Labels used in menus.
System directories search utilities.
wxLogTrace helper definitions.