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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/* -*- 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 .
*/
#include <algorithm>
#include <comphelper/numberedcollection.hxx>
#include <com/sun/star/frame/UntitledNumbersConst.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
namespace comphelper{
static const char ERRMSG_INVALID_COMPONENT_PARAM[] = "NULL as component reference not allowed.";
NumberedCollection::NumberedCollection()
: ::cppu::BaseMutex ()
, m_sUntitledPrefix ()
, m_lComponents ()
, m_xOwner ()
{
}
NumberedCollection::~NumberedCollection()
{
}
void NumberedCollection::setOwner(const css::uno::Reference< css::uno::XInterface >& xOwner)
{
// SYNCHRONIZED ->
osl::MutexGuard aLock(m_aMutex);
m_xOwner = xOwner;
// <- SYNCHRONIZED
}
void NumberedCollection::setUntitledPrefix(const OUString& sPrefix)
{
// SYNCHRONIZED ->
osl::MutexGuard aLock(m_aMutex);
m_sUntitledPrefix = sPrefix;
// <- SYNCHRONIZED
}
::sal_Int32 SAL_CALL NumberedCollection::leaseNumber(const css::uno::Reference< css::uno::XInterface >& xComponent)
{
// SYNCHRONIZED ->
osl::MutexGuard aLock(m_aMutex);
if ( ! xComponent.is ())
throw css::lang::IllegalArgumentException(ERRMSG_INVALID_COMPONENT_PARAM, m_xOwner.get(), 1);
sal_IntPtr pComponent = reinterpret_cast<sal_IntPtr>( xComponent.get() );
TNumberedItemHash::const_iterator pIt = m_lComponents.find (pComponent);
// a) component already exists - return its number directly
if (pIt != m_lComponents.end())
return pIt->second.nNumber;
// b) component must be added new to this container
// b1) collection is full - no further components possible
// -> return INVALID_NUMBER
::sal_Int32 nFreeNumber = impl_searchFreeNumber();
if (nFreeNumber == css::frame::UntitledNumbersConst::INVALID_NUMBER)
return css::frame::UntitledNumbersConst::INVALID_NUMBER;
// b2) add component to collection and return its number
TNumberedItem aItem;
aItem.xItem = css::uno::WeakReference< css::uno::XInterface >(xComponent);
aItem.nNumber = nFreeNumber;
m_lComponents[pComponent] = aItem;
return nFreeNumber;
// <- SYNCHRONIZED
}
void SAL_CALL NumberedCollection::releaseNumber(::sal_Int32 nNumber)
{
// SYNCHRONIZED ->
osl::MutexGuard aLock(m_aMutex);
if (nNumber == css::frame::UntitledNumbersConst::INVALID_NUMBER)
throw css::lang::IllegalArgumentException ("Special valkud INVALID_NUMBER not allowed as input parameter.", m_xOwner.get(), 1);
TDeadItemList lDeadItems;
TNumberedItemHash::iterator pComponent;
for ( pComponent = m_lComponents.begin ();
pComponent != m_lComponents.end ();
++pComponent )
{
const TNumberedItem& rItem = pComponent->second;
const css::uno::Reference< css::uno::XInterface > xItem = rItem.xItem.get();
if ( ! xItem.is ())
{
lDeadItems.push_back(pComponent->first);
continue;
}
if (rItem.nNumber == nNumber)
{
m_lComponents.erase (pComponent);
break;
}
}
impl_cleanUpDeadItems(m_lComponents, lDeadItems);
// <- SYNCHRONIZED
}
void SAL_CALL NumberedCollection::releaseNumberForComponent(const css::uno::Reference< css::uno::XInterface >& xComponent)
{
// SYNCHRONIZED ->
osl::MutexGuard aLock(m_aMutex);
if ( ! xComponent.is ())
throw css::lang::IllegalArgumentException(ERRMSG_INVALID_COMPONENT_PARAM, m_xOwner.get(), 1);
sal_IntPtr pComponent = reinterpret_cast<sal_IntPtr>( xComponent.get() );
TNumberedItemHash::iterator pIt = m_lComponents.find (pComponent);
// a) component exists and will be removed
if (pIt != m_lComponents.end())
m_lComponents.erase(pIt);
// else
// b) component does not exists - nothing todo here (ignore request!)
// <- SYNCHRONIZED
}
OUString SAL_CALL NumberedCollection::getUntitledPrefix()
{
// SYNCHRONIZED ->
osl::MutexGuard aLock(m_aMutex);
return m_sUntitledPrefix;
// <- SYNCHRONIZED
}
/** create an ordered list of all possible numbers ...
e.g. {1,2,3,...,N} Max size of these list will be
current size of component list + 1 .
"+1" ... because in case all numbers in range 1..n
are in use we need a new number n+1 :-)
Every item which is already used as unique number
will be removed. At the end a list of e.g. {3,6,...,M}
exists where the first item represent the lowest free
number (in this example 3).
*/
::sal_Int32 NumberedCollection::impl_searchFreeNumber ()
{
// create ordered list of all possible numbers.
std::vector< ::sal_Int32 > lPossibleNumbers;
::sal_Int32 c = static_cast<::sal_Int32>(m_lComponents.size ());
::sal_Int32 i = 1;
// c can't be less than 0 ... otherwise hash.size() has an error :-)
// But we need at least n+1 numbers here.
c += 1;
for (i=1; i<=c; ++i)
lPossibleNumbers.push_back (i);
// SYNCHRONIZED ->
{
osl::MutexGuard aLock(m_aMutex);
TDeadItemList lDeadItems;
for (const auto& [rComponent, rItem] : m_lComponents)
{
const css::uno::Reference< css::uno::XInterface > xItem = rItem.xItem.get();
if ( ! xItem.is ())
{
lDeadItems.push_back(rComponent);
continue;
}
std::vector< ::sal_Int32 >::iterator pPossible = std::find(lPossibleNumbers.begin (), lPossibleNumbers.end (), rItem.nNumber);
if (pPossible != lPossibleNumbers.end ())
lPossibleNumbers.erase (pPossible);
}
impl_cleanUpDeadItems(m_lComponents, lDeadItems);
// a) non free numbers ... return INVALID_NUMBER
if (lPossibleNumbers.empty())
return css::frame::UntitledNumbersConst::INVALID_NUMBER;
// b) return first free number
return *(lPossibleNumbers.begin ());
}
// <- SYNCHRONIZED
}
void NumberedCollection::impl_cleanUpDeadItems ( TNumberedItemHash& lItems ,
const TDeadItemList& lDeadItems)
{
for (const long& rDeadItem : lDeadItems)
{
lItems.erase(rDeadItem);
}
}
} // namespace comphelper
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
