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.GetPath() );
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.GetPath() );
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.GetPath() );
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  // This only effect the first time KiCad is run. The user's setting will be used for all
615  // subsequent runs. Menu icons are off by default on OSX and on for all other platforms.
616 #if defined( __WXMAC__ )
617  m_useIconsInMenus = false;
618 #else
619  m_useIconsInMenus = true;
620 #endif
621 
624 
625  m_editor_name = m_common_settings->Read( wxT( "Editor" ) );
626 
627  wxString entry, oldPath;
628  wxArrayString entries;
629  long index = 0L;
630 
631  oldPath = m_common_settings->GetPath();
633 
634  while( m_common_settings->GetNextEntry( entry, index ) )
635  {
636  wxLogTrace( traceEnvVars,
637  wxT( "Enumerating over entry %s, %ld." ), GetChars( entry ), index );
638  entries.Add( entry );
639  }
640 
641  for( unsigned i = 0; i < entries.GetCount(); i++ )
642  {
643  wxString val = m_common_settings->Read( entries[i], wxEmptyString );
644  m_local_env_vars[ entries[i] ] = ENV_VAR_ITEM( val, wxGetEnv( entries[i], NULL ) );
645  }
646 
647  for( ENV_VAR_MAP_ITER it = m_local_env_vars.begin(); it != m_local_env_vars.end(); ++it )
648  SetLocalEnvVariable( it->first, it->second.GetValue() );
649 
650  m_common_settings->SetPath( oldPath );
651 }
652 
653 
655 {
656  // m_common_settings is not initialized until fairly late in the
657  // process startup: InitPgm(), so test before using:
658  if( m_common_settings )
659  {
660  wxString cur_dir = wxGetCwd();
661 
662  m_common_settings->Write( workingDirKey, cur_dir );
665 
666  // Save the local environment variables.
668 
669  for( ENV_VAR_MAP_ITER it = m_local_env_vars.begin(); it != m_local_env_vars.end(); ++it )
670  {
671  wxLogTrace( traceEnvVars, wxT( "Saving environment variable config entry %s as %s" ),
672  GetChars( it->first ), GetChars( it->second.GetValue() ) );
673  m_common_settings->Write( it->first, it->second.GetValue() );
674  }
675 
676  m_common_settings->SetPath( wxT( ".." ) );
677  }
678 }
679 
680 
681 bool PGM_BASE::SetLanguage( bool first_time )
682 {
683  bool retv = true;
684 
685  if( first_time )
686  {
687  setLanguageId( wxLANGUAGE_DEFAULT );
688  // First time SetLanguage is called, the user selected language id is set
689  // from commun user config settings
690  wxString languageSel;
691 
692  m_common_settings->Read( languageCfgKey, &languageSel );
693 
694  // Search for the current selection
695  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
696  {
697  if( s_Languages[ii].m_Lang_Label == languageSel )
698  {
699  setLanguageId( s_Languages[ii].m_WX_Lang_Identifier );
700  break;
701  }
702  }
703  }
704 
705  // dictionary file name without extend (full name is kicad.mo)
706  wxString dictionaryName( wxT( "kicad" ) );
707 
708  delete m_locale;
709  m_locale = new wxLocale;
710 
711  if( !m_locale->Init( m_language_id ) )
712  {
713  wxLogDebug( wxT( "This language is not supported by the system." ) );
714 
715  setLanguageId( wxLANGUAGE_DEFAULT );
716  delete m_locale;
717 
718  m_locale = new wxLocale;
719  m_locale->Init();
720  retv = false;
721  }
722  else if( !first_time )
723  {
724  wxLogDebug( wxT( "Search for dictionary %s.mo in %s" ),
725  GetChars( dictionaryName ), GetChars( m_locale->GetName() ) );
726  }
727 
728  if( !first_time )
729  {
730  // If we are here, the user has selected an other language.
731  // Therefore the new prefered language name is stored in common config.
732  // Do NOT store the wxWidgets language Id, it can change between wxWidgets
733  // versions, for a given language
734  wxString languageSel;
735 
736  // Search for the current selection language name
737  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
738  {
739  if( s_Languages[ii].m_WX_Lang_Identifier == m_language_id )
740  {
741  languageSel = s_Languages[ii].m_Lang_Label;
742  break;
743  }
744  }
745 
746  m_common_settings->Write( languageCfgKey, languageSel );
747  }
748 
749  // Test if floating point notation is working (bug encountered in cross compilation)
750  // Make a conversion double <=> string
751  double dtst = 0.5;
752  wxString msg;
753 
754  msg << dtst;
755  double result;
756  msg.ToDouble( &result );
757 
758  if( result != dtst )
759  // string to double encode/decode does not work! Bug detected:
760  // Disable floating point localization:
761  setlocale( LC_ALL, "C" );
762 
763  if( !m_locale->IsLoaded( dictionaryName ) )
764  m_locale->AddCatalog( dictionaryName );
765 
766  if( !retv )
767  return retv;
768 
769  return m_locale->IsOk();
770 }
771 
772 
774 {
775  wxLogDebug( wxT( "Select language ID %d from %d possible languages." ),
776  menu_id, DIM( s_Languages ) );
777 
778  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
779  {
780  if( menu_id == s_Languages[ii].m_KI_Lang_Identifier )
781  {
782  setLanguageId( s_Languages[ii].m_WX_Lang_Identifier );
783  break;
784  }
785  }
786 }
787 
788 
790 {
791  SEARCH_STACK guesses;
792 
793  SystemDirsAppend( &guesses );
794 
795  // Add our internat dir to the wxLocale catalog of paths
796  for( unsigned i = 0; i < guesses.GetCount(); i++ )
797  {
798  wxFileName fn( guesses[i], wxEmptyString );
799 
800  // Append path for Windows and unix KiCad package install
801  fn.AppendDir( wxT( "share" ) );
802  fn.AppendDir( wxT( "internat" ) );
803 
804  if( fn.IsDirReadable() )
805  {
806  wxLogDebug( wxT( "Adding locale lookup path: " ) + fn.GetPath() );
807  wxLocale::AddCatalogLookupPathPrefix( fn.GetPath() );
808  }
809 
810  // Append path for unix standard install
811  fn.RemoveLastDir();
812  fn.AppendDir( wxT( "kicad" ) );
813  fn.AppendDir( wxT( "internat" ) );
814 
815  if( fn.IsDirReadable() )
816  {
817  wxLogDebug( wxT( "Adding locale lookup path: " ) + fn.GetPath() );
818  wxLocale::AddCatalogLookupPathPrefix( fn.GetPath() );
819  }
820  }
821 }
822 
823 
824 void PGM_BASE::AddMenuLanguageList( wxMenu* MasterMenu )
825 {
826  wxMenu* menu = NULL;
827  wxMenuItem* item = MasterMenu->FindItem( ID_LANGUAGE_CHOICE );
828 
829  if( item ) // This menu exists, do nothing
830  return;
831 
832  menu = new wxMenu;
833 
834  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
835  {
836  wxString label;
837 
838  if( s_Languages[ii].m_DoNotTranslate )
839  label = s_Languages[ii].m_Lang_Label;
840  else
841  label = wxGetTranslation( s_Languages[ii].m_Lang_Label );
842 
843  AddMenuItem( menu, s_Languages[ii].m_KI_Lang_Identifier,
844  label, KiBitmap(s_Languages[ii].m_Lang_Icon ),
845  wxITEM_CHECK );
846  }
847 
848  AddMenuItem( MasterMenu, menu,
850  _( "Set Language" ),
851  _( "Select application language (only for testing)" ),
852  KiBitmap( language_xpm ) );
853 
854  // Set Check mark on current selected language
855  for( unsigned ii = 0; ii < DIM( s_Languages ); ii++ )
856  {
857  if( m_language_id == s_Languages[ii].m_WX_Lang_Identifier )
858  menu->Check( s_Languages[ii].m_KI_Lang_Identifier, true );
859  else
860  menu->Check( s_Languages[ii].m_KI_Lang_Identifier, false );
861  }
862 }
863 
864 
865 bool PGM_BASE::SetLocalEnvVariable( const wxString& aName, const wxString& aValue )
866 {
867  wxString env;
868 
869  // Check to see if the environment variable is already set.
870  if( wxGetEnv( aName, &env ) )
871  {
872  wxLogTrace( traceEnvVars, wxT( "Environment variable %s already set to %s." ),
873  GetChars( aName ), GetChars( env ) );
874  return env == aValue;
875  }
876 
877  wxLogTrace( traceEnvVars, wxT( "Setting local environment variable %s to %s." ),
878  GetChars( aName ), GetChars( aValue ) );
879 
880  return wxSetEnv( aName, aValue );
881 }
882 
883 
885 {
886  m_local_env_vars.clear();
887  m_local_env_vars = aEnvVarMap;
888 
889  if( m_common_settings )
890  m_common_settings->DeleteGroup( pathEnvVariables );
891 
893 
894  // Overwrites externally defined environment variable until the next time the application
895  // is run.
896  for( ENV_VAR_MAP_ITER it = m_local_env_vars.begin(); it != m_local_env_vars.end(); ++it )
897  {
898  wxLogTrace( traceEnvVars, wxT( "Setting local environment variable %s to %s." ),
899  GetChars( it->first ), GetChars( it->second.GetValue() ) );
900  wxSetEnv( it->first, it->second.GetValue() );
901  }
902 }
903 
904 
905 void PGM_BASE::ConfigurePaths( wxWindow* aParent )
906 {
907  DIALOG_ENV_VAR_CONFIG dlg_envvars( aParent, GetLocalEnvVariables() );
908 
909  if( dlg_envvars.ShowModal() == wxID_CANCEL )
910  return;
911 
912  ENV_VAR_MAP envVarMap = dlg_envvars.GetEnvVarMap();
913 
914  for( ENV_VAR_MAP_ITER it = envVarMap.begin(); it != envVarMap.end(); ++it )
915  {
916  wxLogTrace( traceEnvVars, wxT( "Environment variable %s=%s defined externally = %d" ),
917  GetChars( it->first ), GetChars( it->second.GetValue() ),
918  it->second.GetDefinedExternally() );
919  }
920 
921  // If any of the environment variables are defined externally, warn the user that the
922  // next time kicad is run that the externally defined variables will be used instead of
923  // the user's settings. This is by design.
924  if( dlg_envvars.ExternalDefsChanged() && m_show_env_var_dialog )
925  {
926  wxString msg1 = _( "Warning! Some of paths you have configured have been defined \n"
927  "externally to the running process and will be temporarily overwritten." );
928  wxString msg2 = _( "The next time KiCad is launched, any paths that have already\n"
929  "been defined are honored and any settings defined in the path\n"
930  "configuration dialog are ignored. If you did not intend for this\n"
931  "behavior, either rename any conflicting entries or remove the\n"
932  "external environment variable definition(s) from your system." );
933  wxRichMessageDialog dlg( aParent, msg1, _( "Warning" ), wxOK | wxCENTRE );
934  dlg.ShowDetailedText( msg2 );
935  dlg.ShowCheckBox( _( "Do not show this message again." ) );
936  dlg.ShowModal();
937  m_show_env_var_dialog = !dlg.IsCheckBoxChecked();
938  }
939 
940  SetLocalEnvVariables( dlg_envvars.GetEnvVarMap() );
941 }
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:654
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:905
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:865
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:773
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:104
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:789
VTBL_ENTRY bool SetLanguage(bool first_time=false)
Function SetLanguage sets the dictionary file name for internationalization.
Definition: pgm_base.cpp:681
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:884
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:824
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:131
File locking utilities.