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
424 wxFont
wxFont::MakeBold() const
427 font
.SetWeight(wxFONTWEIGHT_BOLD
);
431 wxFont
wxFont::MakeItalic() const
434 font
.SetStyle(wxFONTSTYLE_ITALIC
);
438 wxFont
wxFont::Scale(float x
) const
441 font
.SetPointSize(int(x
*GetPointSize() + 0.5));
445 // ----------------------------------------------------------------------------
447 // ----------------------------------------------------------------------------
449 // Up to now, there are no native implementations of this function:
450 void wxNativeFontInfo::SetFaceName(const wxArrayString
& facenames
)
453 for (size_t i
=0; i
< facenames
.GetCount(); i
++)
455 if (wxFontEnumerator::IsValidFacename(facenames
[i
]))
457 SetFaceName(facenames
[i
]);
462 // set the first valid facename we can find on this system
463 wxString validfacename
= wxFontEnumerator::GetFacenames().Item(0);
464 wxLogTrace(wxT("font"), wxT("Falling back to '%s'"), validfacename
.c_str());
465 SetFaceName(validfacename
);
466 #else // !wxUSE_FONTENUM
467 SetFaceName(facenames
[0]);
468 #endif // wxUSE_FONTENUM/!wxUSE_FONTENUM
472 #ifdef wxNO_NATIVE_FONTINFO
474 // These are the generic forms of FromString()/ToString.
476 // convert to/from the string representation: format is
477 // version;pointsize;family;style;weight;underlined;facename;encoding
479 bool wxNativeFontInfo::FromString(const wxString
& s
)
483 wxStringTokenizer
tokenizer(s
, _T(";"));
485 wxString token
= tokenizer
.GetNextToken();
487 // Ignore the version for now
490 token
= tokenizer
.GetNextToken();
491 if ( !token
.ToLong(&l
) )
495 token
= tokenizer
.GetNextToken();
496 if ( !token
.ToLong(&l
) )
498 family
= (wxFontFamily
)l
;
500 token
= tokenizer
.GetNextToken();
501 if ( !token
.ToLong(&l
) )
503 style
= (wxFontStyle
)l
;
505 token
= tokenizer
.GetNextToken();
506 if ( !token
.ToLong(&l
) )
508 weight
= (wxFontWeight
)l
;
510 token
= tokenizer
.GetNextToken();
511 if ( !token
.ToLong(&l
) )
515 faceName
= tokenizer
.GetNextToken();
522 token
= tokenizer
.GetNextToken();
523 if ( !token
.ToLong(&l
) )
525 encoding
= (wxFontEncoding
)l
;
530 wxString
wxNativeFontInfo::ToString() const
534 s
.Printf(_T("%d;%d;%d;%d;%d;%d;%s;%d"),
547 void wxNativeFontInfo::Init()
550 family
= wxFONTFAMILY_DEFAULT
;
551 style
= wxFONTSTYLE_NORMAL
;
552 weight
= wxFONTWEIGHT_NORMAL
;
555 encoding
= wxFONTENCODING_DEFAULT
;
558 int wxNativeFontInfo::GetPointSize() const
563 wxFontStyle
wxNativeFontInfo::GetStyle() const
568 wxFontWeight
wxNativeFontInfo::GetWeight() const
573 bool wxNativeFontInfo::GetUnderlined() const
578 wxString
wxNativeFontInfo::GetFaceName() const
583 wxFontFamily
wxNativeFontInfo::GetFamily() const
588 wxFontEncoding
wxNativeFontInfo::GetEncoding() const
593 void wxNativeFontInfo::SetPointSize(int pointsize
)
595 pointSize
= pointsize
;
598 void wxNativeFontInfo::SetStyle(wxFontStyle style_
)
603 void wxNativeFontInfo::SetWeight(wxFontWeight weight_
)
608 void wxNativeFontInfo::SetUnderlined(bool underlined_
)
610 underlined
= underlined_
;
613 bool wxNativeFontInfo::SetFaceName(const wxString
& facename_
)
615 faceName
= facename_
;
619 void wxNativeFontInfo::SetFamily(wxFontFamily family_
)
624 void wxNativeFontInfo::SetEncoding(wxFontEncoding encoding_
)
626 encoding
= encoding_
;
629 #endif // generic wxNativeFontInfo implementation
631 // conversion to/from user-readable string: this is used in the generic
632 // versions and under MSW as well because there is no standard font description
633 // format there anyhow (but there is a well-defined standard for X11 fonts used
634 // by wxGTK and wxMotif)
636 #if defined(wxNO_NATIVE_FONTINFO) || defined(__WXMSW__) || defined (__WXPM__) || defined(__WXOSX__)
638 wxString
wxNativeFontInfo::ToUserString() const
642 // first put the adjectives, if any - this is English-centric, of course,
643 // but what else can we do?
644 if ( GetUnderlined() )
646 desc
<< _("underlined");
649 switch ( GetWeight() )
652 wxFAIL_MSG( _T("unknown font weight") );
655 case wxFONTWEIGHT_NORMAL
:
658 case wxFONTWEIGHT_LIGHT
:
662 case wxFONTWEIGHT_BOLD
:
667 switch ( GetStyle() )
670 wxFAIL_MSG( _T("unknown font style") );
673 case wxFONTSTYLE_NORMAL
:
676 // we don't distinguish between the two for now anyhow...
677 case wxFONTSTYLE_ITALIC
:
678 case wxFONTSTYLE_SLANT
:
679 desc
<< _(" italic");
683 wxString face
= GetFaceName();
686 if (face
.Contains(' ') || face
.Contains(';') || face
.Contains(','))
688 face
.Replace("'", "");
689 // eventually remove quote characters: most systems do not
690 // allow them in a facename anyway so this usually does nothing
692 // make it possible for FromUserString() function to understand
693 // that the different words which compose this facename are
694 // not different adjectives or other data but rather all parts
696 desc
<< _T(" '") << face
<< _("'");
699 desc
<< _T(' ') << face
;
701 else // no face name specified
705 switch ( GetFamily() )
707 case wxFONTFAMILY_DECORATIVE
:
708 familyStr
= "decorative";
711 case wxFONTFAMILY_ROMAN
:
715 case wxFONTFAMILY_SCRIPT
:
716 familyStr
= "script";
719 case wxFONTFAMILY_SWISS
:
723 case wxFONTFAMILY_MODERN
:
724 familyStr
= "modern";
727 case wxFONTFAMILY_TELETYPE
:
728 familyStr
= "teletype";
731 case wxFONTFAMILY_DEFAULT
:
732 case wxFONTFAMILY_UNKNOWN
:
736 wxFAIL_MSG( "unknown font family" );
739 if ( !familyStr
.empty() )
740 desc
<< " '" << familyStr
<< " family'";
743 int size
= GetPointSize();
744 if ( size
!= wxNORMAL_FONT
->GetPointSize() )
746 desc
<< _T(' ') << size
;
750 wxFontEncoding enc
= GetEncoding();
751 if ( enc
!= wxFONTENCODING_DEFAULT
&& enc
!= wxFONTENCODING_SYSTEM
)
753 desc
<< _T(' ') << wxFontMapper::GetEncodingName(enc
);
755 #endif // wxUSE_FONTMAP
757 return desc
.Strip(wxString::both
).MakeLower();
760 bool wxNativeFontInfo::FromUserString(const wxString
& s
)
762 // reset to the default state
765 // ToUserString() will quote the facename if it contains spaces, commas
766 // or semicolons: we must be able to understand that quoted text is
770 // parse a more or less free form string
771 wxStringTokenizer
tokenizer(toparse
, _T(";, "), wxTOKEN_STRTOK
);
775 bool weightfound
= false, pointsizefound
= false;
777 bool encodingfound
= false;
779 bool insideQuotes
= false;
781 while ( tokenizer
.HasMoreTokens() )
783 wxString token
= tokenizer
.GetNextToken();
786 token
.Trim(true).Trim(false).MakeLower();
789 if (token
.StartsWith("'") ||
792 insideQuotes
= false;
794 // add this last token to the facename:
797 // normalize facename:
798 face
= face
.Trim(true).Trim(false);
799 face
.Replace("'", "");
806 if (token
.StartsWith("'"))
810 // look for the known tokens
813 // only the facename may be quoted:
817 if ( token
== _T("underlined") || token
== _("underlined") )
821 else if ( token
== _T("light") || token
== _("light") )
823 SetWeight(wxFONTWEIGHT_LIGHT
);
826 else if ( token
== _T("bold") || token
== _("bold") )
828 SetWeight(wxFONTWEIGHT_BOLD
);
831 else if ( token
== _T("italic") || token
== _("italic") )
833 SetStyle(wxFONTSTYLE_ITALIC
);
835 else if ( token
.ToULong(&size
) )
838 pointsizefound
= true;
843 // try to interpret this as an encoding
844 wxFontEncoding encoding
= wxFontMapper::Get()->CharsetToEncoding(token
, false);
845 if ( encoding
!= wxFONTENCODING_DEFAULT
&&
846 encoding
!= wxFONTENCODING_SYSTEM
) // returned when the recognition failed
848 SetEncoding(encoding
);
849 encodingfound
= true;
853 #endif // wxUSE_FONTMAP
855 // assume it is the face name
863 // skip the code which resets face below
868 #endif // wxUSE_FONTMAP
871 // if we had had the facename, we shouldn't continue appending tokens
872 // to it (i.e. "foo bold bar" shouldn't result in the facename "foo
877 if ( face
.EndsWith(" family", &familyStr
) )
879 // it's not a facename but rather a font family
881 if ( familyStr
== "decorative" )
882 family
= wxFONTFAMILY_DECORATIVE
;
883 else if ( familyStr
== "roman" )
884 family
= wxFONTFAMILY_ROMAN
;
885 else if ( familyStr
== "script" )
886 family
= wxFONTFAMILY_SCRIPT
;
887 else if ( familyStr
== "swiss" )
888 family
= wxFONTFAMILY_SWISS
;
889 else if ( familyStr
== "modern" )
890 family
= wxFONTFAMILY_MODERN
;
891 else if ( familyStr
== "teletype" )
892 family
= wxFONTFAMILY_TELETYPE
;
898 // NB: the check on the facename is implemented in wxFontBase::SetFaceName
899 // and not in wxNativeFontInfo::SetFaceName thus we need to explicitely
900 // call here wxFontEnumerator::IsValidFacename
903 !wxFontEnumerator::IsValidFacename(face
) ||
904 #endif // wxUSE_FONTENUM
907 SetFaceName(wxNORMAL_FONT
->GetFaceName());
914 // we might not have flushed it inside the loop
917 // NB: the check on the facename is implemented in wxFontBase::SetFaceName
918 // and not in wxNativeFontInfo::SetFaceName thus we need to explicitely
919 // call here wxFontEnumerator::IsValidFacename
922 !wxFontEnumerator::IsValidFacename(face
) ||
923 #endif // wxUSE_FONTENUM
926 SetFaceName(wxNORMAL_FONT
->GetFaceName());
930 // set point size to default value if size was not given
931 if ( !pointsizefound
)
932 SetPointSize(wxNORMAL_FONT
->GetPointSize());
934 // set font weight to default value if weight was not given
936 SetWeight(wxFONTWEIGHT_NORMAL
);
939 // set font encoding to default value if encoding was not given
940 if ( !encodingfound
)
941 SetEncoding(wxFONTENCODING_SYSTEM
);
942 #endif // wxUSE_FONTMAP
947 #endif // generic or wxMSW or wxOS2
950 // wxFont <-> wxString utilities, used by wxConfig
951 wxString
wxToString(const wxFontBase
& font
)
953 return font
.IsOk() ? font
.GetNativeFontInfoDesc()
957 bool wxFromString(const wxString
& str
, wxFontBase
*font
)
959 wxCHECK_MSG( font
, false, _T("NULL output parameter") );
967 return font
->SetNativeFontInfo(str
);