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