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         CPPUNIT_ASSERT( wxFONTFAMILY_ROMAN == test.GetFamily() ||
 135                         wxFONTFAMILY_UNKNOWN == test.GetFamily() );
 136             // note that there is always the possibility that GetFamily() returns
 137             // wxFONTFAMILY_UNKNOWN so that we consider it as a valid return value
 138
 139
 140         // test Get/SetEncoding()
 141
 142         //test.SetEncoding( wxFONTENCODING_KOI8 );
 143         //CPPUNIT_ASSERT( test.IsOk() );
 144         //CPPUNIT_ASSERT_EQUAL( wxFONTENCODING_KOI8 , test.GetEncoding() );
 145
 146
 147         // test Get/SetPointSize()
 148
 149         test.SetPointSize(30);
 150         CPPUNIT_ASSERT( test.IsOk() );
 151         CPPUNIT_ASSERT_EQUAL( 30, test.GetPointSize() );
 152
 153
 154         // test Get/SetPixelSize()
 155
 156         test.SetPixelSize(wxSize(0,30));
 157         CPPUNIT_ASSERT( test.IsOk() );
 158         CPPUNIT_ASSERT( test.GetPixelSize().GetHeight() <= 30 );
 159             // NOTE: the match found by SetPixelSize() may be not 100% precise; it
 160             //       only grants that a font smaller than the required height will
 161             //       be selected
 162
 163
 164         // test Get/SetStyle()
 165
 166         test.SetStyle(wxFONTSTYLE_SLANT);
 167         CPPUNIT_ASSERT( test.IsOk() );
 168 #ifdef __WXMSW__
 169         // on wxMSW wxFONTSTYLE_SLANT==wxFONTSTYLE_ITALIC
 170         CPPUNIT_ASSERT( wxFONTSTYLE_SLANT == test.GetStyle() ||
 171                         wxFONTSTYLE_ITALIC == test.GetStyle() );
 172 #else
 173         CPPUNIT_ASSERT_EQUAL( wxFONTSTYLE_SLANT, test.GetStyle() );
 174 #endif
 175
 176         // test Get/SetUnderlined()
 177
 178         test.SetUnderlined(true);
 179         CPPUNIT_ASSERT( test.IsOk() );
 180         CPPUNIT_ASSERT_EQUAL( true, test.GetUnderlined() );
 181
 182
 183         // test Get/SetWeight()
 184
 185         test.SetWeight(wxFONTWEIGHT_BOLD);
 186         CPPUNIT_ASSERT( test.IsOk() );
 187         CPPUNIT_ASSERT_EQUAL( wxFONTWEIGHT_BOLD, test.GetWeight() );
 188     }
 189 }
 190
 191 void FontTestCase::NativeFontInfo()
 192 {
 193     unsigned numFonts;
 194     const wxFont *pf = GetTestFonts(numFonts);
 195     for ( size_t n = 0; n < numFonts; n++ )
 196     {
 197         wxFont test(*pf++);
 198
 199         const wxString& nid = test.GetNativeFontInfoDesc();
 200         CPPUNIT_ASSERT( !nid.empty() );
 201             // documented to be never empty
 202
 203         wxFont temp;
 204         CPPUNIT_ASSERT( temp.SetNativeFontInfo(nid) );
 205         CPPUNIT_ASSERT( temp.IsOk() );
 206         WX_ASSERT_MESSAGE(
 207             ("Test #%lu failed\ndump of test font: \"%s\"\ndump of temp font: \"%s\"", \
 208              n, DumpFont(&test), DumpFont(&temp)),
 209             temp == test );
 210     }
 211
 212     // test that clearly invalid font info strings do not work
 213     wxFont font;
 214     CPPUNIT_ASSERT( !font.SetNativeFontInfo("") );
 215
 216     // pango_font_description_from_string() used by wxFont in wxGTK and wxX11
 217     // never returns an error at all so this assertion fails there -- and as it
 218     // doesn't seem to be possible to do anything about it maybe we should
 219     // change wxMSW and other ports to also accept any strings?
 220 #if !defined(__WXGTK__) && !defined(__WXX11__)
 221     CPPUNIT_ASSERT( !font.SetNativeFontInfo("bloordyblop") );
 222 #endif
 223 }
 224
 225 void FontTestCase::NativeFontInfoUserDesc()
 226 {
 227     unsigned numFonts;
 228     const wxFont *pf = GetTestFonts(numFonts);
 229     for ( size_t n = 0; n < numFonts; n++ )
 230     {
 231         wxFont test(*pf++);
 232
 233         const wxString& niud = test.GetNativeFontInfoUserDesc();
 234         CPPUNIT_ASSERT( !niud.empty() );
 235             // documented to be never empty
 236
 237         wxFont temp2;
 238         CPPUNIT_ASSERT( temp2.SetNativeFontInfoUserDesc(niud) );
 239         CPPUNIT_ASSERT( temp2.IsOk() );
 240
 241 #ifdef __WXGTK__
 242         // Pango saves/restores all font info in the user-friendly string:
 243         WX_ASSERT_MESSAGE(
 244             ("Test #%lu failed; native info user desc was \"%s\" for test and \"%s\" for temp2", \
 245              n, niud, temp2.GetNativeFontInfoUserDesc()),
 246             temp2 == test );
 247 #else
 248         // NOTE: as documented GetNativeFontInfoUserDesc/SetNativeFontInfoUserDesc
 249         //       are not granted to save/restore all font info.
 250         //       In fact e.g. the font family is not saved at all; test only those
 251         //       info which GetNativeFontInfoUserDesc() does indeed save:
 252         CPPUNIT_ASSERT_EQUAL( test.GetWeight(), temp2.GetWeight() );
 253         CPPUNIT_ASSERT_EQUAL( test.GetStyle(), temp2.GetStyle() );
 254
 255         // if the original face name was empty, it means that any face name (in
 256         // this family) can be used for the new font so we shouldn't be
 257         // surprised to find that they differ in this case
 258         const wxString facename = test.GetFaceName();
 259         if ( !facename.empty() )
 260         {
 261             CPPUNIT_ASSERT_EQUAL( facename.Upper(), temp2.GetFaceName().Upper() );
 262         }
 263
 264         CPPUNIT_ASSERT_EQUAL( test.GetPointSize(), temp2.GetPointSize() );
 265         CPPUNIT_ASSERT_EQUAL( test.GetEncoding(), temp2.GetEncoding() );
 266 #endif
 267     }
 268 }
 269
 270 #endif // wxUSE_FONTMAP