| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef _COMPHELPER_NUMBEREDCOLLECTION_HXX_ |
| #define _COMPHELPER_NUMBEREDCOLLECTION_HXX_ |
| |
| //_______________________________________________ |
| // includes |
| |
| #include "comphelper/comphelperdllapi.h" |
| |
| #include <com/sun/star/uno/Reference.hxx> |
| #include <com/sun/star/lang/IllegalArgumentException.hpp> |
| #include <com/sun/star/uno/XInterface.hpp> |
| #include <com/sun/star/frame/XUntitledNumbers.hpp> |
| |
| #include <cppuhelper/basemutex.hxx> |
| #include <cppuhelper/weakref.hxx> |
| #include <cppuhelper/implbase1.hxx> |
| |
| #include <vector> |
| #include <hash_map> |
| |
| //_______________________________________________ |
| // namespace |
| |
| namespace comphelper{ |
| |
| #ifdef css |
| #error "Ambigious namespace definition of css." |
| #else |
| #define css ::com::sun::star |
| #endif |
| |
| //_______________________________________________ |
| // definitions |
| |
| /** @short defines a collection of UNO components, where every component will get it's own unique number. |
| |
| @descr Such number will be unique at runtime only ... but it supports fragmentation. |
| Note: This collection uses weak refrences only to know her components. |
| So lifetime of thise components must be controlled outside. |
| |
| @threadsafe |
| */ |
| class COMPHELPER_DLLPUBLIC NumberedCollection : private ::cppu::BaseMutex |
| , public ::cppu::WeakImplHelper1< css::frame::XUntitledNumbers > |
| { |
| //------------------------------------------- |
| // types, const |
| private: |
| |
| struct TNumberedItem |
| { |
| css::uno::WeakReference< css::uno::XInterface > xItem; |
| ::sal_Int32 nNumber; |
| }; |
| |
| typedef ::std::hash_map< |
| long , |
| TNumberedItem , |
| ::std::hash< long > , |
| ::std::equal_to< long > > TNumberedItemHash; |
| |
| typedef ::std::vector< long > TDeadItemList; |
| |
| //------------------------------------------- |
| // interface |
| public: |
| |
| //--------------------------------------- |
| /** @short lightweight constructor. |
| */ |
| NumberedCollection(); |
| |
| //--------------------------------------- |
| /** @short free all internaly used resources. |
| */ |
| virtual ~NumberedCollection(); |
| |
| //--------------------------------------- |
| /** set an outside component which uses this container and must be set |
| as source of all broadcasted messages, exceptions. |
| |
| It's holded weak only so we do not need any complex dispose sessions. |
| |
| Note: Passing NULL as parameter will be allowed. It will reset the internal |
| member reference only. |
| |
| @param xOwner |
| the new owner of this collection. |
| */ |
| void setOwner (const css::uno::Reference< css::uno::XInterface >& xOwner); |
| |
| //--------------------------------------- |
| /** set the localized prefix to be used for untitled components. |
| |
| Localization has to be done outside. This container will return |
| those value then. There are no further checks. Its up to you to define |
| a suitable string here :-) |
| |
| @param sPrefix |
| the new prefix for untitled components. |
| */ |
| void setUntitledPrefix(const ::rtl::OUString& sPrefix); |
| |
| //--------------------------------------- |
| /** @see css.frame.XUntitledNumbers */ |
| virtual ::sal_Int32 SAL_CALL leaseNumber(const css::uno::Reference< css::uno::XInterface >& xComponent) |
| throw (css::lang::IllegalArgumentException, |
| css::uno::RuntimeException ); |
| |
| //--------------------------------------- |
| /** @see css.frame.XUntitledNumbers */ |
| virtual void SAL_CALL releaseNumber(::sal_Int32 nNumber) |
| throw (css::lang::IllegalArgumentException, |
| css::uno::RuntimeException ); |
| |
| //--------------------------------------- |
| /** @see css.frame.XUntitledNumbers */ |
| virtual void SAL_CALL releaseNumberForComponent(const css::uno::Reference< css::uno::XInterface >& xComponent) |
| throw (css::lang::IllegalArgumentException, |
| css::uno::RuntimeException ); |
| |
| //--------------------------------------- |
| /** @see css.frame.XUntitledNumbers */ |
| virtual ::rtl::OUString SAL_CALL getUntitledPrefix() |
| throw (css::uno::RuntimeException); |
| |
| //------------------------------------------- |
| // internal |
| private: |
| |
| //--------------------------------------- |
| /** @short trys to find an unique number not already used within this collection. |
| |
| @descr It reuses the smalles number which isnt used by any component |
| of this collection. (fragmentation!) If collection is full (means there |
| is no free number) the special value INVALID_NUMBER will be returned. |
| |
| @note Those method cant be called within a multithreaded environment .. |
| Because such number wont be "reserved" for the calli of these method |
| it can happen that two calls returns the same number (reasoned by the fact that first calli |
| doesnt used the returned number already. |
| |
| So the outside code has to make sure that retrieving and using of those number |
| will be an atomic operation. |
| |
| @return an unique number or special value INVALID_NUMBER if collection is full. |
| */ |
| ::sal_Int32 impl_searchFreeNumber (); |
| |
| void impl_cleanUpDeadItems ( TNumberedItemHash& lItems , |
| const TDeadItemList& lDeadItems); |
| |
| //------------------------------------------- |
| // member |
| private: |
| |
| /// localized string to be used for untitled components |
| ::rtl::OUString m_sUntitledPrefix; |
| |
| /// cache of all "leased numbers" and its bound components |
| TNumberedItemHash m_lComponents; |
| |
| /// used as source of broadcasted messages or exceptions (can be null !) |
| css::uno::WeakReference< css::uno::XInterface > m_xOwner; |
| }; |
| |
| #undef css |
| |
| } // namespace comphelper |
| |
| #endif // _COMPHELPER_NUMBEREDCOLLECTION_HXX_ |
