01f953efb2
Implement preferred language selection on modern systems (OS X, Windows Vista+). User settings for locale (aka "regional settings") and UI language are independent there and the UI language shouldn't be determined from the locale. Moreover, the OS provides a list of preferred languages, not a single value (as with locale), so we should use the best language given user's preferences and available translations. A Czech user may prefer Slovak UI over English, for example, and we should use Slovak translation in absence of Czech one in that case instead of falling back to English. On Unix, locale is language and so things remain as before. Notice that calling wxLocale::Init(wxLANGUAGE_DEFAULT) does the right thing now: it sets the locale to whatever the user has configured in regional settings and loads translations corresponding to default wxTranslations language, which is determined as described above. Previously, UI would be translated using a language corresponding to the regional settings. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72430 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
322 lines
11 KiB
C++
322 lines
11 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/translation.h
|
|
// Purpose: Internationalization and localisation for wxWidgets
|
|
// Author: Vadim Zeitlin, Vaclav Slavik,
|
|
// Michael N. Filippov <michael@idisys.iae.nsk.su>
|
|
// Created: 2010-04-23
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
|
|
// (c) 2010 Vaclav Slavik <vslavik@fastmail.fm>
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_TRANSLATION_H_
|
|
#define _WX_TRANSLATION_H_
|
|
|
|
#include "wx/defs.h"
|
|
#include "wx/string.h"
|
|
|
|
#if wxUSE_INTL
|
|
|
|
#include "wx/buffer.h"
|
|
#include "wx/language.h"
|
|
#include "wx/hashmap.h"
|
|
#include "wx/strconv.h"
|
|
#include "wx/scopedptr.h"
|
|
|
|
// ============================================================================
|
|
// global decls
|
|
// ============================================================================
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// macros
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// gettext() style macros (notice that xgettext should be invoked with
|
|
// --keyword="_" --keyword="wxPLURAL:1,2" options
|
|
// to extract the strings from the sources)
|
|
#ifndef WXINTL_NO_GETTEXT_MACRO
|
|
#define _(s) wxGetTranslation((s))
|
|
#define wxPLURAL(sing, plur, n) wxGetTranslation((sing), (plur), n)
|
|
#endif
|
|
|
|
// another one which just marks the strings for extraction, but doesn't
|
|
// perform the translation (use -kwxTRANSLATE with xgettext!)
|
|
#define wxTRANSLATE(str) str
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// forward decls
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_FWD_BASE wxArrayString;
|
|
class WXDLLIMPEXP_FWD_BASE wxTranslationsLoader;
|
|
class WXDLLIMPEXP_FWD_BASE wxLocale;
|
|
|
|
class wxPluralFormsCalculator;
|
|
wxDECLARE_SCOPED_PTR(wxPluralFormsCalculator, wxPluralFormsCalculatorPtr)
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxMsgCatalog corresponds to one loaded message catalog.
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_BASE wxMsgCatalog
|
|
{
|
|
public:
|
|
// Ctor is protected, because CreateFromXXX functions must be used,
|
|
// but destruction should be unrestricted
|
|
#if !wxUSE_UNICODE
|
|
~wxMsgCatalog();
|
|
#endif
|
|
|
|
// load the catalog from disk or from data; caller is responsible for
|
|
// deleting them if not NULL
|
|
static wxMsgCatalog *CreateFromFile(const wxString& filename,
|
|
const wxString& domain);
|
|
|
|
static wxMsgCatalog *CreateFromData(const wxScopedCharBuffer& data,
|
|
const wxString& domain);
|
|
|
|
// get name of the catalog
|
|
wxString GetDomain() const { return m_domain; }
|
|
|
|
// get the translated string: returns NULL if not found
|
|
const wxString *GetString(const wxString& sz, unsigned n = UINT_MAX) const;
|
|
|
|
protected:
|
|
wxMsgCatalog(const wxString& domain)
|
|
: m_pNext(NULL), m_domain(domain)
|
|
#if !wxUSE_UNICODE
|
|
, m_conv(NULL)
|
|
#endif
|
|
{}
|
|
|
|
private:
|
|
// variable pointing to the next element in a linked list (or NULL)
|
|
wxMsgCatalog *m_pNext;
|
|
friend class wxTranslations;
|
|
|
|
wxStringToStringHashMap m_messages; // all messages in the catalog
|
|
wxString m_domain; // name of the domain
|
|
|
|
#if !wxUSE_UNICODE
|
|
// the conversion corresponding to this catalog charset if we installed it
|
|
// as the global one
|
|
wxCSConv *m_conv;
|
|
#endif
|
|
|
|
wxPluralFormsCalculatorPtr m_pluralFormsCalculator;
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxTranslations: message catalogs
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// this class allows to get translations for strings
|
|
class WXDLLIMPEXP_BASE wxTranslations
|
|
{
|
|
public:
|
|
wxTranslations();
|
|
~wxTranslations();
|
|
|
|
// returns current translations object, may return NULL
|
|
static wxTranslations *Get();
|
|
// sets current translations object (takes ownership; may be NULL)
|
|
static void Set(wxTranslations *t);
|
|
|
|
// changes loader to non-default one; takes ownership of 'loader'
|
|
void SetLoader(wxTranslationsLoader *loader);
|
|
|
|
void SetLanguage(wxLanguage lang);
|
|
void SetLanguage(const wxString& lang);
|
|
|
|
// get languages available for this app
|
|
wxArrayString GetAvailableTranslations(const wxString& domain) const;
|
|
|
|
// find best translation language for given domain
|
|
wxString GetBestTranslation(const wxString& domain, wxLanguage msgIdLanguage);
|
|
wxString GetBestTranslation(const wxString& domain,
|
|
const wxString& msgIdLanguage = "en");
|
|
|
|
// add standard wxWidgets catalog ("wxstd")
|
|
bool AddStdCatalog();
|
|
|
|
// add catalog with given domain name and language, looking it up via
|
|
// wxTranslationsLoader
|
|
bool AddCatalog(const wxString& domain);
|
|
bool AddCatalog(const wxString& domain, wxLanguage msgIdLanguage);
|
|
#if !wxUSE_UNICODE
|
|
bool AddCatalog(const wxString& domain,
|
|
wxLanguage msgIdLanguage,
|
|
const wxString& msgIdCharset);
|
|
#endif
|
|
|
|
// check if the given catalog is loaded
|
|
bool IsLoaded(const wxString& domain) const;
|
|
|
|
// access to translations
|
|
const wxString& GetString(const wxString& origString,
|
|
const wxString& domain = wxEmptyString) const;
|
|
const wxString& GetString(const wxString& origString,
|
|
const wxString& origString2,
|
|
unsigned n,
|
|
const wxString& domain = wxEmptyString) const;
|
|
|
|
wxString GetHeaderValue(const wxString& header,
|
|
const wxString& domain = wxEmptyString) const;
|
|
|
|
// this is hack to work around a problem with wxGetTranslation() which
|
|
// returns const wxString& and not wxString, so when it returns untranslated
|
|
// string, it needs to have a copy of it somewhere
|
|
static const wxString& GetUntranslatedString(const wxString& str);
|
|
|
|
private:
|
|
// perform loading of the catalog via m_loader
|
|
bool LoadCatalog(const wxString& domain, const wxString& lang);
|
|
|
|
// find catalog by name in a linked list, return NULL if !found
|
|
wxMsgCatalog *FindCatalog(const wxString& domain) const;
|
|
|
|
// same as Set(), without taking ownership; only for wxLocale
|
|
static void SetNonOwned(wxTranslations *t);
|
|
friend class wxLocale;
|
|
|
|
private:
|
|
wxString m_lang;
|
|
wxTranslationsLoader *m_loader;
|
|
|
|
wxMsgCatalog *m_pMsgCat; // pointer to linked list of catalogs
|
|
};
|
|
|
|
|
|
// abstraction of translations discovery and loading
|
|
class WXDLLIMPEXP_BASE wxTranslationsLoader
|
|
{
|
|
public:
|
|
wxTranslationsLoader() {}
|
|
virtual ~wxTranslationsLoader() {}
|
|
|
|
virtual wxMsgCatalog *LoadCatalog(const wxString& domain,
|
|
const wxString& lang) = 0;
|
|
|
|
virtual wxArrayString GetAvailableTranslations(const wxString& domain) const = 0;
|
|
};
|
|
|
|
|
|
// standard wxTranslationsLoader implementation, using filesystem
|
|
class WXDLLIMPEXP_BASE wxFileTranslationsLoader
|
|
: public wxTranslationsLoader
|
|
{
|
|
public:
|
|
static void AddCatalogLookupPathPrefix(const wxString& prefix);
|
|
|
|
virtual wxMsgCatalog *LoadCatalog(const wxString& domain,
|
|
const wxString& lang);
|
|
|
|
virtual wxArrayString GetAvailableTranslations(const wxString& domain) const;
|
|
};
|
|
|
|
|
|
#ifdef __WINDOWS__
|
|
// loads translations from win32 resources
|
|
class WXDLLIMPEXP_BASE wxResourceTranslationsLoader
|
|
: public wxTranslationsLoader
|
|
{
|
|
public:
|
|
virtual wxMsgCatalog *LoadCatalog(const wxString& domain,
|
|
const wxString& lang);
|
|
|
|
virtual wxArrayString GetAvailableTranslations(const wxString& domain) const;
|
|
|
|
protected:
|
|
// returns resource type to use for translations
|
|
virtual wxString GetResourceType() const { return "MOFILE"; }
|
|
|
|
// returns module to load resources from
|
|
virtual WXHINSTANCE GetModule() const { return 0; }
|
|
};
|
|
#endif // __WINDOWS__
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// global functions
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// get the translation of the string in the current locale
|
|
inline const wxString& wxGetTranslation(const wxString& str,
|
|
const wxString& domain = wxEmptyString)
|
|
{
|
|
wxTranslations *trans = wxTranslations::Get();
|
|
if ( trans )
|
|
return trans->GetString(str, domain);
|
|
else
|
|
// NB: this function returns reference to a string, so we have to keep
|
|
// a copy of it somewhere
|
|
return wxTranslations::GetUntranslatedString(str);
|
|
}
|
|
|
|
inline const wxString& wxGetTranslation(const wxString& str1,
|
|
const wxString& str2,
|
|
unsigned n,
|
|
const wxString& domain = wxEmptyString)
|
|
{
|
|
wxTranslations *trans = wxTranslations::Get();
|
|
if ( trans )
|
|
return trans->GetString(str1, str2, n, domain);
|
|
else
|
|
// NB: this function returns reference to a string, so we have to keep
|
|
// a copy of it somewhere
|
|
return n == 1
|
|
? wxTranslations::GetUntranslatedString(str1)
|
|
: wxTranslations::GetUntranslatedString(str2);
|
|
}
|
|
|
|
#else // !wxUSE_INTL
|
|
|
|
// the macros should still be defined - otherwise compilation would fail
|
|
|
|
#if !defined(WXINTL_NO_GETTEXT_MACRO)
|
|
#if !defined(_)
|
|
#define _(s) (s)
|
|
#endif
|
|
#define wxPLURAL(sing, plur, n) ((n) == 1 ? (sing) : (plur))
|
|
#endif
|
|
|
|
#define wxTRANSLATE(str) str
|
|
|
|
// NB: we use a template here in order to avoid using
|
|
// wxLocale::GetUntranslatedString() above, which would be required if
|
|
// we returned const wxString&; this way, the compiler should be able to
|
|
// optimize wxGetTranslation() away
|
|
|
|
template<typename TString>
|
|
inline TString wxGetTranslation(TString str)
|
|
{ return str; }
|
|
|
|
template<typename TString, typename TDomain>
|
|
inline TString wxGetTranslation(TString str, TDomain WXUNUSED(domain))
|
|
{ return str; }
|
|
|
|
template<typename TString, typename TDomain>
|
|
inline TString wxGetTranslation(TString str1, TString str2, size_t n)
|
|
{ return n == 1 ? str1 : str2; }
|
|
|
|
template<typename TString, typename TDomain>
|
|
inline TString wxGetTranslation(TString str1, TString str2, size_t n,
|
|
TDomain WXUNUSED(domain))
|
|
{ return n == 1 ? str1 : str2; }
|
|
|
|
#endif // wxUSE_INTL/!wxUSE_INTL
|
|
|
|
// define this one just in case it occurs somewhere (instead of preferred
|
|
// wxTRANSLATE) too
|
|
#if !defined(WXINTL_NO_GETTEXT_MACRO)
|
|
#if !defined(gettext_noop)
|
|
#define gettext_noop(str) (str)
|
|
#endif
|
|
#if !defined(N_)
|
|
#define N_(s) (s)
|
|
#endif
|
|
#endif
|
|
|
|
#endif // _WX_TRANSLATION_H_
|