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
|
/* -*- 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 <helper/ocomponentenumeration.hxx>
#include <vcl/svapp.hxx>
namespace framework{
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::uno;
using namespace ::cppu;
using namespace ::osl;
using namespace ::rtl;
// constructor
OComponentEnumeration::OComponentEnumeration( const Sequence< css::uno::Reference< XComponent > >& seqComponents )
: m_nPosition ( 0 ) // 0 is the first position for a valid list and the right value for an invalid list to!
, m_seqComponents ( seqComponents )
{
// Safe impossible states
// "Method" not defined for ALL parameters!
SAL_WARN_IF( !impldbg_checkParameter_OComponentEnumerationCtor( seqComponents ), "fwk", "OComponentEnumeration::OComponentEnumeration(): Invalid parameter detected!" );
}
// destructor
OComponentEnumeration::~OComponentEnumeration()
{
// Reset instance, free memory ....
impl_resetObject();
}
// XEventListener
void SAL_CALL OComponentEnumeration::disposing( const EventObject& aEvent ) throw( RuntimeException, std::exception )
{
SolarMutexGuard g;
// Safe impossible cases
// This method is not specified for all incoming parameters.
(void) aEvent;
SAL_WARN_IF( !impldbg_checkParameter_disposing( aEvent ), "fwk", "OComponentEnumeration::disposing(): Invalid parameter detected!" );
// Reset instance to defaults, release references and free memory.
impl_resetObject();
}
// XEnumeration
sal_Bool SAL_CALL OComponentEnumeration::hasMoreElements() throw( RuntimeException, std::exception )
{
SolarMutexGuard g;
// First position in a valid list is 0.
// => The last one is getLength() - 1!
// m_nPosition's current value is the position for the next element, which will be return, if user call "nextElement()"
// => We have more elements if current position less then the length of the list!
return ( m_nPosition < (sal_uInt32)(m_seqComponents.getLength()) );
}
// XEnumeration
Any SAL_CALL OComponentEnumeration::nextElement() throw( NoSuchElementException ,
WrappedTargetException ,
RuntimeException, std::exception )
{
SolarMutexGuard g;
// If we have no elements or end of enumeration is arrived ...
if ( hasMoreElements() == sal_False )
{
// .. throw an exception!
throw NoSuchElementException();
}
// Else; Get next element from list ...
Any aComponent;
aComponent <<= m_seqComponents[m_nPosition];
// ... and step to next element!
++m_nPosition;
// Return listitem.
return aComponent;
}
// proteced method
void OComponentEnumeration::impl_resetObject()
{
// Attention:
// Write this for multiple calls - NOT AT THE SAME TIME - but for more then one call again)!
// It exist two ways to call this method. From destructor and from disposing().
// I can't say, which one is the first. Normaly the disposing-call - but other way ....
// Delete list of components.
m_seqComponents.realloc( 0 );
// Reset position in list.
// The list has no elements anymore. m_nPosition is normaly the current position in list for nextElement!
// But a position of 0 in a list of 0 items is an invalid state. This constellation can't work in future.
// End of enumeration is arrived!
// (see hasMoreElements() for more details...)
m_nPosition = 0;
}
// debug methods
/*-----------------------------------------------------------------------------------------------------------------
The follow methods checks the parameter for other functions. If a parameter or his value is non valid,
we return "sal_False". (else sal_True) This mechanism is used to throw an ASSERT!
ATTENTION
If you miss a test for one of this parameters, contact the author or add it himself !(?)
But ... look for right testing! See using of this methods!
-----------------------------------------------------------------------------------------------------------------*/
// An empty list is allowed ... hasMoreElements() will return false then!
bool OComponentEnumeration::impldbg_checkParameter_OComponentEnumerationCtor( const Sequence< css::uno::Reference< XComponent > >& seqComponents )
{
// Set default return value.
bool bOK = true;
// Check parameter.
if (
( &seqComponents == NULL )
)
{
bOK = false;
}
// Return result of check.
return bOK;
}
bool OComponentEnumeration::impldbg_checkParameter_disposing( const EventObject& aEvent )
{
return aEvent.Source.is();
}
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
