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
|
/* -*- 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 OOX_HELPER_REFMAP_HXX
#define OOX_HELPER_REFMAP_HXX
#include <map>
#include <boost/bind.hpp>
#include <boost/shared_ptr.hpp>
#include <sal/types.h>
namespace oox {
// ============================================================================
/** Template for a map of ref-counted objects with additional accessor functions.
An instance of the class RefMap< Type > stores elements of the type
::boost::shared_ptr< Type >. The new accessor functions has() and get()
work correctly for nonexisting keys, there is no need to check the passed
key before.
*/
template< typename KeyType, typename ObjType, typename CompType = ::std::less< KeyType > >
class RefMap : public ::std::map< KeyType, ::boost::shared_ptr< ObjType >, CompType >
{
public:
typedef ::std::map< KeyType, ::boost::shared_ptr< ObjType >, CompType > container_type;
typedef typename container_type::key_type key_type;
typedef typename container_type::mapped_type mapped_type;
typedef typename container_type::value_type value_type;
typedef typename container_type::key_compare key_compare;
public:
/** Returns true, if the object associated to the passed key exists.
Returns false, if the key exists but points to an empty reference. */
inline bool has( key_type nKey ) const
{
const mapped_type* pxRef = getRef( nKey );
return pxRef && pxRef->get();
}
/** Returns a reference to the object associated to the passed key, or an
empty reference on error. */
inline mapped_type get( key_type nKey ) const
{
if( const mapped_type* pxRef = getRef( nKey ) ) return *pxRef;
return mapped_type();
}
/** Calls the passed functor for every contained object, automatically
skips all elements that are empty references. */
template< typename FunctorType >
inline void forEach( const FunctorType& rFunctor ) const
{
::std::for_each( this->begin(), this->end(), ForEachFunctor< FunctorType >( rFunctor ) );
}
/** Calls the passed member function of ObjType on every contained object,
automatically skips all elements that are empty references. */
template< typename FuncType >
inline void forEachMem( FuncType pFunc ) const
{
forEach( ::boost::bind( pFunc, _1 ) );
}
/** Calls the passed member function of ObjType on every contained object,
automatically skips all elements that are empty references. */
template< typename FuncType, typename ParamType >
inline void forEachMem( FuncType pFunc, ParamType aParam ) const
{
forEach( ::boost::bind( pFunc, _1, aParam ) );
}
/** Calls the passed member function of ObjType on every contained object,
automatically skips all elements that are empty references. */
template< typename FuncType, typename ParamType1, typename ParamType2 >
inline void forEachMem( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2 ) const
{
forEach( ::boost::bind( pFunc, _1, aParam1, aParam2 ) );
}
/** Calls the passed member function of ObjType on every contained object,
automatically skips all elements that are empty references. */
template< typename FuncType, typename ParamType1, typename ParamType2, typename ParamType3 >
inline void forEachMem( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2, ParamType3 aParam3 ) const
{
forEach( ::boost::bind( pFunc, _1, aParam1, aParam2, aParam3 ) );
}
/** Calls the passed member function of ObjType on every contained object,
automatically skips all elements that are empty references. */
template< typename FuncType, typename ParamType1, typename ParamType2, typename ParamType3, typename ParamType4 >
inline void forEachMem( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2, ParamType3 aParam3, ParamType4 aParam4 ) const
{
forEach( ::boost::bind( pFunc, _1, aParam1, aParam2, aParam3, aParam4 ) );
}
/** Calls the passed functor for every contained object. Passes the key as
first argument and the object reference as second argument to rFunctor. */
template< typename FunctorType >
inline void forEachWithKey( const FunctorType& rFunctor ) const
{
::std::for_each( this->begin(), this->end(), ForEachFunctorWithKey< FunctorType >( rFunctor ) );
}
/** Calls the passed member function of ObjType on every contained object.
Passes the object key as argument to the member function. */
template< typename FuncType >
inline void forEachMemWithKey( FuncType pFunc ) const
{
forEachWithKey( ::boost::bind( pFunc, _2, _1 ) );
}
/** Calls the passed member function of ObjType on every contained object.
Passes the object key as first argument to the member function. */
template< typename FuncType, typename ParamType >
inline void forEachMemWithKey( FuncType pFunc, ParamType aParam ) const
{
forEachWithKey( ::boost::bind( pFunc, _2, _1, aParam ) );
}
/** Calls the passed member function of ObjType on every contained object.
Passes the object key as first argument to the member function. */
template< typename FuncType, typename ParamType1, typename ParamType2 >
inline void forEachMemWithKey( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2 ) const
{
forEachWithKey( ::boost::bind( pFunc, _2, _1, aParam1, aParam2 ) );
}
/** Calls the passed member function of ObjType on every contained object.
Passes the object key as first argument to the member function. */
template< typename FuncType, typename ParamType1, typename ParamType2, typename ParamType3 >
inline void forEachMemWithKey( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2, ParamType3 aParam3 ) const
{
forEachWithKey( ::boost::bind( pFunc, _2, _1, aParam1, aParam2, aParam3 ) );
}
private:
template< typename FunctorType >
struct ForEachFunctor
{
FunctorType maFunctor;
inline explicit ForEachFunctor( const FunctorType& rFunctor ) : maFunctor( rFunctor ) {}
inline void operator()( const value_type& rValue ) { if( rValue.second.get() ) maFunctor( *rValue.second ); }
};
template< typename FunctorType >
struct ForEachFunctorWithKey
{
FunctorType maFunctor;
inline explicit ForEachFunctorWithKey( const FunctorType& rFunctor ) : maFunctor( rFunctor ) {}
inline void operator()( const value_type& rValue ) { if( rValue.second.get() ) maFunctor( rValue.first, *rValue.second ); }
};
inline const mapped_type* getRef( key_type nKey ) const
{
typename container_type::const_iterator aIt = this->find( nKey );
return (aIt == this->end()) ? 0 : &aIt->second;
}
};
// ============================================================================
} // namespace oox
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
