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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
|
/* -*- 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 .
*/
#pragma once
#include <sfx2/objsh.hxx>
#include <sfx2/docfac.hxx>
#include <sfx2/sfxmodelfactory.hxx>
#include <sfx2/viewsh.hxx>
#include <o3tl/deleter.hxx>
#include <comphelper/servicehelper.hxx>
#include <scdllapi.h>
#include <document.hxx>
#include <shellids.hxx>
#include <optutil.hxx>
#include <docuno.hxx>
#include <memory>
#include <string_view>
#include <unordered_map>
#include <map>
class ScRefreshTimerProtector;
class ScEditEngineDefaulter;
class SfxStyleSheetBasePool;
class SfxStyleSheetHint;
class INetURLObject;
class ScViewData;
class ScDocFunc;
class ScDrawLayer;
class ScTabViewShell;
class ScAutoStyleList;
class ScMarkData;
class ScPaintLockData;
class ScChangeAction;
class ScImportOptions;
class ScDocShellModificator;
class ScOptSolverSave;
class ScSheetSaveData;
class ScFlatBoolRowSegments;
struct ScColWidthParam;
class ScFormulaOptions;
namespace com::sun::star::script::vba { class XVBAScriptListener; }
namespace ooo::vba::excel { class XWorkbook; }
namespace com::sun::star::datatransfer { class XTransferable2; }
namespace sfx2 { class FileDialogHelper; }
struct DocShell_Impl;
typedef std::unordered_map< sal_uLong, sal_uLong > ScChangeActionMergeMap;
//enum ScDBFormat { SC_FORMAT_SDF, SC_FORMAT_DBF };
enum class LOKCommentNotificationType { Add, Modify, Remove };
extern "C" SAL_DLLPUBLIC_EXPORT bool TestImportDBF(SvStream &rStream);
// Extra flags for Repaint
#define SC_PF_LINES 1
#define SC_PF_TESTMERGE 2
#define SC_PF_WHOLEROWS 4
class SC_DLLPUBLIC ScDocShell final: public SfxObjectShell, public SfxListener
{
ScDocument m_aDocument;
OUString m_aDdeTextFmt;
double m_nPrtToScreenFactor;
std::unique_ptr<DocShell_Impl> m_pImpl;
std::unique_ptr<ScDocFunc> m_pDocFunc;
bool m_bHeaderOn;
bool m_bFooterOn;
bool m_bIsInplace:1; // Is set by the View
bool m_bIsEmpty:1;
bool m_bIsInUndo:1;
bool m_bDocumentModifiedPending:1;
bool m_bUpdateEnabled:1;
bool m_bUcalcTest:1; // avoid loading the styles in the ucalc test
bool m_bAreasChangedNeedBroadcast:1;
sal_uInt16 m_nDocumentLock;
sal_Int16 m_nCanUpdate; // stores the UpdateDocMode from loading a document till update links
std::unique_ptr<ScDBData> m_pOldAutoDBRange;
std::unique_ptr<ScAutoStyleList> m_pAutoStyleList;
std::unique_ptr<ScPaintLockData> m_pPaintLockData;
std::unique_ptr<ScOptSolverSave> m_pSolverSaveData;
std::unique_ptr<ScSheetSaveData> m_pSheetSaveData;
std::unique_ptr<ScFormatSaveData> m_pFormatSaveData;
std::unique_ptr<ScDocShellModificator, o3tl::default_delete<ScDocShellModificator>> m_pModificator; // #109979#; is used to load XML (created in BeforeXMLLoading and destroyed in AfterXMLLoading)
css::uno::Reference< ooo::vba::excel::XWorkbook> mxAutomationWorkbookObject;
// Only used by Vba helper functions
css::uno::Reference<css::script::vba::XVBAScriptListener> m_xVBAListener;
css::uno::Reference<css::datatransfer::XTransferable2> m_xClipData;
SAL_DLLPRIVATE void InitItems();
SAL_DLLPRIVATE void DoEnterHandler();
SAL_DLLPRIVATE void InitOptions(bool bForLoading);
SAL_DLLPRIVATE void ResetDrawObjectShell();
/** Do things that need to be done before saving to our own format and
necessary clean ups in dtor. */
class SAL_DLLPRIVATE PrepareSaveGuard
{
public:
explicit PrepareSaveGuard( ScDocShell & rDocShell );
~PrepareSaveGuard() COVERITY_NOEXCEPT_FALSE;
private:
ScDocShell & mrDocShell;
};
SAL_DLLPRIVATE bool LoadXML( SfxMedium* pMedium, const css::uno::Reference< css::embed::XStorage >& );
SAL_DLLPRIVATE bool SaveXML( SfxMedium* pMedium, const css::uno::Reference< css::embed::XStorage >& );
SAL_DLLPRIVATE SCTAB GetSaveTab();
friend bool TestImportDBF(SvStream &rStream);
SAL_DLLPRIVATE ErrCode DBaseImport( const OUString& rFullFileName, rtl_TextEncoding eCharSet,
std::map<SCCOL, ScColWidthParam>& aColWidthParam, ScFlatBoolRowSegments& rRowHeightsRecalc );
SAL_DLLPRIVATE ErrCode DBaseExport(
const OUString& rFullFileName, rtl_TextEncoding eCharSet, bool& bHasMemo );
SAL_DLLPRIVATE static bool MoveFile( const INetURLObject& rSource, const INetURLObject& rDest );
SAL_DLLPRIVATE static bool KillFile( const INetURLObject& rURL );
SAL_DLLPRIVATE static bool IsDocument( const INetURLObject& rURL );
SAL_DLLPRIVATE void LockPaint_Impl(bool bDoc);
SAL_DLLPRIVATE void UnlockPaint_Impl(bool bDoc);
SAL_DLLPRIVATE void LockDocument_Impl(sal_uInt16 nNew);
SAL_DLLPRIVATE void UnlockDocument_Impl(sal_uInt16 nNew);
SAL_DLLPRIVATE void EnableSharedSettings( bool bEnable );
SAL_DLLPRIVATE css::uno::Reference< css::frame::XModel > LoadSharedDocument();
SAL_DLLPRIVATE void UseSheetSaveEntries();
SAL_DLLPRIVATE std::unique_ptr<ScDocFunc> CreateDocFunc();
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
public:
SFX_DECL_INTERFACE(SCID_DOC_SHELL)
SFX_DECL_OBJECTFACTORY();
private:
/// SfxInterface initializer.
static void InitInterface_Impl();
public:
explicit ScDocShell( const ScDocShell& rDocShell ) = delete;
explicit ScDocShell( const SfxModelFlags i_nSfxCreationFlags = SfxModelFlags::EMBEDDED_OBJECT );
virtual ~ScDocShell() override;
virtual SfxUndoManager*
GetUndoManager() override;
virtual void FillClass( SvGlobalName * pClassName,
SotClipboardFormatId * pFormat,
OUString * pFullTypeName,
sal_Int32 nFileFormat,
bool bTemplate = false ) const override;
virtual std::set<Color> GetDocColors() override;
virtual bool InitNew( const css::uno::Reference< css::embed::XStorage >& ) override;
virtual bool Load( SfxMedium& rMedium ) override;
virtual bool LoadFrom( SfxMedium& rMedium ) override;
virtual bool ConvertFrom( SfxMedium &rMedium ) override;
virtual bool LoadExternal( SfxMedium& rMedium ) override;
virtual bool Save() override;
virtual bool SaveAs( SfxMedium& rMedium ) override;
virtual bool ConvertTo( SfxMedium &rMedium ) override;
virtual bool PrepareClose( bool bUI = true ) override;
virtual void LoadStyles( SfxObjectShell &rSource ) override;
virtual bool DoSaveCompleted( SfxMedium * pNewStor=nullptr, bool bRegisterRecent=true ) override; // SfxObjectShell
virtual bool QuerySlotExecutable( sal_uInt16 nSlotId ) override;
virtual void Draw( OutputDevice *, const JobSetup & rSetup, sal_uInt16 nAspect ) override;
virtual void SetVisArea( const tools::Rectangle & rVisArea ) override;
virtual void TerminateEditing() override;
using SfxObjectShell::GetVisArea;
virtual tools::Rectangle GetVisArea( sal_uInt16 nAspect ) const override;
virtual Printer* GetDocumentPrinter() override;
virtual void SetModified( bool = true ) override;
void SetVisAreaOrSize( const tools::Rectangle& rVisArea );
virtual std::shared_ptr<SfxDocumentInfoDialog> CreateDocumentInfoDialog(weld::Window* pParent, const SfxItemSet &rSet) override;
void GetDocStat( ScDocStat& rDocStat );
const ScDocument& GetDocument() const { return m_aDocument; }
ScDocument& GetDocument() { return m_aDocument; }
ScDocFunc& GetDocFunc() { return *m_pDocFunc; }
css::uno::Reference<css::datatransfer::XTransferable2> const & GetClipData() const { return m_xClipData; }
void SetClipData(const css::uno::Reference<css::datatransfer::XTransferable2>& xTransferable) { m_xClipData = xTransferable; }
SfxPrinter* GetPrinter( bool bCreateIfNotExist = true );
sal_uInt16 SetPrinter( VclPtr<SfxPrinter> const & pNewPrinter, SfxPrinterChangeFlags nDiffFlags = SFX_PRINTER_ALL );
void UpdateFontList();
ScDrawLayer* MakeDrawLayer();
void AsciiSave( SvStream& rStream, const ScImportOptions& rOpt, SCTAB nTab );
void Execute( SfxRequest& rReq );
void GetState( SfxItemSet &rSet );
void ExecutePageStyle ( const SfxViewShell& rCaller, SfxRequest& rReq, SCTAB nCurTab );
void GetStatePageStyle( SfxItemSet& rSet, SCTAB nCurTab );
void CompareDocument( ScDocument& rOtherDoc );
void MergeDocument( ScDocument& rOtherDoc, bool bShared = false, bool bCheckDuplicates = false, sal_uLong nOffset = 0, ScChangeActionMergeMap* pMergeMap = nullptr, bool bInverseMap = false );
bool MergeSharedDocument( ScDocShell* pSharedDocShell );
ScChangeAction* GetChangeAction( const ScAddress& rPos );
void SetChangeComment( ScChangeAction* pAction, const OUString& rComment );
void ExecuteChangeCommentDialog( ScChangeAction* pAction, weld::Window* pParent, bool bPrevNext = true );
/// Protect/unprotect ChangeTrack and return <TRUE/> if
/// protection was successfully changed.
/// If bJustQueryIfProtected==sal_True protection is not
/// changed and <TRUE/> is returned if not protected or
/// password was entered correctly.
bool ExecuteChangeProtectionDialog( bool bJustQueryIfProtected = false );
void SetPrintZoom( SCTAB nTab, sal_uInt16 nScale, sal_uInt16 nPages );
bool AdjustPrintZoom( const ScRange& rRange );
void LoadStylesArgs( ScDocShell& rSource, bool bReplace, bool bCellStyles, bool bPageStyles );
void PageStyleModified( std::u16string_view rStyleName, bool bApi );
void NotifyStyle( const SfxStyleSheetHint& rHint );
void DoAutoStyle( const ScRange& rRange, const OUString& rStyle );
static weld::Window* GetActiveDialogParent();
void ErrorMessage(TranslateId pGlobStrId);
bool IsEditable() const;
bool AdjustRowHeight( SCROW nStartRow, SCROW nEndRow, SCTAB nTab );
void UpdateAllRowHeights( const ScMarkData* pTabMark = nullptr );
void UpdatePendingRowHeights( SCTAB nUpdateTab, bool bBefore = false );
void RefreshPivotTables( const ScRange& rSource );
void DoConsolidate( const ScConsolidateParam& rParam, bool bRecord = true );
void UseScenario( SCTAB nTab, const OUString& rName, bool bRecord = true );
SCTAB MakeScenario(SCTAB nTab, const OUString& rName, const OUString& rComment,
const Color& rColor, ScScenarioFlags nFlags,
ScMarkData& rMark, bool bRecord = true);
void ModifyScenario(SCTAB nTab, const OUString& rName, const OUString& rComment,
const Color& rColor, ScScenarioFlags nFlags);
sal_uLong TransferTab( ScDocShell& rSrcDocShell, SCTAB nSrcPos,
SCTAB nDestPos, bool bInsertNew,
bool bNotifyAndPaint );
bool MoveTable( SCTAB nSrcTab, SCTAB nDestTab, bool bCopy, bool bRecord );
void DoRecalc( bool bApi );
void DoHardRecalc();
void UpdateOle(const ScViewData& rViewData, bool bSnapSize = false);
bool IsOle() const;
void DBAreaDeleted( SCTAB nTab, SCCOL nX1, SCROW nY1, SCCOL nX2 );
ScDBData* GetDBData( const ScRange& rMarked, ScGetDBMode eMode, ScGetDBSelection eSel );
ScDBData* GetAnonymousDBData(const ScRange& rRange);
std::unique_ptr<ScDBData> GetOldAutoDBRange();
void CancelAutoDBRange(); // called when dialog is cancelled
virtual void ReconnectDdeLink(SfxObjectShell& rServer) override;
void UpdateLinks() override;
void SetInitialLinkUpdate( const SfxMedium* pMedium );
void AllowLinkUpdate();
void ReloadAllLinks();
void ReloadTabLinks();
ScLkUpdMode GetLinkUpdateModeState() const;
void SetFormulaOptions( const ScFormulaOptions& rOpt, bool bForLoading = false );
/**
* Called when the Options dialog is dismissed with the OK button, to
* handle potentially conflicting option settings.
*/
void CheckConfigOptions();
void PostEditView( ScEditEngineDefaulter* pEditEngine, const ScAddress& rCursorPos );
void PostPaint( SCCOL nStartCol, SCROW nStartRow, SCTAB nStartTab,
SCCOL nEndCol, SCROW nEndRow, SCTAB nEndTab, PaintPartFlags nPart,
sal_uInt16 nExtFlags = 0 );
void PostPaint( const ScRangeList& rRanges, PaintPartFlags nPart, sal_uInt16 nExtFlags = 0 );
void PostPaintCell( SCCOL nCol, SCROW nRow, SCTAB nTab );
void PostPaintCell( const ScAddress& rPos );
void PostPaintGridAll();
void PostPaintExtras();
bool IsPaintLocked() const { return m_pPaintLockData != nullptr; }
void PostDataChanged();
void UpdatePaintExt( sal_uInt16& rExtFlags, SCCOL nStartCol, SCROW nStartRow, SCTAB nStartTab,
SCCOL nEndCol, SCROW nEndRow, SCTAB nEndTab );
void UpdatePaintExt( sal_uInt16& rExtFlags, const ScRange& rRange );
void SetDocumentModified();
void SetDrawModified();
void LockPaint();
void UnlockPaint();
sal_uInt16 GetLockCount() const { return m_nDocumentLock;}
void SetLockCount(sal_uInt16 nNew);
void LockDocument();
void UnlockDocument();
DECL_DLLPRIVATE_LINK( DialogClosedHdl, sfx2::FileDialogHelper*, void );
DECL_DLLPRIVATE_LINK( ReloadAllLinksHdl, weld::Button&, void );
virtual SfxStyleSheetBasePool* GetStyleSheetPool() override;
void SetInplace( bool bInplace );
bool IsEmpty() const { return m_bIsEmpty; }
void SetEmpty(bool bSet);
bool IsInUndo() const { return m_bIsInUndo; }
void SetInUndo(bool bSet);
void CalcOutputFactor();
double GetOutputFactor() const { return m_nPrtToScreenFactor;}
void GetPageOnFromPageStyleSet( const SfxItemSet* pStyleSet,
SCTAB nCurTab,
bool& rbHeader,
bool& rbFooter );
#if defined(_WIN32)
virtual bool DdeGetData( const OUString& rItem, const OUString& rMimeType,
css::uno::Any & rValue ) override;
virtual bool DdeSetData( const OUString& rItem, const OUString& rMimeType,
const css::uno::Any & rValue ) override;
#endif
virtual ::sfx2::SvLinkSource* DdeCreateLinkSource( const OUString& rItem ) override;
const OUString& GetDdeTextFmt() const { return m_aDdeTextFmt; }
SfxBindings* GetViewBindings();
ScTabViewShell* GetBestViewShell( bool bOnlyVisible = true );
void SetDocumentModifiedPending( bool bVal )
{ m_bDocumentModifiedPending = bVal; }
bool IsDocumentModifiedPending() const
{ return m_bDocumentModifiedPending; }
bool IsUpdateEnabled() const
{ return m_bUpdateEnabled; }
void SetUpdateEnabled(bool bValue)
{ m_bUpdateEnabled = bValue; }
void SetAreasChangedNeedBroadcast()
{ m_bAreasChangedNeedBroadcast = true; }
OutputDevice* GetRefDevice(); // WYSIWYG: Printer, otherwise VirtualDevice...
static ScViewData* GetViewData();
static SCTAB GetCurTab();
static ScDocShell* GetShellByNum( sal_uInt16 nDocNo );
static OUString GetOwnFilterName();
static OUString GetHtmlFilterName();
static OUString GetWebQueryFilterName();
static OUString GetAsciiFilterName();
static OUString GetLotusFilterName();
static OUString GetDBaseFilterName();
static OUString GetDifFilterName();
static bool HasAutomaticTableName( std::u16string_view rFilter );
static void LOKCommentNotify(LOKCommentNotificationType nType, const ScDocument* pDocument, const ScAddress& rPos, const ScPostIt* pNote);
DECL_DLLPRIVATE_LINK( RefreshDBDataHdl, Timer*, void );
void BeforeXMLLoading();
void AfterXMLLoading(bool bRet);
virtual HiddenInformation GetHiddenInformationState( HiddenInformation nStates ) override;
const ScOptSolverSave* GetSolverSaveData() const { return m_pSolverSaveData.get(); } // may be null
void SetSolverSaveData( std::unique_ptr<ScOptSolverSave> pData );
ScSheetSaveData* GetSheetSaveData();
ScFormatSaveData* GetFormatSaveData();
static void ResetKeyBindings( ScOptionsUtil::KeyBindingType eType );
// password protection for Calc (derived from SfxObjectShell)
// see also: FID_CHG_RECORD, SID_CHG_PROTECT
virtual bool IsChangeRecording() const override;
virtual bool HasChangeRecordProtection() const override;
virtual void SetChangeRecording( bool bActivate, bool bLockAllViews = false ) override;
virtual void SetProtectionPassword( const OUString &rPassword ) override;
virtual bool GetProtectionHash( /*out*/ css::uno::Sequence< sal_Int8 > &rPasswordHash ) override;
void SnapVisArea( tools::Rectangle& rRect ) const;
void SetIsInUcalc();
void RegisterAutomationWorkbookObject(css::uno::Reference< ooo::vba::excel::XWorkbook > const& xWorkbook);
};
void UpdateAcceptChangesDialog();
typedef tools::SvRef<ScDocShell> ScDocShellRef;
/** Create before modifications of the document and destroy thereafter.
Call SetDocumentModified() at an instance of this class instead of at
ScDocShell.
Remembers in the ctor ScDocument's AutoCalcShellDisabled and IdleDisabled,
switches them off and restores them in the dtor, AutoCalcShellDisabled
also before a ScDocShell::SetDocumentModified() call if necessary.
In the dtor, if ScDocShell's bDocumentModifiedPending is set and
bAutoCalcShellDisabled is not set, then ScDocShell::SetDocumentModified()
is called.
Several instances can be used in nested calls to ScDocFunc or ScDocShell
methods to avoid multiple modified status changes, only the last instance
destroyed calls ScDocShell::SetDocumentModified().
*/
class ScDocShellModificator
{
ScDocShell& rDocShell;
std::unique_ptr<ScRefreshTimerProtector> mpProtector;
bool bAutoCalcShellDisabled;
bool bIdleEnabled;
ScDocShellModificator( const ScDocShellModificator& ) = delete;
ScDocShellModificator& operator=( const ScDocShellModificator& ) = delete;
public:
explicit ScDocShellModificator( ScDocShell& );
~ScDocShellModificator() COVERITY_NOEXCEPT_FALSE;
void SetDocumentModified();
};
//#i97876# Spreadsheet data changes are not notified
namespace HelperNotifyChanges
{
inline ScModelObj* getMustPropagateChangesModel(const ScDocShell &rDocShell)
{
ScModelObj* pModelObj = comphelper::getFromUnoTunnel<ScModelObj>(rDocShell.GetModel());
if (pModelObj && pModelObj->HasChangesListeners())
return pModelObj;
return nullptr;
}
inline void Notify(ScModelObj &rModelObj, const ScRangeList &rChangeRanges,
const OUString &rType = OUString("cell-change"),
const css::uno::Sequence< css::beans::PropertyValue >& rProperties =
css::uno::Sequence< css::beans::PropertyValue >())
{
rModelObj.NotifyChanges(rType, rChangeRanges, rProperties);
}
inline void NotifyIfChangesListeners(const ScDocShell &rDocShell, const ScRange &rRange,
const OUString &rType = OUString("cell-change"))
{
if (ScModelObj* pModelObj = getMustPropagateChangesModel(rDocShell))
{
ScRangeList aChangeRanges(rRange);
Notify(*pModelObj, aChangeRanges, rType);
}
}
};
void VBA_InsertModule( ScDocument& rDoc, SCTAB nTab, const OUString& sModuleSource );
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|