Add some version checks to help compiling on OSX.

[wxWidgets.git] / src / msw / font.cpp

diff --git a/src/msw/font.cpp b/src/msw/font.cpp
index b83bb2288c048797067f0c03dd9e3dbf96556e3d..d995db91ac7e54cd9f4fc5851f517a4aa55447f3 100644 (file)
--- a/src/msw/font.cpp
+++ b/src/msw/font.cpp
@@ -31,11 +31,10 @@
     #include "wx/utils.h"
     #include "wx/app.h"
     #include "wx/log.h"
     #include "wx/utils.h"
     #include "wx/app.h"
     #include "wx/log.h"

-    #include "wx/encinfo.h"
+    #include "wx/msw/private.h"

 #endif // WX_PRECOMP
 
 #endif // WX_PRECOMP
 

-#include "wx/msw/private.h"
-
+#include "wx/encinfo.h"

 #include "wx/fontutil.h"
 #include "wx/fontmap.h"
 
 #include "wx/fontutil.h"
 #include "wx/fontmap.h"
 


@@ -43,54 +42,9 @@
     #include "wx/sysopt.h"
 #endif
 
     #include "wx/sysopt.h"
 #endif
 

+#include "wx/scopeguard.h"

 #include "wx/tokenzr.h"
 
 #include "wx/tokenzr.h"
 

-#if wxUSE_EXTENDED_RTTI
-
-wxBEGIN_ENUM( wxFontFamily )
-    wxENUM_MEMBER( wxDEFAULT )
-    wxENUM_MEMBER( wxDECORATIVE )
-    wxENUM_MEMBER( wxROMAN )
-    wxENUM_MEMBER( wxSCRIPT )
-    wxENUM_MEMBER( wxSWISS )
-    wxENUM_MEMBER( wxMODERN )
-    wxENUM_MEMBER( wxTELETYPE )
-wxEND_ENUM( wxFontFamily )
-
-wxBEGIN_ENUM( wxFontStyle )
-    wxENUM_MEMBER( wxNORMAL )
-    wxENUM_MEMBER( wxITALIC )
-    wxENUM_MEMBER( wxSLANT )
-wxEND_ENUM( wxFontStyle )
-
-wxBEGIN_ENUM( wxFontWeight )
-    wxENUM_MEMBER( wxNORMAL )
-    wxENUM_MEMBER( wxLIGHT )
-    wxENUM_MEMBER( wxBOLD )
-wxEND_ENUM( wxFontWeight )
-
-IMPLEMENT_DYNAMIC_CLASS_WITH_COPY_XTI(wxFont, wxGDIObject,"wx/font.h")
-
-wxBEGIN_PROPERTIES_TABLE(wxFont)
-    wxPROPERTY( Size,int, SetPointSize, GetPointSize, 12 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
-    wxPROPERTY( Family, int  , SetFamily, GetFamily, (int)wxDEFAULT , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // wxFontFamily
-    wxPROPERTY( Style, int , SetStyle, GetStyle, (int)wxNORMAL , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // wxFontStyle
-    wxPROPERTY( Weight, int , SetWeight, GetWeight, (int)wxNORMAL , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // wxFontWeight
-    wxPROPERTY( Underlined, bool , SetUnderlined, GetUnderlined, false , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
-    wxPROPERTY( Face, wxString , SetFaceName, GetFaceName, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
-    wxPROPERTY( Encoding, wxFontEncoding , SetEncoding, GetEncoding, wxFONTENCODING_DEFAULT , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
-wxEND_PROPERTIES_TABLE()
-
-wxCONSTRUCTOR_6( wxFont , int , Size , int , Family , int , Style , int , Weight , bool , Underlined , wxString , Face )
-
-wxBEGIN_HANDLERS_TABLE(wxFont)
-wxEND_HANDLERS_TABLE()
-
-#else
-    IMPLEMENT_DYNAMIC_CLASS(wxFont, wxGDIObject)
-#endif
-
-

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------


@@ -182,7 +136,19 @@ public:
 
     wxString GetFaceName() const
     {
 
     wxString GetFaceName() const
     {

-        return m_nativeFontInfo.GetFaceName();
+        wxString facename = m_nativeFontInfo.GetFaceName();
+        if ( facename.empty() )
+        {
+            facename = GetMSWFaceName();
+            if ( !facename.empty() )
+            {
+                // cache the face name, it shouldn't change unless the family
+                // does and wxNativeFontInfo::SetFamily() resets the face name
+                const_cast<wxFontRefData *>(this)->SetFaceName(facename);
+            }
+        }
+
+        return facename;

     }
 
     wxFontEncoding GetEncoding() const
     }
 
     wxFontEncoding GetEncoding() const


@@ -192,8 +158,7 @@ public:
 
     WXHFONT GetHFONT() const
     {
 
     WXHFONT GetHFONT() const
     {

-        if ( !m_hFont )
-            const_cast<wxFontRefData *>(this)->Alloc();
+        AllocIfNeeded();

 
         return (WXHFONT)m_hFont;
     }
 
         return (WXHFONT)m_hFont;
     }


@@ -216,6 +181,9 @@ public:
 
     void SetPixelSize(const wxSize& pixelSize)
     {
 
     void SetPixelSize(const wxSize& pixelSize)
     {

+        wxCHECK_RET( pixelSize.GetWidth() >= 0, "negative font width" );
+        wxCHECK_RET( pixelSize.GetHeight() != 0, "zero font height" );
+

         Free();
 
         m_nativeFontInfo.SetPixelSize(pixelSize);
         Free();
 
         m_nativeFontInfo.SetPixelSize(pixelSize);


@@ -265,7 +233,18 @@ public:
     }
 
     const wxNativeFontInfo& GetNativeFontInfo() const
     }
 
     const wxNativeFontInfo& GetNativeFontInfo() const

-        { return m_nativeFontInfo; }
+    {
+        // we need to create the font now to get the corresponding LOGFONT if
+        // it hadn't been done yet
+        AllocIfNeeded();
+
+        // ensure that we have a valid face name in our font information:
+        // GetFaceName() will try to retrieve it from our HFONT and save it if
+        // it was successful
+        (void)GetFaceName();
+
+        return m_nativeFontInfo;
+    }

 
     void SetNativeFontInfo(const wxNativeFontInfo& nativeFontInfo)
     {
 
     void SetNativeFontInfo(const wxNativeFontInfo& nativeFontInfo)
     {


@@ -288,6 +267,48 @@ protected:
 
     void Init(const wxNativeFontInfo& info, WXHFONT hFont = 0);
 
 
     void Init(const wxNativeFontInfo& info, WXHFONT hFont = 0);
 

+    void AllocIfNeeded() const
+    {
+        if ( !m_hFont )
+            const_cast<wxFontRefData *>(this)->Alloc();
+    }
+
+    // retrieve the face name really being used by the font: this is used to
+    // get the face name selected by the system when we don't specify it (but
+    // use just the family for example)
+    wxString GetMSWFaceName() const
+    {
+        ScreenHDC hdc;
+        SelectInHDC selectFont(hdc, m_hFont);
+
+        UINT otmSize = GetOutlineTextMetrics(hdc, 0, NULL);
+        if ( !otmSize )
+        {
+            wxLogLastError("GetOutlineTextMetrics(NULL)");
+            return wxString();
+        }
+
+        OUTLINETEXTMETRIC * const
+            otm = static_cast<OUTLINETEXTMETRIC *>(malloc(otmSize));
+        wxON_BLOCK_EXIT1( free, otm );
+
+        otm->otmSize = otmSize;
+        if ( !GetOutlineTextMetrics(hdc, otmSize, otm) )
+        {
+            wxLogLastError("GetOutlineTextMetrics()");
+            return wxString();
+        }
+
+        // in spite of its type, the otmpFamilyName field of OUTLINETEXTMETRIC
+        // gives an offset in _bytes_ of the face (not family!) name from the
+        // struct start while the name itself is an array of TCHARs
+        //
+        // FWIW otmpFaceName contains the same thing as otmpFamilyName followed
+        // by a possible " Italic" or " Bold" or something else suffix
+        return reinterpret_cast<wxChar *>(otm) +
+                    wxPtrToUInt(otm->otmpFamilyName)/sizeof(wxChar);
+    }
+

     // are we using m_nativeFontInfo.lf.lfHeight for point size or pixel size?
     bool             m_sizeUsingPixels;
 
     // are we using m_nativeFontInfo.lf.lfHeight for point size or pixel size?
     bool             m_sizeUsingPixels;
 


@@ -503,13 +524,16 @@ void wxNativeFontInfo::SetPointSize(int pointsize)
 
 void wxNativeFontInfo::SetPixelSize(const wxSize& pixelSize)
 {
 
 void wxNativeFontInfo::SetPixelSize(const wxSize& pixelSize)
 {

-    // NOTE: although the MSW port allows for negative pixel size heights,
-    //       other ports don't and since it's a very useful feature assert
-    //       here if we get a negative height:
-    wxCHECK_RET( pixelSize.GetWidth() >= 0 && pixelSize.GetHeight() > 0,
-                 "Negative values for the pixel size or zero pixel height are not allowed" );
-
-    lf.lfHeight = pixelSize.GetHeight();
+    // MSW accepts both positive and negative heights here but they mean
+    // different things: positive specifies the cell height while negative
+    // specifies the character height. We used to just pass the value to MSW
+    // unchanged but changed the behaviour for positive values in 2.9.1 to
+    // match other ports and, more importantly, the expected behaviour. So now
+    // passing the negative height doesn't make sense at all any more but we
+    // still accept it for compatibility with the existing code which worked
+    // around the wrong interpretation of the height argument in older wxMSW
+    // versions by passing a negative value explicitly itself.
+    lf.lfHeight = -abs(pixelSize.GetHeight());

     lf.lfWidth = pixelSize.GetWidth();
 }
 
     lf.lfWidth = pixelSize.GetWidth();
 }
 


@@ -567,78 +591,39 @@ bool wxNativeFontInfo::SetFaceName(const wxString& facename)
 
 void wxNativeFontInfo::SetFamily(wxFontFamily family)
 {
 
 void wxNativeFontInfo::SetFamily(wxFontFamily family)
 {

-    BYTE ff_family;
-    wxArrayString facename;
-
-    // the list of fonts associated with a family was partially
-    // taken from http://www.codestyle.org/css/font-family
+    BYTE ff_family = FF_DONTCARE;

 
     switch ( family )
     {
         case wxFONTFAMILY_SCRIPT:
             ff_family = FF_SCRIPT;
 
     switch ( family )
     {
         case wxFONTFAMILY_SCRIPT:
             ff_family = FF_SCRIPT;

-            facename.Add(wxS("Script"));
-            facename.Add(wxS("Brush Script MT"));
-            facename.Add(wxS("Comic Sans MS"));
-            facename.Add(wxS("Lucida Handwriting"));

             break;
 
         case wxFONTFAMILY_DECORATIVE:
             ff_family = FF_DECORATIVE;
             break;
 
         case wxFONTFAMILY_DECORATIVE:
             ff_family = FF_DECORATIVE;

-            facename.Add(wxS("Old English Text MT"));
-            facename.Add(wxS("Comic Sans MS"));
-            facename.Add(wxS("Lucida Handwriting"));

             break;
 
         case wxFONTFAMILY_ROMAN:
             ff_family = FF_ROMAN;
             break;
 
         case wxFONTFAMILY_ROMAN:
             ff_family = FF_ROMAN;

-            facename.Add(wxS("Times New Roman"));
-            facename.Add(wxS("Georgia"));
-            facename.Add(wxS("Garamond"));
-            facename.Add(wxS("Bookman Old Style"));
-            facename.Add(wxS("Book Antiqua"));

             break;
 
         case wxFONTFAMILY_TELETYPE:
         case wxFONTFAMILY_MODERN:
             ff_family = FF_MODERN;
             break;
 
         case wxFONTFAMILY_TELETYPE:
         case wxFONTFAMILY_MODERN:
             ff_family = FF_MODERN;

-            facename.Add(wxS("Courier New"));
-            facename.Add(wxS("Lucida Console"));
-            facename.Add(wxS("Andale Mono"));
-            facename.Add(wxS("OCR A Extended"));
-            facename.Add(wxS("Terminal"));

             break;
 
         case wxFONTFAMILY_SWISS:
             break;
 
         case wxFONTFAMILY_SWISS:

+        case wxFONTFAMILY_DEFAULT:

             ff_family = FF_SWISS;
             ff_family = FF_SWISS;

-            facename.Add(wxS("Arial"));
-            facename.Add(wxS("Century Gothic"));
-            facename.Add(wxS("Lucida Sans Unicode"));
-            facename.Add(wxS("Tahoma"));
-            facename.Add(wxS("Trebuchet MS"));
-            facename.Add(wxS("Verdana"));

             break;
 
             break;
 

-        case wxFONTFAMILY_DEFAULT:
-        default:
-        {
-            // We want Windows 2000 or later to have new fonts even MS Shell Dlg
-            // is returned as default GUI font for compatibility
-            int verMaj;
-            ff_family = FF_SWISS;
-            if(wxGetOsVersion(&verMaj) == wxOS_WINDOWS_NT && verMaj >= 5)
-                facename.Add(wxS("MS Shell Dlg 2"));
-            else
-                facename.Add(wxS("MS Shell Dlg"));
-
-            // Quoting the MSDN:
-            //     "MS Shell Dlg is a mapping mechanism that enables
-            //     U.S. English Microsoft Windows NT, and Microsoft Windows 2000 to
-            //     support locales that have characters that are not contained in code
-            //     page 1252. It is not a font but a face name for a nonexistent font."
-        }
+        case wxFONTFAMILY_UNKNOWN:
+            wxFAIL_MSG( "invalid font family" );
+            return;

     }
 
     }
 

+    wxCHECK_RET( ff_family != FF_DONTCARE, "unknown wxFontFamily" );
+

     lf.lfPitchAndFamily = (BYTE)(DEFAULT_PITCH) | ff_family;
 
     // reset the facename so that CreateFontIndirect() will automatically choose a
     lf.lfPitchAndFamily = (BYTE)(DEFAULT_PITCH) | ff_family;
 
     // reset the facename so that CreateFontIndirect() will automatically choose a


@@ -677,7 +662,7 @@ bool wxNativeFontInfo::FromString(const wxString& s)
 {
     long l;
 
 {
     long l;
 

-    wxStringTokenizer tokenizer(s, wxS(";"));
+    wxStringTokenizer tokenizer(s, wxS(";"), wxTOKEN_RET_EMPTY_ALL);

 
     // first the version
     wxString token = tokenizer.GetNextToken();
 
     // first the version
     wxString token = tokenizer.GetNextToken();


@@ -749,10 +734,11 @@ bool wxNativeFontInfo::FromString(const wxString& s)
         return false;
     lf.lfPitchAndFamily = (BYTE)l;
 
         return false;
     lf.lfPitchAndFamily = (BYTE)l;
 

-    token = tokenizer.GetNextToken();
-    if(!token)
+    if ( !tokenizer.HasMoreTokens() )

         return false;
         return false;

-    wxStrcpy(lf.lfFaceName, token.c_str());
+
+    // the face name may be empty
+    SetFaceName(tokenizer.GetNextToken());

 
     return true;
 }
 
     return true;
 }


@@ -776,7 +762,7 @@ wxString wxNativeFontInfo::ToString() const
              lf.lfClipPrecision,
              lf.lfQuality,
              lf.lfPitchAndFamily,
              lf.lfClipPrecision,
              lf.lfQuality,
              lf.lfPitchAndFamily,

-             (const wxChar*)lf.lfFaceName);
+             lf.lfFaceName);

 
     return s;
 }
 
     return s;
 }


@@ -983,10 +969,8 @@ bool wxFont::IsUsingSizeInPixels() const
     return M_FONTDATA->IsUsingSizeInPixels();
 }
 
     return M_FONTDATA->IsUsingSizeInPixels();
 }
 

-wxFontFamily wxFont::GetFamily() const
+wxFontFamily wxFont::DoGetFamily() const

 {
 {

-    wxCHECK_MSG( IsOk(), wxFONTFAMILY_MAX, wxT("invalid font") );
-

     return M_FONTDATA->GetFamily();
 }
 
     return M_FONTDATA->GetFamily();
 }
 


@@ -1030,32 +1014,23 @@ const wxNativeFontInfo *wxFont::GetNativeFontInfo() const
     return IsOk() ? &(M_FONTDATA->GetNativeFontInfo()) : NULL;
 }
 
     return IsOk() ? &(M_FONTDATA->GetNativeFontInfo()) : NULL;
 }
 

-wxString wxFont::GetNativeFontInfoDesc() const
-{
-    wxCHECK_MSG( IsOk(), wxEmptyString, wxT("invalid font") );
-
-    // be sure we have an HFONT associated...
-    const_cast<wxFont*>(this)->RealizeResource();
-    return wxFontBase::GetNativeFontInfoDesc();
-}
-
-wxString wxFont::GetNativeFontInfoUserDesc() const
-{
-    wxCHECK_MSG( IsOk(), wxEmptyString, wxT("invalid font") );
-
-    // be sure we have an HFONT associated...
-    const_cast<wxFont*>(this)->RealizeResource();
-    return wxFontBase::GetNativeFontInfoUserDesc();
-}
-

 bool wxFont::IsFixedWidth() const
 {
     wxCHECK_MSG( IsOk(), false, wxT("invalid font") );
 
 bool wxFont::IsFixedWidth() const
 {
     wxCHECK_MSG( IsOk(), false, wxT("invalid font") );
 

-    // the two low-order bits specify the pitch of the font, the rest is
-    // family
-    BYTE pitch =
-        (BYTE)(M_FONTDATA->GetNativeFontInfo().lf.lfPitchAndFamily & PITCH_MASK);
+    // LOGFONT doesn't contain the correct pitch information so we need to call
+    // GetTextMetrics() to get it
+    ScreenHDC hdc;
+    SelectInHDC selectFont(hdc, M_FONTDATA->GetHFONT());
+
+    TEXTMETRIC tm;
+    if ( !::GetTextMetrics(hdc, &tm) )
+    {
+        wxLogLastError(wxT("GetTextMetrics"));
+        return false;
+    }

 
 

-    return pitch == FIXED_PITCH;
+    // Quoting MSDN description of TMPF_FIXED_PITCH: "Note very carefully that
+    // those meanings are the opposite of what the constant name implies."
+    return !(tm.tmPitchAndFamily & TMPF_FIXED_PITCH);

 }
 }