1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski // MARKER(update_precomp.py): autogen include statement, do not remove
25*b1cdbd2cSJim Jagielski #include "precompiled_comphelper.hxx"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #include <comphelper/numberedcollection.hxx>
28*b1cdbd2cSJim Jagielski #include <algorithm>
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski //_______________________________________________
31*b1cdbd2cSJim Jagielski // includes
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/UntitledNumbersConst.hpp>
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski //_______________________________________________
36*b1cdbd2cSJim Jagielski // namespace
37*b1cdbd2cSJim Jagielski
38*b1cdbd2cSJim Jagielski namespace comphelper{
39*b1cdbd2cSJim Jagielski
40*b1cdbd2cSJim Jagielski namespace css = ::com::sun::star;
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski //_______________________________________________
43*b1cdbd2cSJim Jagielski // definitions
44*b1cdbd2cSJim Jagielski
45*b1cdbd2cSJim Jagielski static const ::rtl::OUString ERRMSG_INVALID_COMPONENT_PARAM = ::rtl::OUString::createFromAscii("NULL as component reference not allowed.");
46*b1cdbd2cSJim Jagielski static const ::rtl::OUString ERRMSG_INVALID_NUMBER_PARAM = ::rtl::OUString::createFromAscii("Special valkud INVALID_NUMBER not allowed as input parameter.");
47*b1cdbd2cSJim Jagielski
48*b1cdbd2cSJim Jagielski //-----------------------------------------------
NumberedCollection()49*b1cdbd2cSJim Jagielski NumberedCollection::NumberedCollection()
50*b1cdbd2cSJim Jagielski : ::cppu::BaseMutex ()
51*b1cdbd2cSJim Jagielski , m_sUntitledPrefix ()
52*b1cdbd2cSJim Jagielski , m_lComponents ()
53*b1cdbd2cSJim Jagielski , m_xOwner ()
54*b1cdbd2cSJim Jagielski {
55*b1cdbd2cSJim Jagielski }
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski //-----------------------------------------------
~NumberedCollection()58*b1cdbd2cSJim Jagielski NumberedCollection::~NumberedCollection()
59*b1cdbd2cSJim Jagielski {
60*b1cdbd2cSJim Jagielski }
61*b1cdbd2cSJim Jagielski
62*b1cdbd2cSJim Jagielski //-----------------------------------------------
setOwner(const css::uno::Reference<css::uno::XInterface> & xOwner)63*b1cdbd2cSJim Jagielski void NumberedCollection::setOwner(const css::uno::Reference< css::uno::XInterface >& xOwner)
64*b1cdbd2cSJim Jagielski {
65*b1cdbd2cSJim Jagielski // SYNCHRONIZED ->
66*b1cdbd2cSJim Jagielski ::osl::ResettableMutexGuard aLock(m_aMutex);
67*b1cdbd2cSJim Jagielski
68*b1cdbd2cSJim Jagielski m_xOwner = xOwner;
69*b1cdbd2cSJim Jagielski
70*b1cdbd2cSJim Jagielski // <- SYNCHRONIZED
71*b1cdbd2cSJim Jagielski }
72*b1cdbd2cSJim Jagielski
73*b1cdbd2cSJim Jagielski //-----------------------------------------------
setUntitledPrefix(const::rtl::OUString & sPrefix)74*b1cdbd2cSJim Jagielski void NumberedCollection::setUntitledPrefix(const ::rtl::OUString& sPrefix)
75*b1cdbd2cSJim Jagielski {
76*b1cdbd2cSJim Jagielski // SYNCHRONIZED ->
77*b1cdbd2cSJim Jagielski ::osl::ResettableMutexGuard aLock(m_aMutex);
78*b1cdbd2cSJim Jagielski
79*b1cdbd2cSJim Jagielski m_sUntitledPrefix = sPrefix;
80*b1cdbd2cSJim Jagielski
81*b1cdbd2cSJim Jagielski // <- SYNCHRONIZED
82*b1cdbd2cSJim Jagielski }
83*b1cdbd2cSJim Jagielski
84*b1cdbd2cSJim Jagielski //-----------------------------------------------
leaseNumber(const css::uno::Reference<css::uno::XInterface> & xComponent)85*b1cdbd2cSJim Jagielski ::sal_Int32 SAL_CALL NumberedCollection::leaseNumber(const css::uno::Reference< css::uno::XInterface >& xComponent)
86*b1cdbd2cSJim Jagielski throw (css::lang::IllegalArgumentException,
87*b1cdbd2cSJim Jagielski css::uno::RuntimeException )
88*b1cdbd2cSJim Jagielski {
89*b1cdbd2cSJim Jagielski // SYNCHRONIZED ->
90*b1cdbd2cSJim Jagielski ::osl::ResettableMutexGuard aLock(m_aMutex);
91*b1cdbd2cSJim Jagielski
92*b1cdbd2cSJim Jagielski if ( ! xComponent.is ())
93*b1cdbd2cSJim Jagielski throw css::lang::IllegalArgumentException (ERRMSG_INVALID_COMPONENT_PARAM, m_xOwner.get(), 1);
94*b1cdbd2cSJim Jagielski
95*b1cdbd2cSJim Jagielski long pComponent = (long) xComponent.get ();
96*b1cdbd2cSJim Jagielski TNumberedItemHash::const_iterator pIt = m_lComponents.find (pComponent);
97*b1cdbd2cSJim Jagielski
98*b1cdbd2cSJim Jagielski // a) component already exists - return it's number directly
99*b1cdbd2cSJim Jagielski if (pIt != m_lComponents.end())
100*b1cdbd2cSJim Jagielski return pIt->second.nNumber;
101*b1cdbd2cSJim Jagielski
102*b1cdbd2cSJim Jagielski // b) component must be added new to this container
103*b1cdbd2cSJim Jagielski
104*b1cdbd2cSJim Jagielski // b1) collection is full - no further components possible
105*b1cdbd2cSJim Jagielski // -> return INVALID_NUMBER
106*b1cdbd2cSJim Jagielski ::sal_Int32 nFreeNumber = impl_searchFreeNumber();
107*b1cdbd2cSJim Jagielski if (nFreeNumber == css::frame::UntitledNumbersConst::INVALID_NUMBER)
108*b1cdbd2cSJim Jagielski return css::frame::UntitledNumbersConst::INVALID_NUMBER;
109*b1cdbd2cSJim Jagielski
110*b1cdbd2cSJim Jagielski // b2) add component to collection and return its number
111*b1cdbd2cSJim Jagielski TNumberedItem aItem;
112*b1cdbd2cSJim Jagielski aItem.xItem = css::uno::WeakReference< css::uno::XInterface >(xComponent);
113*b1cdbd2cSJim Jagielski aItem.nNumber = nFreeNumber;
114*b1cdbd2cSJim Jagielski m_lComponents[pComponent] = aItem;
115*b1cdbd2cSJim Jagielski
116*b1cdbd2cSJim Jagielski return nFreeNumber;
117*b1cdbd2cSJim Jagielski
118*b1cdbd2cSJim Jagielski // <- SYNCHRONIZED
119*b1cdbd2cSJim Jagielski }
120*b1cdbd2cSJim Jagielski
121*b1cdbd2cSJim Jagielski //-----------------------------------------------
releaseNumber(::sal_Int32 nNumber)122*b1cdbd2cSJim Jagielski void SAL_CALL NumberedCollection::releaseNumber(::sal_Int32 nNumber)
123*b1cdbd2cSJim Jagielski throw (css::lang::IllegalArgumentException,
124*b1cdbd2cSJim Jagielski css::uno::RuntimeException )
125*b1cdbd2cSJim Jagielski {
126*b1cdbd2cSJim Jagielski // SYNCHRONIZED ->
127*b1cdbd2cSJim Jagielski ::osl::ResettableMutexGuard aLock(m_aMutex);
128*b1cdbd2cSJim Jagielski
129*b1cdbd2cSJim Jagielski if (nNumber == css::frame::UntitledNumbersConst::INVALID_NUMBER)
130*b1cdbd2cSJim Jagielski throw css::lang::IllegalArgumentException (ERRMSG_INVALID_NUMBER_PARAM, m_xOwner.get(), 1);
131*b1cdbd2cSJim Jagielski
132*b1cdbd2cSJim Jagielski TDeadItemList lDeadItems;
133*b1cdbd2cSJim Jagielski TNumberedItemHash::iterator pComponent;
134*b1cdbd2cSJim Jagielski
135*b1cdbd2cSJim Jagielski for ( pComponent = m_lComponents.begin ();
136*b1cdbd2cSJim Jagielski pComponent != m_lComponents.end ();
137*b1cdbd2cSJim Jagielski ++pComponent )
138*b1cdbd2cSJim Jagielski {
139*b1cdbd2cSJim Jagielski const TNumberedItem& rItem = pComponent->second;
140*b1cdbd2cSJim Jagielski const css::uno::Reference< css::uno::XInterface > xItem = rItem.xItem.get();
141*b1cdbd2cSJim Jagielski
142*b1cdbd2cSJim Jagielski if ( ! xItem.is ())
143*b1cdbd2cSJim Jagielski {
144*b1cdbd2cSJim Jagielski lDeadItems.push_back(pComponent->first);
145*b1cdbd2cSJim Jagielski continue;
146*b1cdbd2cSJim Jagielski }
147*b1cdbd2cSJim Jagielski
148*b1cdbd2cSJim Jagielski if (rItem.nNumber == nNumber)
149*b1cdbd2cSJim Jagielski {
150*b1cdbd2cSJim Jagielski m_lComponents.erase (pComponent);
151*b1cdbd2cSJim Jagielski break;
152*b1cdbd2cSJim Jagielski }
153*b1cdbd2cSJim Jagielski }
154*b1cdbd2cSJim Jagielski
155*b1cdbd2cSJim Jagielski impl_cleanUpDeadItems(m_lComponents, lDeadItems);
156*b1cdbd2cSJim Jagielski
157*b1cdbd2cSJim Jagielski // <- SYNCHRONIZED
158*b1cdbd2cSJim Jagielski }
159*b1cdbd2cSJim Jagielski
160*b1cdbd2cSJim Jagielski //-----------------------------------------------
releaseNumberForComponent(const css::uno::Reference<css::uno::XInterface> & xComponent)161*b1cdbd2cSJim Jagielski void SAL_CALL NumberedCollection::releaseNumberForComponent(const css::uno::Reference< css::uno::XInterface >& xComponent)
162*b1cdbd2cSJim Jagielski throw (css::lang::IllegalArgumentException,
163*b1cdbd2cSJim Jagielski css::uno::RuntimeException )
164*b1cdbd2cSJim Jagielski {
165*b1cdbd2cSJim Jagielski // SYNCHRONIZED ->
166*b1cdbd2cSJim Jagielski ::osl::ResettableMutexGuard aLock(m_aMutex);
167*b1cdbd2cSJim Jagielski
168*b1cdbd2cSJim Jagielski if ( ! xComponent.is ())
169*b1cdbd2cSJim Jagielski throw css::lang::IllegalArgumentException (ERRMSG_INVALID_COMPONENT_PARAM, m_xOwner.get(), 1);
170*b1cdbd2cSJim Jagielski
171*b1cdbd2cSJim Jagielski long pComponent = (long) xComponent.get ();
172*b1cdbd2cSJim Jagielski TNumberedItemHash::iterator pIt = m_lComponents.find (pComponent);
173*b1cdbd2cSJim Jagielski
174*b1cdbd2cSJim Jagielski // a) component exists and will be removed
175*b1cdbd2cSJim Jagielski if (pIt != m_lComponents.end())
176*b1cdbd2cSJim Jagielski m_lComponents.erase(pIt);
177*b1cdbd2cSJim Jagielski
178*b1cdbd2cSJim Jagielski // else
179*b1cdbd2cSJim Jagielski // b) component does not exists - nothing todo here (ignore request!)
180*b1cdbd2cSJim Jagielski
181*b1cdbd2cSJim Jagielski // <- SYNCHRONIZED
182*b1cdbd2cSJim Jagielski }
183*b1cdbd2cSJim Jagielski
184*b1cdbd2cSJim Jagielski //-----------------------------------------------
getUntitledPrefix()185*b1cdbd2cSJim Jagielski ::rtl::OUString SAL_CALL NumberedCollection::getUntitledPrefix()
186*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException)
187*b1cdbd2cSJim Jagielski {
188*b1cdbd2cSJim Jagielski // SYNCHRONIZED ->
189*b1cdbd2cSJim Jagielski ::osl::ResettableMutexGuard aLock(m_aMutex);
190*b1cdbd2cSJim Jagielski
191*b1cdbd2cSJim Jagielski return m_sUntitledPrefix;
192*b1cdbd2cSJim Jagielski
193*b1cdbd2cSJim Jagielski // <- SYNCHRONIZED
194*b1cdbd2cSJim Jagielski }
195*b1cdbd2cSJim Jagielski
196*b1cdbd2cSJim Jagielski //-----------------------------------------------
197*b1cdbd2cSJim Jagielski /** create an ordered list of all possible numbers ...
198*b1cdbd2cSJim Jagielski e.g. {1,2,3,...,N} Max size of these list will be
199*b1cdbd2cSJim Jagielski current size of component list + 1 .
200*b1cdbd2cSJim Jagielski
201*b1cdbd2cSJim Jagielski "+1" ... because in case all numbers in range 1..n
202*b1cdbd2cSJim Jagielski are in use we need a new number n+1 :-)
203*b1cdbd2cSJim Jagielski
204*b1cdbd2cSJim Jagielski Every item which is already used as unique number
205*b1cdbd2cSJim Jagielski will be removed. At the end a list of e.g. {3,6,...,M}
206*b1cdbd2cSJim Jagielski exists where the first item represent the lowest free
207*b1cdbd2cSJim Jagielski number (in this example 3).
208*b1cdbd2cSJim Jagielski */
impl_searchFreeNumber()209*b1cdbd2cSJim Jagielski ::sal_Int32 NumberedCollection::impl_searchFreeNumber ()
210*b1cdbd2cSJim Jagielski {
211*b1cdbd2cSJim Jagielski // create ordered list of all possible numbers.
212*b1cdbd2cSJim Jagielski ::std::vector< ::sal_Int32 > lPossibleNumbers;
213*b1cdbd2cSJim Jagielski ::sal_Int32 c = (::sal_Int32)m_lComponents.size ();
214*b1cdbd2cSJim Jagielski ::sal_Int32 i = 1;
215*b1cdbd2cSJim Jagielski
216*b1cdbd2cSJim Jagielski // c cant be less then 0 ... otherwhise hash.size() has an error :-)
217*b1cdbd2cSJim Jagielski // But we need at least n+1 numbers here.
218*b1cdbd2cSJim Jagielski c += 1;
219*b1cdbd2cSJim Jagielski
220*b1cdbd2cSJim Jagielski for (i=1; i<=c; ++i)
221*b1cdbd2cSJim Jagielski lPossibleNumbers.push_back (i);
222*b1cdbd2cSJim Jagielski
223*b1cdbd2cSJim Jagielski // SYNCHRONIZED ->
224*b1cdbd2cSJim Jagielski ::osl::ResettableMutexGuard aLock(m_aMutex);
225*b1cdbd2cSJim Jagielski
226*b1cdbd2cSJim Jagielski TDeadItemList lDeadItems;
227*b1cdbd2cSJim Jagielski TNumberedItemHash::const_iterator pComponent;
228*b1cdbd2cSJim Jagielski
229*b1cdbd2cSJim Jagielski for ( pComponent = m_lComponents.begin ();
230*b1cdbd2cSJim Jagielski pComponent != m_lComponents.end ();
231*b1cdbd2cSJim Jagielski ++pComponent )
232*b1cdbd2cSJim Jagielski {
233*b1cdbd2cSJim Jagielski const TNumberedItem& rItem = pComponent->second;
234*b1cdbd2cSJim Jagielski const css::uno::Reference< css::uno::XInterface > xItem = rItem.xItem.get();
235*b1cdbd2cSJim Jagielski
236*b1cdbd2cSJim Jagielski if ( ! xItem.is ())
237*b1cdbd2cSJim Jagielski {
238*b1cdbd2cSJim Jagielski lDeadItems.push_back(pComponent->first);
239*b1cdbd2cSJim Jagielski continue;
240*b1cdbd2cSJim Jagielski }
241*b1cdbd2cSJim Jagielski
242*b1cdbd2cSJim Jagielski ::std::vector< ::sal_Int32 >::iterator pPossible = ::std::find(lPossibleNumbers.begin (), lPossibleNumbers.end (), rItem.nNumber);
243*b1cdbd2cSJim Jagielski if (pPossible != lPossibleNumbers.end ())
244*b1cdbd2cSJim Jagielski lPossibleNumbers.erase (pPossible);
245*b1cdbd2cSJim Jagielski }
246*b1cdbd2cSJim Jagielski
247*b1cdbd2cSJim Jagielski impl_cleanUpDeadItems(m_lComponents, lDeadItems);
248*b1cdbd2cSJim Jagielski
249*b1cdbd2cSJim Jagielski // a) non free numbers ... return INVALID_NUMBER
250*b1cdbd2cSJim Jagielski if (lPossibleNumbers.size () < 1)
251*b1cdbd2cSJim Jagielski return css::frame::UntitledNumbersConst::INVALID_NUMBER;
252*b1cdbd2cSJim Jagielski
253*b1cdbd2cSJim Jagielski // b) return first free number
254*b1cdbd2cSJim Jagielski return *(lPossibleNumbers.begin ());
255*b1cdbd2cSJim Jagielski
256*b1cdbd2cSJim Jagielski // <- SYNCHRONIZED
257*b1cdbd2cSJim Jagielski }
258*b1cdbd2cSJim Jagielski
impl_cleanUpDeadItems(TNumberedItemHash & lItems,const TDeadItemList & lDeadItems)259*b1cdbd2cSJim Jagielski void NumberedCollection::impl_cleanUpDeadItems ( TNumberedItemHash& lItems ,
260*b1cdbd2cSJim Jagielski const TDeadItemList& lDeadItems)
261*b1cdbd2cSJim Jagielski {
262*b1cdbd2cSJim Jagielski TDeadItemList::const_iterator pIt;
263*b1cdbd2cSJim Jagielski
264*b1cdbd2cSJim Jagielski for ( pIt = lDeadItems.begin ();
265*b1cdbd2cSJim Jagielski pIt != lDeadItems.end ();
266*b1cdbd2cSJim Jagielski ++pIt )
267*b1cdbd2cSJim Jagielski {
268*b1cdbd2cSJim Jagielski const long& rDeadItem = *pIt;
269*b1cdbd2cSJim Jagielski lItems.erase(rDeadItem);
270*b1cdbd2cSJim Jagielski }
271*b1cdbd2cSJim Jagielski }
272*b1cdbd2cSJim Jagielski
273*b1cdbd2cSJim Jagielski } // namespace comphelper
274