/usr/include/libreoffice/cppuhelper/interfacecontainer.h is in libreoffice-dev 1:3.5.2-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 | /* -*- 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 _CPPUHELPER_INTERFACECONTAINER_H_
#define _CPPUHELPER_INTERFACECONTAINER_H_
#include <vector>
#include <osl/mutex.hxx>
#include <rtl/alloc.h>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/uno/XInterface.hpp>
#ifndef _COM_SUN_STAR_LANG_EVENTOBJECT_HXX_
#include <com/sun/star/lang/EventObject.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_DISPOSEDEXCEPTION_HXX_
#include "com/sun/star/lang/DisposedException.hpp"
#endif
/** */ //for docpp
namespace cppu
{
namespace detail {
union element_alias
{
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > > *pAsSequence;
::com::sun::star::uno::XInterface * pAsInterface;
element_alias() : pAsInterface(0) {}
};
}
//===================================================================
class OInterfaceContainerHelper;
/**
This is the iterator of a InterfaceContainerHelper. Typically
one constructs an instance on the stack for one firing session.
It is not allowed to assign or copy an instance of this class.
@see OInterfaceContainerHelper
*/
class OInterfaceIteratorHelper
{
public:
/**
Create an iterator over the elements of the container. The iterator
copies the elements of the conatainer. A change to the container
during the lifetime of an iterator is allowed and does not
affect the iterator-instance. The iterator and the container take cares
themself for concurrent access, no additional guarding is necessary.
Remark: The copy is on demand. The iterator copy the elements only if the container
change the contents. It is not allowed to destroy the container as long
as an iterator exist.
@param rCont the container of the elements.
*/
OInterfaceIteratorHelper( OInterfaceContainerHelper & rCont ) SAL_THROW( () );
/**
Releases the connection to the container.
*/
~OInterfaceIteratorHelper() SAL_THROW( () );
/** Return sal_True, if there are more elements in the iterator. */
sal_Bool SAL_CALL hasMoreElements() const SAL_THROW( () )
{ return nRemain != 0; }
/** Return the next element of the iterator. Calling this method if
hasMoreElements() has returned sal_False, is an error. Cast the
returned pointer to the
*/
::com::sun::star::uno::XInterface * SAL_CALL next() SAL_THROW( () );
/** Removes the current element (the last one returned by next())
from the underlying container. Calling this method before
next() has been called or calling it twice with no next()
inbetween is an error.
*/
void SAL_CALL remove() SAL_THROW( () );
private:
OInterfaceContainerHelper & rCont;
sal_Bool bIsList;
detail::element_alias aData;
sal_Int32 nRemain;
OInterfaceIteratorHelper( const OInterfaceIteratorHelper & ) SAL_THROW( () );
OInterfaceIteratorHelper & operator = ( const OInterfaceIteratorHelper & ) SAL_THROW( () );
};
//===================================================================
/**
A container of interfaces. To access the elements use an iterator.
This implementation is thread save.
@see OInterfaceIteratorHelper
*/
class OInterfaceContainerHelper
{
public:
// these are here to force memory de/allocation to sal lib.
inline static void * SAL_CALL operator new( size_t nSize ) SAL_THROW( () )
{ return ::rtl_allocateMemory( nSize ); }
inline static void SAL_CALL operator delete( void * pMem ) SAL_THROW( () )
{ ::rtl_freeMemory( pMem ); }
inline static void * SAL_CALL operator new( size_t, void * pMem ) SAL_THROW( () )
{ return pMem; }
inline static void SAL_CALL operator delete( void *, void * ) SAL_THROW( () )
{}
/**
Create an interface container.
@param rMutex the mutex to protect multi thread access.
The lifetime must be longer than the lifetime
of this object.
*/
OInterfaceContainerHelper( ::osl::Mutex & rMutex ) SAL_THROW( () );
/**
Release all interfaces. All iterators must be destroyed before
the container is destructed.
*/
~OInterfaceContainerHelper() SAL_THROW( () );
/**
Return the number of Elements in the container. Only useful if you have acquired
the mutex.
*/
sal_Int32 SAL_CALL getLength() const SAL_THROW( () );
/**
Return all interfaces added to this container.
**/
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > > SAL_CALL getElements() const SAL_THROW( () );
/** Inserts an element into the container. The position is not specified, thus it is not
specified in which order events are fired.
@attention
If you add the same interface more than once, then it will be added to the elements list
more than once and thus if you want to remove that interface from the list, you have to call
removeInterface() the same number of times.
In the latter case, you will also get events fired more than once (if the interface is a
listener interface).
@param rxIFace
interface to be added; it is allowed to insert null or
the same interface more than once
@return
the new count of elements in the container
*/
sal_Int32 SAL_CALL addInterface( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & rxIFace ) SAL_THROW( () );
/** Removes an element from the container. It uses interface equality to remove the interface.
@param rxIFace
interface to be removed
@return
the new count of elements in the container
*/
sal_Int32 SAL_CALL removeInterface( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & rxIFace ) SAL_THROW( () );
/**
Call disposing on all object in the container that
support XEventListener. Than clear the container.
*/
void SAL_CALL disposeAndClear( const ::com::sun::star::lang::EventObject & rEvt ) SAL_THROW( () );
/**
Clears the container without calling disposing().
*/
void SAL_CALL clear() SAL_THROW( () );
/** Executes a functor for each contained listener of specified type, e.g.
<code>forEach<awt::XPaintListener>(...</code>.
If a com::sun::star::lang::DisposedException occurs which relates to
the called listener, then that listener is removed from the container.
@tpl ListenerT listener type
@tpl FuncT unary functor type, let your compiler deduce this for you
@param func unary functor object expecting an argument of type
::com::sun::star::uno::Reference<ListenerT>
*/
template <typename ListenerT, typename FuncT>
inline void forEach( FuncT const& func );
/** Calls a UNO listener method for each contained listener.
The listener method must take a single argument of type EventT,
and return <code>void</code>.
If a com::sun::star::lang::DisposedException occurs which relates to
the called listener, then that listener is removed from the container.
@tpl ListenerT UNO event listener type, let your compiler deduce this for you
@tpl EventT event type, let your compiler deduce this for you
@param NotificationMethod
Pointer to a method of a ListenerT interface.
@param Event
Event to notify to all contained listeners
@example
<pre>
awt::PaintEvent aEvent( static_cast< ::cppu::OWeakObject* >( this ), ... );
listeners.notifyEach( &XPaintListener::windowPaint, aEvent );
</pre>
*/
template< typename ListenerT, typename EventT >
inline void notifyEach( void ( SAL_CALL ListenerT::*NotificationMethod )( const EventT& ), const EventT& Event );
private:
friend class OInterfaceIteratorHelper;
/**
bIsList == TRUE -> aData.pAsSequence of type Sequence< XInterfaceSequence >,
otherwise aData.pAsInterface == of type (XEventListener *)
*/
detail::element_alias aData;
::osl::Mutex & rMutex;
/** TRUE -> used by an iterator. */
sal_Bool bInUse;
/** TRUE -> aData.pAsSequence is of type Sequence< XInterfaceSequence >. */
sal_Bool bIsList;
OInterfaceContainerHelper( const OInterfaceContainerHelper & ) SAL_THROW( () );
OInterfaceContainerHelper & operator = ( const OInterfaceContainerHelper & ) SAL_THROW( () );
/*
Dulicate content of the conaitner and release the old one without destroying.
The mutex must be locked and the memberbInUse must be true.
*/
void copyAndResetInUse() SAL_THROW( () );
private:
template< typename ListenerT, typename EventT >
class NotifySingleListener
{
private:
typedef void ( SAL_CALL ListenerT::*NotificationMethod )( const EventT& );
NotificationMethod m_pMethod;
const EventT& m_rEvent;
public:
NotifySingleListener( NotificationMethod method, const EventT& event ) : m_pMethod( method ), m_rEvent( event ) { }
void operator()( const ::com::sun::star::uno::Reference<ListenerT>& listener ) const
{
(listener.get()->*m_pMethod)( m_rEvent );
}
};
};
template <typename ListenerT, typename FuncT>
inline void OInterfaceContainerHelper::forEach( FuncT const& func )
{
OInterfaceIteratorHelper iter( *this );
while (iter.hasMoreElements()) {
::com::sun::star::uno::Reference<ListenerT> const xListener(
iter.next(), ::com::sun::star::uno::UNO_QUERY );
if (xListener.is()) {
#if defined(EXCEPTIONS_OFF)
func( xListener );
#else
try {
func( xListener );
}
catch (::com::sun::star::lang::DisposedException const& exc) {
if (exc.Context == xListener)
iter.remove();
}
#endif
}
}
}
template< typename ListenerT, typename EventT >
inline void OInterfaceContainerHelper::notifyEach( void ( SAL_CALL ListenerT::*NotificationMethod )( const EventT& ), const EventT& Event )
{
forEach< ListenerT, NotifySingleListener< ListenerT, EventT > >( NotifySingleListener< ListenerT, EventT >( NotificationMethod, Event ) );
}
//===================================================================
/**
A helper class to store interface references of different types.
@see OInterfaceIteratorHelper
@see OInterfaceContainerHelper
*/
template< class key , class hashImpl , class equalImpl >
class OMultiTypeInterfaceContainerHelperVar
{
public:
// these are here to force memory de/allocation to sal lib.
inline static void * SAL_CALL operator new( size_t nSize ) SAL_THROW( () )
{ return ::rtl_allocateMemory( nSize ); }
inline static void SAL_CALL operator delete( void * pMem ) SAL_THROW( () )
{ ::rtl_freeMemory( pMem ); }
inline static void * SAL_CALL operator new( size_t, void * pMem ) SAL_THROW( () )
{ return pMem; }
inline static void SAL_CALL operator delete( void *, void * ) SAL_THROW( () )
{}
/**
Create a container of interface containers.
@param rMutex the mutex to protect multi thread access.
The lifetime must be longer than the lifetime
of this object.
*/
inline OMultiTypeInterfaceContainerHelperVar( ::osl::Mutex & ) SAL_THROW( () );
/**
Deletes all containers.
*/
inline ~OMultiTypeInterfaceContainerHelperVar() SAL_THROW( () );
/**
Return all id's under which at least one interface is added.
*/
inline ::com::sun::star::uno::Sequence< key > SAL_CALL getContainedTypes() const SAL_THROW( () );
/**
Return the container created under this key.
The InterfaceContainerHelper exists until the whole MultiTypeContainer is destroyed.
@return the container created under this key. If the container
was not created, null was returned.
*/
inline OInterfaceContainerHelper * SAL_CALL getContainer( const key & ) const SAL_THROW( () );
/** Inserts an element into the container with the specified key.
The position is not specified, thus it is not specified in which order events are fired.
@attention
If you add the same interface more than once, then it will be added to the elements list
more than once and thus if you want to remove that interface from the list, you have to call
removeInterface() the same number of times.
In the latter case, you will also get events fired more than once (if the interface is a
listener interface).
@param rKey
the id of the container
@param r
interface to be added; it is allowed, to insert null or
the same interface more than once
@return
the new count of elements in the container
*/
inline sal_Int32 SAL_CALL addInterface(
const key & rKey,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & r )
SAL_THROW( () );
/** Removes an element from the container with the specified key.
It uses interface equality to remove the interface.
@param rKey
the id of the container
@param rxIFace
interface to be removed
@return
the new count of elements in the container
*/
inline sal_Int32 SAL_CALL removeInterface(
const key & rKey,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & rxIFace )
SAL_THROW( () );
/**
Call disposing on all references in the container, that
support XEventListener. Then clears the container.
@param rEvt the event object which is passed during disposing() call
*/
inline void SAL_CALL disposeAndClear( const ::com::sun::star::lang::EventObject & rEvt ) SAL_THROW( () );
/**
Remove all elements of all containers. Does not delete the container.
*/
inline void SAL_CALL clear() SAL_THROW( () );
typedef key keyType;
private:
typedef ::std::vector< std::pair < key , void* > > InterfaceMap;
InterfaceMap *m_pMap;
::osl::Mutex & rMutex;
inline typename InterfaceMap::iterator find(const key &rKey) const
{
typename InterfaceMap::iterator iter = m_pMap->begin();
typename InterfaceMap::iterator end = m_pMap->end();
while( iter != end )
{
equalImpl equal;
if( equal( iter->first, rKey ) )
break;
iter++;
}
return iter;
}
inline OMultiTypeInterfaceContainerHelperVar( const OMultiTypeInterfaceContainerHelperVar & ) SAL_THROW( () );
inline OMultiTypeInterfaceContainerHelperVar & operator = ( const OMultiTypeInterfaceContainerHelperVar & ) SAL_THROW( () );
};
/**
This struct contains the standard variables of a broadcaster. Helper
classes only know a reference to this struct instead of references
to the four members. The access to the members must be guarded with
rMutex.
The additional template parameter keyType has been added, because gcc
can't compile addListener( const container::keyType &key ).
*/
template < class container , class keyType >
struct OBroadcastHelperVar
{
/** The shared mutex. */
::osl::Mutex & rMutex;
/** ListenerContainer class is thread save. */
container aLC;
/** Dispose call ready. */
sal_Bool bDisposed;
/** In dispose call. */
sal_Bool bInDispose;
/**
Initialize the structur. bDispose and bInDispose are set to false.
@param rMutex the mutex reference.
*/
OBroadcastHelperVar( ::osl::Mutex & rMutex_ ) SAL_THROW( () )
: rMutex( rMutex_ )
, aLC( rMutex_ )
, bDisposed( sal_False )
, bInDispose( sal_False )
{}
/**
adds a listener threadsafe.
**/
inline void addListener(
const keyType &key,
const ::com::sun::star::uno::Reference < ::com::sun::star::uno::XInterface > &r )
SAL_THROW( () )
{
::osl::MutexGuard guard( rMutex );
OSL_ENSURE( !bInDispose, "do not add listeners in the dispose call" );
OSL_ENSURE( !bDisposed, "object is disposed" );
if( ! bInDispose && ! bDisposed )
aLC.addInterface( key , r );
}
/**
removes a listener threadsafe
**/
inline void removeListener(
const keyType &key,
const ::com::sun::star::uno::Reference < ::com::sun::star::uno::XInterface > & r )
SAL_THROW( () )
{
::osl::MutexGuard guard( rMutex );
OSL_ENSURE( !bDisposed, "object is disposed" );
if( ! bInDispose && ! bDisposed )
aLC.removeInterface( key , r );
}
/**
Return the container created under this key.
@return the container created under this key. If the container
was not created, null was returned. This can be used to optimize
performance ( construction of an event object can be avoided ).
***/
inline OInterfaceContainerHelper * SAL_CALL getContainer( const keyType &key ) const SAL_THROW( () )
{ return aLC.getContainer( key ); }
};
/*------------------------------------------
*
* In general, the above templates are used with a Type as key.
* Therefore a default declaration is given ( OMultiTypeInterfaceContainerHelper and OBroadcastHelper )
*
*------------------------------------------*/
// helper function call class
struct hashType_Impl
{
size_t operator()(const ::com::sun::star::uno::Type & s) const SAL_THROW( () )
{ return s.getTypeName().hashCode(); }
};
/** Specialized class for key type com::sun::star::uno::Type,
without explicit usage of STL symbols.
*/
class OMultiTypeInterfaceContainerHelper
{
public:
// these are here to force memory de/allocation to sal lib.
inline static void * SAL_CALL operator new( size_t nSize ) SAL_THROW( () )
{ return ::rtl_allocateMemory( nSize ); }
inline static void SAL_CALL operator delete( void * pMem ) SAL_THROW( () )
{ ::rtl_freeMemory( pMem ); }
inline static void * SAL_CALL operator new( size_t, void * pMem ) SAL_THROW( () )
{ return pMem; }
inline static void SAL_CALL operator delete( void *, void * ) SAL_THROW( () )
{}
/**
Create a container of interface containers.
@param rMutex the mutex to protect multi thread access.
The lifetime must be longer than the lifetime
of this object.
*/
OMultiTypeInterfaceContainerHelper( ::osl::Mutex & ) SAL_THROW( () );
/**
Delete all containers.
*/
~OMultiTypeInterfaceContainerHelper() SAL_THROW( () );
/**
Return all id's under which at least one interface is added.
*/
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getContainedTypes() const SAL_THROW( () );
/**
Return the container created under this key.
@return the container created under this key. If the container
was not created, null was returned.
*/
OInterfaceContainerHelper * SAL_CALL getContainer( const ::com::sun::star::uno::Type & rKey ) const SAL_THROW( () );
/** Inserts an element into the container with the specified key.
The position is not specified, thus it is not specified in which order events are fired.
@attention
If you add the same interface more than once, then it will be added to the elements list
more than once and thus if you want to remove that interface from the list, you have to call
removeInterface() the same number of times.
In the latter case, you will also get events fired more than once (if the interface is a
listener interface).
@param rKey
the id of the container
@param r
interface to be added; it is allowed, to insert null or
the same interface more than once
@return
the new count of elements in the container
*/
sal_Int32 SAL_CALL addInterface(
const ::com::sun::star::uno::Type & rKey,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & r )
SAL_THROW( () );
/** Removes an element from the container with the specified key.
It uses interface equality to remove the interface.
@param rKey
the id of the container
@param rxIFace
interface to be removed
@return
the new count of elements in the container
*/
sal_Int32 SAL_CALL removeInterface(
const ::com::sun::star::uno::Type & rKey,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & rxIFace )
SAL_THROW( () );
/**
Call disposing on all object in the container that
support XEventListener. Than clear the container.
*/
void SAL_CALL disposeAndClear( const ::com::sun::star::lang::EventObject & rEvt ) SAL_THROW( () );
/**
Remove all elements of all containers. Does not delete the container.
*/
void SAL_CALL clear() SAL_THROW( () );
typedef ::com::sun::star::uno::Type keyType;
private:
void *m_pMap;
::osl::Mutex & rMutex;
inline OMultiTypeInterfaceContainerHelper( const OMultiTypeInterfaceContainerHelper & ) SAL_THROW( () );
inline OMultiTypeInterfaceContainerHelper & operator = ( const OMultiTypeInterfaceContainerHelper & ) SAL_THROW( () );
};
typedef OBroadcastHelperVar< OMultiTypeInterfaceContainerHelper , OMultiTypeInterfaceContainerHelper::keyType > OBroadcastHelper;
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|