Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #ifndef SC_XLROOT_HXX
21 : #define SC_XLROOT_HXX
22 :
23 : #include <com/sun/star/beans/NamedValue.hpp>
24 :
25 : #include <i18npool/lang.h>
26 : #include <sot/storage.hxx>
27 : #include "xlconst.hxx"
28 : #include "xltools.hxx"
29 : #include <boost/shared_ptr.hpp>
30 :
31 : namespace comphelper { class IDocPasswordVerifier; }
32 :
33 : // Forward declarations of objects in public use ==============================
34 :
35 : class DateTime;
36 :
37 : struct XclAddress;
38 : struct XclRange;
39 :
40 : // Global data ================================================================
41 :
42 : #ifdef DBG_UTIL
43 : /** Counts the number of created root objects. */
44 : struct XclDebugObjCounter
45 : {
46 : sal_Int32 mnObjCnt;
47 : inline explicit XclDebugObjCounter() : mnObjCnt( 0 ) {}
48 : ~XclDebugObjCounter();
49 : };
50 : #endif
51 :
52 : // ----------------------------------------------------------------------------
53 :
54 : class SfxMedium;
55 : class ScEditEngineDefaulter;
56 : class ScHeaderEditEngine;
57 : class EditEngine;
58 : class ScExtDocOptions;
59 : class XclFontPropSetHelper;
60 : class XclChPropSetHelper;
61 : class XclTracer;
62 :
63 : struct RootData;//!
64 :
65 : /** Stores global buffers and data needed elsewhere in the Excel filters. */
66 : struct XclRootData
67 : #ifdef DBG_UTIL
68 : : public XclDebugObjCounter
69 : #endif
70 : {
71 : typedef boost::shared_ptr< ScEditEngineDefaulter > ScEEDefaulterRef;
72 : typedef boost::shared_ptr< ScHeaderEditEngine > ScHeaderEERef;
73 : typedef boost::shared_ptr< EditEngine > EditEngineRef;
74 : typedef boost::shared_ptr< XclFontPropSetHelper > XclFontPropSetHlpRef;
75 : typedef boost::shared_ptr< XclChPropSetHelper > XclChPropSetHlpRef;
76 : typedef boost::shared_ptr< ScExtDocOptions > ScExtDocOptRef;
77 : typedef boost::shared_ptr< XclTracer > XclTracerRef;
78 : typedef boost::shared_ptr< RootData > RootDataRef;
79 :
80 : XclBiff meBiff; /// Current BIFF version.
81 : XclOutput meOutput; /// Current Output format.
82 : SfxMedium& mrMedium; /// The medium to import from.
83 : SotStorageRef mxRootStrg; /// The root OLE storage of imported/exported file.
84 : ScDocument& mrDoc; /// The source or destination document.
85 : String maDocUrl; /// Document URL of imported/exported file.
86 : String maBasePath; /// Base path of imported/exported file (path of maDocUrl).
87 : String maUserName; /// Current user name.
88 : const String maDefPassword; /// The default password used for stream encryption.
89 : rtl_TextEncoding meTextEnc; /// Text encoding to import/export byte strings.
90 : LanguageType meSysLang; /// System language.
91 : LanguageType meDocLang; /// Document language (import: from file, export: from system).
92 : LanguageType meUILang; /// UI language (import: from file, export: from system).
93 : sal_Int16 mnDefApiScript; /// Default script type for blank cells (API constant).
94 : ScAddress maScMaxPos; /// Highest Calc cell position.
95 : ScAddress maXclMaxPos; /// Highest Excel cell position.
96 : ScAddress maMaxPos; /// Highest position valid in Calc and Excel.
97 :
98 : ScEEDefaulterRef mxEditEngine; /// Edit engine for rich strings etc.
99 : ScHeaderEERef mxHFEditEngine; /// Edit engine for header/footer.
100 : EditEngineRef mxDrawEditEng; /// Edit engine for text boxes.
101 :
102 : XclFontPropSetHlpRef mxFontPropSetHlp; /// Property set helper for fonts.
103 : XclChPropSetHlpRef mxChPropSetHlp; /// Property set helper for chart filter.
104 :
105 : ScExtDocOptRef mxExtDocOpt; /// Extended document options.
106 : XclTracerRef mxTracer; /// Filter tracer.
107 : RootDataRef mxRD; /// Old RootData struct. Will be removed.
108 :
109 : double mfScreenPixelX; /// Width of a screen pixel (1/100 mm).
110 : double mfScreenPixelY; /// Height of a screen pixel (1/100 mm).
111 : long mnCharWidth; /// Width of '0' in default font (twips).
112 : SCTAB mnScTab; /// Current Calc sheet index.
113 : const bool mbExport; /// false = Import, true = Export.
114 :
115 : explicit XclRootData( XclBiff eBiff, SfxMedium& rMedium,
116 : SotStorageRef xRootStrg, ScDocument& rDoc,
117 : rtl_TextEncoding eTextEnc, bool bExport );
118 : virtual ~XclRootData();
119 : };
120 :
121 : // ----------------------------------------------------------------------------
122 :
123 : class SfxObjectShell;
124 : class ScModelObj;
125 : class OutputDevice;
126 : class SvNumberFormatter;
127 : class SdrPage;
128 : class ScStyleSheetPool;
129 : class ScRangeName;
130 : struct XclFontData;
131 :
132 : /** Access to global data for a filter object (imported or exported document) from other classes. */
133 : class XclRoot
134 : {
135 : public:
136 : explicit XclRoot( XclRootData& rRootData );
137 : XclRoot( const XclRoot& rRoot );
138 :
139 : virtual ~XclRoot();
140 :
141 : XclRoot& operator=( const XclRoot& rRoot );
142 :
143 : /** Returns this root instance - for code readability in derived classes. */
144 : inline const XclRoot& GetRoot() const { return *this; }
145 : /** Returns old RootData struct. Deprecated. */
146 558 : inline RootData& GetOldRoot() const { return *mrData.mxRD; }
147 :
148 : /** Returns the current BIFF version of the importer/exporter. */
149 10545 : inline XclBiff GetBiff() const { return mrData.meBiff; }
150 : /** Returns the current output format of the importer/exporter. */
151 7 : inline XclOutput GetOutput() const { return mrData.meOutput; }
152 : /** Returns true, if currently a document is imported. */
153 61 : inline bool IsImport() const { return !mrData.mbExport; }
154 : /** Returns true, if currently a document is exported. */
155 : inline bool IsExport() const { return mrData.mbExport; }
156 : /** Returns the text encoding to import/export byte strings. */
157 1139 : inline rtl_TextEncoding GetTextEncoding() const { return mrData.meTextEnc; }
158 : /** Returns the system language, i.e. for number formats. */
159 20 : inline LanguageType GetSysLanguage() const { return mrData.meSysLang; }
160 : /** Returns the document language. */
161 1 : inline LanguageType GetDocLanguage() const { return mrData.meDocLang; }
162 : /** Returns the UI language. */
163 0 : inline LanguageType GetUILanguage() const { return mrData.meUILang; }
164 : /** Returns the default script type, e.g. for blank cells. */
165 1034 : inline sal_Int16 GetDefApiScript() const { return mrData.mnDefApiScript; }
166 : /** Returns the width of the '0' character (default font) for the current printer (twips). */
167 1377 : inline long GetCharWidth() const { return mrData.mnCharWidth; }
168 : /** Returns the current Calc sheet index. */
169 9 : inline bool IsInGlobals() const { return mrData.mnScTab == SCTAB_GLOBAL; }
170 : /** Returns the current Calc sheet index. */
171 61854 : inline SCTAB GetCurrScTab() const { return mrData.mnScTab; }
172 :
173 : /** Calculates the width of the passed number of pixels in 1/100 mm. */
174 : sal_Int32 GetHmmFromPixelX( double fPixelX ) const;
175 : /** Calculates the height of the passed number of pixels in 1/100 mm. */
176 : sal_Int32 GetHmmFromPixelY( double fPixelY ) const;
177 :
178 : /** Returns the medium to import from. */
179 6 : inline SfxMedium& GetMedium() const { return mrData.mrMedium; }
180 : /** Returns the document URL of the imported/exported file. */
181 21 : inline const String& GetDocUrl() const { return mrData.maDocUrl; }
182 : /** Returns the base path of the imported/exported file. */
183 104 : inline const String& GetBasePath() const { return mrData.maBasePath; }
184 : /** Returns the current user name. */
185 1 : inline const String& GetUserName() const { return mrData.maUserName; }
186 :
187 : /** Returns the default password used for stream encryption. */
188 0 : inline const String& GetDefaultPassword() const { return mrData.maDefPassword; }
189 : /** Requests and verifies a password from the medium or the user. */
190 : ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >
191 : RequestEncryptionData( ::comphelper::IDocPasswordVerifier& rVerifier ) const;
192 :
193 : /** Returns the OLE2 root storage of the imported/exported file.
194 : @return Pointer to root storage or 0, if the file is a simple stream. */
195 55 : inline SotStorageRef GetRootStorage() const { return mrData.mxRootStrg; }
196 : /** Returns true, if the document contains a VBA storage. */
197 : bool HasVbaStorage() const;
198 :
199 : /** Tries to open a storage as child of the specified storage for reading or writing. */
200 : SotStorageRef OpenStorage( SotStorageRef xStrg, const String& rStrgName ) const;
201 : /** Tries to open a storage as child of the root storage for reading or writing. */
202 : SotStorageRef OpenStorage( const String& rStrgName ) const;
203 : /** Tries to open a new stream in the specified storage for reading or writing. */
204 : SotStorageStreamRef OpenStream( SotStorageRef xStrg, const String& rStrmName ) const;
205 : /** Tries to open a new stream in the root storage for reading or writing. */
206 : SotStorageStreamRef OpenStream( const String& rStrmName ) const;
207 :
208 : /** Returns the destination document (import) or source document (export). */
209 143075 : inline ScDocument& GetDoc() const { return mrData.mrDoc; }
210 : /** Returns pointer to the destination document (import) or source document (export). */
211 154 : inline ScDocument* GetDocPtr() const { return &mrData.mrDoc; }
212 : /** Returns the object shell of the Calc document. May be 0 (i.e. import from clipboard). */
213 : SfxObjectShell* GetDocShell() const;
214 : /** Returns the object model of the Calc document. */
215 : ScModelObj* GetDocModelObj() const;
216 : /** Returns pointer to the printer of the Calc document. */
217 : OutputDevice* GetPrinter() const;
218 : /** Returns the style sheet pool of the Calc document. */
219 : ScStyleSheetPool& GetStyleSheetPool() const;
220 : /** Returns the defined names container of the Calc document. */
221 : ScRangeName& GetNamedRanges() const;
222 : /** Returns the drawing layer page of the passed sheet, if present. */
223 : SdrPage* GetSdrPage( SCTAB nScTab ) const;
224 :
225 : /** Returns the number formatter of the Calc document. */
226 : SvNumberFormatter& GetFormatter() const;
227 : /** Returns the null date of the current number formatter. */
228 : DateTime GetNullDate() const;
229 : /** Returns the base year depending on the current null date (1900 or 1904). */
230 : sal_uInt16 GetBaseYear() const;
231 : /** Converts a date/time value to a floating-point value. */
232 : double GetDoubleFromDateTime( const DateTime& rDateTime ) const;
233 : /** Converts a floating-point value to a date/time value. */
234 : DateTime GetDateTimeFromDouble( double fValue ) const;
235 :
236 : /** Returns the edit engine for import/export of rich strings etc. */
237 : ScEditEngineDefaulter& GetEditEngine() const;
238 : /** Returns the edit engine for import/export of headers/footers. */
239 : ScHeaderEditEngine& GetHFEditEngine() const;
240 : /** Returns the edit engine for import/export of drawing text boxes. */
241 : EditEngine& GetDrawEditEngine() const;
242 :
243 : /** Returns the property set helper for fonts. */
244 : XclFontPropSetHelper& GetFontPropSetHelper() const;
245 : /** Returns the property set helper for the chart filters. */
246 : XclChPropSetHelper& GetChartPropSetHelper() const;
247 :
248 : /** Returns the extended document options. */
249 : ScExtDocOptions& GetExtDocOptions() const;
250 : /** Returns the filter tracer. */
251 : XclTracer& GetTracer() const;
252 :
253 : /** Returns the highest possible cell address in a Calc document. */
254 175 : inline const ScAddress& GetScMaxPos() const { return mrData.maScMaxPos; }
255 : /** Returns the highest possible cell address in an Excel document (using current BIFF version). */
256 232 : inline const ScAddress& GetXclMaxPos() const { return mrData.maXclMaxPos; }
257 : /** Returns the highest possible cell address valid in Calc and Excel (using current BIFF version). */
258 178 : inline const ScAddress& GetMaxPos() const { return mrData.maMaxPos; }
259 :
260 : /** Sets the document language. */
261 17 : inline void SetDocLanguage( LanguageType eLang ) { mrData.meDocLang = eLang; }
262 : /** Sets the UI language, i.e. if it has been read from a file. */
263 17 : inline void SetUILanguage( LanguageType eLang ) { mrData.meUILang = eLang; }
264 : /** Sets the text encoding to import/export byte strings. */
265 : void SetTextEncoding( rtl_TextEncoding eTextEnc );
266 : /** Sets the width of the '0' character (default font) for the current printer (twips).
267 : @param rFontData The font used for the '0' character. */
268 : void SetCharWidth( const XclFontData& rFontData );
269 : /** Sets the current Calc sheet index. */
270 4 : inline void SetCurrScTab( SCTAB nScTab ) { mrData.mnScTab = nScTab; }
271 : /** Increases the current Calc sheet index by 1. */
272 75 : inline void IncCurrScTab() { ++mrData.mnScTab; }
273 :
274 : private:
275 : XclRootData& mrData; /// Reference to the global data struct.
276 : };
277 :
278 : // ============================================================================
279 :
280 : #endif
281 :
282 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|