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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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 OOX_XLS_RICHSTRING_HXX
#define OOX_XLS_RICHSTRING_HXX
#include "oox/helper/refvector.hxx"
#include "stylesbuffer.hxx"
namespace com { namespace sun { namespace star {
namespace text { class XText; }
} } }
namespace oox {
namespace xls {
// ============================================================================
/** Flags used to specify import/export mode of strings. */
typedef sal_Int32 BiffStringFlags;
const BiffStringFlags BIFF_STR_DEFAULT = 0x0000; /// Default string settings.
const BiffStringFlags BIFF_STR_FORCEUNICODE = 0x0001; /// Always use UCS-2 characters (default: try to compress). BIFF8 export only.
const BiffStringFlags BIFF_STR_8BITLENGTH = 0x0002; /// 8-bit string length field (default: 16-bit).
const BiffStringFlags BIFF_STR_SMARTFLAGS = 0x0004; /// Omit flags on empty string (default: read/write always). BIFF8 only.
const BiffStringFlags BIFF_STR_KEEPFONTS = 0x0008; /// Keep old fonts when reading unformatted string (default: clear fonts). Import only.
const BiffStringFlags BIFF_STR_EXTRAFONTS = 0x0010; /// Read trailing rich-string font array (default: nothing). BIFF2-BIFF5 import only.
// ============================================================================
/** Contains text data and font attributes for a part of a rich formatted string. */
class RichStringPortion : public WorkbookHelper
{
public:
explicit RichStringPortion( const WorkbookHelper& rHelper );
/** Sets text data for this portion. */
void setText( const ::rtl::OUString& rText );
/** Creates and returns a new font formatting object. */
FontRef createFont();
/** Links this portion to a font object from the global font list. */
void setFontId( sal_Int32 nFontId );
/** Final processing after import of all strings. */
void finalizeImport();
/** Returns the text data of this portion. */
inline const ::rtl::OUString& getText() const { return maText; }
/** Returns true, if the portion fontains font formatting. */
inline bool hasFont() const { return mxFont.get() != 0; }
/** Converts the portion and replaces or appends to the passed XText. */
void convert(
const ::com::sun::star::uno::Reference< ::com::sun::star::text::XText >& rxText,
const Font* pFont, bool bReplace );
void writeFontProperties(
const ::com::sun::star::uno::Reference< ::com::sun::star::text::XText >& rxText,
const Font* pFont ) const;
private:
::rtl::OUString maText; /// Portion text.
FontRef mxFont; /// Embedded portion font, may be empty.
sal_Int32 mnFontId; /// Link to global font list.
};
typedef ::boost::shared_ptr< RichStringPortion > RichStringPortionRef;
// ----------------------------------------------------------------------------
enum BiffFontPortionMode
{
BIFF_FONTPORTION_8BIT, /// Font portion with 8-bit values.
BIFF_FONTPORTION_16BIT, /// Font portion with 16-bit values.
BIFF_FONTPORTION_OBJ /// Font portion in OBJ or TXO record.
};
// ----------------------------------------------------------------------------
/** Represents a position in a rich-string containing current font identifier.
This object stores the position of a formatted character in a rich-string
and the identifier of a font from the global font list used to format this
and the following characters. Used in binary filters only.
*/
struct FontPortionModel
{
sal_Int32 mnPos; /// First character in the string.
sal_Int32 mnFontId; /// Font identifier for the next characters.
explicit inline FontPortionModel() : mnPos( 0 ), mnFontId( -1 ) {}
explicit inline FontPortionModel( sal_Int32 nPos, sal_Int32 nFontId ) :
mnPos( nPos ), mnFontId( nFontId ) {}
void read( SequenceInputStream& rStrm );
};
// ----------------------------------------------------------------------------
/** A vector with all font portions in a rich-string. */
class FontPortionModelList : public ::std::vector< FontPortionModel >
{
public:
inline explicit FontPortionModelList() {}
/** Appends a rich-string font identifier. */
void appendPortion( const FontPortionModel& rPortion );
/** Reads count and font identifiers from the passed stream. */
void importPortions( SequenceInputStream& rStrm );
};
// ============================================================================
struct PhoneticDataModel
{
sal_Int32 mnFontId; /// Font identifier for text formatting.
sal_Int32 mnType; /// Phonetic text type.
sal_Int32 mnAlignment; /// Phonetic portion alignment.
explicit PhoneticDataModel();
/** Sets the passed data from binary import. */
void setBiffData( sal_Int32 nType, sal_Int32 nAlignment );
};
// ----------------------------------------------------------------------------
class PhoneticSettings : public WorkbookHelper
{
public:
explicit PhoneticSettings( const WorkbookHelper& rHelper );
/** Imports phonetic settings from the phoneticPr element. */
void importPhoneticPr( const AttributeList& rAttribs );
/** Imports phonetic settings from the PHONETICPR record. */
void importPhoneticPr( SequenceInputStream& rStrm );
/** Imports phonetic settings from a rich string. */
void importStringData( SequenceInputStream& rStrm );
private:
PhoneticDataModel maModel;
};
// ============================================================================
/** Contains text data and positioning information for a phonetic text portion. */
class RichStringPhonetic : public WorkbookHelper
{
public:
explicit RichStringPhonetic( const WorkbookHelper& rHelper );
/** Sets text data for this phonetic portion. */
void setText( const ::rtl::OUString& rText );
/** Imports attributes of a phonetic run (rPh element). */
void importPhoneticRun( const AttributeList& rAttribs );
/** Sets the associated range in base text for this phonetic portion. */
void setBaseRange( sal_Int32 nBasePos, sal_Int32 nBaseEnd );
private:
::rtl::OUString maText; /// Portion text.
sal_Int32 mnBasePos; /// Start position in base text.
sal_Int32 mnBaseEnd; /// One-past-end position in base text.
};
typedef ::boost::shared_ptr< RichStringPhonetic > RichStringPhoneticRef;
// ----------------------------------------------------------------------------
/** Represents a phonetic text portion in a rich-string with phonetic text.
Used in binary filters only. */
struct PhoneticPortionModel
{
sal_Int32 mnPos; /// First character in phonetic text.
sal_Int32 mnBasePos; /// First character in base text.
sal_Int32 mnBaseLen; /// Number of characters in base text.
explicit inline PhoneticPortionModel() : mnPos( -1 ), mnBasePos( -1 ), mnBaseLen( 0 ) {}
explicit inline PhoneticPortionModel( sal_Int32 nPos, sal_Int32 nBasePos, sal_Int32 nBaseLen ) :
mnPos( nPos ), mnBasePos( nBasePos ), mnBaseLen( nBaseLen ) {}
void read( SequenceInputStream& rStrm );
};
// ----------------------------------------------------------------------------
/** A vector with all phonetic portions in a rich-string. */
class PhoneticPortionModelList : public ::std::vector< PhoneticPortionModel >
{
public:
inline explicit PhoneticPortionModelList() {}
/** Appends a rich-string phonetic portion. */
void appendPortion( const PhoneticPortionModel& rPortion );
/** Reads all phonetic portions from the passed stream. */
void importPortions( SequenceInputStream& rStrm );
};
// ============================================================================
/** Contains string data and a list of formatting runs for a rich formatted string. */
class RichString : public WorkbookHelper
{
public:
explicit RichString( const WorkbookHelper& rHelper );
/** Appends and returns a portion object for a plain string (t element). */
RichStringPortionRef importText( const AttributeList& rAttribs );
/** Appends and returns a portion object for a new formatting run (r element). */
RichStringPortionRef importRun( const AttributeList& rAttribs );
/** Appends and returns a phonetic text object for a new phonetic run (rPh element). */
RichStringPhoneticRef importPhoneticRun( const AttributeList& rAttribs );
/** Imports phonetic settings from the rPhoneticPr element. */
void importPhoneticPr( const AttributeList& rAttribs );
/** Imports a Unicode rich-string from the passed record stream. */
void importString( SequenceInputStream& rStrm, bool bRich );
/** Final processing after import of all strings. */
void finalizeImport();
/** Tries to extract a plain string from this object. Returns the string,
if there is only one unformatted portion. */
bool extractPlainString(
::rtl::OUString& orString,
const Font* pFirstPortionFont = 0 ) const;
/** Converts the string and writes it into the passed XText.
@param rxText The XText interface of the target object.
@param bReplaceOld True = replace old contents of the text object.
@param pFirstPortionFont Optional font providing additional rich-text
formatting for the first text portion, e.g. font escapement. */
void convert(
const ::com::sun::star::uno::Reference< ::com::sun::star::text::XText >& rxText,
bool bReplaceOld,
const Font* pFirstPortionFont = 0 ) const;
private:
/** Creates, appends, and returns a new empty string portion. */
RichStringPortionRef createPortion();
/** Creates, appends, and returns a new empty phonetic text portion. */
RichStringPhoneticRef createPhonetic();
/** Create base text portions from the passed string and character formatting. */
void createTextPortions( const ::rtl::OUString& rText, FontPortionModelList& rPortions );
/** Create phonetic text portions from the passed string and portion data. */
void createPhoneticPortions( const ::rtl::OUString& rText, PhoneticPortionModelList& rPortions, sal_Int32 nBaseLen );
private:
typedef RefVector< RichStringPortion > PortionVector;
typedef RefVector< RichStringPhonetic > PhoneticVector;
PortionVector maTextPortions; /// String portions with font data.
PhoneticSettings maPhonSettings; /// Phonetic settings for this string.
PhoneticVector maPhonPortions; /// Phonetic text portions.
};
typedef ::boost::shared_ptr< RichString > RichStringRef;
// ============================================================================
} // namespace xls
} // namespace oox
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
