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
  24 class COMObject : public IUnknown
  25 {
  26 public:
  27     COMObject() : ref_count_(0)
  28     {
  29     }
  30
  31     virtual ~COMObject()
  32     {
  33     }
  34
  35     ULONG __stdcall AddRef() override
  36     {
  37         ref_count_++;
  38         return ref_count_;
  39     }
  40
  41     ULONG __stdcall Release() override
  42     {
  43         ULONG cnt = --ref_count_;
  44         if (cnt == 0)
  45             delete this;
  46         return cnt;
  47     }
  48
  49     HRESULT __stdcall QueryInterface(REFIID riid, void** ppv) override
  50     {
  51         if (riid == IID_IUnknown)
  52         {
  53             AddRef();
  54             *ppv = this;
  55             return S_OK;
  56         }
  57         return E_NOINTERFACE;
  58     }
  59
  60     ULONG GetRefCount() const
  61     {
  62         return ref_count_;
  63     }
  64
  65 private:
  66     ULONG ref_count_;
  67 };
  68
  69 static sal::systools::COMReference<IUnknown> comObjectSource()
  70 {
  71     return sal::systools::COMReference<IUnknown>(new COMObject);
  72 }
  73
  74 static bool comObjectSink(sal::systools::COMReference<IUnknown> r, ULONG expectedRefCountOnReturn)
  75 {
  76     r = sal::systools::COMReference<IUnknown>();
  77     COMObject* p = reinterpret_cast<COMObject*>(r.get());
  78     if (p)
  79         return (p->GetRefCount() == expectedRefCountOnReturn);
  80     else
  81         return (0 == expectedRefCountOnReturn);
  82 }
  83
  84 static void comObjectSource2(LPVOID* ppv)
  85 {
  86     COMObject* p = new COMObject;
  87     p->AddRef();
  88     *ppv = p;
  89 }
  90
  91 namespace test_comtools
  92 {
  93
  94     class test_COMReference : public CppUnit::TestFixture
  95     {
  96
  97     public:
  98         /// test of COMReference<IUnknown> r;
  99         void default_ctor()
 100         {
 101             sal::systools::COMReference<IUnknown> r;
 102             CPPUNIT_ASSERT_EQUAL_MESSAGE("COMReference should be empty", static_cast<IUnknown *>(nullptr), r.get());
 103         }
 104
 105         void test_ctor_manual_AddRef()
 106         {
 107             COMObject* p = new COMObject;
 108             p->AddRef();
 109             sal::systools::COMReference<IUnknown> r(p, false);
 110             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 111         }
 112
 113         void test_copy_ctor()
 114         {
 115             sal::systools::COMReference<IUnknown> r(comObjectSource());
 116             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 117         }
 118
 119         void test_copy_assignment()
 120         {
 121             sal::systools::COMReference<IUnknown> r;
 122             CPPUNIT_ASSERT_EQUAL_MESSAGE("COMReference should be empty", static_cast<IUnknown *>(nullptr), r.get());
 123
 124             r = comObjectSource();
 125             CPPUNIT_ASSERT_MESSAGE("COMReference should be empty", r.get() != nullptr);
 126             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 127         }
 128
 129         void test_ref_to_ref_assignment()
 130         {
 131             sal::systools::COMReference<IUnknown> r1 = comObjectSource();
 132             sal::systools::COMReference<IUnknown> r2 = r1;
 133             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 2 is expected", ULONG(2), reinterpret_cast<COMObject*>(r2.get())->GetRefCount());
 134         }
 135
 136         void test_pointer_to_ref_assignment()
 137         {
 138             sal::systools::COMReference<IUnknown> r;
 139             r = new COMObject;
 140             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 141         }
 142
 143         void test_pointer_to_ref_assignment2()
 144         {
 145             sal::systools::COMReference<IUnknown> r = comObjectSource();
 146             r = new COMObject;
 147             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 148         }
 149
 150         void test_source_sink()
 151         {
 152             CPPUNIT_ASSERT_MESSAGE("Wrong reference count, 0 is expected", comObjectSink(comObjectSource(), 0));
 153         }
 154
 155         void test_address_operator()
 156         {
 157             sal::systools::COMReference<IUnknown> r;
 158             comObjectSource2(reinterpret_cast<LPVOID*>(&r));
 159             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count, 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 160         }
 161
 162         void test_address_operator2()
 163         {
 164             sal::systools::COMReference<IUnknown> r1 = comObjectSource();
 165             sal::systools::COMReference<IUnknown> r2 = r1;
 166             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 2 is expected", ULONG(2), reinterpret_cast<COMObject*>(r2.get())->GetRefCount());
 167             comObjectSource2(reinterpret_cast<LPVOID*>(&r1));
 168             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r1.get())->GetRefCount());
 169             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r2.get())->GetRefCount());
 170         }
 171
 172         void test_clear()
 173         {
 174             sal::systools::COMReference<IUnknown> r = comObjectSource();
 175             CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count 1 is expected", ULONG(1), reinterpret_cast<COMObject*>(r.get())->GetRefCount());
 176             r.clear();
 177             CPPUNIT_ASSERT_MESSAGE("Expect reference to be empty", !r.is());
 178         }
 179
 180         void test_query_interface()
 181         {
 182             try
 183             {
 184                 sal::systools::COMReference<IUnknown> r1 = comObjectSource();
 185                 sal::systools::COMReference<IUnknown> r2 = r1.QueryInterface<IUnknown>(IID_IUnknown);
 186                 CPPUNIT_ASSERT_EQUAL_MESSAGE("Wrong reference count, 2 is expected", ULONG(2), reinterpret_cast<COMObject*>(r2.get())->GetRefCount());
 187             }
 188             catch(const sal::systools::ComError&)
 189             {
 190                 CPPUNIT_ASSERT_MESSAGE("Exception should not have been thrown", false);
 191             }
 192         }
 193
 194         void test_query_interface_throw()
 195         {
 196             try
 197             {
 198                 sal::systools::COMReference<IUnknown> r1 = comObjectSource();
 199                 sal::systools::COMReference<IPersistFile> r2 = r1.QueryInterface<IPersistFile>(IID_IPersistFile);
 200             }
 201             catch(const sal::systools::ComError&)
 202             {
 203                 return;
 204             }
 205             CPPUNIT_ASSERT_MESSAGE("Exception should have been thrown", false);
 206         }
 207
 208         // Change the following lines only, if you add, remove or rename
 209         // member functions of the current class,
 210         // because these macros are need by auto register mechanism.
 211
 212         CPPUNIT_TEST_SUITE(test_COMReference);
 213         CPPUNIT_TEST(default_ctor);
 214         CPPUNIT_TEST(test_ctor_manual_AddRef);
 215         CPPUNIT_TEST(test_copy_ctor);
 216         CPPUNIT_TEST(test_copy_assignment);
 217         CPPUNIT_TEST(test_ref_to_ref_assignment);
 218         CPPUNIT_TEST(test_pointer_to_ref_assignment);
 219         CPPUNIT_TEST(test_pointer_to_ref_assignment2);
 220         CPPUNIT_TEST(test_source_sink);
 221         CPPUNIT_TEST(test_address_operator);
 222         CPPUNIT_TEST(test_address_operator2);
 223         CPPUNIT_TEST(test_clear);
 224         CPPUNIT_TEST(test_query_interface);
 225         CPPUNIT_TEST(test_query_interface_throw);
 226         CPPUNIT_TEST_SUITE_END();
 227     };
 228
 229 CPPUNIT_TEST_SUITE_REGISTRATION(test_comtools::test_COMReference);
 230
 231 } // namespace rtl_OUString
 232
 233 CPPUNIT_PLUGIN_IMPLEMENT();
 234
 235 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */