vcl/qa/cppunit/lifecycle.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <unotest/filters-test.hxx>
  11 #include <test/bootstrapfixture.hxx>
  12
  13 #include <vcl/wrkwin.hxx>
  14 #include <vcl/button.hxx>
  15 #include <vcl/edit.hxx>
  16 #include <vcl/combobox.hxx>
  17 #include <vcl/field.hxx>
  18 #include <vcl/virdev.hxx>
  19 #include <vcl/tabctrl.hxx>
  20 #include <vcl/dialog.hxx>
  21 #include <vcl/layout.hxx>
  22 #include <vcl/svapp.hxx>
  23
  24 class LifecycleTest : public test::BootstrapFixture
  25 {
  26     void testWidgets(vcl::Window *pParent);
  27
  28 public:
  29     LifecycleTest() : BootstrapFixture(true, false) {}
  30
  31     void testCast();
  32     void testVirtualDevice();
  33     void testMultiDispose();
  34     void testIsolatedWidgets();
  35     void testParentedWidgets();
  36     void testChildDispose();
  37     void testPostDispose();
  38     void testFocus();
  39     void testLeakage();
  40
  41     CPPUNIT_TEST_SUITE(LifecycleTest);
  42     CPPUNIT_TEST(testCast);
  43     CPPUNIT_TEST(testVirtualDevice);
  44     CPPUNIT_TEST(testMultiDispose);
  45     CPPUNIT_TEST(testIsolatedWidgets);
  46     CPPUNIT_TEST(testParentedWidgets);
  47     CPPUNIT_TEST(testChildDispose);
  48     CPPUNIT_TEST(testPostDispose);
  49     CPPUNIT_TEST(testFocus);
  50     CPPUNIT_TEST(testLeakage);
  51     CPPUNIT_TEST_SUITE_END();
  52 };
  53
  54 // A compile time sanity check
  55 void LifecycleTest::testCast()
  56 {
  57     ScopedVclPtrInstance< PushButton > xButton( nullptr, 0 );
  58     ScopedVclPtr<vcl::Window> xWindow(xButton);
  59
  60     ScopedVclPtrInstance< MetricField > xField( nullptr, 0 );
  61     ScopedVclPtr<SpinField> xSpin(xField);
  62     ScopedVclPtr<Edit> xEdit(xField);
  63
  64 // the following line should NOT compile
  65 //    VclPtr<PushButton> xButton2(xWindow);
  66 }
  67
  68 void LifecycleTest::testVirtualDevice()
  69 {
  70     VclPtr<VirtualDevice> pVDev = VclPtr< VirtualDevice >::Create();
  71     ScopedVclPtrInstance< VirtualDevice > pVDev2;
  72     VclPtrInstance<VirtualDevice> pVDev3;
  73     VclPtrInstance<VirtualDevice> pVDev4( 1 );
  74     CPPUNIT_ASSERT(!!pVDev && !!pVDev2 && !!pVDev3 && !!pVDev4);
  75 }
  76
  77 void LifecycleTest::testMultiDispose()
  78 {
  79     VclPtrInstance<WorkWindow> xWin(nullptr, WB_APP|WB_STDWORK);
  80     CPPUNIT_ASSERT(xWin.get() != NULL);
  81     xWin->disposeOnce();
  82     xWin->disposeOnce();
  83     xWin->disposeOnce();
  84     CPPUNIT_ASSERT(xWin->GetWindow(GetWindowType::Parent) == NULL);
  85     CPPUNIT_ASSERT(xWin->GetChild(0) == NULL);
  86     CPPUNIT_ASSERT(xWin->GetChildCount() == 0);
  87 }
  88
  89 void LifecycleTest::testWidgets(vcl::Window *pParent)
  90 {
  91     { ScopedVclPtrInstance< PushButton > aPtr( pParent );   }
  92     { ScopedVclPtrInstance< OKButton > aPtr( pParent );     }
  93     { ScopedVclPtrInstance< CancelButton > aPtr( pParent ); }
  94     { ScopedVclPtrInstance< HelpButton > aPtr( pParent );   }
  95
  96     // Some widgets really insist on adoption.
  97     if (pParent)
  98     {
  99         { ScopedVclPtrInstance< CheckBox > aPtr( pParent );     }
 100         { ScopedVclPtrInstance< Edit > aPtr( pParent );         }
 101         { ScopedVclPtrInstance< ComboBox > aPtr( pParent );     }
 102         { ScopedVclPtrInstance< RadioButton > aPtr( pParent );  }
 103     }
 104 }
 105
 106 void LifecycleTest::testIsolatedWidgets()
 107 {
 108     testWidgets(NULL);
 109 }
 110
 111 void LifecycleTest::testParentedWidgets()
 112 {
 113     ScopedVclPtrInstance<WorkWindow> xWin(nullptr, WB_APP|WB_STDWORK);
 114     CPPUNIT_ASSERT(xWin.get() != NULL);
 115     xWin->Show();
 116     testWidgets(xWin);
 117 }
 118
 119 class DisposableChild : public vcl::Window
 120 {
 121 public:
 122     DisposableChild(vcl::Window *pParent) : vcl::Window(pParent) {}
 123     virtual ~DisposableChild()
 124     {
 125         disposeOnce();
 126     }
 127 };
 128
 129 void LifecycleTest::testChildDispose()
 130 {
 131     VclPtrInstance<WorkWindow> xWin(nullptr, WB_APP|WB_STDWORK);
 132     CPPUNIT_ASSERT(xWin.get() != NULL);
 133     VclPtrInstance< DisposableChild > xChild( xWin.get() );
 134     xWin->Show();
 135     xChild->disposeOnce();
 136     xWin->disposeOnce();
 137 }
 138
 139 void LifecycleTest::testPostDispose()
 140 {
 141     VclPtrInstance<WorkWindow> xWin(nullptr, WB_APP|WB_STDWORK);
 142     xWin->disposeOnce();
 143
 144     // check selected methods continue to work post-dispose
 145     CPPUNIT_ASSERT(!xWin->GetParent());
 146     xWin->Show();
 147     CPPUNIT_ASSERT(!xWin->IsReallyShown());
 148     CPPUNIT_ASSERT(!xWin->IsEnabled());
 149     CPPUNIT_ASSERT(!xWin->IsInputEnabled());
 150     CPPUNIT_ASSERT(!xWin->GetChild(0));
 151     CPPUNIT_ASSERT(!xWin->GetWindow(GetWindowType::Parent));
 152 }
 153
 154 class FocusCrashPostDispose : public TabControl
 155 {
 156 public:
 157     FocusCrashPostDispose(vcl::Window *pParent) :
 158         TabControl(pParent, 0)
 159     {
 160     }
 161     virtual bool PreNotify( NotifyEvent& ) SAL_OVERRIDE
 162     {
 163         return false;
 164     }
 165     virtual bool Notify( NotifyEvent& ) SAL_OVERRIDE
 166     {
 167 //        CPPUNIT_FAIL("notify");
 168         return false;
 169     }
 170     virtual void GetFocus() SAL_OVERRIDE
 171     {
 172         CPPUNIT_FAIL("get focus");
 173     }
 174     virtual void LoseFocus() SAL_OVERRIDE
 175     {
 176         CPPUNIT_FAIL("this should never be called");
 177     }
 178 };
 179
 180 void LifecycleTest::testFocus()
 181 {
 182     ScopedVclPtrInstance<WorkWindow> xWin(nullptr, WB_APP|WB_STDWORK);
 183     ScopedVclPtrInstance< FocusCrashPostDispose > xChild(xWin);
 184     xWin->Show();
 185     xChild->GrabFocus();
 186     // process asynchronous ToTop
 187     Scheduler::ProcessTaskScheduling(false);
 188     // FIXME: really awful to test focus issues without showing windows.
 189     // CPPUNIT_ASSERT(xChild->HasFocus());
 190 }
 191
 192 template <class vcl_type>
 193 class LeakTestClass : public vcl_type
 194 {
 195     bool &mrDeleted;
 196 public:
 197     template<typename... Arg>
 198         LeakTestClass(bool &bDeleted, Arg &&... arg) :
 199             vcl_type(std::forward<Arg>(arg)...),
 200             mrDeleted(bDeleted)
 201     {
 202         mrDeleted = false;
 203     }
 204     ~LeakTestClass()
 205     {
 206         mrDeleted = true;
 207     }
 208 };
 209
 210 class LeakTestObject
 211 {
 212     bool                mbDeleted;
 213     VclPtr<vcl::Window> mxRef;
 214     void               *mpRef;
 215     LeakTestObject() {}
 216 public:
 217     template<typename vcl_type, typename... Arg> static LeakTestObject *
 218         Create(Arg &&... arg)
 219     {
 220         LeakTestObject *pNew = new LeakTestObject();
 221         pNew->mxRef = VclPtr< LeakTestClass< vcl_type > >::Create( pNew->mbDeleted,
 222                                                                    std::forward<Arg>(arg)...);
 223         pNew->mpRef = static_cast<void *>(static_cast<vcl::Window *>(pNew->mxRef));
 224         return pNew;
 225     }
 226     VclPtr<vcl::Window> getRef() { return mxRef; }
 227     void disposeAndClear()
 228     {
 229         mxRef.disposeAndClear();
 230     }
 231     void assertDeleted()
 232     {
 233         if (!mbDeleted)
 234         {
 235             OUStringBuffer aMsg = "Type '";
 236             vcl::Window *pWin = static_cast<vcl::Window *>(mpRef);
 237             aMsg.appendAscii(typeid(*pWin).name());
 238             aMsg.append("' not freed after dispose");
 239             CPPUNIT_FAIL(OUStringToOString(aMsg.makeStringAndClear(),
 240                                            RTL_TEXTENCODING_UTF8).getStr());
 241         }
 242     }
 243 };
 244
 245 void LifecycleTest::testLeakage()
 246 {
 247     std::vector<LeakTestObject *> aObjects;
 248
 249     // Create objects
 250     aObjects.push_back(LeakTestObject::Create<WorkWindow>(nullptr, WB_APP|WB_STDWORK));
 251     VclPtr<vcl::Window> xParent = aObjects.back()->getRef();
 252
 253     aObjects.push_back(LeakTestObject::Create<PushButton>(xParent));
 254     aObjects.push_back(LeakTestObject::Create<OKButton>(xParent));
 255     aObjects.push_back(LeakTestObject::Create<CancelButton>(xParent));
 256     aObjects.push_back(LeakTestObject::Create<HelpButton>(xParent));
 257     aObjects.push_back(LeakTestObject::Create<CheckBox>(xParent));
 258     aObjects.push_back(LeakTestObject::Create<Edit>(xParent));
 259     aObjects.push_back(LeakTestObject::Create<ComboBox>(xParent));
 260     aObjects.push_back(LeakTestObject::Create<RadioButton>(xParent));
 261
 262     { // something that looks like a dialog
 263         aObjects.push_back(LeakTestObject::Create<Dialog>(xParent,WB_CLIPCHILDREN|WB_MOVEABLE|WB_3DLOOK|WB_CLOSEABLE|WB_SIZEABLE));
 264         VclPtr<vcl::Window> xDlgParent = aObjects.back()->getRef();
 265         aObjects.push_back(LeakTestObject::Create<VclVBox>(xDlgParent));
 266         VclPtr<vcl::Window> xVBox = aObjects.back()->getRef();
 267         aObjects.push_back(LeakTestObject::Create<VclVButtonBox>(xVBox));
 268     }
 269
 270 #if 0 // FIXME - would be good to get internal paths working.
 271     aObjects.push_back(LeakTestObject::Create<ModelessDialog>(xParent, "PrintProgressDialog", "vcl/ui/printprogressdialog.ui"));
 272 #endif
 273     aObjects.push_back(LeakTestObject::Create<ModalDialog>(xParent));
 274     xParent.clear();
 275
 276     for (auto i = aObjects.rbegin(); i != aObjects.rend(); ++i)
 277         (*i)->getRef()->Show();
 278
 279     for (auto i = aObjects.rbegin(); i != aObjects.rend(); ++i)
 280         (*i)->disposeAndClear();
 281
 282     for (auto i = aObjects.begin(); i != aObjects.end(); ++i)
 283         (*i)->assertDeleted();
 284
 285     for (auto i = aObjects.begin(); i != aObjects.end(); ++i)
 286         delete *i;
 287 }
 288
 289 CPPUNIT_TEST_SUITE_REGISTRATION(LifecycleTest);
 290
 291 CPPUNIT_PLUGIN_IMPLEMENT();
 292
 293 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */