tests/font/fonttest.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        tests/font/fonttest.cpp
   3 // Purpose:     wxFont unit test
   4 // Author:      Francesco Montorsi
   5 // Created:     16.3.09
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2009 Francesco Montorsi
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 // ----------------------------------------------------------------------------
  12 // headers
  13 // ----------------------------------------------------------------------------
  14
  15 #include "testprec.h"
  16
  17 #ifdef __BORLANDC__
  18     #pragma hdrstop
  19 #endif
  20
  21 #ifndef WX_PRECOMP
  22     #include "wx/wx.h"
  23 #endif // WX_PRECOMP
  24
  25 #if wxUSE_FONTMAP
  26
  27 #include "wx/font.h"
  28
  29 // ----------------------------------------------------------------------------
  30 // test class
  31 // ----------------------------------------------------------------------------
  32
  33 class FontTestCase : public CppUnit::TestCase
  34 {
  35 public:
  36     FontTestCase() { }
  37
  38 private:
  39     CPPUNIT_TEST_SUITE( FontTestCase );
  40         CPPUNIT_TEST( GetSet );
  41         CPPUNIT_TEST( NativeFontInfo );
  42         CPPUNIT_TEST( NativeFontInfoUserDesc );
  43     CPPUNIT_TEST_SUITE_END();
  44
  45     void GetSet();
  46     void NativeFontInfo();
  47     void NativeFontInfoUserDesc();
  48
  49     static const wxFont *GetTestFonts(unsigned& numFonts)
  50     {
  51         static const wxFont testfonts[] =
  52         {
  53             *wxNORMAL_FONT,
  54             *wxSMALL_FONT,
  55             *wxITALIC_FONT,
  56             *wxSWISS_FONT,
  57             wxFont(5, wxFONTFAMILY_TELETYPE, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL)
  58         };
  59
  60         numFonts = WXSIZEOF(testfonts);
  61
  62         return testfonts;
  63     }
  64
  65     DECLARE_NO_COPY_CLASS(FontTestCase)
  66 };
  67
  68 // register in the unnamed registry so that these tests are run by default
  69 CPPUNIT_TEST_SUITE_REGISTRATION( FontTestCase );
  70
  71 // also include in it's own registry so that these tests can be run alone
  72 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( FontTestCase, "FontTestCase" );
  73
  74 wxString DumpFont(const wxFont *font)
  75 {
  76     // dumps the internal properties of a wxFont in the same order they
  77     // are checked by wxFontBase::operator==()
  78
  79     wxASSERT(font->IsOk());
  80
  81     wxString s;
  82     s.Printf(wxS("%d-%d;%d-%d-%d-%d-%d-%s-%d"),
  83              font->GetPointSize(),
  84              font->GetPixelSize().x,
  85              font->GetPixelSize().y,
  86              font->GetFamily(),
  87              font->GetStyle(),
  88              font->GetWeight(),
  89              font->GetUnderlined() ? 1 : 0,
  90              font->GetFaceName(),
  91              font->GetEncoding());
  92
  93     return s;
  94 }
  95
  96 void FontTestCase::GetSet()
  97 {
  98     unsigned numFonts;
  99     const wxFont *pf = GetTestFonts(numFonts);
 100     for ( unsigned n = 0; n < numFonts; n++ )
 101     {
 102         wxFont test(*pf++);
 103
 104         // remember: getters can only be called when wxFont::IsOk() == true
 105         CPPUNIT_ASSERT( test.IsOk() );
 106
 107
 108         // test Get/SetFaceName()
 109         CPPUNIT_ASSERT( !test.SetFaceName("a dummy face name") );
 110         CPPUNIT_ASSERT( !test.IsOk() );
 111
 112         // if the call to SetFaceName() below fails on your system/port,
 113         // consider adding another branch to this #if
 114 #if defined(__WXMSW__) || defined(__WXOSX__)
 115         static const char *knownGoodFaceName = "Arial";
 116 #else
 117         static const char *knownGoodFaceName = "Monospace";
 118 #endif
 119
 120         WX_ASSERT_MESSAGE
 121         (
 122             ("failed to set face name \"%s\" for test font #%u\n"
 123              "(this failure is harmless if this face name is not "
 124              "available on this system)", knownGoodFaceName, n),
 125             test.SetFaceName(knownGoodFaceName)
 126         );
 127         CPPUNIT_ASSERT( test.IsOk() );
 128
 129
 130         // test Get/SetFamily()
 131
 132         test.SetFamily( wxFONTFAMILY_ROMAN );
 133         CPPUNIT_ASSERT( test.IsOk() );
 134
 135         // note that there is always the possibility that GetFamily() returns
 136         // wxFONTFAMILY_DEFAULT (meaning "unknown" in this case) so that we
 137         // consider it as a valid return value
 138         const wxFontFamily family = test.GetFamily();
 139         if ( family != wxFONTFAMILY_DEFAULT )
 140             CPPUNIT_ASSERT_EQUAL( wxFONTFAMILY_ROMAN, family );
 141
 142
 143         // test Get/SetEncoding()
 144
 145         //test.SetEncoding( wxFONTENCODING_KOI8 );
 146         //CPPUNIT_ASSERT( test.IsOk() );
 147         //CPPUNIT_ASSERT_EQUAL( wxFONTENCODING_KOI8 , test.GetEncoding() );
 148
 149
 150         // test Get/SetPointSize()
 151
 152         test.SetPointSize(30);
 153         CPPUNIT_ASSERT( test.IsOk() );
 154         CPPUNIT_ASSERT_EQUAL( 30, test.GetPointSize() );
 155
 156
 157         // test Get/SetPixelSize()
 158
 159         test.SetPixelSize(wxSize(0,30));
 160         CPPUNIT_ASSERT( test.IsOk() );
 161         CPPUNIT_ASSERT( test.GetPixelSize().GetHeight() <= 30 );
 162             // NOTE: the match found by SetPixelSize() may be not 100% precise; it
 163             //       only grants that a font smaller than the required height will
 164             //       be selected
 165
 166
 167         // test Get/SetStyle()
 168
 169         test.SetStyle(wxFONTSTYLE_SLANT);
 170         CPPUNIT_ASSERT( test.IsOk() );
 171 #ifdef __WXMSW__
 172         // on wxMSW wxFONTSTYLE_SLANT==wxFONTSTYLE_ITALIC
 173         CPPUNIT_ASSERT( wxFONTSTYLE_SLANT == test.GetStyle() ||
 174                         wxFONTSTYLE_ITALIC == test.GetStyle() );
 175 #else
 176         CPPUNIT_ASSERT_EQUAL( wxFONTSTYLE_SLANT, test.GetStyle() );
 177 #endif
 178
 179         // test Get/SetUnderlined()
 180
 181         test.SetUnderlined(true);
 182         CPPUNIT_ASSERT( test.IsOk() );
 183         CPPUNIT_ASSERT_EQUAL( true, test.GetUnderlined() );
 184
 185
 186         // test Get/SetWeight()
 187
 188         test.SetWeight(wxFONTWEIGHT_BOLD);
 189         CPPUNIT_ASSERT( test.IsOk() );
 190         CPPUNIT_ASSERT_EQUAL( wxFONTWEIGHT_BOLD, test.GetWeight() );
 191     }
 192 }
 193
 194 void FontTestCase::NativeFontInfo()
 195 {
 196     unsigned numFonts;
 197     const wxFont *pf = GetTestFonts(numFonts);
 198     for ( size_t n = 0; n < numFonts; n++ )
 199     {
 200         wxFont test(*pf++);
 201
 202         const wxString& nid = test.GetNativeFontInfoDesc();
 203         CPPUNIT_ASSERT( !nid.empty() );
 204             // documented to be never empty
 205
 206         wxFont temp;
 207         CPPUNIT_ASSERT( temp.SetNativeFontInfo(nid) );
 208         CPPUNIT_ASSERT( temp.IsOk() );
 209         WX_ASSERT_MESSAGE(
 210             ("Test #%lu failed\ndump of test font: \"%s\"\ndump of temp font: \"%s\"", \
 211              n, DumpFont(&test), DumpFont(&temp)),
 212             temp == test );
 213     }
 214
 215     // test that clearly invalid font info strings do not work
 216     wxFont font;
 217     CPPUNIT_ASSERT( !font.SetNativeFontInfo("") );
 218
 219     // pango_font_description_from_string() used by wxFont in wxGTK and wxX11
 220     // never returns an error at all so this assertion fails there -- and as it
 221     // doesn't seem to be possible to do anything about it maybe we should
 222     // change wxMSW and other ports to also accept any strings?
 223 #if !defined(__WXGTK__) && !defined(__WXX11__)
 224     CPPUNIT_ASSERT( !font.SetNativeFontInfo("bloordyblop") );
 225 #endif
 226 }
 227
 228 void FontTestCase::NativeFontInfoUserDesc()
 229 {
 230     unsigned numFonts;
 231     const wxFont *pf = GetTestFonts(numFonts);
 232     for ( size_t n = 0; n < numFonts; n++ )
 233     {
 234         wxFont test(*pf++);
 235
 236         const wxString& niud = test.GetNativeFontInfoUserDesc();
 237         CPPUNIT_ASSERT( !niud.empty() );
 238             // documented to be never empty
 239
 240         wxFont temp2;
 241         CPPUNIT_ASSERT( temp2.SetNativeFontInfoUserDesc(niud) );
 242         CPPUNIT_ASSERT( temp2.IsOk() );
 243
 244 #ifdef __WXGTK__
 245         // Pango saves/restores all font info in the user-friendly string:
 246         WX_ASSERT_MESSAGE(
 247             ("Test #%lu failed; native info user desc was \"%s\" for test and \"%s\" for temp2", \
 248              n, niud, temp2.GetNativeFontInfoUserDesc()),
 249             temp2 == test );
 250 #else
 251         // NOTE: as documented GetNativeFontInfoUserDesc/SetNativeFontInfoUserDesc
 252         //       are not granted to save/restore all font info.
 253         //       In fact e.g. the font family is not saved at all; test only those
 254         //       info which GetNativeFontInfoUserDesc() does indeed save:
 255         CPPUNIT_ASSERT_EQUAL( test.GetWeight(), temp2.GetWeight() );
 256         CPPUNIT_ASSERT_EQUAL( test.GetStyle(), temp2.GetStyle() );
 257
 258         // if the original face name was empty, it means that any face name (in
 259         // this family) can be used for the new font so we shouldn't be
 260         // surprised to find that they differ in this case
 261         const wxString facename = test.GetFaceName();
 262         if ( !facename.empty() )
 263         {
 264             CPPUNIT_ASSERT_EQUAL( facename.Upper(), temp2.GetFaceName().Upper() );
 265         }
 266
 267         CPPUNIT_ASSERT_EQUAL( test.GetPointSize(), temp2.GetPointSize() );
 268         CPPUNIT_ASSERT_EQUAL( test.GetEncoding(), temp2.GetEncoding() );
 269 #endif
 270     }
 271 }
 272
 273 #endif // wxUSE_FONTMAP