samples/internat/internat.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        internat.cpp
   3 // Purpose:     Demonstrates internationalisation (i18n) support
   4 // Author:      Vadim Zeitlin/Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // NOTE: don't miss the "readme.txt" file which comes with this sample!
  13
  14
  15
  16 // ============================================================================
  17 // declarations
  18 // ============================================================================
  19
  20 // ----------------------------------------------------------------------------
  21 // headers
  22 // ----------------------------------------------------------------------------
  23
  24 // For compilers that support precompilation, includes "wx/wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28 #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/wx.h"
  33 #endif
  34
  35 #include "wx/intl.h"
  36 #include "wx/file.h"
  37 #include "wx/log.h"
  38 #include "wx/cmdline.h"
  39
  40 #if !defined(__WXMSW__) && !defined(__WXPM__)
  41     #include "../sample.xpm"
  42 #endif
  43
  44 // ----------------------------------------------------------------------------
  45 // private classes
  46 // ----------------------------------------------------------------------------
  47
  48 // Define a new application type
  49 class MyApp: public wxApp
  50 {
  51 public:
  52     MyApp() { m_lang = wxLANGUAGE_UNKNOWN; }
  53
  54     virtual void OnInitCmdLine(wxCmdLineParser& parser);
  55     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
  56     virtual bool OnInit();
  57
  58 protected:
  59     wxLanguage m_lang;  // language specified by user
  60     wxLocale m_locale;  // locale we'll be using
  61 };
  62
  63 // Define a new frame type
  64 class MyFrame: public wxFrame
  65 {
  66 public:
  67     MyFrame(wxLocale& m_locale);
  68
  69 public:
  70     void OnTestLocaleAvail(wxCommandEvent& event);
  71     void OnAbout(wxCommandEvent& event);
  72     void OnQuit(wxCommandEvent& event);
  73
  74     void OnPlay(wxCommandEvent& event);
  75     void OnOpen(wxCommandEvent& event);
  76     void OnTest1(wxCommandEvent& event);
  77     void OnTest2(wxCommandEvent& event);
  78     void OnTest3(wxCommandEvent& event);
  79     void OnTestMsgBox(wxCommandEvent& event);
  80
  81     DECLARE_EVENT_TABLE()
  82
  83     wxLocale& m_locale;
  84 };
  85
  86 // ----------------------------------------------------------------------------
  87 // constants
  88 // ----------------------------------------------------------------------------
  89
  90 // ID for the menu commands
  91 enum
  92 {
  93     INTERNAT_TEST = wxID_HIGHEST + 1,
  94     INTERNAT_PLAY,
  95     INTERNAT_TEST_1,
  96     INTERNAT_TEST_2,
  97     INTERNAT_TEST_3,
  98     INTERNAT_TEST_MSGBOX
  99 };
 100
 101 // language data
 102 static const wxLanguage langIds[] =
 103 {
 104     wxLANGUAGE_DEFAULT,
 105     wxLANGUAGE_FRENCH,
 106     wxLANGUAGE_ITALIAN,
 107     wxLANGUAGE_GERMAN,
 108     wxLANGUAGE_RUSSIAN,
 109     wxLANGUAGE_BULGARIAN,
 110     wxLANGUAGE_CZECH,
 111     wxLANGUAGE_POLISH,
 112     wxLANGUAGE_SWEDISH,
 113 #if wxUSE_UNICODE || defined(__WXMOTIF__)
 114     wxLANGUAGE_JAPANESE,
 115 #endif
 116 #if wxUSE_UNICODE
 117     wxLANGUAGE_GEORGIAN,
 118     wxLANGUAGE_ENGLISH,
 119     wxLANGUAGE_ENGLISH_US,
 120     wxLANGUAGE_ARABIC,
 121     wxLANGUAGE_ARABIC_EGYPT
 122 #endif
 123 };
 124
 125 // note that it makes no sense to translate these strings, they are
 126 // shown before we set the locale anyhow
 127 const wxString langNames[] =
 128 {
 129     "System default",
 130     "French",
 131     "Italian",
 132     "German",
 133     "Russian",
 134     "Bulgarian",
 135     "Czech",
 136     "Polish",
 137     "Swedish",
 138 #if wxUSE_UNICODE || defined(__WXMOTIF__)
 139     "Japanese",
 140 #endif
 141 #if wxUSE_UNICODE
 142     "Georgian",
 143     "English",
 144     "English (U.S.)",
 145     "Arabic",
 146     "Arabic (Egypt)"
 147 #endif
 148 };
 149
 150 // the arrays must be in sync
 151 wxCOMPILE_TIME_ASSERT( WXSIZEOF(langNames) == WXSIZEOF(langIds),
 152                        LangArraysMismatch );
 153
 154 // ----------------------------------------------------------------------------
 155 // wxWidgets macros
 156 // ----------------------------------------------------------------------------
 157
 158 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 159     EVT_MENU(INTERNAT_TEST, MyFrame::OnTestLocaleAvail)
 160     EVT_MENU(wxID_ABOUT, MyFrame::OnAbout)
 161     EVT_MENU(wxID_EXIT, MyFrame::OnQuit)
 162
 163     EVT_MENU(INTERNAT_PLAY, MyFrame::OnPlay)
 164     EVT_MENU(wxID_OPEN, MyFrame::OnOpen)
 165     EVT_MENU(INTERNAT_TEST_1, MyFrame::OnTest1)
 166     EVT_MENU(INTERNAT_TEST_2, MyFrame::OnTest2)
 167     EVT_MENU(INTERNAT_TEST_3, MyFrame::OnTest3)
 168     EVT_MENU(INTERNAT_TEST_MSGBOX, MyFrame::OnTestMsgBox)
 169 END_EVENT_TABLE()
 170
 171 IMPLEMENT_APP(MyApp)
 172
 173 // ============================================================================
 174 // implementation
 175 // ============================================================================
 176
 177 // ----------------------------------------------------------------------------
 178 // MyApp
 179 // ----------------------------------------------------------------------------
 180
 181 // command line arguments handling
 182 void MyApp::OnInitCmdLine(wxCmdLineParser& parser)
 183 {
 184     parser.AddParam(_("locale"),
 185                     wxCMD_LINE_VAL_STRING,
 186                     wxCMD_LINE_PARAM_OPTIONAL);
 187
 188     wxApp::OnInitCmdLine(parser);
 189 }
 190
 191 bool MyApp::OnCmdLineParsed(wxCmdLineParser& parser)
 192 {
 193     if ( !wxApp::OnCmdLineParsed(parser) )
 194         return false;
 195
 196     if ( parser.GetParamCount() )
 197     {
 198         const wxString loc = parser.GetParam();
 199         const wxLanguageInfo * const lang = wxLocale::FindLanguageInfo(loc);
 200         if ( !lang )
 201         {
 202             wxLogError(_("Locale \"%s\" is unknown."), loc);
 203             return false;
 204         }
 205
 206         m_lang = static_cast<wxLanguage>(lang->Language);
 207     }
 208
 209     return true;
 210 }
 211
 212 // `Main program' equivalent, creating windows and returning main app frame
 213 bool MyApp::OnInit()
 214 {
 215     if ( !wxApp::OnInit() )
 216         return false;
 217
 218     if ( m_lang == wxLANGUAGE_UNKNOWN )
 219     {
 220         int lng = wxGetSingleChoiceIndex
 221                   (
 222                     _("Please choose language:"),
 223                     _("Language"),
 224                     WXSIZEOF(langNames),
 225                     langNames
 226                   );
 227         m_lang = lng == -1 ? wxLANGUAGE_DEFAULT : langIds[lng];
 228     }
 229
 230     // don't use wxLOCALE_LOAD_DEFAULT flag so that Init() doesn't return
 231     // false just because it failed to load wxstd catalog
 232     if ( !m_locale.Init(m_lang, wxLOCALE_DONT_LOAD_DEFAULT) )
 233     {
 234         wxLogWarning(_("This language is not supported by the system."));
 235
 236         // continue nevertheless
 237     }
 238
 239     // normally this wouldn't be necessary as the catalog files would be found
 240     // in the default locations, but when the program is not installed the
 241     // catalogs are in the build directory where we wouldn't find them by
 242     // default
 243     wxLocale::AddCatalogLookupPathPrefix(".");
 244
 245     // Initialize the catalogs we'll be using
 246     const wxLanguageInfo* pInfo = wxLocale::GetLanguageInfo(m_lang);
 247     if (!m_locale.AddCatalog("internat"))
 248     {
 249         wxLogError(_("Couldn't find/load the 'internat' catalog for locale '%s'."),
 250                    pInfo ? pInfo->GetLocaleName() : _("unknown"));
 251     }
 252
 253     // Now try to add wxstd.mo so that loading "NOTEXIST.ING" file will produce
 254     // a localized error message:
 255     m_locale.AddCatalog("wxstd");
 256         // NOTE: it's not an error if we couldn't find it!
 257
 258     // this catalog is installed in standard location on Linux systems and
 259     // shows that you may make use of the standard message catalogs as well
 260     //
 261     // if it's not installed on your system, it is just silently ignored
 262 #ifdef __LINUX__
 263     {
 264         wxLogNull noLog;
 265         m_locale.AddCatalog("fileutils");
 266     }
 267 #endif
 268
 269     // Create the main frame window
 270     MyFrame *frame = new MyFrame(m_locale);
 271
 272     // Show the frame
 273     frame->Show(true);
 274
 275     return true;
 276 }
 277
 278 // ----------------------------------------------------------------------------
 279 // MyFrame
 280 // ----------------------------------------------------------------------------
 281
 282 // main frame constructor
 283 MyFrame::MyFrame(wxLocale& locale)
 284        : wxFrame(NULL,
 285                  wxID_ANY,
 286                  _("International wxWidgets App")),
 287          m_locale(locale)
 288 {
 289     SetIcon(wxICON(sample));
 290
 291     // Make a menubar
 292     wxMenu *file_menu = new wxMenu;
 293     file_menu->Append(INTERNAT_TEST, _("&Test locale availability...\tCtrl-T"));
 294     file_menu->AppendSeparator();
 295
 296     // since wxID_ABOUT and wxID_EXIT are stock IDs they will automatically get
 297     // translated help strings; nice isn't it?
 298     file_menu->Append(wxID_ABOUT, _("&About..."));
 299     file_menu->AppendSeparator();
 300     file_menu->Append(wxID_EXIT, _("E&xit"));
 301
 302     wxMenu *test_menu = new wxMenu;
 303     test_menu->Append(wxID_OPEN, _("&Open bogus file"), _("Shows a wxWidgets localized error message"));
 304     test_menu->Append(INTERNAT_PLAY, _("&Play a game"), _("A little game; hint: 17 is a lucky number for many"));
 305     test_menu->AppendSeparator();
 306     test_menu->Append(INTERNAT_TEST_1, _("&1 _() (gettext)"), _("Tests the _() macro"));
 307     test_menu->Append(INTERNAT_TEST_2, _("&2 _N() (ngettext)"), _("Tests the _N() macro"));
 308     test_menu->Append(INTERNAT_TEST_3, _("&3 wxTRANSLATE() (gettext_noop)"), _("Tests the wxTRANSLATE() macro"));
 309     test_menu->Append(INTERNAT_TEST_MSGBOX, _("&Message box test"),
 310                       _("Tests message box buttons labels translation"));
 311
 312     wxMenuBar *menu_bar = new wxMenuBar;
 313     menu_bar->Append(file_menu, _("&File"));
 314     menu_bar->Append(test_menu, _("&Test"));
 315     SetMenuBar(menu_bar);
 316
 317     // this demonstrates RTL support in wxStatusBar:
 318     CreateStatusBar(1);
 319
 320     // this demonstrates RTL layout mirroring for Arabic locales
 321     wxSizer *sizer = new wxBoxSizer(wxHORIZONTAL);
 322     sizer->Add(new wxStaticText(this, wxID_ANY, _("First")),
 323                 wxSizerFlags().Border());
 324     sizer->Add(new wxStaticText(this, wxID_ANY, _("Second")),
 325                 wxSizerFlags().Border());
 326     SetSizer(sizer);
 327 }
 328
 329 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event) )
 330 {
 331     Close(true);
 332 }
 333
 334 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 335 {
 336     wxString localeInfo;
 337     wxString locale = m_locale.GetLocale();
 338     wxString sysname = m_locale.GetSysName();
 339     wxString canname = m_locale.GetCanonicalName();
 340
 341     localeInfo.Printf(_("Language: %s\nSystem locale name: %s\nCanonical locale name: %s\n"),
 342                       locale.c_str(), sysname.c_str(), canname.c_str() );
 343
 344     wxMessageDialog dlg(
 345                         this,
 346                         wxString(_("I18n sample\n(c) 1998, 1999 Vadim Zeitlin and Julian Smart"))
 347                                  + "\n\n"
 348                                  + localeInfo,
 349                                  _("About Internat"),
 350                         wxOK | wxICON_INFORMATION
 351                        );
 352     dlg.ShowModal();
 353 }
 354
 355 void MyFrame::OnPlay(wxCommandEvent& WXUNUSED(event))
 356 {
 357     wxString str = wxGetTextFromUser
 358                    (
 359                     _("Enter your number:"),
 360                     _("Try to guess my number!"),
 361                     wxEmptyString,
 362                     this
 363                    );
 364
 365     if ( str.empty() )
 366     {
 367         // cancelled
 368         return;
 369     }
 370
 371     long num;
 372     if ( !str.ToLong(&num) || num < 0 )
 373     {
 374         str = _("You've probably entered an invalid number.");
 375     }
 376     else if ( num == 9 )
 377     {
 378         // this message is not translated (not in catalog) because we used wxT()
 379         // and not _() around it
 380         str = wxT("You've found a bug in this program!");
 381     }
 382     else if ( num == 17 )
 383     {
 384         str.clear();
 385
 386         // string must be split in two -- otherwise the translation would't be
 387         // found
 388         str << _("Congratulations! you've won. Here is the magic phrase:")
 389             << _("cannot create fifo `%s'");
 390     }
 391     else
 392     {
 393         // this is a more implicit way to write _() but note that if you use it
 394         // you must ensure that the strings get extracted in the message
 395         // catalog as by default xgettext won't do it; it only knows of _(),
 396         // not of wxTRANSLATE(). As internat's readme.txt says you should thus
 397         // call xgettext with -kwxTRANSLATE.
 398         str = wxGetTranslation(wxTRANSLATE("Bad luck! try again..."));
 399
 400         // note also that if we want 'str' to contain a localized string
 401         // we need to use wxGetTranslation explicitly as wxTRANSLATE just
 402         // tells xgettext to extract the string but has no effect on the
 403         // runtime of the program!
 404     }
 405
 406     wxMessageBox(str, _("Result"), wxOK | wxICON_INFORMATION);
 407 }
 408
 409 void MyFrame::OnTestLocaleAvail(wxCommandEvent& WXUNUSED(event))
 410 {
 411     static wxString s_locale;
 412     wxString locale = wxGetTextFromUser
 413                       (
 414                         _("Enter the locale to test"),
 415                         wxGetTextFromUserPromptStr,
 416                         s_locale,
 417                         this
 418                       );
 419     if ( locale.empty() )
 420         return;
 421
 422     s_locale = locale;
 423     const wxLanguageInfo * const info = wxLocale::FindLanguageInfo(s_locale);
 424     if ( !info )
 425     {
 426         wxLogError(_("Locale \"%s\" is unknown."), s_locale.c_str());
 427         return;
 428     }
 429
 430     if ( wxLocale::IsAvailable(info->Language) )
 431     {
 432         wxLogMessage(_("Locale \"%s\" is available."), s_locale.c_str());
 433     }
 434     else
 435     {
 436         wxLogWarning(_("Locale \"%s\" is not available."), s_locale.c_str());
 437     }
 438 }
 439
 440 void MyFrame::OnOpen(wxCommandEvent& WXUNUSED(event))
 441 {
 442     // open a bogus file -- the error message should be also translated if
 443     // you've got wxstd.mo somewhere in the search path (see MyApp::OnInit)
 444     wxFile file("NOTEXIST.ING");
 445 }
 446
 447 void MyFrame::OnTest1(wxCommandEvent& WXUNUSED(event))
 448 {
 449     const wxString& title = _("Testing _() (gettext)");
 450
 451     // NOTE: using the wxTRANSLATE() macro here we won't show a localized
 452     //       string in the text entry dialog; we'll simply show the un-translated
 453     //       string; however if the user press "ok" without altering the text,
 454     //       since the "default value" string has been extracted by xgettext
 455     //       the wxGetTranslation call later will manage to return a localized
 456     //       string
 457     wxTextEntryDialog d(this, _("Please enter text to translate"),
 458                         title, wxTRANSLATE("default value"));
 459
 460     if (d.ShowModal() == wxID_OK)
 461     {
 462         wxString v = d.GetValue();
 463         wxString s(title);
 464         s << "\n" << v << " -> "
 465             << wxGetTranslation(v.c_str()) << "\n";
 466         wxMessageBox(s);
 467     }
 468 }
 469
 470 void MyFrame::OnTest2(wxCommandEvent& WXUNUSED(event))
 471 {
 472     const wxString& title = _("Testing _N() (ngettext)");
 473     wxTextEntryDialog d(this,
 474         _("Please enter range for plural forms of \"n files deleted\" phrase"),
 475         title, "0-10");
 476
 477     if (d.ShowModal() == wxID_OK)
 478     {
 479         int first, last;
 480         wxSscanf(d.GetValue(), "%d-%d", &first, &last);
 481         wxString s(title);
 482         s << "\n";
 483         for (int n = first; n <= last; ++n)
 484         {
 485             s << n << " " <<
 486                 wxPLURAL("file deleted", "files deleted", n) <<
 487                 "\n";
 488         }
 489         wxMessageBox(s);
 490     }
 491 }
 492
 493 void MyFrame::OnTest3(wxCommandEvent& WXUNUSED(event))
 494 {
 495     const char* lines[] =
 496     {
 497         wxTRANSLATE("line 1"),
 498         wxTRANSLATE("line 2"),
 499         wxTRANSLATE("line 3"),
 500     };
 501
 502     wxString s(_("Testing wxTRANSLATE() (gettext_noop)"));
 503     s << "\n";
 504     for (size_t i = 0; i < WXSIZEOF(lines); ++i)
 505     {
 506         s << lines[i] << " -> " << wxGetTranslation(lines[i]) << "\n";
 507     }
 508     wxMessageBox(s);
 509 }
 510
 511 void MyFrame::OnTestMsgBox(wxCommandEvent& WXUNUSED(event))
 512 {
 513     if ( wxMessageBox
 514          (
 515             _("Are the labels of the buttons in this message box "
 516               "translated into the current locale language?"),
 517             _("wxWidgets i18n sample"),
 518             wxYES_NO,
 519             this
 520          ) != wxYES )
 521     {
 522         wxMessageBox(_("Please report the details of your platform to us."));
 523     }
 524 }