1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 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 <boost/unordered_map.hpp>
//_______________________________________________
// 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 ::boost::unordered_map<
long ,
TNumberedItem ,
::boost::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_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
