Allow retrieving the descent and external leading of empty strings.

[wxWidgets.git] / tests / font / fonttest.cpp

diff --git a/tests/font/fonttest.cpp b/tests/font/fonttest.cpp
index c8a60f0f4efa9e4a79b89af2bc9646cc7efae610..bf1940320700a4179c80e6a052edcc6f13c52a44 100644 (file)
--- a/tests/font/fonttest.cpp
+++ b/tests/font/fonttest.cpp
@@ -26,6 +26,8 @@
 
 #include "wx/font.h"
 
 
 #include "wx/font.h"
 

+#include "asserthelper.h"
+

 // ----------------------------------------------------------------------------
 // test class
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // test class
 // ----------------------------------------------------------------------------


@@ -37,10 +39,32 @@ public:
 
 private:
     CPPUNIT_TEST_SUITE( FontTestCase );
 
 private:
     CPPUNIT_TEST_SUITE( FontTestCase );

+        CPPUNIT_TEST( Construct );

         CPPUNIT_TEST( GetSet );
         CPPUNIT_TEST( GetSet );

+        CPPUNIT_TEST( NativeFontInfo );
+        CPPUNIT_TEST( NativeFontInfoUserDesc );

     CPPUNIT_TEST_SUITE_END();
 
     CPPUNIT_TEST_SUITE_END();
 

+    void Construct();

     void GetSet();
     void GetSet();

+    void NativeFontInfo();
+    void NativeFontInfoUserDesc();
+
+    static const wxFont *GetTestFonts(unsigned& numFonts)
+    {
+        static const wxFont testfonts[] =
+        {
+            *wxNORMAL_FONT,
+            *wxSMALL_FONT,
+            *wxITALIC_FONT,
+            *wxSWISS_FONT,
+            wxFont(5, wxFONTFAMILY_TELETYPE, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL)
+        };
+
+        numFonts = WXSIZEOF(testfonts);
+
+        return testfonts;
+    }

 
     DECLARE_NO_COPY_CLASS(FontTestCase)
 };
 
     DECLARE_NO_COPY_CLASS(FontTestCase)
 };


@@ -48,16 +72,16 @@ private:
 // register in the unnamed registry so that these tests are run by default
 CPPUNIT_TEST_SUITE_REGISTRATION( FontTestCase );
 
 // register in the unnamed registry so that these tests are run by default
 CPPUNIT_TEST_SUITE_REGISTRATION( FontTestCase );
 

-// also include in it's own registry so that these tests can be run alone
+// also include in its own registry so that these tests can be run alone

 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( FontTestCase, "FontTestCase" );
 
 wxString DumpFont(const wxFont *font)
 {
     // dumps the internal properties of a wxFont in the same order they
     // are checked by wxFontBase::operator==()
 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( FontTestCase, "FontTestCase" );
 
 wxString DumpFont(const wxFont *font)
 {
     // dumps the internal properties of a wxFont in the same order they
     // are checked by wxFontBase::operator==()

-    
+

     wxASSERT(font->IsOk());
     wxASSERT(font->IsOk());

-    
+

     wxString s;
     s.Printf(wxS("%d-%d;%d-%d-%d-%d-%d-%s-%d"),
              font->GetPointSize(),
     wxString s;
     s.Printf(wxS("%d-%d;%d-%d-%d-%d-%d-%s-%d"),
              font->GetPointSize(),


@@ -73,34 +97,54 @@ wxString DumpFont(const wxFont *font)
     return s;
 }
 
     return s;
 }
 

+void FontTestCase::Construct()
+{
+    // The main purpose of this test is to verify that the font ctors below
+    // compile because it's easy to introduce ambiguities due to the number of
+    // overloaded wxFont ctors.
+
+    CPPUNIT_ASSERT( wxFont(10, wxFONTFAMILY_DEFAULT,
+                               wxFONTSTYLE_NORMAL,
+                               wxFONTWEIGHT_NORMAL).IsOk() );
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    // Tests relying on the soon-to-be-deprecated ctor taking ints and not
+    // wxFontXXX enum elements.
+    CPPUNIT_ASSERT( wxFont(10, wxDEFAULT, wxNORMAL, wxNORMAL).IsOk() );
+#endif // FUTURE_WXWIN_COMPATIBILITY_3_0
+}
+

 void FontTestCase::GetSet()
 {
 void FontTestCase::GetSet()
 {

-    static const wxFont testfonts[] =
+    unsigned numFonts;
+    const wxFont *pf = GetTestFonts(numFonts);
+    for ( unsigned n = 0; n < numFonts; n++ )

     {
     {

-        *wxNORMAL_FONT,
-        *wxSMALL_FONT,
-        *wxITALIC_FONT,
-        *wxSWISS_FONT,
-        wxFont(5, wxFONTFAMILY_TELETYPE, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL)
-    };
-
-    for ( size_t n = 0; n < WXSIZEOF(testfonts); n++ )
-    {
-        wxFont test(testfonts[n]);
+        wxFont test(*pf++);

 
         // remember: getters can only be called when wxFont::IsOk() == true
         CPPUNIT_ASSERT( test.IsOk() );
 
 
         // test Get/SetFaceName()
 
         // remember: getters can only be called when wxFont::IsOk() == true
         CPPUNIT_ASSERT( test.IsOk() );
 
 
         // test Get/SetFaceName()

-
-        const wxString& fn = test.GetFaceName();
-        CPPUNIT_ASSERT( !fn.empty() );
-

         CPPUNIT_ASSERT( !test.SetFaceName("a dummy face name") );
         CPPUNIT_ASSERT( !test.IsOk() );
 
         CPPUNIT_ASSERT( !test.SetFaceName("a dummy face name") );
         CPPUNIT_ASSERT( !test.IsOk() );
 

-        CPPUNIT_ASSERT( test.SetFaceName(fn) );
+        // if the call to SetFaceName() below fails on your system/port,
+        // consider adding another branch to this #if
+#if defined(__WXMSW__) || defined(__WXOSX__)
+        static const char *knownGoodFaceName = "Arial";
+#else
+        static const char *knownGoodFaceName = "Monospace";
+#endif
+
+        WX_ASSERT_MESSAGE
+        (
+            ("failed to set face name \"%s\" for test font #%u\n"
+             "(this failure is harmless if this face name is not "
+             "available on this system)", knownGoodFaceName, n),
+            test.SetFaceName(knownGoodFaceName)
+        );

         CPPUNIT_ASSERT( test.IsOk() );
 
 
         CPPUNIT_ASSERT( test.IsOk() );
 
 


@@ -108,10 +152,13 @@ void FontTestCase::GetSet()
 
         test.SetFamily( wxFONTFAMILY_ROMAN );
         CPPUNIT_ASSERT( test.IsOk() );
 
         test.SetFamily( wxFONTFAMILY_ROMAN );
         CPPUNIT_ASSERT( test.IsOk() );

-        CPPUNIT_ASSERT( wxFONTFAMILY_ROMAN == test.GetFamily() || 
-                        wxFONTFAMILY_UNKNOWN == test.GetFamily() );
-            // note that there is always the possibility that GetFamily() returns
-            // wxFONTFAMILY_UNKNOWN so that we consider it as a valid return value
+
+        // note that there is always the possibility that GetFamily() returns
+        // wxFONTFAMILY_DEFAULT (meaning "unknown" in this case) so that we
+        // consider it as a valid return value
+        const wxFontFamily family = test.GetFamily();
+        if ( family != wxFONTFAMILY_DEFAULT )
+            CPPUNIT_ASSERT_EQUAL( wxFONTFAMILY_ROMAN, family );

 
 
         // test Get/SetEncoding()
 
 
         // test Get/SetEncoding()


@@ -120,35 +167,130 @@ void FontTestCase::GetSet()
         //CPPUNIT_ASSERT( test.IsOk() );
         //CPPUNIT_ASSERT_EQUAL( wxFONTENCODING_KOI8 , test.GetEncoding() );
 
         //CPPUNIT_ASSERT( test.IsOk() );
         //CPPUNIT_ASSERT_EQUAL( wxFONTENCODING_KOI8 , test.GetEncoding() );
 

-        
-        // test Get/SetNativeFontInfo
-        
+
+        // test Get/SetPointSize()
+
+        test.SetPointSize(30);
+        CPPUNIT_ASSERT( test.IsOk() );
+        CPPUNIT_ASSERT_EQUAL( 30, test.GetPointSize() );
+
+
+        // test Get/SetPixelSize()
+
+        test.SetPixelSize(wxSize(0,30));
+        CPPUNIT_ASSERT( test.IsOk() );
+        CPPUNIT_ASSERT( test.GetPixelSize().GetHeight() <= 30 );
+            // NOTE: the match found by SetPixelSize() may be not 100% precise; it
+            //       only grants that a font smaller than the required height will
+            //       be selected
+
+
+        // test Get/SetStyle()
+
+        test.SetStyle(wxFONTSTYLE_SLANT);
+        CPPUNIT_ASSERT( test.IsOk() );
+#ifdef __WXMSW__
+        // on wxMSW wxFONTSTYLE_SLANT==wxFONTSTYLE_ITALIC
+        CPPUNIT_ASSERT( wxFONTSTYLE_SLANT == test.GetStyle() ||
+                        wxFONTSTYLE_ITALIC == test.GetStyle() );
+#else
+        CPPUNIT_ASSERT_EQUAL( wxFONTSTYLE_SLANT, test.GetStyle() );
+#endif
+
+        // test Get/SetUnderlined()
+
+        test.SetUnderlined(true);
+        CPPUNIT_ASSERT( test.IsOk() );
+        CPPUNIT_ASSERT_EQUAL( true, test.GetUnderlined() );
+
+        // test Get/SetStrikethrough()
+
+        test.SetStrikethrough(true);
+        CPPUNIT_ASSERT( test.IsOk() );
+        CPPUNIT_ASSERT_EQUAL( true, test.GetStrikethrough() );
+
+
+        // test Get/SetWeight()
+
+        test.SetWeight(wxFONTWEIGHT_BOLD);
+        CPPUNIT_ASSERT( test.IsOk() );
+        CPPUNIT_ASSERT_EQUAL( wxFONTWEIGHT_BOLD, test.GetWeight() );
+    }
+}
+
+void FontTestCase::NativeFontInfo()
+{
+    unsigned numFonts;
+    const wxFont *pf = GetTestFonts(numFonts);
+    for ( size_t n = 0; n < numFonts; n++ )
+    {
+        wxFont test(*pf++);
+

         const wxString& nid = test.GetNativeFontInfoDesc();
         CPPUNIT_ASSERT( !nid.empty() );
             // documented to be never empty
         const wxString& nid = test.GetNativeFontInfoDesc();
         CPPUNIT_ASSERT( !nid.empty() );
             // documented to be never empty

-        
+

         wxFont temp;
         CPPUNIT_ASSERT( temp.SetNativeFontInfo(nid) );
         CPPUNIT_ASSERT( temp.IsOk() );
         wxFont temp;
         CPPUNIT_ASSERT( temp.SetNativeFontInfo(nid) );
         CPPUNIT_ASSERT( temp.IsOk() );

-        WX_ASSERT_MESSAGE( 
+        WX_ASSERT_MESSAGE(

             ("Test #%lu failed\ndump of test font: \"%s\"\ndump of temp font: \"%s\"", \
              n, DumpFont(&test), DumpFont(&temp)),
             temp == test );
             ("Test #%lu failed\ndump of test font: \"%s\"\ndump of temp font: \"%s\"", \
              n, DumpFont(&test), DumpFont(&temp)),
             temp == test );

+    }
+
+    // test that clearly invalid font info strings do not work
+    wxFont font;
+    CPPUNIT_ASSERT( !font.SetNativeFontInfo("") );
+
+    // pango_font_description_from_string() used by wxFont in wxGTK and wxX11
+    // never returns an error at all so this assertion fails there -- and as it
+    // doesn't seem to be possible to do anything about it maybe we should
+    // change wxMSW and other ports to also accept any strings?
+#if !defined(__WXGTK__) && !defined(__WXX11__)
+    CPPUNIT_ASSERT( !font.SetNativeFontInfo("bloordyblop") );
+#endif
+
+    // Pango font description doesn't have 'underlined' and 'strikethrough'
+    // attributes, so wxNativeFontInfo implements these itself. Test if these
+    // are properly preserved by wxNativeFontInfo or its string description.
+    font.SetUnderlined(true);
+    font.SetStrikethrough(true);
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(font));
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(*font.GetNativeFontInfo()));
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(font.GetNativeFontInfoDesc()));
+    font.SetUnderlined(false);
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(font));
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(*font.GetNativeFontInfo()));
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(font.GetNativeFontInfoDesc()));
+    font.SetUnderlined(true);
+    font.SetStrikethrough(false);
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(font));
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(*font.GetNativeFontInfo()));
+    CPPUNIT_ASSERT_EQUAL(font, wxFont(font.GetNativeFontInfoDesc()));
+    // note: the GetNativeFontInfoUserDesc() doesn't preserve all attributes
+    // according to docs, so it is not tested.
+}
+
+void FontTestCase::NativeFontInfoUserDesc()
+{
+    unsigned numFonts;
+    const wxFont *pf = GetTestFonts(numFonts);
+    for ( size_t n = 0; n < numFonts; n++ )
+    {
+        wxFont test(*pf++);

 
 

-        
-        // test Get/SetNativeFontInfoUserDesc 
-        

         const wxString& niud = test.GetNativeFontInfoUserDesc();
         CPPUNIT_ASSERT( !niud.empty() );
             // documented to be never empty
         const wxString& niud = test.GetNativeFontInfoUserDesc();
         CPPUNIT_ASSERT( !niud.empty() );
             // documented to be never empty

-        
+

         wxFont temp2;
         CPPUNIT_ASSERT( temp2.SetNativeFontInfoUserDesc(niud) );
         CPPUNIT_ASSERT( temp2.IsOk() );
 
 #ifdef __WXGTK__
         // Pango saves/restores all font info in the user-friendly string:
         wxFont temp2;
         CPPUNIT_ASSERT( temp2.SetNativeFontInfoUserDesc(niud) );
         CPPUNIT_ASSERT( temp2.IsOk() );
 
 #ifdef __WXGTK__
         // Pango saves/restores all font info in the user-friendly string:

-        WX_ASSERT_MESSAGE( 
+        WX_ASSERT_MESSAGE(

             ("Test #%lu failed; native info user desc was \"%s\" for test and \"%s\" for temp2", \
              n, niud, temp2.GetNativeFontInfoUserDesc()),
             temp2 == test );
             ("Test #%lu failed; native info user desc was \"%s\" for test and \"%s\" for temp2", \
              n, niud, temp2.GetNativeFontInfoUserDesc()),
             temp2 == test );


@@ -159,53 +301,19 @@ void FontTestCase::GetSet()
         //       info which GetNativeFontInfoUserDesc() does indeed save:
         CPPUNIT_ASSERT_EQUAL( test.GetWeight(), temp2.GetWeight() );
         CPPUNIT_ASSERT_EQUAL( test.GetStyle(), temp2.GetStyle() );
         //       info which GetNativeFontInfoUserDesc() does indeed save:
         CPPUNIT_ASSERT_EQUAL( test.GetWeight(), temp2.GetWeight() );
         CPPUNIT_ASSERT_EQUAL( test.GetStyle(), temp2.GetStyle() );

-        CPPUNIT_ASSERT( test.GetFaceName().CmpNoCase(temp2.GetFaceName()) == 0 );
-        CPPUNIT_ASSERT_EQUAL( test.GetPointSize(), temp2.GetPointSize() );
-        CPPUNIT_ASSERT_EQUAL( test.GetEncoding(), temp2.GetEncoding() );
-#endif

 
 

+        // if the original face name was empty, it means that any face name (in
+        // this family) can be used for the new font so we shouldn't be
+        // surprised to find that they differ in this case
+        const wxString facename = test.GetFaceName();
+        if ( !facename.empty() )
+        {
+            CPPUNIT_ASSERT_EQUAL( facename.Upper(), temp2.GetFaceName().Upper() );
+        }

 
 

-        // test Get/SetPointSize()
-        
-        test.SetPointSize(30);
-        CPPUNIT_ASSERT( test.IsOk() );
-        CPPUNIT_ASSERT_EQUAL( 30, test.GetPointSize() );
-        
-        
-        // test Get/SetPixelSize()
-        
-        test.SetPixelSize(wxSize(0,30));
-        CPPUNIT_ASSERT( test.IsOk() );
-        CPPUNIT_ASSERT( test.GetPixelSize().GetHeight() <= 30 );
-            // NOTE: the match found by SetPixelSize() may be not 100% precise; it
-            //       only grants that a font smaller than the required height will
-            //       be selected
-
-        
-        // test Get/SetStyle()
-        
-        test.SetStyle(wxFONTSTYLE_SLANT);
-        CPPUNIT_ASSERT( test.IsOk() );
-#ifdef __WXMSW__
-        // on wxMSW wxFONTSTYLE_SLANT==wxFONTSTYLE_ITALIC
-        CPPUNIT_ASSERT( wxFONTSTYLE_SLANT == test.GetStyle() ||
-                        wxFONTSTYLE_ITALIC == test.GetStyle() );
-#else
-        CPPUNIT_ASSERT_EQUAL( wxFONTSTYLE_SLANT, test.GetStyle() );
+        CPPUNIT_ASSERT_EQUAL( test.GetPointSize(), temp2.GetPointSize() );
+        CPPUNIT_ASSERT_EQUAL( test.GetEncoding(), temp2.GetEncoding() );

 #endif
 #endif

-        
-        // test Get/SetUnderlined()
-        
-        test.SetUnderlined(true);
-        CPPUNIT_ASSERT( test.IsOk() );
-        CPPUNIT_ASSERT_EQUAL( true, test.GetUnderlined() );
-        
-        
-        // test Get/SetWeight()
-        
-        test.SetWeight(wxFONTWEIGHT_BOLD);
-        CPPUNIT_ASSERT( test.IsOk() );
-        CPPUNIT_ASSERT_EQUAL( wxFONTWEIGHT_BOLD, test.GetWeight() );

     }
 }
 
     }
 }