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 wxT("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()
426 SetWeight(wxFONTWEIGHT_BOLD
);
430 wxFont
wxFont::Bold() const
437 wxFont
& wxFont::MakeItalic()
439 SetStyle(wxFONTSTYLE_ITALIC
);
443 wxFont
wxFont::Italic() const
446 font
.SetStyle(wxFONTSTYLE_ITALIC
);
450 wxFont
& wxFont::Scale(float x
)
452 SetPointSize(int(x
*GetPointSize() + 0.5));
456 wxFont
wxFont::Scaled(float x
) const
463 // ----------------------------------------------------------------------------
465 // ----------------------------------------------------------------------------
467 // Up to now, there are no native implementations of this function:
468 void wxNativeFontInfo::SetFaceName(const wxArrayString
& facenames
)
471 for (size_t i
=0; i
< facenames
.GetCount(); i
++)
473 if (wxFontEnumerator::IsValidFacename(facenames
[i
]))
475 SetFaceName(facenames
[i
]);
480 // set the first valid facename we can find on this system
481 wxString validfacename
= wxFontEnumerator::GetFacenames().Item(0);
482 wxLogTrace(wxT("font"), wxT("Falling back to '%s'"), validfacename
.c_str());
483 SetFaceName(validfacename
);
484 #else // !wxUSE_FONTENUM
485 SetFaceName(facenames
[0]);
486 #endif // wxUSE_FONTENUM/!wxUSE_FONTENUM
490 #ifdef wxNO_NATIVE_FONTINFO
492 // These are the generic forms of FromString()/ToString.
494 // convert to/from the string representation: format is
495 // version;pointsize;family;style;weight;underlined;facename;encoding
497 bool wxNativeFontInfo::FromString(const wxString
& s
)
501 wxStringTokenizer
tokenizer(s
, wxT(";"));
503 wxString token
= tokenizer
.GetNextToken();
505 // Ignore the version for now
508 token
= tokenizer
.GetNextToken();
509 if ( !token
.ToLong(&l
) )
513 token
= tokenizer
.GetNextToken();
514 if ( !token
.ToLong(&l
) )
516 family
= (wxFontFamily
)l
;
518 token
= tokenizer
.GetNextToken();
519 if ( !token
.ToLong(&l
) )
521 style
= (wxFontStyle
)l
;
523 token
= tokenizer
.GetNextToken();
524 if ( !token
.ToLong(&l
) )
526 weight
= (wxFontWeight
)l
;
528 token
= tokenizer
.GetNextToken();
529 if ( !token
.ToLong(&l
) )
533 faceName
= tokenizer
.GetNextToken();
540 token
= tokenizer
.GetNextToken();
541 if ( !token
.ToLong(&l
) )
543 encoding
= (wxFontEncoding
)l
;
548 wxString
wxNativeFontInfo::ToString() const
552 s
.Printf(wxT("%d;%d;%d;%d;%d;%d;%s;%d"),
565 void wxNativeFontInfo::Init()
568 family
= wxFONTFAMILY_DEFAULT
;
569 style
= wxFONTSTYLE_NORMAL
;
570 weight
= wxFONTWEIGHT_NORMAL
;
573 encoding
= wxFONTENCODING_DEFAULT
;
576 int wxNativeFontInfo::GetPointSize() const
581 wxFontStyle
wxNativeFontInfo::GetStyle() const
586 wxFontWeight
wxNativeFontInfo::GetWeight() const
591 bool wxNativeFontInfo::GetUnderlined() const
596 wxString
wxNativeFontInfo::GetFaceName() const
601 wxFontFamily
wxNativeFontInfo::GetFamily() const
606 wxFontEncoding
wxNativeFontInfo::GetEncoding() const
611 void wxNativeFontInfo::SetPointSize(int pointsize
)
613 pointSize
= pointsize
;
616 void wxNativeFontInfo::SetStyle(wxFontStyle style_
)
621 void wxNativeFontInfo::SetWeight(wxFontWeight weight_
)
626 void wxNativeFontInfo::SetUnderlined(bool underlined_
)
628 underlined
= underlined_
;
631 bool wxNativeFontInfo::SetFaceName(const wxString
& facename_
)
633 faceName
= facename_
;
637 void wxNativeFontInfo::SetFamily(wxFontFamily family_
)
642 void wxNativeFontInfo::SetEncoding(wxFontEncoding encoding_
)
644 encoding
= encoding_
;
647 #endif // generic wxNativeFontInfo implementation
649 // conversion to/from user-readable string: this is used in the generic
650 // versions and under MSW as well because there is no standard font description
651 // format there anyhow (but there is a well-defined standard for X11 fonts used
652 // by wxGTK and wxMotif)
654 #if defined(wxNO_NATIVE_FONTINFO) || defined(__WXMSW__) || defined (__WXPM__) || defined(__WXOSX__)
656 wxString
wxNativeFontInfo::ToUserString() const
660 // first put the adjectives, if any - this is English-centric, of course,
661 // but what else can we do?
662 if ( GetUnderlined() )
664 desc
<< _("underlined");
667 switch ( GetWeight() )
670 wxFAIL_MSG( wxT("unknown font weight") );
673 case wxFONTWEIGHT_NORMAL
:
676 case wxFONTWEIGHT_LIGHT
:
680 case wxFONTWEIGHT_BOLD
:
685 switch ( GetStyle() )
688 wxFAIL_MSG( wxT("unknown font style") );
691 case wxFONTSTYLE_NORMAL
:
694 // we don't distinguish between the two for now anyhow...
695 case wxFONTSTYLE_ITALIC
:
696 case wxFONTSTYLE_SLANT
:
697 desc
<< _(" italic");
701 wxString face
= GetFaceName();
704 if (face
.Contains(' ') || face
.Contains(';') || face
.Contains(','))
706 face
.Replace("'", "");
707 // eventually remove quote characters: most systems do not
708 // allow them in a facename anyway so this usually does nothing
710 // make it possible for FromUserString() function to understand
711 // that the different words which compose this facename are
712 // not different adjectives or other data but rather all parts
714 desc
<< wxT(" '") << face
<< _("'");
717 desc
<< wxT(' ') << face
;
719 else // no face name specified
723 switch ( GetFamily() )
725 case wxFONTFAMILY_DECORATIVE
:
726 familyStr
= "decorative";
729 case wxFONTFAMILY_ROMAN
:
733 case wxFONTFAMILY_SCRIPT
:
734 familyStr
= "script";
737 case wxFONTFAMILY_SWISS
:
741 case wxFONTFAMILY_MODERN
:
742 familyStr
= "modern";
745 case wxFONTFAMILY_TELETYPE
:
746 familyStr
= "teletype";
749 case wxFONTFAMILY_DEFAULT
:
750 case wxFONTFAMILY_UNKNOWN
:
754 wxFAIL_MSG( "unknown font family" );
757 if ( !familyStr
.empty() )
758 desc
<< " '" << familyStr
<< " family'";
761 int size
= GetPointSize();
762 if ( size
!= wxNORMAL_FONT
->GetPointSize() )
764 desc
<< wxT(' ') << size
;
768 wxFontEncoding enc
= GetEncoding();
769 if ( enc
!= wxFONTENCODING_DEFAULT
&& enc
!= wxFONTENCODING_SYSTEM
)
771 desc
<< wxT(' ') << wxFontMapper::GetEncodingName(enc
);
773 #endif // wxUSE_FONTMAP
775 return desc
.Strip(wxString::both
).MakeLower();
778 bool wxNativeFontInfo::FromUserString(const wxString
& s
)
780 // reset to the default state
783 // ToUserString() will quote the facename if it contains spaces, commas
784 // or semicolons: we must be able to understand that quoted text is
788 // parse a more or less free form string
789 wxStringTokenizer
tokenizer(toparse
, wxT(";, "), wxTOKEN_STRTOK
);
793 bool weightfound
= false, pointsizefound
= false;
795 bool encodingfound
= false;
797 bool insideQuotes
= false;
799 while ( tokenizer
.HasMoreTokens() )
801 wxString token
= tokenizer
.GetNextToken();
804 token
.Trim(true).Trim(false).MakeLower();
807 if (token
.StartsWith("'") ||
810 insideQuotes
= false;
812 // add this last token to the facename:
815 // normalize facename:
816 face
= face
.Trim(true).Trim(false);
817 face
.Replace("'", "");
824 if (token
.StartsWith("'"))
828 // look for the known tokens
831 // only the facename may be quoted:
835 if ( token
== wxT("underlined") || token
== _("underlined") )
839 else if ( token
== wxT("light") || token
== _("light") )
841 SetWeight(wxFONTWEIGHT_LIGHT
);
844 else if ( token
== wxT("bold") || token
== _("bold") )
846 SetWeight(wxFONTWEIGHT_BOLD
);
849 else if ( token
== wxT("italic") || token
== _("italic") )
851 SetStyle(wxFONTSTYLE_ITALIC
);
853 else if ( token
.ToULong(&size
) )
856 pointsizefound
= true;
861 // try to interpret this as an encoding
862 wxFontEncoding encoding
= wxFontMapper::Get()->CharsetToEncoding(token
, false);
863 if ( encoding
!= wxFONTENCODING_DEFAULT
&&
864 encoding
!= wxFONTENCODING_SYSTEM
) // returned when the recognition failed
866 SetEncoding(encoding
);
867 encodingfound
= true;
871 #endif // wxUSE_FONTMAP
873 // assume it is the face name
881 // skip the code which resets face below
886 #endif // wxUSE_FONTMAP
889 // if we had had the facename, we shouldn't continue appending tokens
890 // to it (i.e. "foo bold bar" shouldn't result in the facename "foo
895 if ( face
.EndsWith(" family", &familyStr
) )
897 // it's not a facename but rather a font family
899 if ( familyStr
== "decorative" )
900 family
= wxFONTFAMILY_DECORATIVE
;
901 else if ( familyStr
== "roman" )
902 family
= wxFONTFAMILY_ROMAN
;
903 else if ( familyStr
== "script" )
904 family
= wxFONTFAMILY_SCRIPT
;
905 else if ( familyStr
== "swiss" )
906 family
= wxFONTFAMILY_SWISS
;
907 else if ( familyStr
== "modern" )
908 family
= wxFONTFAMILY_MODERN
;
909 else if ( familyStr
== "teletype" )
910 family
= wxFONTFAMILY_TELETYPE
;
916 // NB: the check on the facename is implemented in wxFontBase::SetFaceName
917 // and not in wxNativeFontInfo::SetFaceName thus we need to explicitely
918 // call here wxFontEnumerator::IsValidFacename
921 !wxFontEnumerator::IsValidFacename(face
) ||
922 #endif // wxUSE_FONTENUM
925 SetFaceName(wxNORMAL_FONT
->GetFaceName());
932 // we might not have flushed it inside the loop
935 // NB: the check on the facename is implemented in wxFontBase::SetFaceName
936 // and not in wxNativeFontInfo::SetFaceName thus we need to explicitely
937 // call here wxFontEnumerator::IsValidFacename
940 !wxFontEnumerator::IsValidFacename(face
) ||
941 #endif // wxUSE_FONTENUM
944 SetFaceName(wxNORMAL_FONT
->GetFaceName());
948 // set point size to default value if size was not given
949 if ( !pointsizefound
)
950 SetPointSize(wxNORMAL_FONT
->GetPointSize());
952 // set font weight to default value if weight was not given
954 SetWeight(wxFONTWEIGHT_NORMAL
);
957 // set font encoding to default value if encoding was not given
958 if ( !encodingfound
)
959 SetEncoding(wxFONTENCODING_SYSTEM
);
960 #endif // wxUSE_FONTMAP
965 #endif // generic or wxMSW or wxOS2
968 // wxFont <-> wxString utilities, used by wxConfig
969 wxString
wxToString(const wxFontBase
& font
)
971 return font
.IsOk() ? font
.GetNativeFontInfoDesc()
975 bool wxFromString(const wxString
& str
, wxFontBase
*font
)
977 wxCHECK_MSG( font
, false, wxT("NULL output parameter") );
985 return font
->SetNativeFontInfo(str
);