sal/qa/systools/test_comtools.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <cppunit/extensions/HelperMacros.h>
  21 #include <cppunit/plugin/TestPlugIn.h>
  22 #include <systools/win32/comtools.hxx>
  23 #include <shobjidl.h>
  24
  25 namespace {
  26
  27 class COMObject : public IUnknown
  28 {
  29 public:
  30     COMObject() : ref_count_(0)
  31     {
  32     }
  33
  34     virtual ~COMObject()
  35     {
  36     }
  37
  38     ULONG __stdcall AddRef() override
  39     {
  40         ref_count_++;
  41         return ref_count_;
  42     }
  43
  44     ULONG __stdcall Release() override
  45     {
  46         ULONG cnt = --ref_count_;
  47         if (cnt == 0)
  48             delete this;
  49         return cnt;
  50     }
  51
  52     HRESULT __stdcall QueryInterface(REFIID riid, void** ppv) override
  53     {
  54         if (riid == IID_IUnknown)
  55         {
  56             AddRef();
  57             *ppv = this;
  58             return S_OK;
  59         }
  60         return E_NOINTERFACE;
  61     }
  62
  63     ULONG GetRefCount() const
  64     {
  65         return ref_count_;
  66     }
  67
  68 private:
  69     ULONG ref_count_;
  70 };
  71
  72 }
  73
  74 static sal::systools::COMReference<IUnknown> comObjectSource()
  75 {
  76     return sal::systools::COMReference<IUnknown>(new COMObject);
  77 }
  78
  79 static bool comObjectSink(sal::systools::COMReference<IUnknown> r, ULONG expectedRefCountOnReturn)
  80 {
  81     r = sal::systools::COMReference<IUnknown>();
  82     COMObject* p = reinterpret_cast<COMObject*>(r.get());
  83     if (p)
  84         return (p->GetRefCount() == expectedRefCountOnReturn);
  85     else
  86         return (0 == expectedRefCountOnReturn);
  87 }
  88
  89 static void comObjectSource2(LPVOID* ppv)
  90 {
  91     COMObject* p = new COMObject;
  92     p->AddRef();
  93     *ppv = p;
  94 }
  95
  96 namespace test_comtools
  97 {
  98
  99     class test_COMReference : public CppUnit::TestFixture
 100     {
 101
 102     public:
 103         /// test of COMReference<IUnknown> r;
 104         void default_ctor()
 105         {
 106             sal::systools::COMReference<IUnknown> r;
 107             CPPUNIT_ASSERT_EQUAL_MESSAGE("COMReference should be empty", static_cast<IUnknown *>(nullptr), r.get());
 108         }
 109
 110         void test_ctor_manual_AddRef()
 111         {
 112             COMObject* p = new COMObject;
 113             p->AddRef();
 114             sal::systools::COMReference<IUnknown> r(p, false);
 115             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 116         }
 117
 118         void test_copy_ctor()
 119         {
 120             sal::systools::COMReference<IUnknown> r(comObjectSource());
 121             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 122         }
 123
 124         void test_copy_assignment()
 125         {
 126             sal::systools::COMReference<IUnknown> r;
 127             CPPUNIT_ASSERT_EQUAL_MESSAGE("COMReference should be empty", static_cast<IUnknown *>(nullptr), r.get());
 128
 129             r = comObjectSource();
 130             CPPUNIT_ASSERT_MESSAGE("COMReference should be empty", r.get() != nullptr);
 131             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 132         }
 133
 134         void test_ref_to_ref_assignment()
 135         {
 136             sal::systools::COMReference<IUnknown> r1 = comObjectSource();
 137             sal::systools::COMReference<IUnknown> r2 = r1;
 138             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 2 is expected", ULONG(2), reinterpret_cast<COMObject*>(r2.get())->GetRefCount());
 139         }
 140
 141         void test_pointer_to_ref_assignment()
 142         {
 143             sal::systools::COMReference<IUnknown> r;
 144             r = new COMObject;
 145             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 146         }
 147
 148         void test_pointer_to_ref_assignment2()
 149         {
 150             sal::systools::COMReference<IUnknown> r = comObjectSource();
 151             r = new COMObject;
 152             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 153         }
 154
 155         void test_source_sink()
 156         {
 157             CPPUNIT_ASSERT_MESSAGE("Wrong reference count, 0 is expected", comObjectSink(comObjectSource(), 0));
 158         }
 159
 160         void test_address_operator()
 161         {
 162             sal::systools::COMReference<IUnknown> r;
 163             comObjectSource2(reinterpret_cast<LPVOID*>(&r));
 164             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count, 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 165         }
 166
 167         void test_address_operator2()
 168         {
 169             sal::systools::COMReference<IUnknown> r1 = comObjectSource();
 170             sal::systools::COMReference<IUnknown> r2 = r1;
 171             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 2 is expected", ULONG(2), reinterpret_cast<COMObject*>(r2.get())->GetRefCount());
 172             comObjectSource2(reinterpret_cast<LPVOID*>(&r1));
 173             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r1.get())->GetRefCount());
 174             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r2.get())->GetRefCount());
 175         }
 176
 177         void test_clear()
 178         {
 179             sal::systools::COMReference<IUnknown> r = comObjectSource();
 180             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 181             r.clear();
 182             CPPUNIT_ASSERT_MESSAGE("Expect reference to be empty", !r.is());
 183         }
 184
 185         void test_query_interface()
 186         {
 187             sal::systools::COMReference<IUnknown> r1 = comObjectSource();
 188             sal::systools::COMReference<IUnknown> r2;
 189             CPPUNIT_ASSERT_NO_THROW_MESSAGE(
 190                 "Exception should not have been thrown",
 191                 r2 = r1.QueryInterface<IUnknown>(sal::systools::COM_QUERY_THROW));
 192             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count, 2 is expected", ULONG(2),
 193                                          reinterpret_cast<COMObject*>(r2.get())->GetRefCount());
 194         }
 195
 196         void test_query_interface_throw()
 197         {
 198             sal::systools::COMReference<IUnknown> r1 = comObjectSource();
 199             CPPUNIT_ASSERT_THROW_MESSAGE("Exception should have been thrown",
 200                 auto r2 = r1.QueryInterface<IPersistFile>(sal::systools::COM_QUERY_THROW),
 201                 sal::systools::ComError);
 202         }
 203
 204         void test_CoCreateInstance()
 205         {
 206             if (FAILED(CoInitialize(nullptr)))
 207                 return;
 208             {
 209                 // Use scope to destroy the reference before calling CoUninitialize
 210                 sal::systools::COMReference<IFileOpenDialog> r;
 211                 CPPUNIT_ASSERT_NO_THROW(r.CoCreateInstance(__uuidof(FileOpenDialog)));
 212                 // Immediately after CoCreateInstance, refcount must be 1; increasing once gives 2
 213                 CPPUNIT_ASSERT_EQUAL(ULONG(2), r->AddRef());
 214                 r->Release();
 215             }
 216             CoUninitialize();
 217         }
 218
 219         // Change the following lines only, if you add, remove or rename
 220         // member functions of the current class,
 221         // because these macros are need by auto register mechanism.
 222
 223         CPPUNIT_TEST_SUITE(test_COMReference);
 224         CPPUNIT_TEST(default_ctor);
 225         CPPUNIT_TEST(test_ctor_manual_AddRef);
 226         CPPUNIT_TEST(test_copy_ctor);
 227         CPPUNIT_TEST(test_copy_assignment);
 228         CPPUNIT_TEST(test_ref_to_ref_assignment);
 229         CPPUNIT_TEST(test_pointer_to_ref_assignment);
 230         CPPUNIT_TEST(test_pointer_to_ref_assignment2);
 231         CPPUNIT_TEST(test_source_sink);
 232         CPPUNIT_TEST(test_address_operator);
 233         CPPUNIT_TEST(test_address_operator2);
 234         CPPUNIT_TEST(test_clear);
 235         CPPUNIT_TEST(test_query_interface);
 236         CPPUNIT_TEST(test_query_interface_throw);
 237         CPPUNIT_TEST(test_CoCreateInstance);
 238         CPPUNIT_TEST_SUITE_END();
 239     };
 240
 241 CPPUNIT_TEST_SUITE_REGISTRATION(test_comtools::test_COMReference);
 242
 243 } // namespace rtl_OUString
 244
 245 CPPUNIT_PLUGIN_IMPLEMENT();
 246
 247 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */