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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
/* -*- 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 INCLUDED_EMBEDDEDOBJ_SOURCE_INC_OLEEMBOBJ_HXX
#define INCLUDED_EMBEDDEDOBJ_SOURCE_INC_OLEEMBOBJ_HXX
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/embed/XEmbeddedObject.hpp>
#include <com/sun/star/embed/XEmbeddedOleObject.hpp>
#include <com/sun/star/embed/XInplaceObject.hpp>
#include <com/sun/star/embed/XVisualObject.hpp>
#include <com/sun/star/embed/XEmbedPersist.hpp>
#include <com/sun/star/embed/XLinkageSupport.hpp>
#include <com/sun/star/embed/XClassifiedObject.hpp>
#include <com/sun/star/embed/XComponentSupplier.hpp>
#include <com/sun/star/embed/VerbDescriptor.hpp>
#include <com/sun/star/document/XEventBroadcaster.hpp>
#include <com/sun/star/container/XChild.hpp>
#include <com/sun/star/util/XCloseable.hpp>
#include <com/sun/star/util/XCloseListener.hpp>
#include <com/sun/star/io/XActiveDataStreamer.hpp>
#include <cppuhelper/implbase.hxx>
#include <rtl/ref.hxx>
#include <osl/thread.h>
namespace cppu {
class OMultiTypeInterfaceContainerHelper;
}
class VerbExecutionController
{
// the following mutex is allowed to be locked only for variables initialization, so no deadlock can be caused
::osl::Mutex m_aVerbExecutionMutex;
sal_Int32 m_nNotificationLock;
#ifdef _WIN32
bool m_bWasEverActive;
bool m_bVerbExecutionInProgress;
oslThreadIdentifier m_nVerbExecutionThreadIdentifier;
bool m_bChangedOnVerbExecution;
#endif
public:
VerbExecutionController()
: m_nNotificationLock( 0 )
#ifdef _WIN32
, m_bWasEverActive( false )
, m_bVerbExecutionInProgress( false )
, m_nVerbExecutionThreadIdentifier( 0 )
, m_bChangedOnVerbExecution( false )
#endif
{}
#ifdef _WIN32
void StartControlExecution();
bool EndControlExecution_WasModified();
void ModificationNotificationIsDone();
// no need to lock anything to check the value of the numeric members
bool CanDoNotification() { return ( !m_bVerbExecutionInProgress && !m_bWasEverActive && !m_nNotificationLock ); }
// ... or to change it
void ObjectIsActive() { m_bWasEverActive = true; }
#endif
void LockNotification();
void UnlockNotification();
};
class VerbExecutionControllerGuard
{
VerbExecutionController& m_rController;
public:
VerbExecutionControllerGuard( VerbExecutionController& rController )
: m_rController( rController )
{
m_rController.LockNotification();
}
~VerbExecutionControllerGuard()
{
m_rController.UnlockNotification();
}
};
class OleComponent;
class OwnView_Impl;
class OleEmbeddedObject : public ::cppu::WeakImplHelper
< css::embed::XEmbeddedObject
, css::embed::XEmbeddedOleObject
, css::embed::XEmbedPersist
, css::embed::XLinkageSupport
, css::embed::XInplaceObject
, css::container::XChild
, css::io::XActiveDataStreamer >
{
friend class OleComponent;
::osl::Mutex m_aMutex;
OleComponent* m_pOleComponent;
::cppu::OMultiTypeInterfaceContainerHelper* m_pInterfaceContainer;
bool m_bReadOnly;
bool m_bDisposed;
sal_Int32 m_nObjectState;
sal_Int32 m_nTargetState;
sal_Int32 m_nUpdateMode;
css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory;
css::uno::Sequence< sal_Int8 > m_aClassID;
OUString m_aClassName;
css::uno::Reference< css::embed::XEmbeddedClient > m_xClientSite;
OUString m_aContainerName;
css::uno::Reference< css::util::XCloseListener > m_xClosePreventer;
bool m_bWaitSaveCompleted;
bool m_bNewVisReplInStream;
css::uno::Reference< css::io::XStream > m_xNewCachedVisRepl;
OUString m_aNewEntryName;
css::uno::Reference< css::embed::XStorage > m_xNewParentStorage;
css::uno::Reference< css::io::XStream > m_xNewObjectStream;
bool m_bStoreLoaded;
css::uno::Reference< css::io::XStream > m_xCachedVisualRepresentation;
bool m_bVisReplInitialized;
bool m_bVisReplInStream;
bool m_bStoreVisRepl;
bool m_bIsLink;
// TODO/LATER: may need to cache more than one aspect in future
bool m_bHasCachedSize; // the object has cached size
css::awt::Size m_aCachedSize;
sal_Int64 m_nCachedAspect;
bool m_bHasSizeToSet; // the object has cached size that should be set to OLE component
css::awt::Size m_aSizeToSet; // this size might be different from the cached one ( scaling is applied )
sal_Int64 m_nAspectToSet;
// cache the status of the object
// TODO/LATER: may need to cache more than one aspect in future
bool m_bGotStatus;
sal_Int64 m_nStatus;
sal_Int64 m_nStatusAspect;
// embedded object related stuff
OUString m_aEntryName;
css::uno::Reference< css::embed::XStorage > m_xParentStorage;
css::uno::Reference< css::io::XStream > m_xObjectStream;
// link related stuff
OUString m_aLinkURL; // ???
// points to own view provider if the object has no server
rtl::Reference<OwnView_Impl> m_xOwnView;
// whether the object should be initialized from clipboard in case of default initialization
bool m_bFromClipboard;
OUString m_aTempURL;
OUString m_aTempDumpURL;
// STAMPIT solution
// the following member is used during verb execution to detect whether the verb execution modifies the object
VerbExecutionController m_aVerbExecutionController;
// if the following member is set, the object works in wrapper mode
css::uno::Reference< css::embed::XEmbeddedObject > m_xWrappedObject;
bool m_bTriedConversion;
OUString m_aFilterName; // if m_bTriedConversion, then the filter detected by that
css::uno::Reference< css::uno::XInterface > m_xParent;
protected:
/// @throws css::uno::Exception
css::uno::Reference< css::io::XStream > TryToGetAcceptableFormat_Impl(
const css::uno::Reference< css::io::XStream >& xStream );
/// @throws css::io::IOException
/// @throws css::uno::RuntimeException
css::uno::Reference< css::io::XStream > GetNewFilledTempStream_Impl(
const css::uno::Reference< css::io::XInputStream >& xInStream );
#ifdef _WIN32
void SwitchComponentToRunningState_Impl();
#endif
void MakeEventListenerNotification_Impl( const OUString& aEventName );
#ifdef _WIN32
void StateChangeNotification_Impl( bool bBeforeChange, sal_Int32 nOldState, sal_Int32 nNewState );
css::uno::Reference< css::io::XOutputStream > GetStreamForSaving();
css::uno::Sequence< sal_Int32 > GetIntermediateVerbsSequence_Impl( sal_Int32 nNewState );
static css::uno::Sequence< sal_Int32 > GetReachableStatesList_Impl(
const css::uno::Sequence< css::embed::VerbDescriptor >& aVerbList );
#endif
void Dispose();
void SwitchOwnPersistence(
const css::uno::Reference< css::embed::XStorage >& xNewParentStorage,
const css::uno::Reference< css::io::XStream >& xNewObjectStream,
const OUString& aNewName );
void SwitchOwnPersistence(
const css::uno::Reference< css::embed::XStorage >& xNewParentStorage,
const OUString& aNewName );
void GetRidOfComponent();
/// @throws css::uno::Exception
void StoreToLocation_Impl(
const css::uno::Reference< css::embed::XStorage >& xStorage,
const OUString& sEntName,
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs,
bool bSaveAs );
#ifdef _WIN32
/// @throws css::uno::Exception
void StoreObjectToStream( css::uno::Reference< css::io::XOutputStream > const & xOutStream );
#endif
/// @throws css::uno::Exception
void InsertVisualCache_Impl(
const css::uno::Reference< css::io::XStream >& xTargetStream,
const css::uno::Reference< css::io::XStream >& xCachedVisualRepresentation );
/// @throws css::uno::Exception
void RemoveVisualCache_Impl( const css::uno::Reference< css::io::XStream >& xTargetStream );
void SetVisReplInStream( bool bExists );
bool HasVisReplInStream();
/// @throws css::uno::Exception
css::embed::VisualRepresentation GetVisualRepresentationInNativeFormat_Impl(
const css::uno::Reference< css::io::XStream >& xCachedVisRepr );
css::uno::Reference< css::io::XStream > TryToRetrieveCachedVisualRepresentation_Impl(
const css::uno::Reference< css::io::XStream >& xStream,
bool bAllowRepair50 = false )
throw ();
#ifdef _WIN32
bool SaveObject_Impl();
bool OnShowWindow_Impl( bool bShow );
void CreateOleComponent_Impl( OleComponent* pOleComponent = nullptr );
void CreateOleComponentAndLoad_Impl( OleComponent* pOleComponent = nullptr );
void CreateOleComponentFromClipboard_Impl( OleComponent* pOleComponent = nullptr );
OUString CreateTempURLEmpty_Impl();
OUString GetTempURL_Impl();
void SetObjectIsLink_Impl( bool bIsLink ) { m_bIsLink = bIsLink; }
#endif
// the following 4 methods are related to switch to wrapping mode
void MoveListeners();
css::uno::Reference< css::embed::XStorage > CreateTemporarySubstorage( OUString& o_aStorageName );
OUString MoveToTemporarySubstream();
bool TryToConvertToOOo( const css::uno::Reference< css::io::XStream >& xStream );
public:
// in case a new object must be created the class ID must be specified
OleEmbeddedObject( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory,
const css::uno::Sequence< sal_Int8 >& aClassID,
const OUString& aClassName );
// in case object will be loaded from a persistent entry or from a file the class ID will be detected on loading
// factory can do it for OOo objects, but for OLE objects OS dependent code is required
OleEmbeddedObject( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory,
bool bLink );
#ifdef _WIN32
// this constructor let object be initialized from clipboard
OleEmbeddedObject( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
#endif
virtual ~OleEmbeddedObject() override;
#ifdef _WIN32
static void OnIconChanged_Impl();
void OnViewChanged_Impl();
void OnClosed_Impl();
#endif
// XEmbeddedObject
virtual void SAL_CALL changeState( sal_Int32 nNewState ) override;
virtual css::uno::Sequence< sal_Int32 > SAL_CALL getReachableStates() override;
virtual sal_Int32 SAL_CALL getCurrentState() override;
virtual void SAL_CALL doVerb( sal_Int32 nVerbID ) override;
virtual css::uno::Sequence< css::embed::VerbDescriptor > SAL_CALL getSupportedVerbs() override;
virtual void SAL_CALL setClientSite(
const css::uno::Reference< css::embed::XEmbeddedClient >& xClient ) override;
virtual css::uno::Reference< css::embed::XEmbeddedClient > SAL_CALL getClientSite() override;
virtual void SAL_CALL update() override;
virtual void SAL_CALL setUpdateMode( sal_Int32 nMode ) override;
virtual sal_Int64 SAL_CALL getStatus( sal_Int64 nAspect ) override;
virtual void SAL_CALL setContainerName( const OUString& sName ) override;
// XVisualObject
virtual void SAL_CALL setVisualAreaSize( sal_Int64 nAspect, const css::awt::Size& aSize ) override;
virtual css::awt::Size SAL_CALL getVisualAreaSize( sal_Int64 nAspect ) override;
virtual css::embed::VisualRepresentation SAL_CALL getPreferredVisualRepresentation( ::sal_Int64 nAspect ) override;
virtual sal_Int32 SAL_CALL getMapUnit( sal_Int64 nAspect ) override;
// XEmbedPersist
virtual void SAL_CALL setPersistentEntry(
const css::uno::Reference< css::embed::XStorage >& xStorage,
const OUString& sEntName,
sal_Int32 nEntryConnectionMode,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
virtual void SAL_CALL storeToEntry( const css::uno::Reference< css::embed::XStorage >& xStorage, const OUString& sEntName, const css::uno::Sequence< css::beans::PropertyValue >& lArguments, const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
virtual void SAL_CALL storeAsEntry(
const css::uno::Reference< css::embed::XStorage >& xStorage,
const OUString& sEntName,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
virtual void SAL_CALL saveCompleted( sal_Bool bUseNew ) override;
virtual sal_Bool SAL_CALL hasEntry() override;
virtual OUString SAL_CALL getEntryName() override;
// XLinkageSupport
virtual void SAL_CALL breakLink( const css::uno::Reference< css::embed::XStorage >& xStorage,
const OUString& sEntName ) override;
virtual sal_Bool SAL_CALL isLink() override;
virtual OUString SAL_CALL getLinkURL() override;
// XCommonEmbedPersist
virtual void SAL_CALL storeOwn() override;
virtual sal_Bool SAL_CALL isReadonly() override;
virtual void SAL_CALL reload(
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
// XClassifiedObject
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getClassID() override;
virtual OUString SAL_CALL getClassName() override;
virtual void SAL_CALL setClassInfo(
const css::uno::Sequence< sal_Int8 >& aClassID, const OUString& aClassName ) override;
// XStateChangeBroadcaster
virtual void SAL_CALL addStateChangeListener( const css::uno::Reference< css::embed::XStateChangeListener >& xListener ) override;
virtual void SAL_CALL removeStateChangeListener( const css::uno::Reference< css::embed::XStateChangeListener >& xListener ) override;
// XComponentSupplier
virtual css::uno::Reference< css::util::XCloseable > SAL_CALL getComponent() override;
// XCloseable
virtual void SAL_CALL close( sal_Bool DeliverOwnership ) override;
virtual void SAL_CALL addCloseListener(
const css::uno::Reference< css::util::XCloseListener >& Listener ) override;
virtual void SAL_CALL removeCloseListener(
const css::uno::Reference< css::util::XCloseListener >& Listener ) override;
// XEventBroadcaster
virtual void SAL_CALL addEventListener(
const css::uno::Reference< css::document::XEventListener >& Listener ) override;
virtual void SAL_CALL removeEventListener(
const css::uno::Reference< css::document::XEventListener >& Listener ) override;
// XInplaceObject ( only for wrapping scenario here )
virtual void SAL_CALL setObjectRectangles( const css::awt::Rectangle& aPosRect,
const css::awt::Rectangle& aClipRect ) override;
virtual void SAL_CALL enableModeless( sal_Bool bEnable ) override;
virtual void SAL_CALL translateAccelerators(
const css::uno::Sequence< css::awt::KeyEvent >& aKeys ) override;
// XChild ( only for wrapping scenario here )
virtual css::uno::Reference< css::uno::XInterface > SAL_CALL getParent( ) override;
virtual void SAL_CALL setParent( const css::uno::Reference< css::uno::XInterface >& Parent ) override;
// XActiveDataStreamer
void SAL_CALL setStream(const css::uno::Reference<css::io::XStream>& xStream) override;
css::uno::Reference<css::io::XStream> SAL_CALL getStream() override;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */