include/systools/win32/comptr.hxx

   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 #ifndef INCLUDED_SYSTOOLS_WIN32_COMPTR_HXX
  21 #define INCLUDED_SYSTOOLS_WIN32_COMPTR_HXX
  22
  23 #include <sal/types.h>
  24 #include <osl/diagnose.h>
  25 #include <shobjidl.h>
  26
  27 template< class    T_INTERFACE          ,
  28           REFIID   P_IID   = IID_NULL   ,
  29           REFCLSID P_CLSID = CLSID_NULL >
  30 class ComPtr
  31 {
  32     public:
  33
  34
  35         /** initialize com ptr with null.
  36          */
  37         ComPtr()
  38         {
  39             m_pInterface = NULL;
  40         }
  41
  42
  43         /** initialize com ptr with given interface.
  44          */
  45         ComPtr(T_INTERFACE* pInterface)
  46         {
  47             m_pInterface = pInterface;
  48             if (m_pInterface)
  49                 m_pInterface->AddRef();
  50         }
  51
  52
  53         /** copy ctor.
  54          */
  55         ComPtr(const ComPtr< T_INTERFACE, P_IID, P_CLSID >& aCopy)
  56         {
  57             m_pInterface = aCopy.m_pInterface;
  58             if (m_pInterface)
  59                 m_pInterface->AddRef();
  60         }
  61
  62
  63         /** initialize object by quering external object for the right interface.
  64          */
  65         ComPtr(IUnknown* pIUnknown)
  66         {
  67             if (pIUnknown)
  68                 pIUnknown->QueryInterface(P_IID, (void**)&m_pInterface);
  69         }
  70
  71
  72         /** deinitialize com object right.
  73          */
  74         ~ComPtr()
  75         {
  76             release();
  77         }
  78
  79     public:
  80
  81
  82         HRESULT create()
  83         {
  84             return CoCreateInstance(P_CLSID, NULL, CLSCTX_ALL, P_IID, (void**)&m_pInterface);
  85         }
  86
  87
  88         operator T_INTERFACE*() const
  89         {
  90             return m_pInterface;
  91         }
  92
  93
  94         T_INTERFACE& operator*() const
  95         {
  96             return *m_pInterface;
  97         }
  98
  99
 100         T_INTERFACE** operator&()
 101         {
 102             return &m_pInterface;
 103         }
 104
 105
 106         T_INTERFACE* operator->() const
 107         {
 108             return m_pInterface;
 109         }
 110
 111
 112         T_INTERFACE* operator=(T_INTERFACE* pInterface)
 113         {
 114             if ( equals(pInterface) )
 115                 return m_pInterface;
 116
 117             m_pInterface->Release();
 118             m_pInterface = pInterface;
 119             if (m_pInterface)
 120                 m_pInterface->AddRef();
 121
 122             return m_pInterface;
 123         }
 124
 125
 126         T_INTERFACE* operator=(IUnknown* pIUnknown)
 127         {
 128             if (pIUnknown)
 129                 pIUnknown->QueryInterface(P_IID, (void**)&m_pInterface);
 130             return m_pInterface;
 131         }
 132
 133
 134         T_INTERFACE* operator=(const ComPtr< T_INTERFACE, P_IID, P_CLSID >& aCopy)
 135         {
 136             m_pInterface = aCopy.m_pInterface;
 137             if (m_pInterface)
 138                 m_pInterface->AddRef();
 139
 140             return m_pInterface;
 141         }
 142
 143
 144         T_INTERFACE* get() const
 145         {
 146             return m_pInterface;
 147         }
 148
 149
 150         void attach(T_INTERFACE* pInterface)
 151         {
 152             if (pInterface)
 153             {
 154                 m_pInterface->Release();
 155                 m_pInterface = pInterface;
 156             }
 157         }
 158
 159
 160         T_INTERFACE* detach()
 161         {
 162             T_INTERFACE* pInterface = m_pInterface;
 163             m_pInterface = NULL;
 164             return pInterface;
 165         }
 166
 167
 168         void release()
 169         {
 170             if (m_pInterface)
 171             {
 172                 m_pInterface->Release();
 173                 m_pInterface = NULL;
 174             }
 175         }
 176
 177 #ifndef __MINGW32__
 178
 179         template< class T_QUERYINTERFACE >
 180         HRESULT query(T_QUERYINTERFACE** pQuery)
 181         {
 182             return m_pInterface->QueryInterface(__uuidof(T_QUERYINTERFACE), (void**)pQuery);
 183         }
 184 #endif
 185
 186
 187         HRESULT query(REFIID rIID  ,
 188                       void** pQuery)
 189         {
 190             return m_pInterface->QueryInterface(rIID, pQuery);
 191         }
 192
 193
 194         HRESULT unknown(IUnknown** pQuery)
 195         {
 196             return m_pInterface->QueryInterface(IID_IUnknown, (void**)pQuery);
 197         }
 198
 199
 200         sal_Bool equals(IUnknown* pCheck)
 201         {
 202             if (
 203                 ( ! m_pInterface ) &&
 204                 ( ! pCheck       )
 205                )
 206                 return sal_True;
 207
 208             IUnknown* pCurrent = NULL;
 209             m_pInterface->QueryInterface(IID_IUnknown, (void**)&pCurrent);
 210
 211             sal_Bool bEquals = (pCheck == pCurrent);
 212             pCurrent->Release();
 213
 214             return bEquals;
 215         }
 216
 217
 218         sal_Bool is()
 219         {
 220             return (m_pInterface != 0);
 221         }
 222
 223     private:
 224         T_INTERFACE* m_pInterface;
 225 };
 226
 227 #endif
 228
 229 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */