include/comphelper/proparrhlp.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_COMPHELPER_PROPARRHLP_HXX
  21 #define INCLUDED_COMPHELPER_PROPARRHLP_HXX
  22
  23 #include <comphelper/propagg.hxx>
  24 #include <cppuhelper/propshlp.hxx>
  25 #include <osl/mutex.hxx>
  26 #include <osl/diagnose.h>
  27 #include <rtl/instance.hxx>
  28
  29 namespace cppu {
  30     class IPropertyArrayHelper;
  31 }
  32
  33 namespace comphelper
  34 {
  35
  36 template <typename TYPE> struct OPropertyArrayUsageHelperMutex
  37     : public rtl::Static< ::osl::Mutex, OPropertyArrayUsageHelperMutex<TYPE> > {};
  38
  39 template <class TYPE>
  40 class OPropertyArrayUsageHelper
  41 {
  42 protected:
  43     static sal_Int32                        s_nRefCount;
  44     static ::cppu::IPropertyArrayHelper*    s_pProps;
  45
  46 public:
  47     OPropertyArrayUsageHelper();
  48     virtual ~OPropertyArrayUsageHelper();
  49
  50     /** call this in the getInfoHelper method of your derived class. The method returns the array helper of the
  51         class, which is created if necessary.
  52     */
  53     ::cppu::IPropertyArrayHelper*   getArrayHelper();
  54
  55 protected:
  56     /** used to implement the creation of the array helper which is shared amongst all instances of the class.
  57         This method needs to be implemented in derived classes.
  58         <BR>
  59         The method gets called with Mutex acquired.
  60         @return                         an pointer to the newly created array helper. Must not be NULL.
  61     */
  62     virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const = 0;
  63 };
  64
  65 /** a OPropertyArrayUsageHelper which will create an OPropertyArrayAggregationHelper
  66 */
  67 template <class TYPE>
  68 class OAggregationArrayUsageHelper: public OPropertyArrayUsageHelper<TYPE>
  69 {
  70 protected:
  71     /** overwrite this in your derived class. initialize the two sequences with your and your aggregate's
  72         properties.
  73         <BR>
  74         The method gets called with Mutex acquired.
  75         @param      _rProps             out parameter to be filled with the property descriptions of your own class
  76         @param      _rAggregateProps    out parameter to be filled with the properties of your aggregate.
  77     */
  78     virtual void fillProperties(
  79         css::uno::Sequence< css::beans::Property >& /* [out] */ _rProps,
  80         css::uno::Sequence< css::beans::Property >& /* [out] */ _rAggregateProps
  81         ) const = 0;
  82
  83     /** creates an OPropertyArrayAggregationHelper filled with properties for which's initialization
  84         fillProperties is called. getInfoService and getFirstAggregateId may be overwritten to determine
  85         the additional parameters of the OPropertyArrayAggregationHelper.
  86     */
  87     virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const;
  88 };
  89
  90 template<class TYPE>
  91 sal_Int32                       OPropertyArrayUsageHelper< TYPE >::s_nRefCount  = 0;
  92
  93 template<class TYPE>
  94 ::cppu::IPropertyArrayHelper*   OPropertyArrayUsageHelper< TYPE >::s_pProps = nullptr;
  95
  96 template <class TYPE>
  97 OPropertyArrayUsageHelper<TYPE>::OPropertyArrayUsageHelper()
  98 {
  99     ::osl::MutexGuard aGuard(OPropertyArrayUsageHelperMutex<TYPE>::get());
 100     ++s_nRefCount;
 101 }
 102
 103 template <class TYPE>
 104 OPropertyArrayUsageHelper<TYPE>::~OPropertyArrayUsageHelper()
 105 {
 106     ::osl::MutexGuard aGuard(OPropertyArrayUsageHelperMutex<TYPE>::get());
 107     OSL_ENSURE(s_nRefCount > 0, "OPropertyArrayUsageHelper::~OPropertyArrayUsageHelper : suspicious call : have a refcount of 0 !");
 108     if (!--s_nRefCount)
 109     {
 110         delete s_pProps;
 111         s_pProps = nullptr;
 112     }
 113 }
 114
 115 template <class TYPE>
 116 ::cppu::IPropertyArrayHelper* OPropertyArrayUsageHelper<TYPE>::getArrayHelper()
 117 {
 118     OSL_ENSURE(s_nRefCount, "OPropertyArrayUsageHelper::getArrayHelper : suspicious call : have a refcount of 0 !");
 119     if (!s_pProps)
 120     {
 121         ::osl::MutexGuard aGuard(OPropertyArrayUsageHelperMutex<TYPE>::get());
 122         if (!s_pProps)
 123         {
 124             s_pProps = createArrayHelper();
 125             OSL_ENSURE(s_pProps, "OPropertyArrayUsageHelper::getArrayHelper : createArrayHelper returned nonsense !");
 126         }
 127     }
 128     return s_pProps;
 129 }
 130
 131 template <class TYPE> inline
 132 ::cppu::IPropertyArrayHelper* OAggregationArrayUsageHelper<TYPE>::createArrayHelper() const
 133 {
 134     css::uno::Sequence< css::beans::Property > aProps;
 135     css::uno::Sequence< css::beans::Property > aAggregateProps;
 136     fillProperties(aProps, aAggregateProps);
 137     OSL_ENSURE(aProps.getLength(), "OAggregationArrayUsageHelper::createArrayHelper : fillProperties returned nonsense !");
 138     return new OPropertyArrayAggregationHelper(aProps, aAggregateProps, nullptr, DEFAULT_AGGREGATE_PROPERTY_ID);
 139 }
 140
 141 }
 142
 143 #endif // INCLUDED_COMPHELPER_PROPARRHLP_HXX
 144
 145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */