KiCad PCB EDA Suite
pgm_base.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2004-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2008-2015 Wayne Stambaugh <stambaughw@verizon.net>
6  * Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
33 #include <fctsys.h>
34 #include <wx/html/htmlwin.h>
35 #include <wx/fs_zip.h>
36 #include <wx/dir.h>
37 #include <wx/filename.h>
38 #include <wx/snglinst.h>
39 #include <wx/stdpaths.h>
40 #include <wx/sysopt.h>
41 #include <wx/richmsgdlg.h>
42 
43 #include <pgm_base.h>
44 #include <wxstruct.h>
45 #include <macros.h>
46 #include <config_params.h>
47 #include <id.h>
48 #include <build_version.h>
49 #include <hotkeys_basic.h>
50 #include <gestfich.h>
51 #include <menus_helpers.h>
52 #include <confirm.h>
53 #include <dialog_env_var_config.h>
54 #include <lockfile.h>
55 #include <systemdirsappend.h>
56 
57 
58 #define KICAD_COMMON wxT( "kicad_common" )
59 
60 // some key strings used to store parameters in KICAD_COMMON
61 
62 const wxChar PGM_BASE::workingDirKey[] = wxT( "WorkingDir" ); // public
63 
64 static const wxChar languageCfgKey[] = wxT( "LanguageID" );
65 static const wxChar pathEnvVariables[] = wxT( "EnvironmentVariables" );
66 static const wxChar showEnvVarWarningDialog[] = wxT( "ShowEnvVarWarningDialog" );
67 static const wxChar traceEnvVars[] = wxT( "KIENVVARS" );
69 static const wxChar entryUseIconsInMenus[] = wxT( "UseIconsInMenus" );
70 
71 
81 {
84 
87 
90 
92  wxString m_Lang_Label;
93 
96 };
97 
98 
106 {
107  // Default language
108  {
109  wxLANGUAGE_DEFAULT,
111  lang_def_xpm,
112  _( "Default" )
113  },
114 
115  // English language
116  {
117  wxLANGUAGE_ENGLISH,
119  lang_en_xpm,
120  wxT( "English" ),
121  true
122  },
123 
124  // French language
125  {
126  wxLANGUAGE_FRENCH,
128  lang_fr_xpm,
129  _( "French" )
130  },
131 
132  // Finnish language
133  {
134  wxLANGUAGE_FINNISH,
136  lang_fi_xpm,
137  _( "Finnish" )
138  },
139 
140  // Spanish language
141  {
142  wxLANGUAGE_SPANISH,
144  lang_es_xpm,
145  _( "Spanish" )
146  },
147 
148  // Portuguese language
149  {
150  wxLANGUAGE_PORTUGUESE,
152  lang_pt_xpm,
153  _( "Portuguese" )
154  },
155 
156  // Italian language
157  {
158  wxLANGUAGE_ITALIAN,
160  lang_it_xpm,
161  _( "Italian" )
162  },
163 
164  // German language
165  {
166  wxLANGUAGE_GERMAN,
168  lang_de_xpm,
169  _( "German" )
170  },
171 
172  // Greek language
173  {
174  wxLANGUAGE_GREEK,
176  lang_gr_xpm,
177  _( "Greek" )
178  },
179 
180  // Slovenian language
181  {
182  wxLANGUAGE_SLOVENIAN,
184  lang_sl_xpm,
185  _( "Slovenian" )
186  },
187 
188  // Slovenian language
189  {
190  wxLANGUAGE_SLOVAK,
192  lang_sk_xpm,
193  _( "Slovak" )
194  },
195 
196  // Hungarian language
197  {
198  wxLANGUAGE_HUNGARIAN,
200  lang_hu_xpm,
201  _( "Hungarian" )
202  },
203 
204  // Polish language
205  {
206  wxLANGUAGE_POLISH,
208  lang_pl_xpm,
209  _( "Polish" )
210  },
211 
212  // Czech language
213  {
214  wxLANGUAGE_CZECH,
216  lang_cs_xpm,
217  _( "Czech" )
218  },
219 
220  // Russian language
221  {
222  wxLANGUAGE_RUSSIAN,
224  lang_ru_xpm,
225  _( "Russian" )
226  },
227 
228  // Korean language
229  {
230  wxLANGUAGE_KOREAN,
232  lang_ko_xpm,
233  _( "Korean" )
234  },
235 
236  // Chinese simplified
237  {
238  wxLANGUAGE_CHINESE_SIMPLIFIED,
240  lang_chinese_xpm,
241  _( "Chinese simplified" )
242  },
243 
244  // Catalan language
245  {
246  wxLANGUAGE_CATALAN,
248  lang_catalan_xpm,
249  _( "Catalan" )
250  },
251 
252  // Dutch language
253  {
254  wxLANGUAGE_DUTCH,
256  lang_nl_xpm,
257  _( "Dutch" )
258  },
259 
260  // Japanese language
261  {
262  wxLANGUAGE_JAPANESE,
264  lang_jp_xpm,
265  _( "Japanese" )
266  },
267 
268  // Bulgarian language
269  {
270  wxLANGUAGE_BULGARIAN,
272  lang_bg_xpm,
273  _( "Bulgarian" )
274  },
275 
276  // Lithuanian language
277  {
278  wxLANGUAGE_LITHUANIAN,
280  lang_lt_xpm,
281  _( "Lithuanian" )
282  }
283 };
284 
285 
287 {
288  m_pgm_checker = NULL;
289  m_locale = NULL;
290  m_common_settings = NULL;
291  m_iconsScale = 1.0;
292  m_useIconsInMenus = true; // will be set later after reading the config
293 
294  m_show_env_var_dialog = true;
295 
296  setLanguageId( wxLANGUAGE_DEFAULT );
297 
298  ForceSystemPdfBrowser( false );
299 }
300 
301 
303 {
304  Destroy();
305 }
306 
307 
309 {
310  // unlike a normal destructor, this is designed to be called more than once safely:
311 
312  delete m_common_settings;
313  m_common_settings = 0;
314 
315  delete m_pgm_checker;
316  m_pgm_checker = 0;
317 
318  delete m_locale;
319  m_locale = 0;
320 }
321 
322 
324 {
325  wxASSERT( wxTheApp );
326  return *wxTheApp;
327 }
328 
329 
330 void PGM_BASE::SetEditorName( const wxString& aFileName )
331 {
332  m_editor_name = aFileName;
333  wxASSERT( m_common_settings );
334  m_common_settings->Write( wxT( "Editor" ), aFileName );
335 }
336 
337 
338 const wxString& PGM_BASE::GetEditorName( bool aCanShowFileChooser )
339 {
340  wxString editorname = m_editor_name;
341 
342  if( !editorname )
343  {
344  if( !wxGetEnv( wxT( "EDITOR" ), &editorname ) )
345  {
346  // If there is no EDITOR variable set, try the desktop default
347 #ifdef __WXMAC__
348  editorname = "/usr/bin/open";
349 #elif __WXX11__
350  editorname = "/usr/bin/xdg-open";
351 #endif
352  }
353  }
354 
355  // If we still don't have an editor name show a dialog asking the user to select one
356  if( !editorname && aCanShowFileChooser )
357  {
358  DisplayInfoMessage( NULL,
359  _( "No default editor found, you must choose it" ) );
360 
361  editorname = AskUserForPreferredEditor();
362  }
363 
364  // If we finally have a new editor name request it to be copied to m_editor_name and
365  // saved to the preferences file.
366  if( !editorname.IsEmpty() )
367  SetEditorName( editorname );
368 
369  // m_editor_name already has the same value that editorname, or empty if no editor was
370  // found/chosen.
371  return m_editor_name;
372 }
373 
374 
375 const wxString PGM_BASE::AskUserForPreferredEditor( const wxString& aDefaultEditor )
376 {
377  // Create a mask representing the executable files in the current platform
378 #ifdef __WINDOWS__
379  wxString mask( _( "Executable file (*.exe)|*.exe" ) );
380 #else
381  wxString mask( _( "Executable file (*)|*" ) );
382 #endif
383 
384  // Extract the path, name and extension from the default editor (even if the editor's
385  // name was empty, this method will succeed and return empty strings).
386  wxString path, name, ext;
387  wxFileName::SplitPath( aDefaultEditor, &path, &name, &ext );
388 
389  // Show the modal editor and return the file chosen (may be empty if the user cancels
390  // the dialog).
391  return EDA_FILE_SELECTOR( _( "Select Preferred Editor" ), path,
392  name, ext, mask,
393  NULL, wxFD_OPEN | wxFD_FILE_MUST_EXIST,
394  true );
395 }
396 
397 
399 {
400  wxFileName pgm_name( App().argv[0] );
401 
402  wxConfigBase::DontCreateOnDemand();
403 
404  wxInitAllImageHandlers();
405 
406  m_pgm_checker = new wxSingleInstanceChecker( pgm_name.GetName().Lower() + wxT( "-" ) +
407  wxGetUserId(), GetKicadLockFilePath() );
408 
409  if( m_pgm_checker->IsAnotherRunning() )
410  {
411  wxString quiz = wxString::Format(
412  _( "%s is already running, Continue?" ),
413  GetChars( pgm_name.GetName() )
414  );
415 
416  if( !IsOK( NULL, quiz ) )
417  return false;
418  }
419 
420  // Init KiCad environment
421  // the environment variable KICAD (if exists) gives the kicad path:
422  // something like set KICAD=d:\kicad
423  bool isDefined = wxGetEnv( wxT( "KICAD" ), &m_kicad_env );
424 
425  if( isDefined ) // ensure m_kicad_env ends by "/"
426  {
428 
429  if( !m_kicad_env.IsEmpty() && m_kicad_env.Last() != '/' )
431  }
432 
433  // Init parameters for configuration
434  App().SetVendorName( wxT( "KiCad" ) );
435  App().SetAppName( pgm_name.GetName().Lower() );
436 
437  // Install some image handlers, mainly for help
438  if( wxImage::FindHandler( wxBITMAP_TYPE_PNG ) == NULL )
439  wxImage::AddHandler( new wxPNGHandler );
440 
441  if( wxImage::FindHandler( wxBITMAP_TYPE_GIF ) == NULL )
442  wxImage::AddHandler( new wxGIFHandler );
443 
444  if( wxImage::FindHandler( wxBITMAP_TYPE_JPEG ) == NULL )
445  wxImage::AddHandler( new wxJPEGHandler );
446 
447  wxFileSystem::AddHandler( new wxZipFSHandler );
448 
449  // Analyze the command line & initialize the binary path
451 
452  SetLanguagePath();
453 
454  // OS specific instantiation of wxConfigBase derivative:
456 
457  wxString envVarName = wxT( "KIGITHUB" );
458  ENV_VAR_ITEM envVarItem;
459  wxString envValue;
460  wxFileName tmpFileName;
461 
462  if( wxGetEnv( envVarName, &envValue ) == true && !envValue.IsEmpty() )
463  {
464  tmpFileName.AssignDir( envValue );
465  envVarItem.SetDefinedExternally( true );
466  }
467  else
468  {
469  envVarItem.SetValue( wxString( wxT( "https://github.com/KiCad" ) ) );
470  envVarItem.SetDefinedExternally( false );
471  }
472 
473  m_local_env_vars[ envVarName ] = envVarItem;
474 
475  wxFileName baseSharePath;
476  baseSharePath.AssignDir( wxString( wxT( DEFAULT_INSTALL_PATH ) ) );
477 
478 #if !defined( __WXMAC__ )
479  baseSharePath.AppendDir( wxT( "share" ) );
480  baseSharePath.AppendDir( wxT( "kicad" ) );
481 #endif
482 
483  // KISYSMOD
484  envVarName = wxT( "KISYSMOD" );
485  if( wxGetEnv( envVarName, &envValue ) == true && !envValue.IsEmpty() )
486  {
487  tmpFileName.AssignDir( envValue );
488  envVarItem.SetDefinedExternally( true );
489  }
490  else
491  {
492  tmpFileName = baseSharePath;
493  tmpFileName.AppendDir( wxT( "modules" ) );
494  envVarItem.SetDefinedExternally( false );
495  }
496  envVarItem.SetValue( tmpFileName.GetFullPath() );
497  m_local_env_vars[ envVarName ] = envVarItem;
498 
499  // KISYS3DMOD
500  envVarName = wxT( "KISYS3DMOD" );
501  if( wxGetEnv( envVarName, &envValue ) == true && !envValue.IsEmpty() )
502  {
503  tmpFileName.AssignDir( envValue );
504  envVarItem.SetDefinedExternally( true );
505  }
506  else
507  {
508  tmpFileName.AppendDir( wxT( "packages3d" ) );
509  envVarItem.SetDefinedExternally( false );
510  }
511  envVarItem.SetValue( tmpFileName.GetFullPath() );
512  m_local_env_vars[ envVarName ] = envVarItem;
513 
514  // KICAD_PTEMPLATES
515  envVarName = wxT( "KICAD_PTEMPLATES" );
516  if( wxGetEnv( envVarName, &envValue ) == true && !envValue.IsEmpty() )
517  {
518  tmpFileName.AssignDir( envValue );
519  envVarItem.SetDefinedExternally( true );
520  }
521  else
522  {
523  tmpFileName = baseSharePath;
524  tmpFileName.AppendDir( wxT( "template" ) );
525  envVarItem.SetDefinedExternally( false );
526  }
527  envVarItem.SetValue( tmpFileName.GetFullPath() );
528  m_local_env_vars[ envVarName ] = envVarItem;
529 
530  // KICAD_SYMBOLS
531  envVarName = wxT( "KICAD_SYMBOL_DIR" );
532  if( wxGetEnv( envVarName, &envValue ) == true && !envValue.IsEmpty() )
533  {
534  tmpFileName.AssignDir( envValue );
535  envVarItem.SetDefinedExternally( true );
536  }
537  else
538  {
539  tmpFileName = baseSharePath;
540  tmpFileName.AppendDir( wxT( "library" ) );
541  envVarItem.SetDefinedExternally( false );
542  }
543  envVarItem.SetValue( tmpFileName.GetFullPath() );
544  m_local_env_vars[ envVarName ] = envVarItem;
545 
546  ReadPdfBrowserInfos(); // needs m_common_settings
547 
548  // Init user language *before* calling loadCommonSettings, because
549  // env vars could be incorrectly initialized on Linux
550  // (if the value contains some non ASCII7 chars, the env var is not initialized)
551  SetLanguage( true );
552 
554 
555 #ifdef __WXMAC__
556  // Always show filters on Open dialog to be able to choose plugin
557  wxSystemOptions::SetOption( wxOSX_FILEDIALOG_ALWAYS_SHOW_TYPES, 1 );
558 #endif
559 
560  return true;
561 }
562 
563 
565 {
566  m_bin_dir = wxStandardPaths::Get().GetExecutablePath();
567 
568 #ifdef __WXMAC__
569  // On OSX Pgm().GetExecutablePath() will always point to main
570  // bundle directory, e.g., /Applications/kicad.app/
571 
572  wxFileName fn( m_bin_dir );
573 
574  if( fn.GetName() == wxT( "kicad" ) )
575  {
576  // kicad launcher, so just remove the Contents/MacOS part
577  fn.RemoveLastDir();
578  fn.RemoveLastDir();
579  }
580  else
581  {
582  // standalone binaries live in Contents/Applications/<standalone>.app/Contents/MacOS
583  fn.RemoveLastDir();
584  fn.RemoveLastDir();
585  fn.RemoveLastDir();
586  fn.RemoveLastDir();
587  fn.RemoveLastDir();
588  }
589 
590  m_bin_dir = fn.GetPath() + wxT( "/" );
591 #else
592  // Use unix notation for paths. I am not sure this is a good idea,
593  // but it simplifies compatibility between Windows and Unices.
594  // However it is a potential problem in path handling under Windows.
596 
597  // Remove file name form command line:
598  while( m_bin_dir.Last() != '/' && !m_bin_dir.IsEmpty() )
599  m_bin_dir.RemoveLast();
600 #endif
601 
602  return true;
603 }
604 
605 
607 {
608  wxASSERT( m_common_settings );
609 
610  m_help_size.x = 500;
611  m_help_size.y = 400;
612  m_iconsScale = 1.0;
613 
614 #if defined( __WXMAC__ )
615  m_useIconsInMenus = false;
616 #else
617  m_useIconsInMenus = true;
618 #endif
619 
622 
623  m_editor_name = m_common_settings->Read( wxT( "Editor" ) );
624 
625  wxString entry, oldPath;
626  wxArrayString entries;
627  long index = 0L;
628 
629  oldPath = m_common_settings->GetPath();
631 
632  while( m_common_settings->GetNextEntry( entry, index ) )
633  {
634  wxLogTrace( traceEnvVars,
635  wxT( "Enumerating over entry %s, %ld." ), GetChars( entry ), index );
636  entries.Add( entry );
637  }
638 
639  for( unsigned i = 0; i < entries.GetCount(); i++ )
640  {
641  wxString val = m_common_settings->Read( entries[i], wxEmptyString );
642  m_local_env_vars[ entries[i] ] = ENV_VAR_ITEM( val, wxGetEnv( entries[i], NULL ) );
643  }
644 
645  for( ENV_VAR_MAP_ITER it = m_local_env_vars.begin(); it != m_local_env_vars.end(); ++it )
646  SetLocalEnvVariable( it->first, it->second.GetValue() );
647 
648  m_common_settings->SetPath( oldPath );
649 }
650 
651 
653 {
654  // m_common_settings is not initialized until fairly late in the
655  // process startup: InitPgm(), so test before using:
656  if( m_common_settings )
657  {
658  wxString cur_dir = wxGetCwd();
659 
660  m_common_settings->Write( workingDirKey, cur_dir );
663 
664  // Save the local environment variables.
666 
667  for( ENV_VAR_MAP_ITER it = m_local_env_vars.begin(); it != m_local_env_vars.end(); ++it )
668  {
669  wxLogTrace( traceEnvVars, wxT( "Saving environment variable config entry %s as %s" ),
670  GetChars( it->first ), GetChars( it->second.GetValue() ) );
671  m_common_settings->Write( it->first, it->second.GetValue() );
672  }
673 
674  m_common_settings->SetPath( wxT( ".." ) );
675  }
676 }
677 
678 
679 bool PGM_BASE::SetLanguage( bool first_time )
680 {
681  bool retv = true;
682 
683  if( first_time )
684  {
685  setLanguageId( wxLANGUAGE_DEFAULT );
686  // First time SetLanguage is called, the user selected language id is set
687  // from commun user config settings
688  wxString languageSel;
689 
690  m_common_settings->Read( languageCfgKey, &languageSel );
691 
692  // Search for the current selection
693  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
694  {
695  if( s_Languages[ii].m_Lang_Label == languageSel )
696  {
697  setLanguageId( s_Languages[ii].m_WX_Lang_Identifier );
698  break;
699  }
700  }
701  }
702 
703  // dictionary file name without extend (full name is kicad.mo)
704  wxString dictionaryName( wxT( "kicad" ) );
705 
706  delete m_locale;
707  m_locale = new wxLocale;
708 
709  if( !m_locale->Init( m_language_id ) )
710  {
711  wxLogDebug( wxT( "This language is not supported by the system." ) );
712 
713  setLanguageId( wxLANGUAGE_DEFAULT );
714  delete m_locale;
715 
716  m_locale = new wxLocale;
717  m_locale->Init();
718  retv = false;
719  }
720  else if( !first_time )
721  {
722  wxLogDebug( wxT( "Search for dictionary %s.mo in %s" ),
723  GetChars( dictionaryName ), GetChars( m_locale->GetName() ) );
724  }
725 
726  if( !first_time )
727  {
728  // If we are here, the user has selected an other language.
729  // Therefore the new prefered language name is stored in common config.
730  // Do NOT store the wxWidgets language Id, it can change between wxWidgets
731  // versions, for a given language
732  wxString languageSel;
733 
734  // Search for the current selection language name
735  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
736  {
737  if( s_Languages[ii].m_WX_Lang_Identifier == m_language_id )
738  {
739  languageSel = s_Languages[ii].m_Lang_Label;
740  break;
741  }
742  }
743 
744  m_common_settings->Write( languageCfgKey, languageSel );
745  }
746 
747  // Test if floating point notation is working (bug encountered in cross compilation)
748  // Make a conversion double <=> string
749  double dtst = 0.5;
750  wxString msg;
751 
752  msg << dtst;
753  double result;
754  msg.ToDouble( &result );
755 
756  if( result != dtst )
757  // string to double encode/decode does not work! Bug detected:
758  // Disable floating point localization:
759  setlocale( LC_ALL, "C" );
760 
761  if( !m_locale->IsLoaded( dictionaryName ) )
762  m_locale->AddCatalog( dictionaryName );
763 
764  if( !retv )
765  return retv;
766 
767  return m_locale->IsOk();
768 }
769 
770 
772 {
773  wxLogDebug( wxT( "Select language ID %d from %d possible languages." ),
774  menu_id, DIM( s_Languages ) );
775 
776  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
777  {
778  if( menu_id == s_Languages[ii].m_KI_Lang_Identifier )
779  {
780  setLanguageId( s_Languages[ii].m_WX_Lang_Identifier );
781  break;
782  }
783  }
784 }
785 
786 
788 {
789  SEARCH_STACK guesses;
790 
791  SystemDirsAppend( &guesses );
792 
793  // Add our internat dir to the wxLocale catalog of paths
794  for( unsigned i = 0; i < guesses.GetCount(); i++ )
795  {
796  wxFileName fn( guesses[i], wxEmptyString );
797 
798  // Append path for Windows and unix KiCad package install
799  fn.AppendDir( wxT( "share" ) );
800  fn.AppendDir( wxT( "internat" ) );
801 
802  if( fn.IsDirReadable() )
803  {
804  wxLogDebug( wxT( "Adding locale lookup path: " ) + fn.GetPath() );
805  wxLocale::AddCatalogLookupPathPrefix( fn.GetPath() );
806  }
807 
808  // Append path for unix standard install
809  fn.RemoveLastDir();
810  fn.AppendDir( wxT( "kicad" ) );
811  fn.AppendDir( wxT( "internat" ) );
812 
813  if( fn.IsDirReadable() )
814  {
815  wxLogDebug( wxT( "Adding locale lookup path: " ) + fn.GetPath() );
816  wxLocale::AddCatalogLookupPathPrefix( fn.GetPath() );
817  }
818  }
819 }
820 
821 
822 void PGM_BASE::AddMenuLanguageList( wxMenu* MasterMenu )
823 {
824  wxMenu* menu = NULL;
825  wxMenuItem* item = MasterMenu->FindItem( ID_LANGUAGE_CHOICE );
826 
827  if( item ) // This menu exists, do nothing
828  return;
829 
830  menu = new wxMenu;
831 
832  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
833  {
834  wxString label;
835 
836  if( s_Languages[ii].m_DoNotTranslate )
837  label = s_Languages[ii].m_Lang_Label;
838  else
839  label = wxGetTranslation( s_Languages[ii].m_Lang_Label );
840 
841  AddMenuItem( menu, s_Languages[ii].m_KI_Lang_Identifier,
842  label, KiBitmap(s_Languages[ii].m_Lang_Icon ),
843  wxITEM_CHECK );
844  }
845 
846  AddMenuItem( MasterMenu, menu,
848  _( "Set Language" ),
849  _( "Select application language (only for testing)" ),
850  KiBitmap( language_xpm ) );
851 
852  // Set Check mark on current selected language
853  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
854  {
855  if( m_language_id == s_Languages[ii].m_WX_Lang_Identifier )
856  menu->Check( s_Languages[ii].m_KI_Lang_Identifier, true );
857  else
858  menu->Check( s_Languages[ii].m_KI_Lang_Identifier, false );
859  }
860 }
861 
862 
863 bool PGM_BASE::SetLocalEnvVariable( const wxString& aName, const wxString& aValue )
864 {
865  wxString env;
866 
867  // Check to see if the environment variable is already set.
868  if( wxGetEnv( aName, &env ) )
869  {
870  wxLogTrace( traceEnvVars, wxT( "Environment variable %s already set to %s." ),
871  GetChars( aName ), GetChars( env ) );
872  return env == aValue;
873  }
874 
875  wxLogTrace( traceEnvVars, wxT( "Setting local environment variable %s to %s." ),
876  GetChars( aName ), GetChars( aValue ) );
877 
878  return wxSetEnv( aName, aValue );
879 }
880 
881 
883 {
884  m_local_env_vars.clear();
885  m_local_env_vars = aEnvVarMap;
886 
887  if( m_common_settings )
888  m_common_settings->DeleteGroup( pathEnvVariables );
889 
891 
892  // Overwrites externally defined environment variable until the next time the application
893  // is run.
894  for( ENV_VAR_MAP_ITER it = m_local_env_vars.begin(); it != m_local_env_vars.end(); ++it )
895  {
896  wxLogTrace( traceEnvVars, wxT( "Setting local environment variable %s to %s." ),
897  GetChars( it->first ), GetChars( it->second.GetValue() ) );
898  wxSetEnv( it->first, it->second.GetValue() );
899  }
900 }
901 
902 
903 void PGM_BASE::ConfigurePaths( wxWindow* aParent )
904 {
905  DIALOG_ENV_VAR_CONFIG dlg_envvars( aParent, GetLocalEnvVariables() );
906 
907  if( dlg_envvars.ShowModal() == wxID_CANCEL )
908  return;
909 
910  ENV_VAR_MAP envVarMap = dlg_envvars.GetEnvVarMap();
911 
912  for( ENV_VAR_MAP_ITER it = envVarMap.begin(); it != envVarMap.end(); ++it )
913  {
914  wxLogTrace( traceEnvVars, wxT( "Environment variable %s=%s defined externally = %d" ),
915  GetChars( it->first ), GetChars( it->second.GetValue() ),
916  it->second.GetDefinedExternally() );
917  }
918 
919  // If any of the environment variables are defined externally, warn the user that the
920  // next time kicad is run that the externally defined variables will be used instead of
921  // the user's settings. This is by design.
922  if( dlg_envvars.ExternalDefsChanged() && m_show_env_var_dialog )
923  {
924  wxString msg1 = _( "Warning! Some of paths you have configured have been defined \n"
925  "externally to the running process and will be temporarily overwritten." );
926  wxString msg2 = _( "The next time KiCad is launched, any paths that have already\n"
927  "been defined are honored and any settings defined in the path\n"
928  "configuration dialog are ignored. If you did not intend for this\n"
929  "behavior, either rename any conflicting entries or remove the\n"
930  "external environment variable definition(s) from your system." );
931  wxRichMessageDialog dlg( aParent, msg1, _( "Warning" ), wxOK | wxCENTRE );
932  dlg.ShowDetailedText( msg2 );
933  dlg.ShowCheckBox( _( "Do not show this message again." ) );
934  dlg.ShowModal();
935  m_show_env_var_dialog = !dlg.IsCheckBoxChecked();
936  }
937 
938  SetLocalEnvVariables( dlg_envvars.GetEnvVarMap() );
939 }
static const wxChar pathEnvVariables[]
Definition: pgm_base.cpp:65
void loadCommonSettings()
Function loadCommonSettings loads the program (process) settings subset which are stored in ...
Definition: pgm_base.cpp:606
#define DIM(x)
of elements in an array
Definition: macros.h:98
wxString GetKicadLockFilePath()
Function GetKicadLockFilePath.
Definition: lockfile.cpp:59
#define WIN_STRING_DIR_SEP
Definition: gestfich.h:44
VTBL_ENTRY void SetEditorName(const wxString &aFileName)
Definition: pgm_base.cpp:330
virtual ~PGM_BASE()
Definition: pgm_base.cpp:302
PNG memory record (file in memory).
Definition: bitmap_types.h:38
This file is part of the common library TODO brief description.
ENV_VAR_MAP m_local_env_vars
Local environment variable expansion settings such as KIGITHUB, KISYSMOD, and KISYS3DMOD.
Definition: pgm_base.h:382
This file is part of the common library.
void SaveCommonSettings()
Function saveCommonSettings saves the program (process) settings subset which are stored ...
Definition: pgm_base.cpp:652
wxMenuItem * AddMenuItem(wxMenu *aMenu, int aId, const wxString &aText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
Function AddMenuItem is an inline helper function to create and insert a menu item with an icon into ...
Definition: bitmap.cpp:55
#define UNIX_STRING_DIR_SEP
Definition: gestfich.h:43
wxLocale * m_locale
The current locale.
Definition: pgm_base.h:353
Class ENV_VAR_ITEM.
Definition: pgm_base.h:58
static const wxChar workingDirKey[]
Definition: pgm_base.h:297
BITMAP_DEF m_Lang_Icon
The menu language icons.
Definition: pgm_base.cpp:89
VTBL_ENTRY void ForceSystemPdfBrowser(bool aFlg)
Function ForceSystemPdfBrowser forces the use of system PDF browser, even if a preferred PDF browser ...
Definition: pgm_base.h:196
static const wxChar showEnvVarWarningDialog[]
Definition: pgm_base.cpp:66
int m_KI_Lang_Identifier
KiCad identifier used in menu selection (See id.h)
Definition: pgm_base.cpp:86
wxConfigBase * GetNewConfig(const wxString &aProgName)
Function GetNewConfig.
Definition: common.cpp:205
VTBL_ENTRY wxApp & App()
Function App returns a bare naked wxApp, which may come from wxPython, SINGLE_TOP, or kicad.exe.
Definition: pgm_base.cpp:323
static const wxChar traceEnvVars[]
enable/disable icons in menus
Definition: pgm_base.cpp:67
bool m_show_env_var_dialog
Flag to indicate if the environment variable overwrite warning dialog should be shown.
Definition: pgm_base.h:385
void Destroy()
Definition: pgm_base.cpp:308
bool setExecutablePath()
Function setExecutablePath finds the path to the executable and stores it in PGM_BASE::m_bin_dir.
Definition: pgm_base.cpp:564
System directories search utilities.
The common library.
A small class to handle the list of existing translations.
Definition: pgm_base.cpp:80
wxSingleInstanceChecker * m_pgm_checker
prevents multiple instances of a program from being run at the same time.
Definition: pgm_base.h:340
static const wxChar entryUseIconsInMenus[]
Definition: pgm_base.cpp:69
Class SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
bool m_DoNotTranslate
Set to true if the m_Lang_Label must not be translated.
Definition: pgm_base.cpp:95
VTBL_ENTRY const wxString AskUserForPreferredEditor(const wxString &aDefaultEditor=wxEmptyString)
Shows a dialog that instructs the user to select a new preferred editor.
Definition: pgm_base.cpp:375
#define KICAD_COMMON
Definition: pgm_base.cpp:58
double m_iconsScale
Scaling factor for menus and tool icons.
Definition: pgm_base.h:362
int m_language_id
The current language setting.
Definition: pgm_base.h:356
This file contains miscellaneous commonly used macros and functions.
VTBL_ENTRY void ConfigurePaths(wxWindow *aParent=NULL)
Function ConfigurePaths.
Definition: pgm_base.cpp:903
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
wxString m_kicad_env
The KICAD system environment variable.
Definition: pgm_base.h:350
VTBL_ENTRY bool SetLocalEnvVariable(const wxString &aName, const wxString &aValue)
Function SetLocalEnvVariable.
Definition: pgm_base.cpp:863
const ENV_VAR_MAP & GetEnvVarMap() const
VTBL_ENTRY const ENV_VAR_MAP & GetLocalEnvVariables() const
Definition: pgm_base.h:270
VTBL_ENTRY void SetLanguageIdentifier(int menu_id)
Function SetLanguageIdentifier sets in .m_language_id member the wxWidgets language identifier Id fro...
Definition: pgm_base.cpp:771
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:87
void SetDefinedExternally(bool aIsDefinedExternally)
Definition: pgm_base.h:70
Base window classes and related definitions.
wxString EDA_FILE_SELECTOR(const wxString &aTitle, const wxString &aPath, const wxString &aFileName, const wxString &aExtension, const wxString &aWildcard, wxWindow *aParent, int aStyle, const bool aKeepWorkingDirectory, const wxPoint &aPosition, wxString *aMruPath)
Function EDA_FILE_SELECTOR.
Definition: gestfich.cpp:82
void SystemDirsAppend(SEARCH_STACK *aSearchStack)
Function SystemDirsAppend appends system places to aSearchStack in a platform specific way...
void setLanguageId(int aId)
Trap all changes in here, simplifies debugging.
Definition: pgm_base.h:367
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:102
DIALOG_ENV_VAR_CONFIG class declaration.
int m_WX_Lang_Identifier
wxWidgets locale identifier (See wxWidgets doc)
Definition: pgm_base.cpp:83
wxString m_Lang_Label
Labels used in menus.
Definition: pgm_base.cpp:92
VTBL_ENTRY void SetLanguagePath()
Definition: pgm_base.cpp:787
VTBL_ENTRY bool SetLanguage(bool first_time=false)
Function SetLanguage sets the dictionary file name for internationalization.
Definition: pgm_base.cpp:679
wxString m_bin_dir
full path to this program
Definition: pgm_base.h:347
VTBL_ENTRY void SetLocalEnvVariables(const ENV_VAR_MAP &aEnvVarMap)
Function SetLocalEnvVariables.
Definition: pgm_base.cpp:882
wxConfigBase * m_common_settings
Configuration settings common to all KiCad program modules, like as in $HOME/.kicad_common.
Definition: pgm_base.h:344
VTBL_ENTRY void ReadPdfBrowserInfos()
Function ReadPdfBrowserInfos reads the PDF browser choice from the common configuration.
Definition: eda_doc.cpp:41
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
see class PGM_BASE
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void SetValue(const wxString &aValue)
Definition: pgm_base.h:76
wxSize m_help_size
Definition: pgm_base.h:379
bool InitPgm()
Function initPgm initializes this program (process) in a KiCad standard way, using some generalized t...
Definition: pgm_base.cpp:398
static const wxChar languageCfgKey[]
Definition: pgm_base.cpp:64
static LANGUAGE_DESCR s_Languages[]
Variable s_Languages Note: because this list is not created on the fly, wxTranslation must be called ...
Definition: pgm_base.cpp:105
wxString m_editor_name
Definition: pgm_base.h:378
const char * name
bool m_useIconsInMenus
True to use menu icons.
Definition: pgm_base.h:364
std::map< wxString, ENV_VAR_ITEM >::iterator ENV_VAR_MAP_ITER
Definition: pgm_base.h:88
VTBL_ENTRY const wxString & GetEditorName(bool aCanShowFileChooser=true)
Return the preferred editor name.
Definition: pgm_base.cpp:338
VTBL_ENTRY void AddMenuLanguageList(wxMenu *MasterMenu)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
Definition: pgm_base.cpp:822
Some functions to handle hotkeys in KiCad.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Function IsOK displays a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:129
File locking utilities.