src/common/fontmap.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        common/fontmap.cpp
   3 // Purpose:     wxFontMapper class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     04.11.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1999-2003 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21     #pragma implementation "fontmap.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_FONTMAP
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/app.h"
  35     #include "wx/log.h"
  36     #include "wx/intl.h"
  37 #endif // PCH
  38
  39 #if wxUSE_CONFIG
  40     #include "wx/config.h"
  41 #endif // wxUSE_CONFIG
  42
  43 #if defined(__WXMSW__)
  44   #include  "wx/msw/private.h"  // includes windows.h for LOGFONT
  45   #include  "wx/msw/winundef.h"
  46 #endif
  47
  48 #include "wx/fontmap.h"
  49 #include "wx/fmappriv.h"
  50 #include "wx/fontutil.h"
  51 #include "wx/msgdlg.h"
  52 #include "wx/fontdlg.h"
  53 #include "wx/choicdlg.h"
  54
  55 #include "wx/encconv.h"
  56
  57 #if wxUSE_EXTENDED_RTTI
  58
  59 wxBEGIN_ENUM( wxFontEncoding )
  60     wxENUM_MEMBER( wxFONTENCODING_SYSTEM )
  61     wxENUM_MEMBER( wxFONTENCODING_DEFAULT )
  62
  63     wxENUM_MEMBER( wxFONTENCODING_ISO8859_1 )
  64     wxENUM_MEMBER( wxFONTENCODING_ISO8859_2 )
  65     wxENUM_MEMBER( wxFONTENCODING_ISO8859_3 )
  66     wxENUM_MEMBER( wxFONTENCODING_ISO8859_4 )
  67     wxENUM_MEMBER( wxFONTENCODING_ISO8859_5 )
  68     wxENUM_MEMBER( wxFONTENCODING_ISO8859_6 )
  69     wxENUM_MEMBER( wxFONTENCODING_ISO8859_7 )
  70     wxENUM_MEMBER( wxFONTENCODING_ISO8859_8 )
  71     wxENUM_MEMBER( wxFONTENCODING_ISO8859_9 )
  72     wxENUM_MEMBER( wxFONTENCODING_ISO8859_10 )
  73     wxENUM_MEMBER( wxFONTENCODING_ISO8859_11 )
  74     wxENUM_MEMBER( wxFONTENCODING_ISO8859_12 )
  75     wxENUM_MEMBER( wxFONTENCODING_ISO8859_13 )
  76     wxENUM_MEMBER( wxFONTENCODING_ISO8859_14 )
  77     wxENUM_MEMBER( wxFONTENCODING_ISO8859_15 )
  78     wxENUM_MEMBER( wxFONTENCODING_ISO8859_MAX )
  79     wxENUM_MEMBER( wxFONTENCODING_KOI8 )
  80     wxENUM_MEMBER( wxFONTENCODING_KOI8_U )
  81     wxENUM_MEMBER( wxFONTENCODING_ALTERNATIVE )
  82     wxENUM_MEMBER( wxFONTENCODING_BULGARIAN )
  83     wxENUM_MEMBER( wxFONTENCODING_CP437 )
  84     wxENUM_MEMBER( wxFONTENCODING_CP850 )
  85     wxENUM_MEMBER( wxFONTENCODING_CP852 )
  86     wxENUM_MEMBER( wxFONTENCODING_CP855 )
  87     wxENUM_MEMBER( wxFONTENCODING_CP866 )
  88
  89     wxENUM_MEMBER( wxFONTENCODING_CP874 )
  90     wxENUM_MEMBER( wxFONTENCODING_CP932 )
  91     wxENUM_MEMBER( wxFONTENCODING_CP936 )
  92     wxENUM_MEMBER( wxFONTENCODING_CP949 )
  93     wxENUM_MEMBER( wxFONTENCODING_CP950 )
  94     wxENUM_MEMBER( wxFONTENCODING_CP1250 )
  95     wxENUM_MEMBER( wxFONTENCODING_CP1251 )
  96     wxENUM_MEMBER( wxFONTENCODING_CP1252 )
  97     wxENUM_MEMBER( wxFONTENCODING_CP1253 )
  98     wxENUM_MEMBER( wxFONTENCODING_CP1254 )
  99     wxENUM_MEMBER( wxFONTENCODING_CP1255 )
 100     wxENUM_MEMBER( wxFONTENCODING_CP1256 )
 101     wxENUM_MEMBER( wxFONTENCODING_CP1257 )
 102     wxENUM_MEMBER( wxFONTENCODING_CP12_MAX )
 103     wxENUM_MEMBER( wxFONTENCODING_UTF7 )
 104     wxENUM_MEMBER( wxFONTENCODING_UTF8 )
 105     wxENUM_MEMBER( wxFONTENCODING_GB2312 )
 106     wxENUM_MEMBER( wxFONTENCODING_BIG5 )
 107     wxENUM_MEMBER( wxFONTENCODING_SHIFT_JIS )
 108     wxENUM_MEMBER( wxFONTENCODING_EUC_JP )
 109     wxENUM_MEMBER( wxFONTENCODING_UNICODE )
 110 wxEND_ENUM( wxFontEncoding )
 111 #endif
 112
 113 // ----------------------------------------------------------------------------
 114 // constants
 115 // ----------------------------------------------------------------------------
 116
 117 // the config paths we use
 118 #if wxUSE_CONFIG
 119
 120 static const wxChar* FONTMAPPER_FONT_FROM_ENCODING_PATH = wxT("Encodings");
 121 static const wxChar* FONTMAPPER_FONT_DONT_ASK = wxT("none");
 122
 123 #endif // wxUSE_CONFIG
 124
 125 // ----------------------------------------------------------------------------
 126 // private classes
 127 // ----------------------------------------------------------------------------
 128
 129 // it may happen that while we're showing a dialog asking the user about
 130 // something, another request for an encoding mapping arrives: in this case it
 131 // is best to not do anything because otherwise we risk to enter an infinite
 132 // loop so we create an object of this class on stack to test for this in all
 133 // interactive functions
 134 class ReentrancyBlocker
 135 {
 136 public:
 137     ReentrancyBlocker(bool& flag) : m_flagOld(flag), m_flag(flag)
 138         { m_flag = true; }
 139     ~ReentrancyBlocker() { m_flag = m_flagOld; }
 140
 141 private:
 142     bool m_flagOld;
 143     bool& m_flag;
 144
 145     DECLARE_NO_COPY_CLASS(ReentrancyBlocker)
 146 };
 147
 148 // ============================================================================
 149 // implementation
 150 // ============================================================================
 151
 152 // ----------------------------------------------------------------------------
 153 // ctor and dtor
 154 // ----------------------------------------------------------------------------
 155
 156 wxFontMapper::wxFontMapper()
 157 {
 158     m_windowParent = NULL;
 159 }
 160
 161 wxFontMapper::~wxFontMapper()
 162 {
 163 }
 164
 165 wxFontEncoding
 166 wxFontMapper::CharsetToEncoding(const wxString& charset, bool interactive)
 167 {
 168     // try the ways not needing the users intervention first
 169     int encoding = wxFontMapperBase::NonInteractiveCharsetToEncoding(charset);
 170
 171     // if we failed to find the encoding, ask the user -- unless disabled
 172     if ( encoding == wxFONTENCODING_UNKNOWN )
 173     {
 174         // this is the special value which disables asking the user (he had
 175         // chosen to suppress this the last time)
 176         encoding = wxFONTENCODING_SYSTEM;
 177     }
 178 #if wxUSE_CHOICEDLG
 179     else if ( (encoding == wxFONTENCODING_SYSTEM) && interactive )
 180     {
 181         // prepare the dialog data
 182
 183         // the dialog title
 184         wxString title(m_titleDialog);
 185         if ( !title )
 186             title << wxTheApp->GetAppName() << _(": unknown charset");
 187
 188         // the message
 189         wxString msg;
 190         msg.Printf(_("The charset '%s' is unknown. You may select\nanother charset to replace it with or choose\n[Cancel] if it cannot be replaced"), charset.c_str());
 191
 192         // the list of choices
 193         const size_t count = GetSupportedEncodingsCount();
 194
 195         wxString *encodingNamesTranslated = new wxString[count];
 196
 197         for ( size_t i = 0; i < count; i++ )
 198         {
 199             encodingNamesTranslated[i] = GetEncodingDescription(GetEncoding(i));
 200         }
 201
 202         // the parent window
 203         wxWindow *parent = m_windowParent;
 204         if ( !parent )
 205             parent = wxTheApp->GetTopWindow();
 206
 207         // do ask the user and get back the index in encodings table
 208         int n = wxGetSingleChoiceIndex(msg, title,
 209                                        count,
 210                                        encodingNamesTranslated,
 211                                        parent);
 212
 213         delete [] encodingNamesTranslated;
 214
 215         if ( n != -1 )
 216         {
 217             encoding = GetEncoding(n);
 218         }
 219
 220 #if wxUSE_CONFIG && wxUSE_FILECONFIG
 221         // save the result in the config now
 222         wxFontMapperPathChanger path(this, FONTMAPPER_CHARSET_PATH);
 223         if ( path.IsOk() )
 224         {
 225             wxConfigBase *config = GetConfig();
 226
 227             // remember the alt encoding for this charset -- or remember that
 228             // we don't know it
 229             long value = n == -1 ? wxFONTENCODING_UNKNOWN : (long)encoding;
 230             if ( !config->Write(charset, value) )
 231             {
 232                 wxLogError(_("Failed to remember the encoding for the charset '%s'."), charset.c_str());
 233             }
 234         }
 235 #endif // wxUSE_CONFIG
 236     }
 237 #else
 238     wxUnusedVar(interactive);
 239 #endif // wxUSE_CHOICEDLG
 240
 241     return (wxFontEncoding)encoding;
 242 }
 243
 244 // ----------------------------------------------------------------------------
 245 // support for unknown encodings: we maintain a map between the
 246 // (platform-specific) strings identifying them and our wxFontEncodings they
 247 // correspond to which is used by GetFontForEncoding() function
 248 // ----------------------------------------------------------------------------
 249
 250 bool wxFontMapper::TestAltEncoding(const wxString& configEntry,
 251                                    wxFontEncoding encReplacement,
 252                                    wxNativeEncodingInfo *info)
 253 {
 254     if ( wxGetNativeFontEncoding(encReplacement, info) &&
 255          wxTestFontEncoding(*info) )
 256     {
 257 #if wxUSE_CONFIG && wxUSE_FILECONFIG
 258         // remember the mapping in the config
 259         wxFontMapperPathChanger path(this, FONTMAPPER_FONT_FROM_ENCODING_PATH);
 260
 261         if ( path.IsOk() )
 262         {
 263             GetConfig()->Write(configEntry, info->ToString());
 264         }
 265 #endif // wxUSE_CONFIG
 266         return true;
 267     }
 268
 269     return false;
 270 }
 271
 272 bool wxFontMapper::GetAltForEncoding(wxFontEncoding encoding,
 273                                      wxNativeEncodingInfo *info,
 274                                      const wxString& facename,
 275                                      bool interactive)
 276 {
 277 #if wxUSE_GUI
 278     // we need a flag to prevent infinite recursion which happens, for
 279     // example, when GetAltForEncoding() is called from an OnPaint() handler:
 280     // in this case, wxYield() which is called from wxMessageBox() we use here
 281     // will lead to another call of OnPaint() and hence to another call of
 282     // GetAltForEncoding() -- and it is impossible to catch this from the user
 283     // code because we are called from wxFont ctor implicitly.
 284
 285     // assume we're always called from the main thread, so that it is safe to
 286     // use a static var
 287     static bool s_inGetAltForEncoding = false;
 288
 289     if ( interactive && s_inGetAltForEncoding )
 290         return false;
 291
 292     ReentrancyBlocker blocker(s_inGetAltForEncoding);
 293 #endif // wxUSE_GUI
 294
 295     wxCHECK_MSG( info, false, wxT("bad pointer in GetAltForEncoding") );
 296
 297     info->facename = facename;
 298
 299     if ( encoding == wxFONTENCODING_DEFAULT )
 300     {
 301         encoding = wxFont::GetDefaultEncoding();
 302     }
 303
 304     // if we failed to load the system default encoding, something is really
 305     // wrong and we'd better stop now -- otherwise we will go into endless
 306     // recursion trying to create the font in the msg box with the error
 307     // message
 308     if ( encoding == wxFONTENCODING_SYSTEM )
 309     {
 310         wxLogFatalError(_("can't load any font, aborting"));
 311
 312         // wxLogFatalError doesn't return
 313     }
 314
 315     wxString configEntry,
 316              encName = GetEncodingName(encoding);
 317     if ( !!facename )
 318     {
 319         configEntry = facename + _T("_");
 320     }
 321     configEntry += encName;
 322
 323 #if wxUSE_CONFIG && wxUSE_FILECONFIG
 324     // do we have a font spec for this encoding?
 325     wxString fontinfo;
 326     wxFontMapperPathChanger path(this, FONTMAPPER_FONT_FROM_ENCODING_PATH);
 327     if ( path.IsOk() )
 328     {
 329         fontinfo = GetConfig()->Read(configEntry);
 330     }
 331
 332     // this special value means that we don't know of fonts for this
 333     // encoding but, moreover, have already asked the user as well and he
 334     // didn't specify any font neither
 335     if ( fontinfo == FONTMAPPER_FONT_DONT_ASK )
 336     {
 337         interactive = false;
 338     }
 339     else // use the info entered the last time
 340     {
 341         if ( !!fontinfo && !!facename )
 342         {
 343             // we tried to find a match with facename -- now try without it
 344             fontinfo = GetConfig()->Read(encName);
 345         }
 346
 347         if ( !!fontinfo )
 348         {
 349             if ( info->FromString(fontinfo) )
 350             {
 351                 if ( wxTestFontEncoding(*info) )
 352                 {
 353                     // ok, got something
 354                     return true;
 355                 }
 356                 //else: no such fonts, look for something else
 357                 //      (should we erase the outdated value?)
 358             }
 359             else
 360             {
 361                 wxLogDebug(wxT("corrupted config data: string '%s' is not a valid font encoding info"),
 362                            fontinfo.c_str());
 363             }
 364         }
 365         //else: there is no information in config about this encoding
 366     }
 367 #endif // wxUSE_CONFIG
 368
 369     // now try to map this encoding to a compatible one which we have on this
 370     // system
 371     wxFontEncodingArray equiv = wxEncodingConverter::GetAllEquivalents(encoding);
 372     size_t count = equiv.GetCount();
 373     bool foundEquivEncoding = false;
 374     wxFontEncoding equivEncoding = wxFONTENCODING_SYSTEM;
 375     if ( count )
 376     {
 377         for ( size_t i = 0; i < count && !foundEquivEncoding; i++ )
 378         {
 379             // don't test for encoding itself, we already know we don't have it
 380             if ( equiv[i] == encoding )
 381                 continue;
 382
 383             if ( TestAltEncoding(configEntry, equiv[i], info) )
 384             {
 385                 equivEncoding = equiv[i];
 386
 387                 foundEquivEncoding = true;
 388             }
 389         }
 390     }
 391
 392     // ask the user
 393 #if wxUSE_FONTDLG
 394     if ( interactive )
 395     {
 396         wxString title(m_titleDialog);
 397         if ( !title )
 398             title << wxTheApp->GetAppName() << _(": unknown encoding");
 399
 400         // built the message
 401         wxString encDesc = GetEncodingDescription(encoding),
 402                  msg;
 403         if ( foundEquivEncoding )
 404         {
 405             // ask the user if he wants to override found alternative encoding
 406             msg.Printf(_("No font for displaying text in encoding '%s' found,\nbut an alternative encoding '%s' is available.\nDo you want to use this encoding (otherwise you will have to choose another one)?"),
 407                        encDesc.c_str(), GetEncodingDescription(equivEncoding).c_str());
 408         }
 409         else
 410         {
 411             msg.Printf(_("No font for displaying text in encoding '%s' found.\nWould you like to select a font to be used for this encoding\n(otherwise the text in this encoding will not be shown correctly)?"),
 412                        encDesc.c_str());
 413         }
 414
 415         // the question is different in 2 cases so the answer has to be
 416         // interpreted differently as well
 417         int answer = foundEquivEncoding ? wxNO : wxYES;
 418
 419         if ( wxMessageBox(msg, title,
 420                           wxICON_QUESTION | wxYES_NO,
 421                           m_windowParent) == answer )
 422         {
 423             wxFontData data;
 424             data.SetEncoding(encoding);
 425             data.EncodingInfo() = *info;
 426             wxFontDialog dialog(m_windowParent, data);
 427             if ( dialog.ShowModal() == wxID_OK )
 428             {
 429                 wxFontData retData = dialog.GetFontData();
 430                 wxFont font = retData.GetChosenFont();
 431
 432                 *info = retData.EncodingInfo();
 433                 info->encoding = retData.GetEncoding();
 434
 435 #if wxUSE_CONFIG && wxUSE_FILECONFIG
 436                 // remember this in the config
 437                 wxFontMapperPathChanger path(this,
 438                                              FONTMAPPER_FONT_FROM_ENCODING_PATH);
 439                 if ( path.IsOk() )
 440                 {
 441                     GetConfig()->Write(configEntry, info->ToString());
 442                 }
 443 #endif // wxUSE_CONFIG
 444
 445                 return true;
 446             }
 447             //else: the user canceled the font selection dialog
 448         }
 449         else
 450         {
 451             // the user doesn't want to select a font for this encoding
 452             // or selected to use equivalent encoding
 453             //
 454             // remember it to avoid asking the same question again later
 455 #if wxUSE_CONFIG && wxUSE_FILECONFIG
 456             wxFontMapperPathChanger path(this,
 457                                          FONTMAPPER_FONT_FROM_ENCODING_PATH);
 458             if ( path.IsOk() )
 459             {
 460                 GetConfig()->Write
 461                              (
 462                                 configEntry,
 463                                 foundEquivEncoding ? info->ToString().c_str()
 464                                                    : FONTMAPPER_FONT_DONT_ASK
 465                              );
 466             }
 467 #endif // wxUSE_CONFIG
 468         }
 469     }
 470     //else: we're in non-interactive mode
 471 #else
 472     wxUnusedVar(equivEncoding);
 473 #endif // wxUSE_FONTDLG
 474
 475     return foundEquivEncoding;
 476 }
 477
 478 bool wxFontMapper::GetAltForEncoding(wxFontEncoding encoding,
 479                                      wxFontEncoding *encodingAlt,
 480                                      const wxString& facename,
 481                                      bool interactive)
 482 {
 483     wxNativeEncodingInfo info;
 484     if ( !GetAltForEncoding(encoding, &info, facename, interactive) )
 485         return false;
 486
 487     wxCHECK_MSG( encodingAlt, false,
 488                     _T("wxFontEncoding::GetAltForEncoding(): NULL pointer") );
 489
 490     *encodingAlt = info.encoding;
 491
 492     return true;
 493 }
 494
 495 bool wxFontMapper::IsEncodingAvailable(wxFontEncoding encoding,
 496                                        const wxString& facename)
 497 {
 498     wxNativeEncodingInfo info;
 499
 500     if ( !wxGetNativeFontEncoding(encoding, &info) )
 501         return false;
 502
 503     info.facename = facename;
 504     return wxTestFontEncoding(info);
 505 }
 506
 507 #endif // wxUSE_FONTMAP