canvas/inc/base/basemutexhelper.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 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <osl/mutex.hxx>
  25
  26 /* Definition of the BaseMutexHelper class */
  27
  28 namespace canvas
  29 {
  30     /** Base class, initializing its own baseclass with m_aMutex.
  31
  32         This is necessary to make the CanvasBase, GraphicDeviceBase,
  33         etc. classes freely combinable - letting them perform this
  34         initialization would prohibit deriving e.g. CanvasBase from
  35         GraphicDeviceBase.
  36      */
  37     template< class Base > class BaseMutexHelper : public Base
  38     {
  39     protected:
  40         /** Construct BaseMutexHelper
  41
  42             This method is the whole purpose of this template:
  43             initializing a base class with the provided m_aMutex
  44             member (the WeakComponentImplHelper templates need that,
  45             as they require the lifetime of the mutex to extend
  46             theirs).
  47          */
  48         BaseMutexHelper() :
  49             Base( m_aMutex )
  50         {
  51         }
  52
  53         virtual void disposeThis() {}
  54
  55         mutable osl::Mutex m_aMutex;
  56
  57     private:
  58         virtual void SAL_CALL disposing() override
  59         { disposeThis(); }
  60     };
  61 }
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */