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
|
/*************************************************************************
*
* 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 __FRAMEWORK_SERVICES_PLUGINFRAME_HXX_
#define __FRAMEWORK_SERVICES_PLUGINFRAME_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#include <services/frame.hxx>
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/mozilla/XPluginInstance.hpp>
#include <com/sun/star/mozilla/XPluginInstancePeer.hpp>
#include <com/sun/star/mozilla/XPluginWindowPeer.hpp>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/awt/XWindow.hpp>
#include <com/sun/star/frame/XDispatchResultListener.hpp>
#include <com/sun/star/frame/FeatureStateEvent.hpp>
#include <com/sun/star/lang/EventObject.hpp>
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#ifndef _VCL_ATOM_HXX
#include <vcl/threadex.hxx>
#endif
#include <unotools/cmdoptions.hxx>
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// exported const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// exported definitions
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short implements an special frame - a plugin frame
@descr -
@implements XInitialization
XPluginInstance
XDispatchResultListener
@base Frame
*//*-*************************************************************************************************************/
class PlugInFrame : public css::lang::XInitialization ,
public css::mozilla::XPluginInstance ,
public css::frame::XDispatchResultListener , // => XEVENTLISTENER
public Frame // Order of baseclasses is neccessary for right initialization!
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short standard constructor to create instance
@descr This constructor initialize a new instance of this class,
and will be set valid values on his member and baseclasses.
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
PlugInFrame( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
/*-****************************************************************************************************//**
@short standard destructor
@descr This method destruct an instance of this class and clear some member.
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual ~PlugInFrame();
//---------------------------------------------------------------------------------------------------------
// XInterface, XTypeProvider, XServiceInfo
//---------------------------------------------------------------------------------------------------------
DECLARE_XINTERFACE
DECLARE_XTYPEPROVIDER
DECLARE_XSERVICEINFO
//---------------------------------------------------------------------------------------------------------
// XInitialization
//---------------------------------------------------------------------------------------------------------
void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& seqArguments ) throw( css::uno::Exception ,
css::uno::RuntimeException );
//---------------------------------------------------------------------------------------------------------
// XPluginInstance
//---------------------------------------------------------------------------------------------------------
void SAL_CALL start () throw( css::uno::RuntimeException );
void SAL_CALL implcb_start () throw( css::uno::RuntimeException );
void SAL_CALL stop () throw( css::uno::RuntimeException );
void SAL_CALL implcb_stop () throw( css::uno::RuntimeException );
void SAL_CALL destroy () throw( css::uno::RuntimeException );
void SAL_CALL implcb_destroy() throw( css::uno::RuntimeException );
void SAL_CALL createWindow ( const css::uno::Any& aPlatformWindowHandle ,
sal_Bool bEmbedded ) throw( css::uno::RuntimeException );
void SAL_CALL implcb_createWindow ( const css::uno::Any& aPlatformWindowHandle ,
sal_Bool bEmbedded ) throw( css::uno::RuntimeException );
void SAL_CALL newStream ( const ::rtl::OUString& sMIMEDescription,
const ::rtl::OUString& sURL ,
const ::rtl::OUString& sFilter ,
const css::uno::Reference< css::io::XInputStream >& xStream ,
const css::uno::Any& aSessionId ) throw( css::uno::RuntimeException );
void SAL_CALL implcb_newStream
( const ::rtl::OUString& sMIMEDescription,
const ::rtl::OUString& sURL ,
const ::rtl::OUString& sFilter ,
const css::uno::Reference< css::io::XInputStream >& xStream ,
const css::uno::Any& aSessionId ) throw( css::uno::RuntimeException );
void SAL_CALL newURL ( const ::rtl::OUString& sMIMEDescription,
const ::rtl::OUString& sURL ,
const ::rtl::OUString& sFilter ,
const css::uno::Any& aSessionId ) throw( css::uno::RuntimeException );
void SAL_CALL implcb_newURL ( const ::rtl::OUString& sMIMEDescription,
const ::rtl::OUString& sURL ,
const ::rtl::OUString& sFilter ,
const css::uno::Any& aSessionId ) throw( css::uno::RuntimeException );
virtual void SAL_CALL getHttpServerURL( ::rtl::OUString& sHost ,
sal_uInt16& nPort ,
::rtl::OUString& sPrefix ) throw( css::uno::RuntimeException );
//---------------------------------------------------------------------------------------------------------
// XDispatchProvider
//---------------------------------------------------------------------------------------------------------
virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch( const css::util::URL& aURL ,
const ::rtl::OUString& sTargetFrameName,
sal_Int32 nSearchFlags ) throw( css::uno::RuntimeException );
virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& seqDescripts ) throw( css::uno::RuntimeException );
//---------------------------------------------------------------------------------------------------------
// XDispatchResultListener
//---------------------------------------------------------------------------------------------------------
virtual void SAL_CALL dispatchFinished ( const css::frame::DispatchResultEvent& aEvent ) throw( css::uno::RuntimeException );
//---------------------------------------------------------------------------------------------------------
// XEventListener
//---------------------------------------------------------------------------------------------------------
void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
//-------------------------------------------------------------------------------------------------------------
// protected methods
//-------------------------------------------------------------------------------------------------------------
protected:
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
void impl_tryToLoadDocument();
sal_Bool impl_registerRemoteFactories( const css::uno::Reference< css::lang::XMultiServiceFactory >& xRemoteServiceManager );
//-------------------------------------------------------------------------------------------------------------
// debug methods
// (should be private everyway!)
//-------------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short debug-method to check incoming parameter of some other mehods of this class
@descr The following methods are used to check parameters for other methods
of this class. The return value is used directly for an ASSERT(...).
@seealso ASSERTs in implementation!
@param references to checking variables
@return sal_False on invalid parameter<BR>
sal_True otherway
@onerror -
*//*-*****************************************************************************************************/
#ifdef ENABLE_ASSERTIONS
private:
static sal_Bool impldbg_checkParameter_initialize ( const css::uno::Sequence< css::uno::Any >& seqArguments );
static sal_Bool impldbg_checkParameter_createWindow ( const css::uno::Any& aPlatformWindowHandle ,
sal_Bool bEmbedded );
static sal_Bool impldbg_checkParameter_newStream ( const ::rtl::OUString& sMIMEDescription ,
const ::rtl::OUString& sURL ,
const ::rtl::OUString& sFilter ,
const css::uno::Reference< css::io::XInputStream >& xStream );
static sal_Bool impldbg_checkParameter_newURL ( const ::rtl::OUString& sMIMEDescription ,
const ::rtl::OUString& sURL ,
const ::rtl::OUString& sFilter );
static sal_Bool impldbg_checkParameter_getHttpServerURL ( ::rtl::OUString& sHost ,
sal_uInt16& nPort ,
::rtl::OUString& sPrefix );
static sal_Bool impldbg_checkParameter_queryDispatch ( const css::util::URL& aURL ,
const ::rtl::OUString& sTargetFrameName ,
sal_Int32 nSearchFlags );
static sal_Bool impldbg_checkParameter_queryDispatches ( const css::uno::Sequence< css::frame::DispatchDescriptor >& seqDescripts );
static sal_Bool impldbg_checkParameter_statusChanged ( const css::frame::FeatureStateEvent& aEvent );
static sal_Bool impldbg_checkParameter_disposing ( const css::lang::EventObject& aEvent );
#endif // #ifdef ENABLE_ASSERTIONS
//-------------------------------------------------------------------------------------------------------------
// variables
// (should be private everyway!)
//-------------------------------------------------------------------------------------------------------------
private:
css::uno::Reference< css::mozilla::XPluginInstancePeer > m_xPlugInInstancePeer ; /// Reference to UNO interface of PlugIn dll for communication with browser
css::uno::Reference< css::mozilla::XPluginWindowPeer > m_xPlugInWindowPeer ; /// Reference to set child window at plugin window
css::uno::Sequence< css::beans::PropertyValue > m_seqProperties ; /// Sequence of properties as arguments for load document
css::util::URL m_aURL ; /// URL for document to load
sal_Bool m_bILoad ; /// PlugInFrame has a valid loader which load the document and wait for finished/cancelled
sal_Bool m_bIHaveDocument ; /// We have a document loaded successful.
css::uno::Reference< css::frame::XDispatchProvider > m_xPlugInDispatcher ; /// Dispatcher to forward dispatches to browser
static sal_Bool m_bRemoteFactoriesExist ; /// indicates, if remote factories was already registered (neccessary one times only!)
SvtCommandOptions m_aCommandOptions ; /// ref counted class to support disabling commands defined by configuration file
}; // class PlugInFrame
/*-************************************************************************************************************//**
@short used to forward all asynchronous calls which use VCL internal to the main thread
@descr We need this asynchronous mechanism to prevent us against dead locks. Sometimes our main thread
can call us for event handling like FOCUS, ACTIVATE and something else. But at the same time we will call
the main thread to CREATE A WINDOW, SET IT VISIBLE ... Then we have a problem. We must send us himself a event
to run our code synchronized with our main thread!
@implements
@base -
*//*-*************************************************************************************************************/
enum eIMPL_PluginCommand
{
START ,
STOP ,
CREATEWINDOW ,
DESTROY ,
NEWSTREAM ,
NEWURL
};
class cIMPL_MainThreadExecutorRequest
{
public:
cIMPL_MainThreadExecutorRequest( eIMPL_PluginCommand eCommand ,
PlugInFrame* pPluginInstance );
cIMPL_MainThreadExecutorRequest( eIMPL_PluginCommand eCommand ,
PlugInFrame* pPluginInstance ,
const css::uno::Any& aPlatformWindowHandle ,
sal_Bool bEmbedded );
cIMPL_MainThreadExecutorRequest( eIMPL_PluginCommand eCommand ,
PlugInFrame* pPluginInstance ,
const ::rtl::OUString& sMIMEDescription ,
const ::rtl::OUString& sURL ,
const ::rtl::OUString& sFilter ,
const css::uno::Reference< css::io::XInputStream >& xStream ,
const css::uno::Any& aSessionId );
/*-****************************************************************************************************//**
@short -
@descr -
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual long doIt();
//-------------------------------------------------------------------------------------------------------------
// private variables
//-------------------------------------------------------------------------------------------------------------
private:
eIMPL_PluginCommand m_eCommand ; /// switch to specify forward function
PlugInFrame* m_pPluginInstance ; /// instance wich has started this swicth mechanism and wish to called back from us
css::uno::Reference< css::uno::XInterface > m_xPluginInstance ; /// reference to our plugin frame to prevent that plugin frame dies before we call back
css::uno::Any m_aPlatformWindowHandle ; /// parameter for XPluginInstance->createWindow()
sal_Bool m_bEmbedded ; /// parameter for XPluginInstance->createWindow()
::rtl::OUString m_sMIMEDescription ; /// parameter for XPluginInstance->newStream()/newURL()
::rtl::OUString m_sURL ; /// parameter for XPluginInstance->newStream()/newURL()
::rtl::OUString m_sFilter ; /// parameter for XPluginInstance->newStream()/newURL()
css::uno::Reference< css::io::XInputStream > m_xStream ; /// parameter for XPluginInstance->newStream()/newURL()
css::uno::Any m_aSessionId ; /// parameter for XPluginInstance->newStream()/newURL()
};
class cIMPL_MainThreadExecutor
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
static void execute( cIMPL_MainThreadExecutorRequest* pRequest );
/*-****************************************************************************************************//**
@short -
@descr -
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
DECL_STATIC_LINK( cIMPL_MainThreadExecutor, worker, cIMPL_MainThreadExecutorRequest* );
};
} // namespace framework
#endif // #ifndef __FRAMEWORK_SERVICES_PLUGINFRAME_HXX_
|
