Remove all lines containing cvs/svn "$Id$" keyword.
[wxWidgets.git] / src / gtk1 / font.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk1/font.cpp
3 // Purpose:
4 // Author: Robert Roebling
5 // Copyright: (c) 1998 Robert Roebling and Julian Smart
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
8
9 // ============================================================================
10 // declarations
11 // ============================================================================
12
13 // ----------------------------------------------------------------------------
14 // headers
15 // ----------------------------------------------------------------------------
16
17 // For compilers that support precompilation, includes "wx.h".
18 #include "wx/wxprec.h"
19
20 #include "wx/font.h"
21
22 #ifndef WX_PRECOMP
23 #include "wx/log.h"
24 #include "wx/settings.h"
25 #include "wx/gdicmn.h"
26 #include "wx/crt.h"
27 #endif
28
29 #include "wx/fontutil.h"
30 #include "wx/encinfo.h"
31 #include "wx/utils.h"
32 #include "wx/tokenzr.h"
33
34 #include <strings.h>
35
36 #include "wx/gtk1/private.h"
37 #include <gdk/gdkprivate.h>
38
39 // ----------------------------------------------------------------------------
40 // constants
41 // ----------------------------------------------------------------------------
42
43 // the default size (in points) for the fonts
44 static const int wxDEFAULT_FONT_SIZE = 12;
45
46 // ----------------------------------------------------------------------------
47 // wxScaledFontList: maps the font sizes to the GDK fonts for the given font
48 // ----------------------------------------------------------------------------
49
50 WX_DECLARE_HASH_MAP(int, GdkFont *, wxIntegerHash, wxIntegerEqual,
51 wxScaledFontList);
52
53 // ----------------------------------------------------------------------------
54 // wxFontRefData
55 // ----------------------------------------------------------------------------
56
57 class wxFontRefData : public wxGDIRefData
58 {
59 public:
60 // from broken down font parameters, also default ctor
61 wxFontRefData(int size = -1,
62 wxFontFamily family = wxFONTFAMILY_DEFAULT,
63 wxFontStyle style = wxFONTSTYLE_NORMAL,
64 wxFontWeight weight = wxFONTWEIGHT_NORMAL,
65 bool underlined = false,
66 const wxString& faceName = wxEmptyString,
67 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
68
69 // from XFLD
70 wxFontRefData(const wxString& fontname);
71
72 // copy ctor
73 wxFontRefData( const wxFontRefData& data );
74
75 virtual ~wxFontRefData();
76
77 // do we have the native font info?
78 bool HasNativeFont() const
79 {
80 // only use m_nativeFontInfo if it had been initialized
81 return !m_nativeFontInfo.IsDefault();
82 }
83
84 // setters: all of them also take care to modify m_nativeFontInfo if we
85 // have it so as to not lose the information not carried by our fields
86 void SetPointSize(int pointSize);
87 void SetFamily(wxFontFamily family);
88 void SetStyle(wxFontStyle style);
89 void SetWeight(wxFontWeight weight);
90 void SetUnderlined(bool underlined);
91 bool SetFaceName(const wxString& facename);
92 void SetEncoding(wxFontEncoding encoding);
93
94 // and this one also modifies all the other font data fields
95 void SetNativeFontInfo(const wxNativeFontInfo& info);
96
97 protected:
98 // common part of all ctors
99 void Init(int pointSize,
100 wxFontFamily family,
101 wxFontStyle style,
102 wxFontWeight weight,
103 bool underlined,
104 const wxString& faceName,
105 wxFontEncoding encoding);
106
107 // set all fields from (already initialized and valid) m_nativeFontInfo
108 void InitFromNative();
109
110 private:
111 // clear m_scaled_xfonts if any
112 void ClearGdkFonts();
113
114 // the map of font sizes to "GdkFont *"
115 wxScaledFontList m_scaled_xfonts;
116
117 int m_pointSize;
118 wxFontFamily m_family;
119 wxFontStyle m_style;
120 wxFontWeight m_weight;
121 bool m_underlined;
122 wxString m_faceName;
123 wxFontEncoding m_encoding; // Unused under GTK 2.0
124
125 // The native font info, basicly an XFLD under GTK 1.2 and
126 // the pango font description under GTK 2.0.
127 wxNativeFontInfo m_nativeFontInfo;
128
129 friend class wxFont;
130 };
131
132 #define M_FONTDATA ((wxFontRefData*)m_refData)
133
134 // ----------------------------------------------------------------------------
135 // wxFontRefData
136 // ----------------------------------------------------------------------------
137
138 void wxFontRefData::Init(int pointSize,
139 wxFontFamily family,
140 wxFontStyle style,
141 wxFontWeight weight,
142 bool underlined,
143 const wxString& faceName,
144 wxFontEncoding encoding)
145 {
146 m_family = family == wxFONTFAMILY_DEFAULT ? wxFONTFAMILY_SWISS : family;
147
148 m_faceName = faceName;
149
150 // we accept both wxDEFAULT and wxNORMAL here - should we?
151 m_style = style == wxDEFAULT ? wxFONTSTYLE_NORMAL : style;
152 m_weight = weight == wxDEFAULT ? wxFONTWEIGHT_NORMAL : weight;
153
154 // and here, do we really want to forbid creation of the font of the size
155 // 90 (the value of wxDEFAULT)??
156 m_pointSize = pointSize == wxDEFAULT || pointSize == -1
157 ? wxDEFAULT_FONT_SIZE
158 : pointSize;
159
160 m_underlined = underlined;
161 m_encoding = encoding;
162 }
163
164 void wxFontRefData::InitFromNative()
165 {
166 // get the font parameters from the XLFD
167 // -------------------------------------
168
169 m_faceName = m_nativeFontInfo.GetXFontComponent(wxXLFD_FAMILY);
170
171 m_weight = wxFONTWEIGHT_NORMAL;
172
173 wxString w = m_nativeFontInfo.GetXFontComponent(wxXLFD_WEIGHT).Upper();
174 if ( !w.empty() && w != wxT('*') )
175 {
176 // the test below catches all of BOLD, EXTRABOLD, DEMIBOLD, ULTRABOLD
177 // and BLACK
178 if ( ((w[0u] == wxT('B') && (!wxStrcmp(w.c_str() + 1, wxT("OLD")) ||
179 !wxStrcmp(w.c_str() + 1, wxT("LACK"))))) ||
180 wxStrstr(w.c_str() + 1, wxT("BOLD")) )
181 {
182 m_weight = wxFONTWEIGHT_BOLD;
183 }
184 else if ( w == wxT("LIGHT") || w == wxT("THIN") )
185 {
186 m_weight = wxFONTWEIGHT_LIGHT;
187 }
188 }
189
190 switch ( wxToupper(m_nativeFontInfo.
191 GetXFontComponent(wxXLFD_SLANT)[0u]).GetValue() )
192 {
193 case wxT('I'): // italique
194 m_style = wxFONTSTYLE_ITALIC;
195 break;
196
197 case wxT('O'): // oblique
198 m_style = wxFONTSTYLE_SLANT;
199 break;
200
201 default:
202 m_style = wxFONTSTYLE_NORMAL;
203 }
204
205 long ptSize;
206 if ( m_nativeFontInfo.GetXFontComponent(wxXLFD_POINTSIZE).ToLong(&ptSize) )
207 {
208 // size in XLFD is in 10 point units
209 m_pointSize = (int)(ptSize / 10);
210 }
211 else
212 {
213 m_pointSize = wxDEFAULT_FONT_SIZE;
214 }
215
216 // examine the spacing: if the font is monospaced, assume wxTELETYPE
217 // family for compatibility with the old code which used it instead of
218 // IsFixedWidth()
219 if ( m_nativeFontInfo.GetXFontComponent(wxXLFD_SPACING).Upper() == wxT('M') )
220 {
221 m_family = wxFONTFAMILY_TELETYPE;
222 }
223 else // not monospaceed
224 {
225 // don't even try guessing it, it doesn't work for too many fonts
226 // anyhow
227 m_family = wxFONTFAMILY_UNKNOWN;
228 }
229
230 // X fonts are never underlined...
231 m_underlined = false;
232
233 // deal with font encoding
234 wxString
235 registry = m_nativeFontInfo.GetXFontComponent(wxXLFD_REGISTRY).Upper(),
236 encoding = m_nativeFontInfo.GetXFontComponent(wxXLFD_ENCODING).Upper();
237
238 if ( registry == wxT("ISO8859") )
239 {
240 int cp;
241 if ( wxSscanf(encoding, wxT("%d"), &cp) == 1 )
242 {
243 m_encoding = (wxFontEncoding)(wxFONTENCODING_ISO8859_1 + cp - 1);
244 }
245 }
246 else if ( registry == wxT("MICROSOFT") )
247 {
248 int cp;
249 if ( wxSscanf(encoding, wxT("cp125%d"), &cp) == 1 )
250 {
251 m_encoding = (wxFontEncoding)(wxFONTENCODING_CP1250 + cp);
252 }
253 }
254 else if ( registry == wxT("KOI8") )
255 {
256 m_encoding = wxFONTENCODING_KOI8;
257 }
258 else // unknown encoding
259 {
260 // may be give a warning here? or use wxFontMapper?
261 m_encoding = wxFONTENCODING_SYSTEM;
262 }
263 }
264
265 wxFontRefData::wxFontRefData( const wxFontRefData& data )
266 : wxGDIRefData()
267 {
268 m_pointSize = data.m_pointSize;
269 m_family = data.m_family;
270 m_style = data.m_style;
271 m_weight = data.m_weight;
272
273 m_underlined = data.m_underlined;
274
275 m_faceName = data.m_faceName;
276 m_encoding = data.m_encoding;
277
278 // Forces a copy of the internal data. wxNativeFontInfo should probably
279 // have a copy ctor and assignment operator to fix this properly but that
280 // would break binary compatibility...
281 m_nativeFontInfo.FromString(data.m_nativeFontInfo.ToString());
282 }
283
284 wxFontRefData::wxFontRefData(int size, wxFontFamily family, wxFontStyle style,
285 wxFontWeight weight, bool underlined,
286 const wxString& faceName,
287 wxFontEncoding encoding)
288 {
289 Init(size, family, style, weight, underlined, faceName, encoding);
290 }
291
292 wxFontRefData::wxFontRefData(const wxString& fontname)
293 {
294 // FromString() should really work in GTK1 too, doesn't it?
295 m_nativeFontInfo.SetXFontName(fontname);
296
297 InitFromNative();
298 }
299
300 void wxFontRefData::ClearGdkFonts()
301 {
302 for ( wxScaledFontList::iterator i = m_scaled_xfonts.begin();
303 i != m_scaled_xfonts.end();
304 ++i )
305 {
306 GdkFont *font = i->second;
307 gdk_font_unref( font );
308 }
309
310 m_scaled_xfonts.clear();
311 }
312
313 wxFontRefData::~wxFontRefData()
314 {
315 ClearGdkFonts();
316 }
317
318 // ----------------------------------------------------------------------------
319 // wxFontRefData SetXXX()
320 // ----------------------------------------------------------------------------
321
322 void wxFontRefData::SetPointSize(int pointSize)
323 {
324 m_pointSize = pointSize;
325
326 if ( HasNativeFont() )
327 {
328 wxString size;
329 if ( pointSize == -1 )
330 size = wxT('*');
331 else
332 size.Printf(wxT("%d"), 10*pointSize);
333
334 m_nativeFontInfo.SetXFontComponent(wxXLFD_POINTSIZE, size);
335 }
336 }
337
338 void wxFontRefData::SetFamily(wxFontFamily family)
339 {
340 m_family = family;
341
342 // TODO: what are we supposed to do with m_nativeFontInfo here?
343 }
344
345 void wxFontRefData::SetStyle(wxFontStyle style)
346 {
347 m_style = style;
348
349 if ( HasNativeFont() )
350 {
351 wxString slant;
352 switch ( style )
353 {
354 case wxFONTSTYLE_ITALIC:
355 slant = wxT('i');
356 break;
357
358 case wxFONTSTYLE_SLANT:
359 slant = wxT('o');
360 break;
361
362 default:
363 wxFAIL_MSG( wxT("unknown font style") );
364 // fall through
365
366 case wxFONTSTYLE_NORMAL:
367 slant = wxT('r');
368 }
369
370 m_nativeFontInfo.SetXFontComponent(wxXLFD_SLANT, slant);
371 }
372 }
373
374 void wxFontRefData::SetWeight(wxFontWeight weight)
375 {
376 m_weight = weight;
377
378 if ( HasNativeFont() )
379 {
380 wxString boldness;
381 switch ( weight )
382 {
383 case wxFONTWEIGHT_BOLD:
384 boldness = wxT("bold");
385 break;
386
387 case wxFONTWEIGHT_LIGHT:
388 boldness = wxT("light");
389 break;
390
391 default:
392 wxFAIL_MSG( wxT("unknown font weight") );
393 // fall through
394
395 case wxFONTWEIGHT_NORMAL:
396 // unspecified
397 boldness = wxT("medium");
398 }
399
400 m_nativeFontInfo.SetXFontComponent(wxXLFD_WEIGHT, boldness);
401 }
402 }
403
404 void wxFontRefData::SetUnderlined(bool underlined)
405 {
406 m_underlined = underlined;
407
408 // the XLFD doesn't have "underlined" field anyhow
409 }
410
411 bool wxFontRefData::SetFaceName(const wxString& facename)
412 {
413 m_faceName = facename;
414
415 if ( HasNativeFont() )
416 {
417 m_nativeFontInfo.SetXFontComponent(wxXLFD_FAMILY, facename);
418 }
419
420 return true;
421 }
422
423 void wxFontRefData::SetEncoding(wxFontEncoding encoding)
424 {
425 m_encoding = encoding;
426
427 if ( HasNativeFont() )
428 {
429 wxNativeEncodingInfo info;
430 if ( wxGetNativeFontEncoding(encoding, &info) )
431 {
432 m_nativeFontInfo.SetXFontComponent(wxXLFD_REGISTRY, info.xregistry);
433 m_nativeFontInfo.SetXFontComponent(wxXLFD_ENCODING, info.xencoding);
434 }
435 }
436 }
437
438 void wxFontRefData::SetNativeFontInfo(const wxNativeFontInfo& info)
439 {
440 // previously cached fonts shouldn't be used
441 ClearGdkFonts();
442
443 m_nativeFontInfo = info;
444
445 // set all the other font parameters from the native font info
446 InitFromNative();
447 }
448
449 // ----------------------------------------------------------------------------
450 // wxFont creation
451 // ----------------------------------------------------------------------------
452
453 wxFont::wxFont(const wxNativeFontInfo& info)
454 {
455 (void) Create(info.GetXFontName());
456 }
457
458 bool wxFont::Create( int pointSize,
459 wxFontFamily family,
460 wxFontStyle style,
461 wxFontWeight weight,
462 bool underlined,
463 const wxString& face,
464 wxFontEncoding encoding)
465 {
466 UnRef();
467
468 m_refData = new wxFontRefData(pointSize, family, style, weight,
469 underlined, face, encoding);
470
471 return true;
472 }
473
474 bool wxFont::Create(const wxString& fontname)
475 {
476 // VZ: does this really happen?
477 if ( fontname.empty() )
478 {
479 *this = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
480
481 return true;
482 }
483
484 m_refData = new wxFontRefData(fontname);
485
486 return true;
487 }
488
489 void wxFont::Unshare()
490 {
491 if (!m_refData)
492 {
493 m_refData = new wxFontRefData();
494 }
495 else
496 {
497 wxFontRefData* ref = new wxFontRefData(*(wxFontRefData*)m_refData);
498 UnRef();
499 m_refData = ref;
500 }
501 }
502
503 wxFont::~wxFont()
504 {
505 }
506
507 wxGDIRefData *wxFont::CreateGDIRefData() const
508 {
509 return new wxFontRefData;
510 }
511
512 wxGDIRefData *wxFont::CloneGDIRefData(const wxGDIRefData *data) const
513 {
514 return new wxFontRefData(*static_cast<const wxFontRefData *>(data));
515 }
516
517 // ----------------------------------------------------------------------------
518 // accessors
519 // ----------------------------------------------------------------------------
520
521 int wxFont::GetPointSize() const
522 {
523 wxCHECK_MSG( IsOk(), 0, wxT("invalid font") );
524
525 return M_FONTDATA->m_pointSize;
526 }
527
528 wxString wxFont::GetFaceName() const
529 {
530 wxCHECK_MSG( IsOk(), wxEmptyString, wxT("invalid font") );
531
532 return M_FONTDATA->m_faceName;
533 }
534
535 wxFontFamily wxFont::DoGetFamily() const
536 {
537 return M_FONTDATA->m_family;
538 }
539
540 wxFontStyle wxFont::GetStyle() const
541 {
542 wxCHECK_MSG( IsOk(), wxFONTSTYLE_MAX, wxT("invalid font") );
543
544 return M_FONTDATA->m_style;
545 }
546
547 wxFontWeight wxFont::GetWeight() const
548 {
549 wxCHECK_MSG( IsOk(), wxFONTWEIGHT_MAX, wxT("invalid font") );
550
551 return M_FONTDATA->m_weight;
552 }
553
554 bool wxFont::GetUnderlined() const
555 {
556 wxCHECK_MSG( IsOk(), false, wxT("invalid font") );
557
558 return M_FONTDATA->m_underlined;
559 }
560
561 wxFontEncoding wxFont::GetEncoding() const
562 {
563 wxCHECK_MSG( IsOk(), wxFONTENCODING_DEFAULT, wxT("invalid font") );
564
565 // m_encoding is unused in wxGTK2, return encoding that the user set.
566 return M_FONTDATA->m_encoding;
567 }
568
569 const wxNativeFontInfo *wxFont::GetNativeFontInfo() const
570 {
571 wxCHECK_MSG( IsOk(), NULL, wxT("invalid font") );
572
573 if ( !M_FONTDATA->HasNativeFont() )
574 {
575 // NB: this call has important side-effect: it not only finds
576 // GdkFont representation, it also initializes m_nativeFontInfo
577 // by calling its SetXFontName method
578 GetInternalFont();
579 }
580
581 return &(M_FONTDATA->m_nativeFontInfo);
582 }
583
584 bool wxFont::IsFixedWidth() const
585 {
586 wxCHECK_MSG( IsOk(), false, wxT("invalid font") );
587
588 if ( M_FONTDATA->HasNativeFont() )
589 {
590 // the monospace fonts are supposed to have "M" in the spacing field
591 wxString spacing = M_FONTDATA->
592 m_nativeFontInfo.GetXFontComponent(wxXLFD_SPACING);
593
594 return spacing.Upper() == wxT('M');
595 }
596
597 return wxFontBase::IsFixedWidth();
598 }
599
600 // ----------------------------------------------------------------------------
601 // change font attributes
602 // ----------------------------------------------------------------------------
603
604 void wxFont::SetPointSize(int pointSize)
605 {
606 Unshare();
607
608 M_FONTDATA->SetPointSize(pointSize);
609 }
610
611 void wxFont::SetFamily(wxFontFamily family)
612 {
613 Unshare();
614
615 M_FONTDATA->SetFamily(family);
616 }
617
618 void wxFont::SetStyle(wxFontStyle style)
619 {
620 Unshare();
621
622 M_FONTDATA->SetStyle(style);
623 }
624
625 void wxFont::SetWeight(wxFontWeight weight)
626 {
627 Unshare();
628
629 M_FONTDATA->SetWeight(weight);
630 }
631
632 bool wxFont::SetFaceName(const wxString& faceName)
633 {
634 Unshare();
635
636 return M_FONTDATA->SetFaceName(faceName) &&
637 wxFontBase::SetFaceName(faceName);
638 }
639
640 void wxFont::SetUnderlined(bool underlined)
641 {
642 Unshare();
643
644 M_FONTDATA->SetUnderlined(underlined);
645 }
646
647 void wxFont::SetEncoding(wxFontEncoding encoding)
648 {
649 Unshare();
650
651 M_FONTDATA->SetEncoding(encoding);
652 }
653
654 void wxFont::DoSetNativeFontInfo( const wxNativeFontInfo& info )
655 {
656 Unshare();
657
658 M_FONTDATA->SetNativeFontInfo( info );
659 }
660
661 // ----------------------------------------------------------------------------
662 // get internal representation of font
663 // ----------------------------------------------------------------------------
664
665 static GdkFont *g_systemDefaultGuiFont = NULL;
666
667 // this is also used from toolbar.cpp and tooltip.cpp, hence extern
668 extern GdkFont *GtkGetDefaultGuiFont()
669 {
670 if (!g_systemDefaultGuiFont)
671 {
672 GtkWidget *widget = gtk_button_new();
673 GtkStyle *def = gtk_rc_get_style( widget );
674 if (def)
675 {
676 g_systemDefaultGuiFont = gdk_font_ref( def->font );
677 }
678 else
679 {
680 def = gtk_widget_get_default_style();
681 if (def)
682 g_systemDefaultGuiFont = gdk_font_ref( def->font );
683 }
684 gtk_widget_destroy( widget );
685 }
686 else
687 {
688 // already have it, but ref it once more before returning
689 gdk_font_ref(g_systemDefaultGuiFont);
690 }
691
692 return g_systemDefaultGuiFont;
693 }
694
695 GdkFont *wxFont::GetInternalFont( float scale ) const
696 {
697 GdkFont *font = NULL;
698
699 wxCHECK_MSG( IsOk(), font, wxT("invalid font") );
700
701 long int_scale = long(scale * 100.0 + 0.5); // key for fontlist
702 int point_scale = (int)((M_FONTDATA->m_pointSize * 10 * int_scale) / 100);
703
704 wxScaledFontList& list = M_FONTDATA->m_scaled_xfonts;
705 wxScaledFontList::iterator i = list.find(int_scale);
706 if ( i != list.end() )
707 {
708 font = i->second;
709 }
710 else // we don't have this font in this size yet
711 {
712 if (*this == wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT))
713 {
714 font = GtkGetDefaultGuiFont();
715 }
716
717 if ( !font )
718 {
719 // do we have the XLFD?
720 if ( int_scale == 100 && M_FONTDATA->HasNativeFont() )
721 {
722 font = wxLoadFont(M_FONTDATA->m_nativeFontInfo.GetXFontName());
723 }
724
725 // no XLFD of no exact match - try the approximate one now
726 if ( !font )
727 {
728 wxString xfontname;
729 font = wxLoadQueryNearestFont( point_scale,
730 M_FONTDATA->m_family,
731 M_FONTDATA->m_style,
732 M_FONTDATA->m_weight,
733 M_FONTDATA->m_underlined,
734 M_FONTDATA->m_faceName,
735 M_FONTDATA->m_encoding,
736 &xfontname);
737 // NB: wxFont::GetNativeFontInfo relies on this
738 // side-effect of GetInternalFont
739 if ( int_scale == 100 )
740 M_FONTDATA->m_nativeFontInfo.SetXFontName(xfontname);
741 }
742 }
743
744 if ( font )
745 {
746 list[int_scale] = font;
747 }
748 }
749
750 // it's quite useless to make it a wxCHECK because we're going to crash
751 // anyhow...
752 wxASSERT_MSG( font, wxT("could not load any font?") );
753
754 return font;
755 }