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
|
/* -*- 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 .
*/
#ifndef __FRAMEWORK_JOBS_JOB_HXX_
#define __FRAMEWORK_JOBS_JOB_HXX_
#include <jobs/jobresult.hxx>
#include <jobs/jobdata.hxx>
#include <threadhelp/threadhelpbase.hxx>
#include <macros/debug.hxx>
#include <macros/xinterface.hxx>
#include <macros/xtypeprovider.hxx>
#include <stdtypes.h>
#include <general.h>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/XDesktop.hpp>
#include <com/sun/star/frame/XDispatchResultListener.hpp>
#include <com/sun/star/task/XJobListener.hpp>
#include <com/sun/star/util/XCloseListener.hpp>
#include <com/sun/star/frame/DispatchResultEvent.hpp>
#include <cppuhelper/weak.hxx>
#include <rtl/ustring.hxx>
//_______________________________________
// namespace
namespace framework{
//_______________________________________
// public const
//_______________________________________
// definitions
/**
@short it represent a job; execute it and control it's lifetime
@descr This implemetation can be used to wrapp jobs, execute it
synchronously or asynchronous, control it's lifetime
and differe between jobs with and without configuration.
*/
class Job : public css::lang::XTypeProvider
, public css::task::XJobListener
, public css::frame::XTerminateListener
, public css::util::XCloseListener
, private ThreadHelpBase
, public ::cppu::OWeakObject
{
//___________________________________
// structs
private:
/** different possible states for the internal wrapped job.
It can be started, stopped by a queryClosing() request or
disposed() by a notifyClosing() request ...
*/
enum ERunState
{
E_NEW,
E_RUNNING,
E_STOPPED_OR_FINISHED,
E_DISPOSED
};
//___________________________________
// member
private:
/**
hold all neccessary informations about this job.
It can be used for both modes: with and without configuration.
*/
JobData m_aJobCfg;
/**
We need it to create own services on demand.
*/
css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
/**
Hold the (may asynchronous) job alive.
*/
css::uno::Reference< css::uno::XInterface > m_xJob;
/**
Used to wait for finishing of asynchronous started jobs.
*/
::osl::Condition m_aAsyncWait;
/**
For some special cases we must know the environment, in which
this job runs. Means the frame inside which we may was triggered.
We use it too, to listen for closing events of this resource.
Please note: If m_xFrame is set - m_xModel should be NULL.
Only one environment can be supported realy.
*/
css::uno::Reference< css::frame::XFrame > m_xFrame;
/**
For some special cases we must know the environment, in which
this job runs. Means the document inside which we may was triggered.
We use it too, to listen for closing events of this resource.
Please note: If m_xModel is set - m_xFrame should be NULL.
Only one environment can be supported realy.
*/
css::uno::Reference< css::frame::XModel > m_xModel;
/**
We are registered at this instance to listen for office shutdown events.
It's neccessary supress it (if possible) or to react in the right way.
*/
css::uno::Reference< css::frame::XDesktop > m_xDesktop;
/**
A job can return a dispatch result event after finishing its work.
We have to transport it to any outside interested listener then.
(see m_xResultSourceFake for further informations too!)
*/
css::uno::Reference< css::frame::XDispatchResultListener > m_xResultListener;
/**
We can't set ourself as source of a dispatch result event ... nor our job.
Because the listener (set as m_xResultListener) expect the original instance,
where it was registered. This original instance is the user of this class.
It must be set explicitly and will be used to fake the source of the event!
*/
css::uno::Reference< css::uno::XInterface > m_xResultSourceFake;
/**
Holds the state, if we are listen for desktop/frame or model closing events or not.
The used references are not realy enough to detect a valid listener connection.
Thats why we use this additional information here too.
*/
sal_Bool m_bListenOnDesktop;
sal_Bool m_bListenOnFrame;
sal_Bool m_bListenOnModel;
/**
In case we got a close request from our desktop/frame/model (on which we listen) ... and
the ownership was delivered there ... we have to close ourself and this object
in case the internal wrapped and running job finish his work.
*/
sal_Bool m_bPendingCloseFrame;
sal_Bool m_bPendingCloseModel;
/**
indicates in which state the internal job currently exist.
We can use this information to throw any suitable veto exception
to prevent the environment against dieing or supress superflous dispose()
calls at the job.
*/
ERunState m_eRunState;
//___________________________________
// native interface
public:
Job( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ,
const css::uno::Reference< css::frame::XFrame >& xFrame );
Job( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ,
const css::uno::Reference< css::frame::XModel >& xModel );
virtual ~Job( );
void setDispatchResultFake( const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ,
const css::uno::Reference< css::uno::XInterface >& xSourceFake );
void setJobData ( const JobData& aData );
void execute ( const css::uno::Sequence< css::beans::NamedValue >& lDynamicArgs );
void die ( );
private:
css::uno::Sequence< css::beans::NamedValue > impl_generateJobArgs ( const css::uno::Sequence< css::beans::NamedValue >& lDynamicArgs );
void impl_reactForJobResult( const css::uno::Any& aResult );
void impl_startListening ( );
void impl_stopListening ( );
//___________________________________
// uno interface
public:
FWK_DECLARE_XINTERFACE
FWK_DECLARE_XTYPEPROVIDER
// XJobListener
virtual void SAL_CALL jobFinished( const css::uno::Reference< css::task::XAsyncJob >& xJob,
const css::uno::Any& aResult ) throw(css::uno::RuntimeException);
// XTerminateListener
virtual void SAL_CALL queryTermination ( const css::lang::EventObject& aEvent ) throw(css::frame::TerminationVetoException,
css::uno::RuntimeException );
virtual void SAL_CALL notifyTermination( const css::lang::EventObject& aEvent ) throw(css::uno::RuntimeException );
// XCloseListener
virtual void SAL_CALL queryClosing ( const css::lang::EventObject& aEvent ,
sal_Bool bGetsOwnership ) throw(css::util::CloseVetoException,
css::uno::RuntimeException );
virtual void SAL_CALL notifyClosing( const css::lang::EventObject& aEvent ) throw(css::uno::RuntimeException );
// XEventListener
virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw(css::uno::RuntimeException);
};
} // namespace framework
#endif // __FRAMEWORK_JOBS_JOB_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
