INTEGRATION: CWS titles02 (1.1.2); FILE ADDED
2007/10/12 08:49:57 as 1.1.2.1: #116375# new helper to control numbers bound to uno components with fragmentation
This commit is contained in:
Kurt Zenker
parent
2ffb4768d9
commit
5621648089
1 changed files with 206 additions and 0 deletions
206
comphelper/inc/comphelper/numberedcollection.hxx
Normal file
206
comphelper/inc/comphelper/numberedcollection.hxx
Normal file
|
|
@ -0,0 +1,206 @@
|
|||
/*************************************************************************
|
||||
*
|
||||
* OpenOffice.org - a multi-platform office productivity suite
|
||||
*
|
||||
* $RCSfile: numberedcollection.hxx,v $
|
||||
*
|
||||
* $Revision: 1.2 $
|
||||
*
|
||||
* last change: $Author: kz $ $Date: 2008-04-04 14:23:12 $
|
||||
*
|
||||
* The Contents of this file are made available subject to
|
||||
* the terms of GNU Lesser General Public License Version 2.1.
|
||||
*
|
||||
*
|
||||
* GNU Lesser General Public License Version 2.1
|
||||
* =============================================
|
||||
* Copyright 2005 by Sun Microsystems, Inc.
|
||||
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License version 2.1, as published by the Free Software Foundation.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
||||
* MA 02111-1307 USA
|
||||
*
|
||||
************************************************************************/
|
||||
|
||||
#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_
|
||||
Loading…
Reference in a new issue