/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ /* * This file is part of LibreOffice published API. */ #ifndef INCLUDED_CPPUHELPER_PROPSHLP_HXX #define INCLUDED_CPPUHELPER_PROPSHLP_HXX #include "rtl/alloc.h" #include "cppuhelper/interfacecontainer.h" #include "com/sun/star/beans/XPropertySet.hpp" #include "com/sun/star/beans/XPropertySetOption.hpp" #include "com/sun/star/beans/XMultiPropertySet.hpp" #include "com/sun/star/beans/XFastPropertySet.hpp" #include "cppuhelper/cppuhelperdllapi.h" namespace cppu { /************************************************************************* *************************************************************************/ /** This interface is used by the OPropertyHelper, to access the property description. */ class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC IPropertyArrayHelper { public: // these are here to force memory de/allocation to sal lib. static void * SAL_CALL operator new( size_t nSize ) { return ::rtl_allocateMemory( nSize ); } static void SAL_CALL operator delete( void * pMem ) { ::rtl_freeMemory( pMem ); } static void * SAL_CALL operator new( size_t, void * pMem ) { return pMem; } static void SAL_CALL operator delete( void *, void * ) {} /** Following the rule, the first virtual method implies a virtual destructor. */ virtual ~IPropertyArrayHelper(); /** Return the property members Name and Attribute from the handle nHandle. @param nHandle the handle of a property. If the values of the handles are sorted in the same way as the names and the highest handle value is getCount() -1, then it must be an indexed access to the property array. @param pPropName is an out parameter filled with property name of the property with the handle nHandle. May be NULL. @param pAttributes is an out parameter filled with attributes of the property with the handle nHandle. May be NULL. @return True, if the handle exist, otherwise false. */ virtual sal_Bool SAL_CALL fillPropertyMembersByHandle( ::rtl::OUString * pPropName, sal_Int16 * pAttributes, sal_Int32 nHandle ) = 0; /** Return the sequence of properties. The sequence is sorted by name. */ virtual css::uno::Sequence< css::beans::Property > SAL_CALL getProperties() = 0; /** Return the property with the name rPropertyName. @param rPropertyName the name of the property. @exception UnknownPropertyException thrown if the property name is unknown. */ virtual css::beans::Property SAL_CALL getPropertyByName( const ::rtl::OUString& rPropertyName ) = 0; /** Return true if the property with the name rPropertyName exist, otherwise false. @param rPropertyName the name of the property. */ virtual sal_Bool SAL_CALL hasPropertyByName(const ::rtl::OUString& rPropertyName) = 0; /** Return the handle of the property with the name rPropertyName. If the property does not exist -1 is returned. @param rPropertyName the name of the property. */ virtual sal_Int32 SAL_CALL getHandleByName( const ::rtl::OUString & rPropertyName ) = 0; /** Fill the array with the handles of the properties. @return the handles of the names from the pHandles array. -1 indicates an unknown property name. */ virtual sal_Int32 SAL_CALL fillHandles( /*out*/ sal_Int32 * pHandles, const css::uno::Sequence< ::rtl::OUString > & rPropNames ) = 0; }; /** You can use this helper class to map a XPropertySet-Interface to a XFast- or a XMultiPropertySet interface. */ class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC OPropertyArrayHelper : public IPropertyArrayHelper { public: /** Create an object which supports the common property interfaces. @param pProps array of properties The array pProps should be sorted. @param nElements is the number of properties in the pProps structure. @param bSorted indicates that the elements are sorted. *********/ OPropertyArrayHelper( css::beans::Property *pProps, sal_Int32 nElements , sal_Bool bSorted = true ); /** Create an object which supports the common property interfaces. @param aProps sequence of properties which are supported by this helper. The sequence aProps should be sorted. @param bSorted indicates that the elements are sorted. */ OPropertyArrayHelper( const css::uno::Sequence< css::beans::Property > & aProps, sal_Bool bSorted = true ); /** Return the number of properties. */ sal_Int32 SAL_CALL getCount() const; /** Return the property members Name and Attribute from the handle nHandle. @param nHandle the handle of a property. If the values of the handles are sorted in the same way as the names and the highest handle value is getCount() -1, then it is only an indexed access to the property array. Otherwise it is a linear search through the array. @param pPropName is an out parameter filled with property name of the property with the handle nHandle. May be NULL. @param pAttributes is an out parameter filled with attributes of the property with the handle nHandle. May be NULL. @return True, if the handle exist, otherwise false. */ virtual sal_Bool SAL_CALL fillPropertyMembersByHandle( ::rtl::OUString * pPropName, sal_Int16 * pAttributes, sal_Int32 nHandle ) SAL_OVERRIDE; /** Return the sequence of properties. The sequence is sorted by name. */ virtual css::uno::Sequence< css::beans::Property > SAL_CALL getProperties() SAL_OVERRIDE; /** Return the property with the name rPropertyName. @param rPropertyName the name of the property. @exception UnknownPropertyException thrown if the property name is unknown. */ virtual css::beans::Property SAL_CALL getPropertyByName( const ::rtl::OUString& rPropertyName ) SAL_OVERRIDE; /** Return true if the property with the name rPropertyName exist, otherwise false. @param rPropertyName the name of the property. */ virtual sal_Bool SAL_CALL hasPropertyByName(const ::rtl::OUString& rPropertyName) SAL_OVERRIDE; /** Return the handle of the property with the name rPropertyName. If the property does not exist -1 is returned. @param rPropertyName the name of the property. */ virtual sal_Int32 SAL_CALL getHandleByName( const ::rtl::OUString & rPropertyName ) SAL_OVERRIDE; /** Fill the array with the handles of the properties. @return the handles of the names from the pHandles array. -1 indicates an unknown property name. */ virtual sal_Int32 SAL_CALL fillHandles( /*out*/sal_Int32 * pHandles, const css::uno::Sequence< ::rtl::OUString > & rPropNames ) SAL_OVERRIDE; protected: /** reserved for future use. do not use. */ void * m_pReserved; private: void init( sal_Bool bSorted ); /** The sequence generated from the pProperties array. */ css::uno::Sequence< css::beans::Property > aInfos; /** True, If the values of the handles are sorted in the same way as the names and the highest handle value is getCount() -1, otherwise false. */ sal_Bool bRightOrdered; }; // helper defines needed for an interface container with a 32 bit key values struct equalInt32_Impl { bool operator()(const sal_Int32 & i1 , const sal_Int32 & i2) const { return i1 == i2; } }; struct hashInt32_Impl { size_t operator()(const sal_Int32 & i) const { return i; } }; /** Specialized class for key type sal_Int32, without explicit usage of STL symbols. */ class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC OMultiTypeInterfaceContainerHelperInt32 { public: // these are here to force memory de/allocation to sal lib. static void * SAL_CALL operator new( size_t nSize ) { return ::rtl_allocateMemory( nSize ); } static void SAL_CALL operator delete( void * pMem ) { ::rtl_freeMemory( pMem ); } static void * SAL_CALL operator new( size_t, void * pMem ) { return pMem; } static void SAL_CALL operator delete( void *, void * ) {} /** Create a container of interface containers. @param rMutex the mutex to protect multi thread access. The lifetime must be longer than the lifetime of this object. */ OMultiTypeInterfaceContainerHelperInt32( ::osl::Mutex & rMutex ); /** Delete all containers. */ ~OMultiTypeInterfaceContainerHelperInt32(); /** Return all id's under which at least one interface is added. */ css::uno::Sequence< sal_Int32 > SAL_CALL getContainedTypes() const; /** Return the container created under this key. @return the container created under this key. If the container was not created, null was returned. */ OInterfaceContainerHelper * SAL_CALL getContainer( const sal_Int32 & rKey ) const; /** Insert an element in the container specified with the key. The position is not specified. @param rKey the id of the container. @param r the added interface. It is allowed to insert null or the same pointer more than once. @return the new count of elements in the container. */ sal_Int32 SAL_CALL addInterface( const sal_Int32 & rKey, const css::uno::Reference< css::uno::XInterface > & r ); /** Remove an element from the container specified with the key. It uses the equal definition of uno objects to remove the interfaces. @param rKey the id of the container. @param rxIFace the removed interface. @return the new count of elements in the container. */ sal_Int32 SAL_CALL removeInterface( const sal_Int32 & rKey, const css::uno::Reference< css::uno::XInterface > & rxIFace ); /** Call disposing on all objects in the container that support XEventListener. Then clear the container. */ void SAL_CALL disposeAndClear( const css::lang::EventObject & rEvt ); /** Remove all elements of all containers. Does not delete the container. */ void SAL_CALL clear(); typedef sal_Int32 keyType; private: void * m_pMap; ::osl::Mutex & rMutex; OMultiTypeInterfaceContainerHelperInt32( const OMultiTypeInterfaceContainerHelperInt32 & ) SAL_DELETED_FUNCTION; OMultiTypeInterfaceContainerHelperInt32 & operator = ( const OMultiTypeInterfaceContainerHelperInt32 & )SAL_DELETED_FUNCTION; }; /** An interface to extend event notification actions. */ class IEventNotificationHook { public: /** Method to be called by OPropertySetHelper::fire. @param pnHandles the id's of the properties that changed. @param nCount the number of elements in the arrays pnHandles, pNewValues and pOldValues. @param bVetoable true means fire to VetoableChangeListener, false means fire to XPropertyChangedListener and XMultiPropertyChangedListener. @param bIgnoreRuntimeExceptionsWhileFiring indicates whether occurring RuntimeExceptions will be ignored when firing notifications (vetoableChange(), propertyChange()) to listeners. PropertyVetoExceptions may still be thrown. This flag is useful in an inter-process scenario when remote bridges may break down (firing DisposedExceptions). @see OPropertySetHelper::fire */ virtual void fireEvents( sal_Int32 * pnHandles, sal_Int32 nCount, sal_Bool bVetoable, bool bIgnoreRuntimeExceptionsWhileFiring) = 0; #if !defined _MSC_VER // public -> protected changes mangled names there protected: #endif ~IEventNotificationHook() {} // avoid warnings about virtual members and non-virtual dtor }; /** This abstract class maps the methods of the interfaces XMultiPropertySet, XFastPropertySet and XPropertySet to the methods getInfoHelper, convertFastPropertyValue, setFastPropertyValue_NoBroadcast and getFastPropertyValue. You must derive from this class and override the methods. It provides a standard implementation of the XPropertySetInfo. The XPropertiesChangeListener are inserted in the rBHelper.aLC structure. The XPropertyChangeListener and XVetoableChangeListener with no names are inserted in the rBHelper.aLC structure. So it is possible to advise property listeners with the connection point interfaces. But only listeners that listen to all property changes. */ class CPPUHELPER_DLLPUBLIC OPropertySetHelper : public css::beans::XMultiPropertySet, public css::beans::XFastPropertySet, public css::beans::XPropertySet { public: /** @param rBHelper this structure contains the basic members of a broadcaster. The lifetime must be longer than the lifetime of this object. Stored in the variable rBHelper. */ OPropertySetHelper( OBroadcastHelper & rBHelper ); /** Constructor. @param rBHelper this structure contains the basic members of a broadcaster. The lifetime must be longer than the lifetime of this object. Stored in the variable rBHelper. @param bIgnoreRuntimeExceptionsWhileFiring indicates whether occurring RuntimeExceptions will be ignored when firing notifications (vetoableChange(), propertyChange()) to listeners. PropertyVetoExceptions may still be thrown. This flag is useful in an inter-process scenario when remote bridges may break down (firing DisposedExceptions). */ OPropertySetHelper( OBroadcastHelper & rBHelper, bool bIgnoreRuntimeExceptionsWhileFiring ); /** Constructor. @param rBHelper this structure contains the basic members of a broadcaster. The lifetime must be longer than the lifetime of this object. Stored in the variable rBHelper. @param i_pFireEvents additional event notifier @param bIgnoreRuntimeExceptionsWhileFiring indicates whether occurring RuntimeExceptions will be ignored when firing notifications (vetoableChange(), propertyChange()) to listeners. PropertyVetoExceptions may still be thrown. This flag is useful in an inter-process scenario when remote bridges may break down (firing DisposedExceptions). */ OPropertySetHelper( OBroadcastHelper & rBHelper, IEventNotificationHook *i_pFireEvents, bool bIgnoreRuntimeExceptionsWhileFiring = false); /** Only returns a reference to XMultiPropertySet, XFastPropertySet, XPropertySet and XEventListener. */ virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) SAL_OVERRIDE; /** eases implementing XTypeProvider::getTypes, returns the types of XMultiPropertySet, XFastPropertySet, XPropertySet @throws css::uno::RuntimeException */ css::uno::Sequence< css::uno::Type > getTypes(); /** Send a disposing notification to the listeners in the containers aBoundLC and aVetoableLC. @see OComponentHelper */ void SAL_CALL disposing(); /** Throw UnknownPropertyException or PropertyVetoException if the property with the name rPropertyName does not exist or is readonly. Otherwise rPropertyName is changed to its handle value and setFastPropertyValue is called. */ virtual void SAL_CALL setPropertyValue( const ::rtl::OUString& rPropertyName, const css::uno::Any& aValue ) SAL_OVERRIDE; /** Throw UnknownPropertyException if the property with the name rPropertyName does not exist. */ virtual css::uno::Any SAL_CALL getPropertyValue(const ::rtl::OUString& aPropertyName) SAL_OVERRIDE; /** Ignored if the property is not bound. */ virtual void SAL_CALL addPropertyChangeListener( const ::rtl::OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener) SAL_OVERRIDE; /** Ignored if the property is not bound. */ virtual void SAL_CALL removePropertyChangeListener( const ::rtl::OUString& aPropertyName, const css::uno::Reference < css::beans::XPropertyChangeListener >& aListener) SAL_OVERRIDE; /** Ignored if the property is not constrained. */ virtual void SAL_CALL addVetoableChangeListener( const ::rtl::OUString& aPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener) SAL_OVERRIDE; /** Ignored if the property is not constrained. */ virtual void SAL_CALL removeVetoableChangeListener( const ::rtl::OUString& aPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > & aListener ) SAL_OVERRIDE; /** Throw UnknownPropertyException or PropertyVetoException if the property with the name rPropertyName does not exist or is readonly. Otherwise the method convertFastPropertyValue is called, then the vetoable listeners are notified. After this the value of the property is changed with the setFastPropertyValue_NoBroadcast method and the bound listeners are notified. */ virtual void SAL_CALL setFastPropertyValue( sal_Int32 nHandle, const css::uno::Any& rValue ) SAL_OVERRIDE; /** @exception css::beans::UnknownPropertyException if the property with the handle nHandle does not exist. */ virtual css::uno::Any SAL_CALL getFastPropertyValue( sal_Int32 nHandle ) SAL_OVERRIDE; // XMultiPropertySet virtual void SAL_CALL setPropertyValues( const css::uno::Sequence< ::rtl::OUString >& PropertyNames, const css::uno::Sequence< css::uno::Any >& Values ) SAL_OVERRIDE; virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPropertyValues( const css::uno::Sequence< ::rtl::OUString >& PropertyNames ) SAL_OVERRIDE; virtual void SAL_CALL addPropertiesChangeListener( const css::uno::Sequence< ::rtl::OUString >& PropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener >& Listener ) SAL_OVERRIDE; virtual void SAL_CALL removePropertiesChangeListener( const css::uno::Reference< css::beans::XPropertiesChangeListener >& Listener ) SAL_OVERRIDE; virtual void SAL_CALL firePropertiesChangeEvent( const css::uno::Sequence< ::rtl::OUString >& PropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > & Listener ) SAL_OVERRIDE; /** The property sequence is created in the call. The interface isn't used after the call. */ static css::uno::Reference < css::beans::XPropertySetInfo > SAL_CALL createPropertySetInfo( IPropertyArrayHelper & rProperties ); protected: /** This method fire events to all registered property listeners. @param pnHandles the id's of the properties that changed. @param pNewValues the new values of the properties. @param pOldValues the old values of the properties. @param nCount the number of elements in the arrays pnHandles, pNewValues and pOldValues. @param bVetoable true means fire to VetoableChangeListener, false means fire to XPropertyChangedListener and XMultiPropertyChangedListener. */ void SAL_CALL fire( sal_Int32 * pnHandles, const css::uno::Any * pNewValues, const css::uno::Any * pOldValues, sal_Int32 nCount, sal_Bool bVetoable ); /** Set multiple properties with the handles. @param nSeqLen the length of the arrays pHandles and Values. @param pHandles the handles of the properties. The number of elements in the Values sequence is the length of the handle array. A value of -1 of a handle means invalid property. These are ignored. @param pValues the values of the properties. @param nHitCount the number of valid entries in the handle array. */ void SAL_CALL setFastPropertyValues( sal_Int32 nSeqLen, sal_Int32 * pHandles, const css::uno::Any * pValues, sal_Int32 nHitCount ); /** This abstract method must return the name to index table. This table contains all property names and types of this object. The method is not implemented in this class. */ virtual IPropertyArrayHelper & SAL_CALL getInfoHelper() = 0; /** Converted the value rValue and return the result in rConvertedValue and the old value in rOldValue. An IllegalArgumentException is thrown. The method is not implemented in this class. After this call the vetoable listeners are notified. @param rConvertedValue the converted value. Only set if return is true. @param rOldValue the old value. Only set if return is true. @param nHandle the handle of the property. @param rValue the value to be converted @return true if the value converted. @throws css::lang::IllegalArgumentException @throws css::beans::UnknownPropertyException @throws css::uno::RuntimeException */ virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any & rConvertedValue, css::uno::Any & rOldValue, sal_Int32 nHandle, const css::uno::Any& rValue ) = 0; /** The same as setFastPropertyValue; nHandle is always valid. The changes must not be broadcasted in this method. The method is implemented in a derived class. @attention Although you are permitted to throw any UNO exception, only the following are valid for usage: -- css::beans::UnknownPropertyException -- css::beans::PropertyVetoException -- css::lang::IllegalArgumentException -- css::lang::WrappedTargetException -- css::uno::RuntimeException @param nHandle handle @param rValue value @throws css::uno::Exception */ virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const css::uno::Any& rValue ) = 0; /** The same as getFastPropertyValue, but return the value through rValue and nHandle is always valid. The method is not implemented in this class. */ virtual void SAL_CALL getFastPropertyValue( css::uno::Any& rValue, sal_Int32 nHandle ) const = 0; /** sets an dependent property's value

Sometimes setting a given property needs to implicitly modify another property's value. Calling |setPropertyValue| from within |setFastPropertyValue_NoBroadcast| is not an option here, as it would notify the property listeners while our mutex is still locked. Setting the dependent property's value directly (e.g. by calling |setFastPropertyValue_NoBroadcast| recursively) is not an option, too, since it would miss firing the property change event.

So, in such cases, you use |setDependentFastPropertyValue| from within |setFastPropertyValue_NoBroadcast|. It will convert and actually set the property value (invoking |convertFastPropertyValue| and |setFastPropertyValue_NoBroadcast| for the given handle and value), and add the property change event to the list of events to be notified when the bottom-most |setFastPropertyValue_NoBroadcast| on the stack returns.

Note: The method will not invoke veto listeners for the property.

Note: It's the caller's responsibility to ensure that our mutex is locked. This is canonically given when the method is invoked from within |setFastPropertyValue_NoBroadcast|, in other contexts, you might need to take own measures.

*/ void setDependentFastPropertyValue( sal_Int32 i_handle, const css::uno::Any& i_value ); /** The common data of a broadcaster. Use the mutex, disposing state and the listener container. */ OBroadcastHelper &rBHelper; /** Container for the XPropertyChangedListener. The listeners are inserted by handle. */ OMultiTypeInterfaceContainerHelperInt32 aBoundLC; /** Container for the XPropertyVetoableListener. The listeners are inserted by handle. */ OMultiTypeInterfaceContainerHelperInt32 aVetoableLC; class Impl; /** reserved for future use. finally, the future has arrived... */ Impl * const m_pReserved; private: OPropertySetHelper( const OPropertySetHelper & ) SAL_DELETED_FUNCTION; OPropertySetHelper & operator = ( const OPropertySetHelper & ) SAL_DELETED_FUNCTION; /** notifies the given changes in property's values, plus all property changes collected during recent |setDependentFastPropertyValue| calls. */ void impl_fireAll( sal_Int32* i_handles, const css::uno::Any * i_newValues, const css::uno::Any * i_oldValues, sal_Int32 i_count ); #if defined _MSC_VER // public -> protected changes mangled names there public: #else protected: #endif /** You must call disposing before destruction. */ ~OPropertySetHelper(); }; /** OPropertySetHelper plus XPropertySetOption @attention The getTypes() inherited from OPropertysetHelper does not cover XPropertySetOption. */ class CPPUHELPER_DLLPUBLIC OPropertySetHelper2 : public OPropertySetHelper, public css::beans::XPropertySetOption { public: /** Constructor. See OPropertySetHelper constructors documentation */ explicit OPropertySetHelper2( OBroadcastHelper & rBHelper, IEventNotificationHook *i_pFireEvents = NULL, bool bIgnoreRuntimeExceptionsWhileFiring = false); // XInterface virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) SAL_OVERRIDE; // XPropertySetOption virtual void SAL_CALL enableChangeListenerNotification( sal_Bool bEnable ) SAL_OVERRIDE; private: OPropertySetHelper2( const OPropertySetHelper2 & ) SAL_DELETED_FUNCTION; OPropertySetHelper2 & operator = ( const OPropertySetHelper2 & ) SAL_DELETED_FUNCTION; #if defined _MSC_VER // public -> protected changes mangled names there public: #else protected: #endif // Suppress warning about virtual functions but non-virtual destructor: /** You must call disposing before destruction. */ virtual ~OPropertySetHelper2(); }; } // end namespace cppuhelper #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */