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
|
/* -*- 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_SC_SOURCE_FILTER_INC_XELINK_HXX
#define INCLUDED_SC_SOURCE_FILTER_INC_XELINK_HXX
#include "markdata.hxx"
#include "xllink.hxx"
#include "xerecord.hxx"
#include "xehelper.hxx"
#include "xeformula.hxx"
#include "externalrefmgr.hxx"
#include <memory>
struct ScSingleRefData;
struct ScComplexRefData;
/* ============================================================================
Classes for export of different kinds of internal/external references.
- 3D cell and cell range links
- External cell and cell range links
- External defined names
- Macro calls
- Add-in functions
- DDE links
- OLE object links
============================================================================ */
// Excel sheet indexes ========================================================
/** Stores the correct Excel sheet index for each Calc sheet.
@descr The class knows all sheets which will not exported
(i.e. external link sheets, scenario sheets). */
class XclExpTabInfo : protected XclExpRoot
{
public:
/** Initializes the complete buffer from the current exported document. */
explicit XclExpTabInfo( const XclExpRoot& rRoot );
/** Returns true, if the specified Calc sheet will be exported. */
bool IsExportTab( SCTAB nScTab ) const;
/** Returns true, if the specified Calc sheet is used to store external cell contents. */
bool IsExternalTab( SCTAB nScTab ) const;
/** Returns true, if the specified Calc sheet is visible and will be exported. */
bool IsVisibleTab( SCTAB nScTab ) const;
/** Returns true, if the specified Calc sheet is selected and will be exported. */
bool IsSelectedTab( SCTAB nScTab ) const;
/** Returns true, if the specified Calc sheet is the displayed (active) sheet. */
bool IsDisplayedTab( SCTAB nScTab ) const;
/** Returns true, if the specified Calc sheet is displayed in right-to-left mode. */
bool IsMirroredTab( SCTAB nScTab ) const;
/** Returns the Calc name of the specified sheet. */
OUString GetScTabName( SCTAB nScTab ) const;
/** Returns the Excel sheet index for a given Calc sheet. */
sal_uInt16 GetXclTab( SCTAB nScTab ) const;
/** Returns the Calc sheet index of the nSortedTab-th entry in the sorted sheet names list. */
SCTAB GetRealScTab( SCTAB nSortedScTab ) const;
/** Returns the number of Calc sheets. */
inline SCTAB GetScTabCount() const { return mnScCnt; }
/** Returns the number of Excel sheets to be exported. */
inline sal_uInt16 GetXclTabCount() const { return mnXclCnt; }
/** Returns the number of external linked sheets. */
inline sal_uInt16 GetXclExtTabCount() const { return mnXclExtCnt; }
/** Returns the number of exported selected sheets. */
inline sal_uInt16 GetXclSelectedCount() const { return mnXclSelCnt; }
/** Returns the Excel index of the active, displayed sheet. */
inline sal_uInt16 GetDisplayedXclTab() const { return mnDisplXclTab; }
/** Returns the Excel index of the first visible sheet. */
inline sal_uInt16 GetFirstVisXclTab() const { return mnFirstVisXclTab; }
private:
/** Returns true, if any of the passed flags is set for the specified Calc sheet. */
bool GetFlag( SCTAB nScTab, sal_uInt8 nFlags ) const;
/** Sets or clears (depending on bSet) all passed flags for the specified Calc sheet. */
void SetFlag( SCTAB nScTab, sal_uInt8 nFlags, bool bSet = true );
/** Searches for sheets not to be exported. */
void CalcXclIndexes();
/** Sorts the names of all tables and stores the indexes of the sorted indexes. */
void CalcSortedIndexes();
private:
/** Data structure with information about one Calc sheet. */
struct XclExpTabInfoEntry
{
OUString maScName;
sal_uInt16 mnXclTab;
sal_uInt8 mnFlags;
inline explicit XclExpTabInfoEntry() : mnXclTab( 0 ), mnFlags( 0 ) {}
};
typedef ::std::vector< XclExpTabInfoEntry > XclExpTabInfoVec;
typedef ::std::vector< SCTAB > ScTabVec;
XclExpTabInfoVec maTabInfoVec; /// Array of Calc sheet index information.
SCTAB mnScCnt; /// Count of Calc sheets.
sal_uInt16 mnXclCnt; /// Count of Excel sheets to be exported.
sal_uInt16 mnXclExtCnt; /// Count of external link sheets.
sal_uInt16 mnXclSelCnt; /// Count of selected and exported sheets.
sal_uInt16 mnDisplXclTab; /// Displayed (active) sheet.
sal_uInt16 mnFirstVisXclTab; /// First visible sheet.
ScTabVec maFromSortedVec; /// Sorted Calc sheet index -> real Calc sheet index.
ScTabVec maToSortedVec; /// Real Calc sheet index -> sorted Calc sheet index.
};
// Export link manager ========================================================
class XclExpLinkManagerImpl;
/** Stores all data for internal/external references (the link table). */
class XclExpLinkManager : public XclExpRecordBase, protected XclExpRoot
{
public:
explicit XclExpLinkManager( const XclExpRoot& rRoot );
virtual ~XclExpLinkManager() override;
/** Searches for an EXTERNSHEET index for the given Calc sheet.
@descr See above for the meaning of EXTERNSHEET indexes.
@param rnExtSheet (out-param) Returns the EXTERNSHEET index.
@param rnXclTab (out-param) Returns the Excel sheet index.
@param nScTab The Calc sheet index to process.
param pRefLogEntry If not 0, data about the external link is stored here. */
void FindExtSheet( sal_uInt16& rnExtSheet,
sal_uInt16& rnXclTab, SCTAB nScTab,
XclExpRefLogEntry* pRefLogEntry = nullptr );
/** Searches for an EXTERNSHEET index for the given Calc sheet range.
@descr See above for the meaning of EXTERNSHEET indexes.
@param rnExtSheet (out-param) Returns the EXTERNSHEET index.
@param rnFirstXclTab (out-param) Returns the Excel sheet index of the first sheet.
@param rnXclTab (out-param) Returns the Excel sheet index of the last sheet.
@param nFirstScTab The first Calc sheet index to process.
@param nLastScTab The last Calc sheet index to process.
param pRefLogEntry If not 0, data about the external link is stored here. */
void FindExtSheet( sal_uInt16& rnExtSheet,
sal_uInt16& rnFirstXclTab, sal_uInt16& rnLastXclTab,
SCTAB nFirstScTab, SCTAB nLastScTab,
XclExpRefLogEntry* pRefLogEntry );
/** Searches for a special EXTERNSHEET index for the own document. */
sal_uInt16 FindExtSheet( sal_Unicode cCode );
void FindExtSheet( sal_uInt16 nFileId, const OUString& rTabName, sal_uInt16 nXclTabSpan,
sal_uInt16& rnExtSheet, sal_uInt16& rnFirstSBTab, sal_uInt16& rnLastSBTab,
XclExpRefLogEntry* pRefLogEntry );
/** Stores the cell with the given address in a CRN record list. */
void StoreCell( const ScSingleRefData& rRef, const ScAddress& rPos );
/** Stores all cells in the given range in a CRN record list. */
void StoreCellRange( const ScComplexRefData& rRef, const ScAddress& rPos );
void StoreCell( sal_uInt16 nFileId, const OUString& rTabName, const ScAddress& rPos );
void StoreCellRange( sal_uInt16 nFileId, const OUString& rTabName, const ScRange& rRange );
/** Finds or inserts an EXTERNNAME record for an add-in function name.
@param rnExtSheet (out-param) Returns the index of the EXTSHEET structure for the add-in function name.
@param rnExtName (out-param) Returns the 1-based EXTERNNAME record index.
@return true = add-in function inserted; false = error (i.e. not supported in current BIFF). */
bool InsertAddIn(
sal_uInt16& rnExtSheet, sal_uInt16& rnExtName,
const OUString& rName );
/** InsertEuroTool */
bool InsertEuroTool(
sal_uInt16& rnExtSheet, sal_uInt16& rnExtName,
const OUString& rName );
/** Finds or inserts an EXTERNNAME record for DDE links.
@param rnExtSheet (out-param) Returns the index of the EXTSHEET structure for the DDE link.
@param rnExtName (out-param) Returns the 1-based EXTERNNAME record index.
@return true = DDE link inserted; false = error (i.e. not supported in current BIFF). */
bool InsertDde(
sal_uInt16& rnExtSheet, sal_uInt16& rnExtName,
const OUString& rApplic, const OUString& rTopic, const OUString& rItem );
bool InsertExtName(
sal_uInt16& rnExtSheet, sal_uInt16& rnExtName, const OUString& rUrl,
const OUString& rName, const ScExternalRefCache::TokenArrayRef& rArray );
/** Writes the entire Link table. */
virtual void Save( XclExpStream& rStrm ) override;
/** Writes the entire Link table to OOXML. */
virtual void SaveXml( XclExpXmlStream& rStrm ) override;
private:
typedef std::shared_ptr< XclExpLinkManagerImpl > XclExpLinkMgrImplPtr;
XclExpLinkMgrImplPtr mxImpl;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
