miscellaneous wxFont enhancements (patch 1496606):
[wxWidgets.git] / src / motif / font.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/motif/font.cpp
3 // Purpose: wxFont class
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 17/09/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __VMS
24 #pragma message disable nosimpint
25 #include "wx/vms_x_fix.h"
26 #endif
27 #include <Xm/Xm.h>
28 #ifdef __VMS
29 #pragma message enable nosimpint
30 #endif
31
32 #include "wx/font.h"
33
34 #ifndef WX_PRECOMP
35 #include "wx/string.h"
36 #include "wx/utils.h" // for wxGetDisplay()
37 #include "wx/settings.h"
38 #endif
39
40 #include "wx/gdicmn.h"
41 #include "wx/fontutil.h" // for wxNativeFontInfo
42 #include "wx/tokenzr.h"
43 #include "wx/motif/private.h"
44
45 IMPLEMENT_DYNAMIC_CLASS(wxFont, wxGDIObject)
46
47 // ----------------------------------------------------------------------------
48 // private classes
49 // ----------------------------------------------------------------------------
50
51 // For every wxFont, there must be a font for each display and scale requested.
52 // So these objects are stored in wxFontRefData::m_fonts
53 class wxXFont : public wxObject
54 {
55 public:
56 wxXFont();
57 ~wxXFont();
58
59 #if !wxMOTIF_NEW_FONT_HANDLING
60 WXFontStructPtr m_fontStruct; // XFontStruct
61 #endif
62 #if !wxMOTIF_USE_RENDER_TABLE && !wxMOTIF_NEW_FONT_HANDLING
63 WXFontList m_fontList; // Motif XmFontList
64 #else // if wxUSE_RENDER_TABLE
65 WXRenderTable m_renderTable; // Motif XmRenderTable
66 WXRendition m_rendition; // Motif XmRendition
67 #endif
68 WXDisplay* m_display; // XDisplay
69 int m_scale; // Scale * 100
70 };
71
72 class wxFontRefData: public wxGDIRefData
73 {
74 friend class wxFont;
75
76 public:
77 wxFontRefData(int size = wxDEFAULT,
78 int family = wxDEFAULT,
79 int style = wxDEFAULT,
80 int weight = wxDEFAULT,
81 bool underlined = false,
82 const wxString& faceName = wxEmptyString,
83 wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
84 {
85 Init(size, family, style, weight, underlined, faceName, encoding);
86 }
87
88 wxFontRefData(const wxFontRefData& data)
89 {
90 Init(data.m_pointSize, data.m_family, data.m_style, data.m_weight,
91 data.m_underlined, data.m_faceName, data.m_encoding);
92 }
93
94 ~wxFontRefData();
95
96 protected:
97 // common part of all ctors
98 void Init(int size,
99 int family,
100 int style,
101 int weight,
102 bool underlined,
103 const wxString& faceName,
104 wxFontEncoding encoding);
105
106 // font attributes
107 int m_pointSize;
108 int m_family;
109 int m_style;
110 int m_weight;
111 bool m_underlined;
112 wxString m_faceName;
113 wxFontEncoding m_encoding;
114
115 wxNativeFontInfo m_nativeFontInfo;
116
117 // A list of wxXFonts
118 wxList m_fonts;
119 };
120
121 // ============================================================================
122 // implementation
123 // ============================================================================
124
125 // ----------------------------------------------------------------------------
126 // wxXFont
127 // ----------------------------------------------------------------------------
128
129 wxXFont::wxXFont()
130 {
131 #if !wxMOTIF_NEW_FONT_HANDLING
132 m_fontStruct = (WXFontStructPtr) 0;
133 #endif
134 #if !wxMOTIF_USE_RENDER_TABLE && !wxMOTIF_NEW_FONT_HANDLING
135 m_fontList = (WXFontList) 0;
136 #else // if wxMOTIF_USE_RENDER_TABLE
137 m_renderTable = (WXRenderTable) 0;
138 m_rendition = (WXRendition) 0;
139 #endif
140 m_display = (WXDisplay*) 0;
141 m_scale = 100;
142 }
143
144 wxXFont::~wxXFont()
145 {
146 #if !wxMOTIF_USE_RENDER_TABLE
147 if (m_fontList)
148 XmFontListFree ((XmFontList) m_fontList);
149 m_fontList = NULL;
150 #else // if wxUSE_RENDER_TABLE
151 if (m_renderTable)
152 XmRenderTableFree ((XmRenderTable) m_renderTable);
153 m_renderTable = NULL;
154 #endif
155
156 // TODO: why does freeing the font produce a segv???
157 // Note that XFreeFont wasn't called in wxWin 1.68 either.
158 // MBN: probably some interaction with fonts being still
159 // in use in some widgets...
160 // XFontStruct* fontStruct = (XFontStruct*) m_fontStruct;
161 // XFreeFont((Display*) m_display, fontStruct);
162 }
163
164 // ----------------------------------------------------------------------------
165 // wxFontRefData
166 // ----------------------------------------------------------------------------
167
168 void wxFontRefData::Init(int pointSize,
169 int family,
170 int style,
171 int weight,
172 bool underlined,
173 const wxString& faceName,
174 wxFontEncoding encoding)
175 {
176 if (family == wxDEFAULT)
177 m_family = wxSWISS;
178 else
179 m_family = family;
180
181 m_faceName = faceName;
182
183 if (style == wxDEFAULT)
184 m_style = wxNORMAL;
185 else
186 m_style = style;
187
188 if (weight == wxDEFAULT)
189 m_weight = wxNORMAL;
190 else
191 m_weight = weight;
192
193 if (pointSize == wxDEFAULT)
194 m_pointSize = 12;
195 else
196 m_pointSize = pointSize;
197
198 m_underlined = underlined;
199 m_encoding = encoding;
200 }
201
202 wxFontRefData::~wxFontRefData()
203 {
204 wxList::compatibility_iterator node = m_fonts.GetFirst();
205 while (node)
206 {
207 wxXFont* f = (wxXFont*) node->GetData();
208 delete f;
209 node = node->GetNext();
210 }
211 m_fonts.Clear();
212 }
213
214 // ----------------------------------------------------------------------------
215 // wxFont
216 // ----------------------------------------------------------------------------
217
218 wxFont::wxFont(const wxNativeFontInfo& info)
219 {
220 (void)Create(info.GetXFontName());
221 }
222
223 bool wxFont::Create(int pointSize,
224 int family,
225 int style,
226 int weight,
227 bool underlined,
228 const wxString& faceName,
229 wxFontEncoding encoding)
230 {
231 UnRef();
232 m_refData = new wxFontRefData(pointSize, family, style, weight,
233 underlined, faceName, encoding);
234
235 return true;
236 }
237
238 bool wxFont::Create(const wxString& fontname, wxFontEncoding enc)
239 {
240 if( !fontname )
241 {
242 *this = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT);
243 return true;
244 }
245
246 m_refData = new wxFontRefData();
247
248 M_FONTDATA->m_nativeFontInfo.SetXFontName(fontname); // X font name
249
250 wxString tmp;
251
252 wxStringTokenizer tn( fontname, wxT("-") );
253
254 tn.GetNextToken(); // skip initial empty token
255 tn.GetNextToken(); // foundry
256
257
258 M_FONTDATA->m_faceName = tn.GetNextToken(); // family
259
260 tmp = tn.GetNextToken().MakeUpper(); // weight
261 if (tmp == wxT("BOLD")) M_FONTDATA->m_weight = wxBOLD;
262 if (tmp == wxT("BLACK")) M_FONTDATA->m_weight = wxBOLD;
263 if (tmp == wxT("EXTRABOLD")) M_FONTDATA->m_weight = wxBOLD;
264 if (tmp == wxT("DEMIBOLD")) M_FONTDATA->m_weight = wxBOLD;
265 if (tmp == wxT("ULTRABOLD")) M_FONTDATA->m_weight = wxBOLD;
266
267 if (tmp == wxT("LIGHT")) M_FONTDATA->m_weight = wxLIGHT;
268 if (tmp == wxT("THIN")) M_FONTDATA->m_weight = wxLIGHT;
269
270 tmp = tn.GetNextToken().MakeUpper(); // slant
271 if (tmp == wxT("I")) M_FONTDATA->m_style = wxITALIC;
272 if (tmp == wxT("O")) M_FONTDATA->m_style = wxITALIC;
273
274 tn.GetNextToken(); // set width
275 tn.GetNextToken(); // add. style
276 tn.GetNextToken(); // pixel size
277
278 tmp = tn.GetNextToken(); // pointsize
279 if (tmp != wxT("*"))
280 {
281 long num = wxStrtol (tmp.c_str(), (wxChar **) NULL, 10);
282 M_FONTDATA->m_pointSize = (int)(num / 10);
283 }
284
285 tn.GetNextToken(); // x-res
286 tn.GetNextToken(); // y-res
287
288 tmp = tn.GetNextToken().MakeUpper(); // spacing
289
290 if (tmp == wxT("M"))
291 M_FONTDATA->m_family = wxMODERN;
292 else if (M_FONTDATA->m_faceName == wxT("TIMES"))
293 M_FONTDATA->m_family = wxROMAN;
294 else if (M_FONTDATA->m_faceName == wxT("HELVETICA"))
295 M_FONTDATA->m_family = wxSWISS;
296 else if (M_FONTDATA->m_faceName == wxT("LUCIDATYPEWRITER"))
297 M_FONTDATA->m_family = wxTELETYPE;
298 else if (M_FONTDATA->m_faceName == wxT("LUCIDA"))
299 M_FONTDATA->m_family = wxDECORATIVE;
300 else if (M_FONTDATA->m_faceName == wxT("UTOPIA"))
301 M_FONTDATA->m_family = wxSCRIPT;
302
303 tn.GetNextToken(); // avg width
304
305 // deal with font encoding
306 M_FONTDATA->m_encoding = enc;
307 if ( M_FONTDATA->m_encoding == wxFONTENCODING_SYSTEM )
308 {
309 wxString registry = tn.GetNextToken().MakeUpper(),
310 encoding = tn.GetNextToken().MakeUpper();
311
312 if ( registry == _T("ISO8859") )
313 {
314 int cp;
315 if ( wxSscanf(encoding, wxT("%d"), &cp) == 1 )
316 {
317 M_FONTDATA->m_encoding =
318 (wxFontEncoding)(wxFONTENCODING_ISO8859_1 + cp - 1);
319 }
320 }
321 else if ( registry == _T("MICROSOFT") )
322 {
323 int cp;
324 if ( wxSscanf(encoding, wxT("cp125%d"), &cp) == 1 )
325 {
326 M_FONTDATA->m_encoding =
327 (wxFontEncoding)(wxFONTENCODING_CP1250 + cp);
328 }
329 }
330 else if ( registry == _T("KOI8") )
331 {
332 M_FONTDATA->m_encoding = wxFONTENCODING_KOI8;
333 }
334 //else: unknown encoding - may be give a warning here?
335 else
336 return false;
337 }
338 return true;
339 }
340
341 wxFont::~wxFont()
342 {
343 }
344
345 // ----------------------------------------------------------------------------
346 // change the font attributes
347 // ----------------------------------------------------------------------------
348
349 void wxFont::Unshare()
350 {
351 // Don't change shared data
352 if (!m_refData)
353 {
354 m_refData = new wxFontRefData();
355 }
356 else
357 {
358 wxFontRefData* ref = new wxFontRefData(*(wxFontRefData*)m_refData);
359 UnRef();
360 m_refData = ref;
361 }
362 }
363
364 void wxFont::SetPointSize(int pointSize)
365 {
366 Unshare();
367
368 M_FONTDATA->m_pointSize = pointSize;
369 M_FONTDATA->m_nativeFontInfo.GetXFontName().Clear(); // invalid now
370 }
371
372 void wxFont::SetFamily(int family)
373 {
374 Unshare();
375
376 M_FONTDATA->m_family = family;
377 M_FONTDATA->m_nativeFontInfo.GetXFontName().Clear(); // invalid now
378 }
379
380 void wxFont::SetStyle(int style)
381 {
382 Unshare();
383
384 M_FONTDATA->m_style = style;
385 M_FONTDATA->m_nativeFontInfo.GetXFontName().Clear(); // invalid now
386 }
387
388 void wxFont::SetWeight(int weight)
389 {
390 Unshare();
391
392 M_FONTDATA->m_weight = weight;
393 M_FONTDATA->m_nativeFontInfo.GetXFontName().Clear(); // invalid now
394 }
395
396 bool wxFont::SetFaceName(const wxString& faceName)
397 {
398 Unshare();
399
400 M_FONTDATA->m_faceName = faceName;
401 M_FONTDATA->m_nativeFontInfo.GetXFontName().Clear(); // invalid now
402
403 return wxFontBase::SetFaceName(faceName);
404 }
405
406 void wxFont::SetUnderlined(bool underlined)
407 {
408 Unshare();
409
410 M_FONTDATA->m_underlined = underlined;
411 }
412
413 void wxFont::SetEncoding(wxFontEncoding encoding)
414 {
415 Unshare();
416
417 M_FONTDATA->m_encoding = encoding;
418 M_FONTDATA->m_nativeFontInfo.GetXFontName().Clear(); // invalid now
419 }
420
421 void wxFont::DoSetNativeFontInfo(const wxNativeFontInfo& info)
422 {
423 Unshare();
424
425 M_FONTDATA->m_nativeFontInfo = info;
426 }
427
428 // ----------------------------------------------------------------------------
429 // query font attributes
430 // ----------------------------------------------------------------------------
431
432 int wxFont::GetPointSize() const
433 {
434 wxCHECK_MSG( Ok(), 0, wxT("invalid font") );
435
436 return M_FONTDATA->m_pointSize;
437 }
438
439 wxString wxFont::GetFaceName() const
440 {
441 wxCHECK_MSG( Ok(), wxEmptyString, wxT("invalid font") );
442
443 return M_FONTDATA->m_faceName ;
444 }
445
446 int wxFont::GetFamily() const
447 {
448 wxCHECK_MSG( Ok(), 0, wxT("invalid font") );
449
450 return M_FONTDATA->m_family;
451 }
452
453 int wxFont::GetStyle() const
454 {
455 wxCHECK_MSG( Ok(), 0, wxT("invalid font") );
456
457 return M_FONTDATA->m_style;
458 }
459
460 int wxFont::GetWeight() const
461 {
462 wxCHECK_MSG( Ok(), 0, wxT("invalid font") );
463
464 return M_FONTDATA->m_weight;
465 }
466
467 bool wxFont::GetUnderlined() const
468 {
469 wxCHECK_MSG( Ok(), false, wxT("invalid font") );
470
471 return M_FONTDATA->m_underlined;
472 }
473
474 wxFontEncoding wxFont::GetEncoding() const
475 {
476 wxCHECK_MSG( Ok(), wxFONTENCODING_DEFAULT, wxT("invalid font") );
477
478 return M_FONTDATA->m_encoding;
479 }
480
481 const wxNativeFontInfo *wxFont::GetNativeFontInfo() const
482 {
483 wxCHECK_MSG( Ok(), (wxNativeFontInfo *)NULL, wxT("invalid font") );
484
485 if(M_FONTDATA->m_nativeFontInfo.GetXFontName().empty())
486 GetInternalFont();
487
488 return &(M_FONTDATA->m_nativeFontInfo);
489 }
490
491 // ----------------------------------------------------------------------------
492 // real implementation
493 // ----------------------------------------------------------------------------
494
495 // Find an existing, or create a new, XFontStruct
496 // based on this wxFont and the given scale. Append the
497 // font to list in the private data for future reference.
498 wxXFont* wxFont::GetInternalFont(double scale, WXDisplay* display) const
499 {
500 if ( !Ok() )
501 return (wxXFont *)NULL;
502
503 long intScale = long(scale * 100.0 + 0.5); // key for wxXFont
504 int pointSize = (M_FONTDATA->m_pointSize * 10 * intScale) / 100;
505
506 // search existing fonts first
507 wxList::compatibility_iterator node = M_FONTDATA->m_fonts.GetFirst();
508 while (node)
509 {
510 wxXFont* f = (wxXFont*) node->GetData();
511 if ((!display || (f->m_display == display)) && (f->m_scale == intScale))
512 return f;
513 node = node->GetNext();
514 }
515
516 // not found, create a new one
517 wxString xFontSpec;
518 XFontStruct *font = (XFontStruct *)
519 wxLoadQueryNearestFont(pointSize,
520 M_FONTDATA->m_family,
521 M_FONTDATA->m_style,
522 M_FONTDATA->m_weight,
523 M_FONTDATA->m_underlined,
524 wxT(""),
525 M_FONTDATA->m_encoding,
526 &xFontSpec);
527
528 if ( !font )
529 {
530 wxFAIL_MSG( wxT("Could not allocate even a default font -- something is wrong.") );
531
532 return (wxXFont*) NULL;
533 }
534
535 wxXFont* f = new wxXFont;
536 #if wxMOTIF_NEW_FONT_HANDLING
537 XFreeFont( (Display*) display, font );
538 #else
539 f->m_fontStruct = (WXFontStructPtr)font;
540 #endif
541 f->m_display = ( display ? display : wxGetDisplay() );
542 f->m_scale = intScale;
543
544 #if wxMOTIF_USE_RENDER_TABLE
545 XmRendition rendition;
546 XmRenderTable renderTable;
547 Arg args[5];
548 int count = 0;
549
550 #if wxMOTIF_NEW_FONT_HANDLING
551 wxChar* fontSpec = wxStrdup( xFontSpec.c_str() );
552 XtSetArg( args[count], XmNfontName, fontSpec ); ++count;
553 XtSetArg( args[count], XmNfontType, XmFONT_IS_FONTSET ); ++count;
554 #else
555 XtSetArg( args[count], XmNfont, font ); ++count;
556 #endif
557 XtSetArg( args[count], XmNunderlineType,
558 GetUnderlined() ? XmSINGLE_LINE : XmNO_LINE ); ++count;
559 rendition = XmRenditionCreate( XmGetXmDisplay( (Display*)f->m_display ),
560 (XmStringTag)"",
561 args, count );
562 renderTable = XmRenderTableAddRenditions( NULL, &rendition, 1,
563 XmMERGE_REPLACE );
564
565 f->m_renderTable = (WXRenderTable)renderTable;
566 f->m_rendition = (WXRendition)rendition;
567 wxASSERT( f->m_renderTable != NULL );
568 #else // if !wxMOTIF_USE_RENDER_TABLE
569 f->m_fontList = XmFontListCreate ((XFontStruct*) font, XmSTRING_DEFAULT_CHARSET);
570 wxASSERT( f->m_fontList != NULL );
571 #endif
572
573 M_FONTDATA->m_fonts.Append(f);
574
575 return f;
576 }
577
578 #if !wxMOTIF_NEW_FONT_HANDLING
579
580 WXFontStructPtr wxFont::GetFontStruct(double scale, WXDisplay* display) const
581 {
582 wxXFont* f = GetInternalFont(scale, display);
583
584 return (f ? f->m_fontStruct : (WXFontStructPtr) 0);
585 }
586
587 #endif
588
589 #if !wxMOTIF_USE_RENDER_TABLE
590
591 WXFontList wxFont::GetFontList(double scale, WXDisplay* display) const
592 {
593 wxXFont* f = GetInternalFont(scale, display);
594
595 return (f ? f->m_fontList : (WXFontList) 0);
596 }
597
598 #else // if wxMOTIF_USE_RENDER_TABLE
599
600 WXRenderTable wxFont::GetRenderTable(WXDisplay* display) const
601 {
602 wxXFont* f = GetInternalFont(1.0, display);
603
604 return (f ? f->m_renderTable : (WXRenderTable) 0);
605 }
606
607 #endif // wxMOTIF_USE_RENDER_TABLE
608
609 WXFontType wxFont::GetFontType(WXDisplay* display) const
610 {
611 #if wxMOTIF_USE_RENDER_TABLE
612 return Ok() ? GetRenderTable(display) : NULL;
613 #else
614 return Ok() ? GetFontList(1.0, display) : NULL;
615 #endif
616 }
617
618 WXFontType wxFont::GetFontTypeC(WXDisplay* display) const
619 {
620 #if wxMOTIF_USE_RENDER_TABLE
621 return Ok() ? GetRenderTable(display) : NULL;
622 #else
623 return Ok() ? XmFontListCopy( (XmFontList)GetFontList(1.0, display) ) : NULL;
624 #endif
625 }
626
627 /*static*/ WXString wxFont::GetFontTag()
628 {
629 #if wxMOTIF_USE_RENDER_TABLE
630 return (WXString)XmNrenderTable;
631 #else
632 return (WXString)XmNfontList;
633 #endif
634 }
635
636 #if wxMOTIF_NEW_FONT_HANDLING
637
638 WXFontSet wxFont::GetFontSet(double scale, WXDisplay* display) const
639 {
640 wxXFont* f = GetInternalFont(scale, display);
641
642 if( !f ) return (WXFontSet) 0;
643
644 Arg args[2];
645 int count = 0;
646
647 XtSetArg( args[count], XmNfont, 0 ); ++count;
648 XmRenditionRetrieve( (XmRendition) f->m_rendition, args, count );
649
650 return (WXFontSet) args[0].value;
651 }
652
653 void wxGetTextExtent(WXDisplay* display, const wxFont& font, double scale,
654 const wxString& str,
655 int* width, int* height, int* ascent, int* descent)
656 {
657 XRectangle ink, logical;
658 WXFontSet fset = font.GetFontSet(scale, display);
659
660 XmbTextExtents( (XFontSet)fset, str.c_str(), str.length(), &ink, &logical);
661
662 if( width ) *width = logical.width;
663 if( height ) *height = logical.height;
664 if( ascent ) *ascent = -logical.y;
665 if( descent ) *descent = logical.height + logical.y;
666 }
667
668 #else // if !wxMOTIF_NEW_FONT_HANDLING
669
670 void wxGetTextExtent(WXDisplay* display, const wxFont& font,
671 double scale, const wxString& str,
672 int* width, int* height, int* ascent, int* descent)
673 {
674 WXFontStructPtr pFontStruct = font.GetFontStruct(scale, display);
675
676 int direction, ascent2, descent2;
677 XCharStruct overall;
678 int slen = str.Len();
679
680 XTextExtents((XFontStruct*) pFontStruct, (char*) str.c_str(), slen,
681 &direction, &ascent2, &descent2, &overall);
682
683 if ( width )
684 *width = (overall.width);
685 if ( height )
686 *height = (ascent2 + descent2);
687 if ( descent )
688 *descent = descent2;
689 if ( ascent )
690 *ascent = ascent2;
691 }
692
693 #endif // !wxMOTIF_NEW_FONT_HANDLING