1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/fontcmn.cpp
3 // Purpose: implementation of wxFontBase methods
4 // Author: Vadim Zeitlin
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
32 #include "wx/dcscreen.h"
34 #include "wx/gdicmn.h"
37 #if defined(__WXMSW__)
38 #include "wx/msw/private.h" // includes windows.h for LOGFONT
39 #include "wx/msw/winundef.h"
42 #include "wx/fontutil.h" // for wxNativeFontInfo
43 #include "wx/fontmap.h"
44 #include "wx/fontenum.h"
46 #include "wx/tokenzr.h"
48 // debugger helper: this function can be called from a debugger to show what
50 extern const char *wxDumpFont(const wxFont
*font
)
54 const wxFontWeight weight
= font
->GetWeight();
57 s
.Printf(wxS("%s-%s-%s-%d-%d"),
59 weight
== wxFONTWEIGHT_NORMAL
61 : weight
== wxFONTWEIGHT_BOLD
64 font
->GetStyle() == wxFONTSTYLE_NORMAL
70 wxStrlcpy(buf
, s
.mb_str(), WXSIZEOF(buf
));
74 // ============================================================================
76 // ============================================================================
78 // ----------------------------------------------------------------------------
80 // ----------------------------------------------------------------------------
82 static inline int flags2Style(int flags
)
84 return flags
& wxFONTFLAG_ITALIC
86 : flags
& wxFONTFLAG_SLANT
91 static inline int flags2Weight(int flags
)
93 return flags
& wxFONTFLAG_LIGHT
95 : flags
& wxFONTFLAG_BOLD
97 : wxFONTWEIGHT_NORMAL
;
100 static inline bool flags2Underlined(int flags
)
102 return (flags
& wxFONTFLAG_UNDERLINED
) != 0;
105 // ----------------------------------------------------------------------------
107 // ----------------------------------------------------------------------------
109 wxFontEncoding
wxFontBase::ms_encodingDefault
= wxFONTENCODING_SYSTEM
;
112 void wxFontBase::SetDefaultEncoding(wxFontEncoding encoding
)
114 // GetDefaultEncoding() should return something != wxFONTENCODING_DEFAULT
115 // and, besides, using this value here doesn't make any sense
116 wxCHECK_RET( encoding
!= wxFONTENCODING_DEFAULT
,
117 _T("can't set default encoding to wxFONTENCODING_DEFAULT") );
119 ms_encodingDefault
= encoding
;
122 wxFontBase::~wxFontBase()
124 // this destructor is required for Darwin
128 wxFont
*wxFontBase::New(int size
,
133 const wxString
& face
,
134 wxFontEncoding encoding
)
136 return new wxFont(size
, family
, style
, weight
, underlined
, face
, encoding
);
140 wxFont
*wxFontBase::New(const wxSize
& pixelSize
,
145 const wxString
& face
,
146 wxFontEncoding encoding
)
148 return new wxFont(pixelSize
, family
, style
, weight
, underlined
,
153 wxFont
*wxFontBase::New(int pointSize
,
156 const wxString
& face
,
157 wxFontEncoding encoding
)
159 return New(pointSize
, family
, flags2Style(flags
), flags2Weight(flags
),
160 flags2Underlined(flags
), face
, encoding
);
164 wxFont
*wxFontBase::New(const wxSize
& pixelSize
,
167 const wxString
& face
,
168 wxFontEncoding encoding
)
170 return New(pixelSize
, family
, flags2Style(flags
), flags2Weight(flags
),
171 flags2Underlined(flags
), face
, encoding
);
175 wxFont
*wxFontBase::New(const wxNativeFontInfo
& info
)
177 return new wxFont(info
);
181 wxFont
*wxFontBase::New(const wxString
& strNativeFontDesc
)
183 wxNativeFontInfo fontInfo
;
184 if ( !fontInfo
.FromString(strNativeFontDesc
) )
185 return new wxFont(*wxNORMAL_FONT
);
187 return New(fontInfo
);
190 bool wxFontBase::IsFixedWidth() const
192 return GetFamily() == wxFONTFAMILY_TELETYPE
;
195 wxSize
wxFontBase::GetPixelSize() const
198 dc
.SetFont(*(wxFont
*)this);
199 return wxSize(dc
.GetCharWidth(), dc
.GetCharHeight());
202 bool wxFontBase::IsUsingSizeInPixels() const
207 void wxFontBase::SetPixelSize( const wxSize
& pixelSize
)
209 wxCHECK_RET( pixelSize
.GetWidth() >= 0 && pixelSize
.GetHeight() > 0,
210 "Negative values for the pixel size or zero pixel height are not allowed" );
214 // NOTE: this algorithm for adjusting the font size is used by all
215 // implementations of wxFont except under wxMSW and wxGTK where
216 // native support to font creation using pixel-size is provided.
221 bool initialGoodFound
= false;
222 bool initialBadFound
= false;
224 // NB: this assignment was separated from the variable definition
225 // in order to fix a gcc v3.3.3 compiler crash
226 int currentSize
= GetPointSize();
227 while (currentSize
> 0)
229 dc
.SetFont(*static_cast<wxFont
*>(this));
231 // if currentSize (in points) results in a font that is smaller
232 // than required by pixelSize it is considered a good size
233 // NOTE: the pixel size width may be zero
234 if (dc
.GetCharHeight() <= pixelSize
.GetHeight() &&
235 (pixelSize
.GetWidth() == 0 ||
236 dc
.GetCharWidth() <= pixelSize
.GetWidth()))
238 largestGood
= currentSize
;
239 initialGoodFound
= true;
243 smallestBad
= currentSize
;
244 initialBadFound
= true;
246 if (!initialGoodFound
)
250 else if (!initialBadFound
)
256 int distance
= smallestBad
- largestGood
;
260 currentSize
= largestGood
+ distance
/ 2;
263 SetPointSize(currentSize
);
266 if (currentSize
!= largestGood
)
267 SetPointSize(largestGood
);
270 void wxFontBase::DoSetNativeFontInfo(const wxNativeFontInfo
& info
)
272 #ifdef wxNO_NATIVE_FONTINFO
273 SetPointSize(info
.pointSize
);
274 SetFamily(info
.family
);
275 SetStyle(info
.style
);
276 SetWeight(info
.weight
);
277 SetUnderlined(info
.underlined
);
278 SetFaceName(info
.faceName
);
279 SetEncoding(info
.encoding
);
285 wxString
wxFontBase::GetNativeFontInfoDesc() const
288 const wxNativeFontInfo
*fontInfo
= GetNativeFontInfo();
291 fontDesc
= fontInfo
->ToString();
292 wxASSERT_MSG(!fontDesc
.empty(), wxT("This should be a non-empty string!"));
296 wxFAIL_MSG(wxT("Derived class should have created the wxNativeFontInfo!"));
302 wxString
wxFontBase::GetNativeFontInfoUserDesc() const
305 const wxNativeFontInfo
*fontInfo
= GetNativeFontInfo();
308 fontDesc
= fontInfo
->ToUserString();
309 wxASSERT_MSG(!fontDesc
.empty(), wxT("This should be a non-empty string!"));
313 wxFAIL_MSG(wxT("Derived class should have created the wxNativeFontInfo!"));
319 bool wxFontBase::SetNativeFontInfo(const wxString
& info
)
321 wxNativeFontInfo fontInfo
;
322 if ( !info
.empty() && fontInfo
.FromString(info
) )
324 SetNativeFontInfo(fontInfo
);
331 bool wxFontBase::SetNativeFontInfoUserDesc(const wxString
& info
)
333 wxNativeFontInfo fontInfo
;
334 if ( !info
.empty() && fontInfo
.FromUserString(info
) )
336 SetNativeFontInfo(fontInfo
);
343 bool wxFontBase::operator==(const wxFont
& font
) const
345 // either it is the same font, i.e. they share the same common data or they
346 // have different ref datas but still describe the same font
347 return IsSameAs(font
) ||
349 IsOk() == font
.IsOk() &&
350 GetPointSize() == font
.GetPointSize() &&
351 // in wxGTK1 GetPixelSize() calls GetInternalFont() which uses
352 // operator==() resulting in infinite recursion so we can't use it
354 #if !defined(__WXGTK__) || defined(__WXGTK20__)
355 GetPixelSize() == font
.GetPixelSize() &&
357 GetFamily() == font
.GetFamily() &&
358 GetStyle() == font
.GetStyle() &&
359 GetWeight() == font
.GetWeight() &&
360 GetUnderlined() == font
.GetUnderlined() &&
361 GetFaceName().IsSameAs(font
.GetFaceName(), false) &&
362 GetEncoding() == font
.GetEncoding()
366 wxString
wxFontBase::GetFamilyString() const
368 wxCHECK_MSG( IsOk(), "wxFONTFAMILY_DEFAULT", "invalid font" );
370 switch ( GetFamily() )
372 case wxFONTFAMILY_DECORATIVE
: return "wxFONTFAMILY_DECORATIVE";
373 case wxFONTFAMILY_ROMAN
: return "wxFONTFAMILY_ROMAN";
374 case wxFONTFAMILY_SCRIPT
: return "wxFONTFAMILY_SCRIPT";
375 case wxFONTFAMILY_SWISS
: return "wxFONTFAMILY_SWISS";
376 case wxFONTFAMILY_MODERN
: return "wxFONTFAMILY_MODERN";
377 case wxFONTFAMILY_TELETYPE
: return "wxFONTFAMILY_TELETYPE";
378 case wxFONTFAMILY_UNKNOWN
: return "wxFONTFAMILY_UNKNOWN";
379 default: return "wxFONTFAMILY_DEFAULT";
383 wxString
wxFontBase::GetStyleString() const
385 wxCHECK_MSG( IsOk(), "wxFONTSTYLE_DEFAULT", "invalid font" );
387 switch ( GetStyle() )
389 case wxFONTSTYLE_NORMAL
: return "wxFONTSTYLE_NORMAL";
390 case wxFONTSTYLE_SLANT
: return "wxFONTSTYLE_SLANT";
391 case wxFONTSTYLE_ITALIC
: return "wxFONTSTYLE_ITALIC";
392 default: return "wxFONTSTYLE_DEFAULT";
396 wxString
wxFontBase::GetWeightString() const
398 wxCHECK_MSG( IsOk(), "wxFONTWEIGHT_DEFAULT", "invalid font" );
400 switch ( GetWeight() )
402 case wxFONTWEIGHT_NORMAL
: return "wxFONTWEIGHT_NORMAL";
403 case wxFONTWEIGHT_BOLD
: return "wxFONTWEIGHT_BOLD";
404 case wxFONTWEIGHT_LIGHT
: return "wxFONTWEIGHT_LIGHT";
405 default: return "wxFONTWEIGHT_DEFAULT";
409 bool wxFontBase::SetFaceName(const wxString
& facename
)
412 if (!wxFontEnumerator::IsValidFacename(facename
))
414 UnRef(); // make IsOk() return false
417 #else // !wxUSE_FONTENUM
418 wxUnusedVar(facename
);
419 #endif // wxUSE_FONTENUM/!wxUSE_FONTENUM
425 // ----------------------------------------------------------------------------
427 // ----------------------------------------------------------------------------
429 // Up to now, there are no native implementations of this function:
430 void wxNativeFontInfo::SetFaceName(const wxArrayString
& facenames
)
433 for (size_t i
=0; i
< facenames
.GetCount(); i
++)
435 if (wxFontEnumerator::IsValidFacename(facenames
[i
]))
437 SetFaceName(facenames
[i
]);
442 // set the first valid facename we can find on this system
443 wxString validfacename
= wxFontEnumerator::GetFacenames().Item(0);
444 wxLogTrace(wxT("font"), wxT("Falling back to '%s'"), validfacename
.c_str());
445 SetFaceName(validfacename
);
446 #else // !wxUSE_FONTENUM
447 SetFaceName(facenames
[0]);
448 #endif // wxUSE_FONTENUM/!wxUSE_FONTENUM
452 #ifdef wxNO_NATIVE_FONTINFO
454 // These are the generic forms of FromString()/ToString.
456 // convert to/from the string representation: format is
457 // version;pointsize;family;style;weight;underlined;facename;encoding
459 bool wxNativeFontInfo::FromString(const wxString
& s
)
463 wxStringTokenizer
tokenizer(s
, _T(";"));
465 wxString token
= tokenizer
.GetNextToken();
467 // Ignore the version for now
470 token
= tokenizer
.GetNextToken();
471 if ( !token
.ToLong(&l
) )
475 token
= tokenizer
.GetNextToken();
476 if ( !token
.ToLong(&l
) )
478 family
= (wxFontFamily
)l
;
480 token
= tokenizer
.GetNextToken();
481 if ( !token
.ToLong(&l
) )
483 style
= (wxFontStyle
)l
;
485 token
= tokenizer
.GetNextToken();
486 if ( !token
.ToLong(&l
) )
488 weight
= (wxFontWeight
)l
;
490 token
= tokenizer
.GetNextToken();
491 if ( !token
.ToLong(&l
) )
495 faceName
= tokenizer
.GetNextToken();
502 token
= tokenizer
.GetNextToken();
503 if ( !token
.ToLong(&l
) )
505 encoding
= (wxFontEncoding
)l
;
510 wxString
wxNativeFontInfo::ToString() const
514 s
.Printf(_T("%d;%d;%d;%d;%d;%d;%s;%d"),
527 void wxNativeFontInfo::Init()
530 family
= wxFONTFAMILY_DEFAULT
;
531 style
= wxFONTSTYLE_NORMAL
;
532 weight
= wxFONTWEIGHT_NORMAL
;
535 encoding
= wxFONTENCODING_DEFAULT
;
538 int wxNativeFontInfo::GetPointSize() const
543 wxFontStyle
wxNativeFontInfo::GetStyle() const
548 wxFontWeight
wxNativeFontInfo::GetWeight() const
553 bool wxNativeFontInfo::GetUnderlined() const
558 wxString
wxNativeFontInfo::GetFaceName() const
563 wxFontFamily
wxNativeFontInfo::GetFamily() const
568 wxFontEncoding
wxNativeFontInfo::GetEncoding() const
573 void wxNativeFontInfo::SetPointSize(int pointsize
)
575 pointSize
= pointsize
;
578 void wxNativeFontInfo::SetStyle(wxFontStyle style_
)
583 void wxNativeFontInfo::SetWeight(wxFontWeight weight_
)
588 void wxNativeFontInfo::SetUnderlined(bool underlined_
)
590 underlined
= underlined_
;
593 bool wxNativeFontInfo::SetFaceName(const wxString
& facename_
)
595 faceName
= facename_
;
599 void wxNativeFontInfo::SetFamily(wxFontFamily family_
)
604 void wxNativeFontInfo::SetEncoding(wxFontEncoding encoding_
)
606 encoding
= encoding_
;
609 #endif // generic wxNativeFontInfo implementation
611 // conversion to/from user-readable string: this is used in the generic
612 // versions and under MSW as well because there is no standard font description
613 // format there anyhow (but there is a well-defined standard for X11 fonts used
614 // by wxGTK and wxMotif)
616 #if defined(wxNO_NATIVE_FONTINFO) || defined(__WXMSW__) || defined (__WXPM__) || defined(__WXOSX__)
618 wxString
wxNativeFontInfo::ToUserString() const
622 // first put the adjectives, if any - this is English-centric, of course,
623 // but what else can we do?
624 if ( GetUnderlined() )
626 desc
<< _("underlined");
629 switch ( GetWeight() )
632 wxFAIL_MSG( _T("unknown font weight") );
635 case wxFONTWEIGHT_NORMAL
:
638 case wxFONTWEIGHT_LIGHT
:
642 case wxFONTWEIGHT_BOLD
:
647 switch ( GetStyle() )
650 wxFAIL_MSG( _T("unknown font style") );
653 case wxFONTSTYLE_NORMAL
:
656 // we don't distinguish between the two for now anyhow...
657 case wxFONTSTYLE_ITALIC
:
658 case wxFONTSTYLE_SLANT
:
659 desc
<< _(" italic");
663 wxString face
= GetFaceName();
666 if (face
.Contains(' ') || face
.Contains(';') || face
.Contains(','))
668 face
.Replace("'", "");
669 // eventually remove quote characters: most systems do not
670 // allow them in a facename anyway so this usually does nothing
672 // make it possible for FromUserString() function to understand
673 // that the different words which compose this facename are
674 // not different adjectives or other data but rather all parts
676 desc
<< _T(" '") << face
<< _("'");
679 desc
<< _T(' ') << face
;
681 else // no face name specified
685 switch ( GetFamily() )
687 case wxFONTFAMILY_DECORATIVE
:
688 familyStr
= "decorative";
691 case wxFONTFAMILY_ROMAN
:
695 case wxFONTFAMILY_SCRIPT
:
696 familyStr
= "script";
699 case wxFONTFAMILY_SWISS
:
703 case wxFONTFAMILY_MODERN
:
704 familyStr
= "modern";
707 case wxFONTFAMILY_TELETYPE
:
708 familyStr
= "teletype";
711 case wxFONTFAMILY_DEFAULT
:
712 case wxFONTFAMILY_UNKNOWN
:
716 wxFAIL_MSG( "unknown font family" );
719 if ( !familyStr
.empty() )
720 desc
<< " '" << familyStr
<< " family'";
723 int size
= GetPointSize();
724 if ( size
!= wxNORMAL_FONT
->GetPointSize() )
726 desc
<< _T(' ') << size
;
730 wxFontEncoding enc
= GetEncoding();
731 if ( enc
!= wxFONTENCODING_DEFAULT
&& enc
!= wxFONTENCODING_SYSTEM
)
733 desc
<< _T(' ') << wxFontMapper::GetEncodingName(enc
);
735 #endif // wxUSE_FONTMAP
737 return desc
.Strip(wxString::both
).MakeLower();
740 bool wxNativeFontInfo::FromUserString(const wxString
& s
)
742 // reset to the default state
745 // ToUserString() will quote the facename if it contains spaces, commas
746 // or semicolons: we must be able to understand that quoted text is
750 // parse a more or less free form string
751 wxStringTokenizer
tokenizer(toparse
, _T(";, "), wxTOKEN_STRTOK
);
755 bool weightfound
= false, pointsizefound
= false;
757 bool encodingfound
= false;
759 bool insideQuotes
= false;
761 while ( tokenizer
.HasMoreTokens() )
763 wxString token
= tokenizer
.GetNextToken();
766 token
.Trim(true).Trim(false).MakeLower();
769 if (token
.StartsWith("'") ||
772 insideQuotes
= false;
774 // add this last token to the facename:
777 // normalize facename:
778 face
= face
.Trim(true).Trim(false);
779 face
.Replace("'", "");
786 if (token
.StartsWith("'"))
790 // look for the known tokens
793 // only the facename may be quoted:
797 if ( token
== _T("underlined") || token
== _("underlined") )
801 else if ( token
== _T("light") || token
== _("light") )
803 SetWeight(wxFONTWEIGHT_LIGHT
);
806 else if ( token
== _T("bold") || token
== _("bold") )
808 SetWeight(wxFONTWEIGHT_BOLD
);
811 else if ( token
== _T("italic") || token
== _("italic") )
813 SetStyle(wxFONTSTYLE_ITALIC
);
815 else if ( token
.ToULong(&size
) )
818 pointsizefound
= true;
823 // try to interpret this as an encoding
824 wxFontEncoding encoding
= wxFontMapper::Get()->CharsetToEncoding(token
, false);
825 if ( encoding
!= wxFONTENCODING_DEFAULT
&&
826 encoding
!= wxFONTENCODING_SYSTEM
) // returned when the recognition failed
828 SetEncoding(encoding
);
829 encodingfound
= true;
833 #endif // wxUSE_FONTMAP
835 // assume it is the face name
843 // skip the code which resets face below
848 #endif // wxUSE_FONTMAP
851 // if we had had the facename, we shouldn't continue appending tokens
852 // to it (i.e. "foo bold bar" shouldn't result in the facename "foo
857 if ( face
.EndsWith(" family", &familyStr
) )
859 // it's not a facename but rather a font family
861 if ( familyStr
== "decorative" )
862 family
= wxFONTFAMILY_DECORATIVE
;
863 else if ( familyStr
== "roman" )
864 family
= wxFONTFAMILY_ROMAN
;
865 else if ( familyStr
== "script" )
866 family
= wxFONTFAMILY_SCRIPT
;
867 else if ( familyStr
== "swiss" )
868 family
= wxFONTFAMILY_SWISS
;
869 else if ( familyStr
== "modern" )
870 family
= wxFONTFAMILY_MODERN
;
871 else if ( familyStr
== "teletype" )
872 family
= wxFONTFAMILY_TELETYPE
;
878 // NB: the check on the facename is implemented in wxFontBase::SetFaceName
879 // and not in wxNativeFontInfo::SetFaceName thus we need to explicitely
880 // call here wxFontEnumerator::IsValidFacename
883 !wxFontEnumerator::IsValidFacename(face
) ||
884 #endif // wxUSE_FONTENUM
887 SetFaceName(wxNORMAL_FONT
->GetFaceName());
894 // we might not have flushed it inside the loop
897 // NB: the check on the facename is implemented in wxFontBase::SetFaceName
898 // and not in wxNativeFontInfo::SetFaceName thus we need to explicitely
899 // call here wxFontEnumerator::IsValidFacename
902 !wxFontEnumerator::IsValidFacename(face
) ||
903 #endif // wxUSE_FONTENUM
906 SetFaceName(wxNORMAL_FONT
->GetFaceName());
910 // set point size to default value if size was not given
911 if ( !pointsizefound
)
912 SetPointSize(wxNORMAL_FONT
->GetPointSize());
914 // set font weight to default value if weight was not given
916 SetWeight(wxFONTWEIGHT_NORMAL
);
919 // set font encoding to default value if encoding was not given
920 if ( !encodingfound
)
921 SetEncoding(wxFONTENCODING_SYSTEM
);
922 #endif // wxUSE_FONTMAP
927 #endif // generic or wxMSW or wxOS2
930 // wxFont <-> wxString utilities, used by wxConfig
931 wxString
wxToString(const wxFontBase
& font
)
933 return font
.IsOk() ? font
.GetNativeFontInfoDesc()
937 bool wxFromString(const wxString
& str
, wxFontBase
*font
)
939 wxCHECK_MSG( font
, false, _T("NULL output parameter") );
947 return font
->SetNativeFontInfo(str
);