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 | /* -*- 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 <framework/framelistanalyzer.hxx>
#include <targets.h>
#include <properties.h>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <com/sun/star/frame/ModuleManager.hpp>
#include <com/sun/star/frame/UnknownModuleException.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <comphelper/processfactory.hxx>
#include <tools/diagnose_ex.h>
#include <sal/log.hxx>
namespace framework{
FrameListAnalyzer::FrameListAnalyzer( const css::uno::Reference< css::frame::XFramesSupplier >& xSupplier ,
const css::uno::Reference< css::frame::XFrame >& xReferenceFrame ,
FrameAnalyzerFlags eDetectMode )
: m_xSupplier (xSupplier )
, m_xReferenceFrame(xReferenceFrame)
, m_eDetectMode (eDetectMode )
{
impl_analyze();
}
FrameListAnalyzer::~FrameListAnalyzer()
{
}
/** returns an analyzed list of all currently opened (top!) frames inside the desktop tree.
We try to get a snapshot of all opened frames, which are part of the desktop frame container.
Of course we can't access frames, which stands outside of this tree.
But it's necessary to collect top frames here only. Otherwise we interpret closing of last
frame wrong. Further we analyze this list and split into different parts.
E.g. for "CloseDoc" we must know, which frames of the given list refer to the same model.
These frames must be closed then. But all other frames must be untouched.
In case the request was "CloseWin" these split lists can be used too, to decide if the last window
or document was closed. Then we have to initialize the backing window...
Last but not least we must know something about our special help frame. It must be handled
separately. And last but not least - the backing component frame must be detected too.
*/
void FrameListAnalyzer::impl_analyze()
{
// reset all members to get a consistent state
m_bReferenceIsHidden = false;
m_bReferenceIsHelp = false;
m_bReferenceIsBacking = false;
m_xHelp.clear();
m_xBackingComponent.clear();
// try to get the task container by using the given supplier
css::uno::Reference< css::container::XIndexAccess > xFrameContainer = m_xSupplier->getFrames();
// All return list get an initial size to include all possible frames.
// They will be packed at the end of this method ... using the actual step positions then.
sal_Int32 nVisibleStep = 0;
sal_Int32 nHiddenStep = 0;
sal_Int32 nModelStep = 0;
sal_Int32 nCount = xFrameContainer->getCount();
m_lOtherVisibleFrames.resize(nCount);
m_lOtherHiddenFrames.resize(nCount);
m_lModelFrames.resize(nCount);
// ask for the model of the given reference frame.
// It must be compared with the model of every frame of the container
// to sort it into the list of frames with the same model.
// Suppress this step, if right detect mode isn't set.
css::uno::Reference< css::frame::XModel > xReferenceModel;
if (m_eDetectMode & FrameAnalyzerFlags::Model)
{
css::uno::Reference< css::frame::XController > xReferenceController;
if (m_xReferenceFrame.is())
xReferenceController = m_xReferenceFrame->getController();
if (xReferenceController.is())
xReferenceModel = xReferenceController->getModel();
}
// check, if the reference frame is in hidden mode.
// But look, if this analyze step is really needed.
css::uno::Reference< css::beans::XPropertySet > xSet(m_xReferenceFrame, css::uno::UNO_QUERY);
if ( (m_eDetectMode & FrameAnalyzerFlags::Hidden) && xSet.is() )
{
xSet->getPropertyValue(FRAME_PROPNAME_ASCII_ISHIDDEN) >>= m_bReferenceIsHidden;
}
// check, if the reference frame includes the backing component.
// But look, if this analyze step is really needed.
if ((m_eDetectMode & FrameAnalyzerFlags::BackingComponent) && m_xReferenceFrame.is() )
{
try
{
css::uno::Reference< css::uno::XComponentContext > xContext = ::comphelper::getProcessComponentContext();
css::uno::Reference< css::frame::XModuleManager2 > xModuleMgr = css::frame::ModuleManager::create(xContext);
OUString sModule = xModuleMgr->identify(m_xReferenceFrame);
m_bReferenceIsBacking = sModule == "com.sun.star.frame.StartModule";
}
catch(const css::frame::UnknownModuleException&)
{
}
catch(const css::uno::Exception&)
{
DBG_UNHANDLED_EXCEPTION("fwk");
}
}
// check, if the reference frame includes the help module.
// But look, if this analyze step is really needed.
if (
(m_eDetectMode & FrameAnalyzerFlags::Help) &&
(m_xReferenceFrame.is() ) &&
(m_xReferenceFrame->getName() == SPECIALTARGET_HELPTASK)
)
{
m_bReferenceIsHelp = true;
}
try
{
// Step over all frames of the desktop frame container and analyze it.
for (sal_Int32 i=0; i<nCount; ++i)
{
// Ignore invalid items ... and of course the reference frame.
// It will be a member of the given frame list too - but it was already
// analyzed before!
css::uno::Reference< css::frame::XFrame > xFrame;
if (
!(xFrameContainer->getByIndex(i) >>= xFrame) ||
!(xFrame.is() ) ||
(xFrame==m_xReferenceFrame )
)
continue;
if (
(m_eDetectMode & FrameAnalyzerFlags::Zombie) &&
(
(!xFrame->getContainerWindow().is()) ||
(!xFrame->getComponentWindow().is())
)
)
{
SAL_INFO("fwk", "FrameListAnalyzer::impl_analyze(): ZOMBIE!");
}
// a) Is it the special help task?
// Return it separated from any return list.
if (
(m_eDetectMode & FrameAnalyzerFlags::Help) &&
(xFrame->getName()==SPECIALTARGET_HELPTASK)
)
{
m_xHelp = xFrame;
continue;
}
// b) Or is includes this task the special backing component?
// Return it separated from any return list.
// But check if the reference task itself is the backing frame.
// Our user must know it to decide right.
if (m_eDetectMode & FrameAnalyzerFlags::BackingComponent)
{
try
{
css::uno::Reference< css::uno::XComponentContext > xContext = ::comphelper::getProcessComponentContext();
css::uno::Reference< css::frame::XModuleManager2 > xModuleMgr = css::frame::ModuleManager::create(xContext);
OUString sModule = xModuleMgr->identify(xFrame);
if (sModule == "com.sun.star.frame.StartModule")
{
m_xBackingComponent = xFrame;
continue;
}
}
catch (const css::uno::Exception&)
{
}
}
// c) Or is it the a task, which uses the specified model?
// Add it to the list of "model frames".
if (m_eDetectMode & FrameAnalyzerFlags::Model)
{
css::uno::Reference< css::frame::XController > xController = xFrame->getController();
css::uno::Reference< css::frame::XModel > xModel;
if (xController.is())
xModel = xController->getModel();
if (xModel==xReferenceModel)
{
m_lModelFrames[nModelStep] = xFrame;
++nModelStep;
continue;
}
}
// d) Or is it the a task, which use another or no model at all?
// Add it to the list of "other frames". But look for its
// visible state ... if it's allowed to do so.
bool bHidden = false;<--- Assignment 'bHidden=false', assigned value is 0
if (m_eDetectMode & FrameAnalyzerFlags::Hidden)
{
xSet.set(xFrame, css::uno::UNO_QUERY);
if (xSet.is())
{
xSet->getPropertyValue(FRAME_PROPNAME_ASCII_ISHIDDEN) >>= bHidden;
}
}
if (bHidden)<--- Condition 'bHidden' is always false
{
m_lOtherHiddenFrames[nHiddenStep] = xFrame;
++nHiddenStep;
}
else
{
m_lOtherVisibleFrames[nVisibleStep] = xFrame;
++nVisibleStep;
}
}
}
catch (const css::lang::IndexOutOfBoundsException&)
{
// stop copying if index seems to be wrong.
// This interface can't really guarantee its count for multithreaded
// environments. So it can occur!
}
// Pack both lists by using the actual step positions.
// All empty or ignorable items should exist at the end of these lists
// behind the position pointers. So they will be removed by a reallocation.
m_lOtherVisibleFrames.resize(nVisibleStep);
m_lOtherHiddenFrames.resize(nHiddenStep);
m_lModelFrames.resize(nModelStep);
}
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|