1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Internationalization and localisation for wxWindows
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "intl.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
39 #include "wx/string.h"
48 // ----------------------------------------------------------------------------
50 // ----------------------------------------------------------------------------
52 // this should *not* be wxChar, this type must have exactly 8 bits!
53 typedef unsigned char size_t8
;
56 #if defined(__WIN16__)
57 typedef unsigned long size_t32
;
58 #elif defined(__WIN32__)
59 typedef unsigned int size_t32
;
61 // Win64 will have different type sizes
62 #error "Please define a 32 bit type"
65 // SIZEOF_XXX are defined by configure
66 #if defined(SIZEOF_INT) && (SIZEOF_INT == 4)
67 typedef unsigned int size_t32
;
68 #elif defined(SIZEOF_LONG) && (SIZEOF_LONG == 4)
69 typedef unsigned long size_t32
;
71 // assume sizeof(int) == 4 - what else can we do
72 typedef unsigned int size_t32
;
74 // ... but at least check it during run time
75 static class IntSizeChecker
80 // Asserting a sizeof directly causes some compilers to
81 // issue a "using constant in a conditional expression" warning
82 size_t intsize
= sizeof(int);
84 wxASSERT_MSG( intsize
== 4,
85 "size_t32 is incorrectly defined!" );
91 // ----------------------------------------------------------------------------
93 // ----------------------------------------------------------------------------
95 // magic number identifying the .mo format file
96 const size_t32 MSGCATALOG_MAGIC
= 0x950412de;
97 const size_t32 MSGCATALOG_MAGIC_SW
= 0xde120495;
99 // extension of ".mo" files
100 #define MSGCATALOG_EXTENSION ".mo"
102 // ----------------------------------------------------------------------------
104 // ----------------------------------------------------------------------------
106 // suppress further error messages about missing translations
107 // (if you don't have one catalog file, you wouldn't like to see the
108 // error message for each string in it, so normally it's given only
110 void wxSuppressTransErrors();
112 // restore the logging
113 void wxRestoreTransErrors();
115 // get the current state
116 bool wxIsLoggingTransErrors();
118 static wxLocale
*wxSetLocale(wxLocale
*pLocale
);
120 // ----------------------------------------------------------------------------
121 // wxMsgCatalog corresponds to one disk-file message catalog.
123 // This is a "low-level" class and is used only by wxLocale (that's why
124 // it's designed to be stored in a linked list)
125 // ----------------------------------------------------------------------------
134 // load the catalog from disk (szDirPrefix corresponds to language)
135 bool Load(const wxChar
*szDirPrefix
, const wxChar
*szName
, bool bConvertEncoding
= FALSE
);
136 bool IsLoaded() const { return m_pData
!= NULL
; }
138 // get name of the catalog
139 const wxChar
*GetName() const { return m_pszName
; }
141 // get the translated string: returns NULL if not found
142 const char *GetString(const char *sz
) const;
144 // public variable pointing to the next element in a linked list (or NULL)
145 wxMsgCatalog
*m_pNext
;
148 // this implementation is binary compatible with GNU gettext() version 0.10
150 // an entry in the string table
151 struct wxMsgTableEntry
153 size_t32 nLen
; // length of the string
154 size_t32 ofsString
; // pointer to the string
157 // header of a .mo file
158 struct wxMsgCatalogHeader
160 size_t32 magic
, // offset +00: magic id
161 revision
, // +04: revision
162 numStrings
; // +08: number of strings in the file
163 size_t32 ofsOrigTable
, // +0C: start of original string table
164 ofsTransTable
; // +10: start of translated string table
165 size_t32 nHashSize
, // +14: hash table size
166 ofsHashTable
; // +18: offset of hash table start
169 // all data is stored here, NULL if no data loaded
173 size_t32 m_numStrings
, // number of strings in this domain
174 m_nHashSize
; // number of entries in hash table
175 size_t32
*m_pHashTable
; // pointer to hash table
176 wxMsgTableEntry
*m_pOrigTable
, // pointer to original strings
177 *m_pTransTable
; // translated
179 const char *StringAtOfs(wxMsgTableEntry
*pTable
, size_t32 index
) const
180 { return (const char *)(m_pData
+ Swap(pTable
[index
].ofsString
)); }
182 // convert encoding to platform native one, if neccessary
183 void ConvertEncoding();
186 // calculate the hash value of given string
187 static inline size_t32
GetHash(const char *sz
);
188 // big<->little endian
189 inline size_t32
Swap(size_t32 ui
) const;
192 bool HasHashTable() const // true if hash table is present
193 { return m_nHashSize
> 2 && m_pHashTable
!= NULL
; }
195 bool m_bSwapped
; // wrong endianness?
197 wxChar
*m_pszName
; // name of the domain
200 // ----------------------------------------------------------------------------
202 // ----------------------------------------------------------------------------
204 // the list of the directories to search for message catalog files
205 static wxArrayString s_searchPrefixes
;
207 // ============================================================================
209 // ============================================================================
211 // ----------------------------------------------------------------------------
212 // wxMsgCatalog class
213 // ----------------------------------------------------------------------------
215 // calculate hash value using the so called hashpjw function by P.J. Weinberger
216 // [see Aho/Sethi/Ullman, COMPILERS: Principles, Techniques and Tools]
217 size_t32
wxMsgCatalog::GetHash(const char *sz
)
219 #define HASHWORDBITS 32 // the length of size_t32
223 while ( *sz
!= '\0' ) {
225 hval
+= (size_t32
)*sz
++;
226 g
= hval
& ((size_t32
)0xf << (HASHWORDBITS
- 4));
228 hval
^= g
>> (HASHWORDBITS
- 8);
236 // swap the 2 halves of 32 bit integer if needed
237 size_t32
wxMsgCatalog::Swap(size_t32 ui
) const
239 return m_bSwapped
? (ui
<< 24) | ((ui
& 0xff00) << 8) |
240 ((ui
>> 8) & 0xff00) | (ui
>> 24)
244 wxMsgCatalog::wxMsgCatalog()
250 wxMsgCatalog::~wxMsgCatalog()
253 wxDELETEA(m_pszName
);
256 // small class to suppress the translation erros until exit from current scope
260 NoTransErr() { wxSuppressTransErrors(); }
261 ~NoTransErr() { wxRestoreTransErrors(); }
264 // return all directories to search for given prefix
265 static wxString
GetAllMsgCatalogSubdirs(const wxChar
*prefix
,
270 // search first in prefix/fr/LC_MESSAGES, then in prefix/fr and finally in
271 // prefix (assuming the language is 'fr')
272 searchPath
<< prefix
<< wxFILE_SEP_PATH
<< lang
<< wxFILE_SEP_PATH
273 << wxT("LC_MESSAGES") << wxPATH_SEP
274 << prefix
<< wxFILE_SEP_PATH
<< lang
<< wxPATH_SEP
275 << prefix
<< wxPATH_SEP
;
280 // construct the search path for the given language
281 static wxString
GetFullSearchPath(const wxChar
*lang
)
285 // first take the entries explicitly added by the program
286 size_t count
= s_searchPrefixes
.Count();
287 for ( size_t n
= 0; n
< count
; n
++ )
289 searchPath
<< GetAllMsgCatalogSubdirs(s_searchPrefixes
[n
], lang
)
293 // then take the current directory
294 // FIXME it should be the directory of the executable
295 searchPath
<< GetAllMsgCatalogSubdirs(wxT("."), lang
) << wxPATH_SEP
;
297 // and finally add some standard ones
299 << GetAllMsgCatalogSubdirs(wxT("/usr/share/locale"), lang
) << wxPATH_SEP
300 << GetAllMsgCatalogSubdirs(wxT("/usr/lib/locale"), lang
) << wxPATH_SEP
301 << GetAllMsgCatalogSubdirs(wxT("/usr/local/share/locale"), lang
);
306 // open disk file and read in it's contents
307 bool wxMsgCatalog::Load(const wxChar
*szDirPrefix
, const wxChar
*szName0
, bool bConvertEncoding
)
309 /* We need to handle locales like de_AT.iso-8859-1
310 For this we first chop off the .CHARSET specifier and ignore it.
311 FIXME: UNICODE SUPPORT: must use CHARSET specifier!
313 wxString szName
= szName0
;
314 if(szName
.Find(wxT('.')) != -1) // contains a dot
315 szName
= szName
.Left(szName
.Find(wxT('.')));
317 // FIXME VZ: I forgot the exact meaning of LC_PATH - anyone to remind me?
318 // KB: search path where to find the mo files, probably : delimited
320 const wxChar
*pszLcPath
= wxGetenv("LC_PATH");
321 if ( pszLcPath
!= NULL
)
322 strPath
+= pszLcPath
+ wxString(szDirPrefix
) + MSG_PATH
;
325 wxString searchPath
= GetFullSearchPath(szDirPrefix
);
326 const wxChar
*sublocale
= wxStrchr(szDirPrefix
, wxT('_'));
329 // also add just base locale name: for things like "fr_BE" (belgium
330 // french) we should use "fr" if no belgium specific message catalogs
332 searchPath
<< GetFullSearchPath(wxString(szDirPrefix
).
333 Left((size_t)(sublocale
- szDirPrefix
)))
337 wxString strFile
= szName
;
338 strFile
+= MSGCATALOG_EXTENSION
;
340 // don't give translation errors here because the wxstd catalog might
341 // not yet be loaded (and it's normal)
343 // (we're using an object because we have several return paths)
345 NoTransErr noTransErr
;
346 wxLogVerbose(wxT("looking for catalog '%s' in path '%s'."),
347 szName
.c_str(), searchPath
.c_str());
349 wxString strFullName
;
350 if ( !wxFindFileInPath(&strFullName
, searchPath
, strFile
) ) {
351 wxLogWarning(_("catalog file for domain '%s' not found."), szName
.c_str());
356 wxLogVerbose(_("using catalog '%s' from '%s'."),
357 szName
.c_str(), strFullName
.c_str());
359 wxFile
fileMsg(strFullName
);
360 if ( !fileMsg
.IsOpened() )
364 off_t nSize
= fileMsg
.Length();
365 if ( nSize
== wxInvalidOffset
)
368 // read the whole file in memory
369 m_pData
= new size_t8
[nSize
];
370 if ( fileMsg
.Read(m_pData
, nSize
) != nSize
) {
376 bool bValid
= (size_t)nSize
> sizeof(wxMsgCatalogHeader
);
378 wxMsgCatalogHeader
*pHeader
= (wxMsgCatalogHeader
*)m_pData
;
380 // we'll have to swap all the integers if it's true
381 m_bSwapped
= pHeader
->magic
== MSGCATALOG_MAGIC_SW
;
383 // check the magic number
384 bValid
= m_bSwapped
|| pHeader
->magic
== MSGCATALOG_MAGIC
;
388 // it's either too short or has incorrect magic number
389 wxLogWarning(_("'%s' is not a valid message catalog."), strFullName
.c_str());
396 m_numStrings
= Swap(pHeader
->numStrings
);
397 m_pOrigTable
= (wxMsgTableEntry
*)(m_pData
+
398 Swap(pHeader
->ofsOrigTable
));
399 m_pTransTable
= (wxMsgTableEntry
*)(m_pData
+
400 Swap(pHeader
->ofsTransTable
));
402 m_nHashSize
= Swap(pHeader
->nHashSize
);
403 m_pHashTable
= (size_t32
*)(m_pData
+ Swap(pHeader
->ofsHashTable
));
405 m_pszName
= new wxChar
[wxStrlen(szName
) + 1];
406 wxStrcpy(m_pszName
, szName
);
408 if (bConvertEncoding
) ConvertEncoding();
410 // everything is fine
414 // search for a string
415 const char *wxMsgCatalog::GetString(const char *szOrig
) const
417 if ( szOrig
== NULL
)
420 if ( HasHashTable() ) { // use hash table for lookup if possible
421 size_t32 nHashVal
= GetHash(szOrig
);
422 size_t32 nIndex
= nHashVal
% m_nHashSize
;
424 size_t32 nIncr
= 1 + (nHashVal
% (m_nHashSize
- 2));
426 #if defined(__VISAGECPP__)
427 // VA just can't stand while(1) or while(TRUE)
433 size_t32 nStr
= Swap(m_pHashTable
[nIndex
]);
437 if ( strcmp(szOrig
, StringAtOfs(m_pOrigTable
, nStr
- 1)) == 0 )
438 return StringAtOfs(m_pTransTable
, nStr
- 1);
440 if ( nIndex
>= m_nHashSize
- nIncr
)
441 nIndex
-= m_nHashSize
- nIncr
;
446 else { // no hash table: use default binary search
450 while ( bottom
< top
) {
451 current
= (bottom
+ top
) / 2;
452 int res
= strcmp(szOrig
, StringAtOfs(m_pOrigTable
, current
));
456 bottom
= current
+ 1;
458 return StringAtOfs(m_pTransTable
, current
);
468 #include "wx/fontmap.h"
469 #include "wx/encconv.h"
472 void wxMsgCatalog::ConvertEncoding()
477 // first, find encoding header:
478 const char *hdr
= GetString("$ENCODING");
479 if (hdr
== NULL
) return; // not supported by this catalog
480 if ((enc
= wxTheFontMapper
-> CharsetToEncoding(hdr
, FALSE
)) == wxFONTENCODING_SYSTEM
) return;
482 wxFontEncodingArray a
= wxEncodingConverter::GetPlatformEquivalents(enc
);
483 if (a
[0] == enc
) return; // no conversion needed, locale uses native encoding
485 if (a
.GetCount() == 0) return; // we don't know common equiv. under this platform
487 wxEncodingConverter converter
;
489 converter
.Init(enc
, a
[0]);
490 for (unsigned i
= 0; i
< m_numStrings
; i
++)
491 converter
.Convert((char*)StringAtOfs(m_pTransTable
, i
));
496 // ----------------------------------------------------------------------------
498 // ----------------------------------------------------------------------------
502 m_pszOldLocale
= NULL
;
506 // NB: this function has (desired) side effect of changing current locale
507 bool wxLocale::Init(const wxChar
*szName
,
508 const wxChar
*szShort
,
509 const wxChar
*szLocale
,
511 bool bConvertEncoding
)
513 m_strLocale
= szName
;
514 m_strShort
= szShort
;
515 m_bConvertEncoding
= bConvertEncoding
;
517 // change current locale (default: same as long name)
518 if ( szLocale
== NULL
)
520 // the argument to setlocale()
523 m_pszOldLocale
= wxSetlocale(LC_ALL
, szLocale
);
524 if ( m_pszOldLocale
== NULL
)
525 wxLogError(_("locale '%s' can not be set."), szLocale
);
527 // the short name will be used to look for catalog files as well,
528 // so we need something here
529 if ( m_strShort
.IsEmpty() ) {
530 // FIXME I don't know how these 2 letter abbreviations are formed,
531 // this wild guess is surely wrong
532 m_strShort
= tolower(szLocale
[0]) + tolower(szLocale
[1]);
535 // save the old locale to be able to restore it later
536 m_pOldLocale
= wxSetLocale(this);
538 // load the default catalog with wxWindows standard messages
542 bOk
= AddCatalog(wxT("wxstd"));
547 void wxLocale::AddCatalogLookupPathPrefix(const wxString
& prefix
)
549 if ( s_searchPrefixes
.Index(prefix
) == wxNOT_FOUND
)
551 s_searchPrefixes
.Add(prefix
);
553 //else: already have it
557 wxLocale::~wxLocale()
560 wxMsgCatalog
*pTmpCat
;
561 while ( m_pMsgCat
!= NULL
) {
563 m_pMsgCat
= m_pMsgCat
->m_pNext
;
567 // restore old locale
568 wxSetLocale(m_pOldLocale
);
569 wxSetlocale(LC_ALL
, m_pszOldLocale
);
572 // get the translation of given string in current locale
573 const wxMB2WXbuf
wxLocale::GetString(const wxChar
*szOrigString
,
574 const wxChar
*szDomain
) const
576 if ( wxIsEmpty(szOrigString
) )
579 const char *pszTrans
= NULL
;
581 const wxWX2MBbuf szOrgString
= wxConvCurrent
->cWX2MB(szOrigString
);
583 #define szOrgString szOrigString
584 #endif // Unicode/ANSI
586 wxMsgCatalog
*pMsgCat
;
587 if ( szDomain
!= NULL
) {
588 pMsgCat
= FindCatalog(szDomain
);
590 // does the catalog exist?
591 if ( pMsgCat
!= NULL
)
592 pszTrans
= pMsgCat
->GetString(szOrgString
);
595 // search in all domains
596 for ( pMsgCat
= m_pMsgCat
; pMsgCat
!= NULL
; pMsgCat
= pMsgCat
->m_pNext
) {
597 pszTrans
= pMsgCat
->GetString(szOrgString
);
598 if ( pszTrans
!= NULL
) // take the first found
603 if ( pszTrans
== NULL
) {
604 if ( wxIsLoggingTransErrors() ) {
605 // suppress further error messages if we're not debugging: this avoids
606 // flooding the user with messages about each and every missing string if,
607 // for example, a whole catalog file is missing.
609 // do it before calling LogWarning to prevent infinite recursion!
611 NoTransErr noTransErr
;
613 wxSuppressTransErrors();
614 #endif // debug/!debug
616 if ( szDomain
!= NULL
)
618 wxLogWarning(_("string '%s' not found in domain '%s' for locale '%s'."),
619 szOrigString
, szDomain
, m_strLocale
.c_str());
623 wxLogWarning(_("string '%s' not found in locale '%s'."),
624 szOrigString
, m_strLocale
.c_str());
628 return (wxMB2WXbuf
)(szOrigString
);
632 return wxConvertMB2WX(pszTrans
); // or preferably wxCSConv(charset).cMB2WX(pszTrans) or something,
633 // a macro similar to wxConvertMB2WX could be written for that
639 // find catalog by name in a linked list, return NULL if !found
640 wxMsgCatalog
*wxLocale::FindCatalog(const wxChar
*szDomain
) const
642 // linear search in the linked list
643 wxMsgCatalog
*pMsgCat
;
644 for ( pMsgCat
= m_pMsgCat
; pMsgCat
!= NULL
; pMsgCat
= pMsgCat
->m_pNext
) {
645 if ( wxStricmp(pMsgCat
->GetName(), szDomain
) == 0 )
652 // check if the given catalog is loaded
653 bool wxLocale::IsLoaded(const wxChar
*szDomain
) const
655 return FindCatalog(szDomain
) != NULL
;
658 // add a catalog to our linked list
659 bool wxLocale::AddCatalog(const wxChar
*szDomain
)
661 wxMsgCatalog
*pMsgCat
= new wxMsgCatalog
;
663 if ( pMsgCat
->Load(m_strShort
, szDomain
, m_bConvertEncoding
) ) {
664 // add it to the head of the list so that in GetString it will
665 // be searched before the catalogs added earlier
666 pMsgCat
->m_pNext
= m_pMsgCat
;
672 // don't add it because it couldn't be loaded anyway
679 // ----------------------------------------------------------------------------
680 // global functions and variables
681 // ----------------------------------------------------------------------------
683 // translation errors logging
684 // --------------------------
686 static bool gs_bGiveTransErrors
= TRUE
;
688 void wxSuppressTransErrors()
690 gs_bGiveTransErrors
= FALSE
;
693 void wxRestoreTransErrors()
695 gs_bGiveTransErrors
= TRUE
;
698 bool wxIsLoggingTransErrors()
700 return gs_bGiveTransErrors
;
703 // retrieve/change current locale
704 // ------------------------------
706 // the current locale object
707 static wxLocale
*g_pLocale
= NULL
;
709 wxLocale
*wxGetLocale()
714 wxLocale
*wxSetLocale(wxLocale
*pLocale
)
716 wxLocale
*pOld
= g_pLocale
;