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
|
/*************************************************************************
*
* 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 _SV_SALLAYOUT_HXX
#define _SV_SALLAYOUT_HXX
#include <tools/gen.hxx>
#include <vector>
namespace basegfx {
class B2DPolyPolygon;
typedef std::vector<B2DPolyPolygon> B2DPolyPolygonVector;
}
#ifndef _TOOLS_LANG_HXX
typedef unsigned short LanguageType;
#endif
#include <vector>
#include <list>
#include <vcl/dllapi.h>
// for typedef sal_UCS4
#include <vcl/vclenum.hxx>
class SalGraphics;
class ImplFontData;
#define MAX_FALLBACK 16
// ----------------
// - LayoutOption -
// ----------------
#define SAL_LAYOUT_BIDI_RTL 0x0001
#define SAL_LAYOUT_BIDI_STRONG 0x0002
#define SAL_LAYOUT_RIGHT_ALIGN 0x0004
#define SAL_LAYOUT_KERNING_PAIRS 0x0010
#define SAL_LAYOUT_KERNING_ASIAN 0x0020
#define SAL_LAYOUT_VERTICAL 0x0040
#define SAL_LAYOUT_COMPLEX_DISABLED 0x0100
#define SAL_LAYOUT_ENABLE_LIGATURES 0x0200
#define SAL_LAYOUT_SUBSTITUTE_DIGITS 0x0400
#define SAL_LAYOUT_KASHIDA_JUSTIFICATON 0x0800
#define SAL_LAYOUT_DISABLE_GLYPH_PROCESSING 0x1000
#define SAL_LAYOUT_FOR_FALLBACK 0x2000
// -----------------
// used for managing runs e.g. for BiDi, glyph and script fallback
class VCL_DLLPUBLIC ImplLayoutRuns
{
private:
int mnRunIndex;
std::vector<int> maRuns;
public:
ImplLayoutRuns() { mnRunIndex = 0; maRuns.reserve(8); }
void Clear() { maRuns.clear(); }
bool AddPos( int nCharPos, bool bRTL );
bool AddRun( int nMinRunPos, int nEndRunPos, bool bRTL );
bool IsEmpty() const { return maRuns.empty(); }
void ResetPos() { mnRunIndex = 0; }
void NextRun() { mnRunIndex += 2; }
bool GetRun( int* nMinRunPos, int* nEndRunPos, bool* bRTL ) const;
bool GetNextPos( int* nCharPos, bool* bRTL );
bool PosIsInRun( int nCharPos ) const;
bool PosIsInAnyRun( int nCharPos ) const;
};
// -----------------
class ImplLayoutArgs
{
public:
// string related inputs
int mnFlags;
int mnLength;
int mnMinCharPos;
int mnEndCharPos;
const xub_Unicode* mpStr;
// positioning related inputs
const sal_Int32* mpDXArray; // in pixel units
long mnLayoutWidth; // in pixel units
int mnOrientation; // in 0-3600 system
// data for bidi and glyph+script fallback
ImplLayoutRuns maRuns;
ImplLayoutRuns maReruns;
public:
ImplLayoutArgs( const xub_Unicode* pStr, int nLength,
int nMinCharPos, int nEndCharPos, int nFlags );
void SetLayoutWidth( long nWidth ) { mnLayoutWidth = nWidth; }
void SetDXArray( const sal_Int32* pDXArray ) { mpDXArray = pDXArray; }
void SetOrientation( int nOrientation ) { mnOrientation = nOrientation; }
void ResetPos()
{ maRuns.ResetPos(); }
bool GetNextPos( int* nCharPos, bool* bRTL )
{ return maRuns.GetNextPos( nCharPos, bRTL ); }
bool GetNextRun( int* nMinRunPos, int* nEndRunPos, bool* bRTL );
bool NeedFallback( int nCharPos, bool bRTL )
{ return maReruns.AddPos( nCharPos, bRTL ); }
bool NeedFallback( int nMinRunPos, int nEndRunPos, bool bRTL )
{ return maReruns.AddRun( nMinRunPos, nEndRunPos, bRTL ); }
// methods used by BiDi and glyph fallback
bool NeedFallback() const
{ return !maReruns.IsEmpty(); }
bool PrepareFallback();
protected:
void AddRun( int nMinCharPos, int nEndCharPos, bool bRTL );
};
// helper functions often used with ImplLayoutArgs
bool IsDiacritic( sal_UCS4 );
int GetVerticalFlags( sal_UCS4 );
sal_UCS4 GetVerticalChar( sal_UCS4 );
// #i80090# GetMirroredChar also needed outside vcl, moved to svapp.hxx
// VCL_DLLPUBLIC sal_UCS4 GetMirroredChar( sal_UCS4 );
sal_UCS4 GetLocalizedChar( sal_UCS4, LanguageType );
VCL_DLLPUBLIC const char* GetAutofallback( sal_UCS4 ) ;
// -------------
// - SalLayout -
// -------------
typedef sal_uInt32 sal_GlyphId;
// Glyph Flags
#define GF_NONE 0x00000000
#define GF_FLAGMASK 0xFF800000
#define GF_IDXMASK ~GF_FLAGMASK
#define GF_ISCHAR 0x00800000
#define GF_ROTL 0x01000000
// caution !!!
#define GF_VERT 0x02000000
// GF_VERT is only for windows implementation
// (win/source/gdi/salgdi3.cxx, win/source/gdi/winlayout.cxx)
// don't use this elsewhere !!!
#define GF_ROTR 0x03000000
#define GF_ROTMASK 0x03000000
#define GF_UNHINTED 0x04000000
#define GF_GSUB 0x08000000
#define GF_FONTMASK 0xF0000000
#define GF_FONTSHIFT 28
#define GF_DROPPED 0xFFFFFFFF
// all positions/widths are in font units
// one exception: drawposition is in pixel units
class VCL_DLLPUBLIC SalLayout
{
public:
// used by upper layers
Point& DrawBase() { return maDrawBase; }
const Point& DrawBase() const { return maDrawBase; }
Point& DrawOffset() { return maDrawOffset; }
const Point& DrawOffset() const { return maDrawOffset; }
Point GetDrawPosition( const Point& rRelative = Point(0,0) ) const;
virtual bool LayoutText( ImplLayoutArgs& ) = 0; // first step of layouting
virtual void AdjustLayout( ImplLayoutArgs& ); // adjusting after fallback etc.
virtual void InitFont() const {}
virtual void DrawText( SalGraphics& ) const = 0;
int GetUnitsPerPixel() const { return mnUnitsPerPixel; }
int GetOrientation() const { return mnOrientation; }
virtual const ImplFontData* GetFallbackFontData( sal_GlyphId ) const;
// methods using string indexing
virtual int GetTextBreak( long nMaxWidth, long nCharExtra=0, int nFactor=1 ) const = 0;
virtual long FillDXArray( sal_Int32* pDXArray ) const = 0;
virtual long GetTextWidth() const { return FillDXArray( NULL ); }
virtual void GetCaretPositions( int nArraySize, sal_Int32* pCaretXArray ) const = 0;
virtual bool IsKashidaPosValid ( int /*nCharPos*/ ) const { return true; } // i60594
// methods using glyph indexing
virtual int GetNextGlyphs( int nLen, sal_GlyphId* pGlyphIdAry, Point& rPos, int&,
sal_Int32* pGlyphAdvAry = NULL, int* pCharPosAry = NULL ) const = 0;
virtual bool GetOutline( SalGraphics&, ::basegfx::B2DPolyPolygonVector& ) const;
virtual bool GetBoundRect( SalGraphics&, Rectangle& ) const;
virtual bool IsSpacingGlyph( sal_GlyphId ) const;
// reference counting
void Reference() const;
void Release() const;
// used by glyph+font+script fallback
virtual void MoveGlyph( int nStart, long nNewXPos ) = 0;
virtual void DropGlyph( int nStart ) = 0;
virtual void Simplify( bool bIsBase ) = 0;
virtual void DisableGlyphInjection( bool /*bDisable*/ ) {}
protected:
// used by layout engines
SalLayout();
virtual ~SalLayout();
// used by layout layers
void SetUnitsPerPixel( int n ) { mnUnitsPerPixel = n; }
void SetOrientation( int nOrientation ) // in 0-3600 system
{ mnOrientation = nOrientation; }
static int CalcAsianKerning( sal_UCS4, bool bLeft, bool bVertical );
private:
// enforce proper copy semantic
SAL_DLLPRIVATE SalLayout( const SalLayout& );
SAL_DLLPRIVATE SalLayout& operator=( const SalLayout& );
protected:
int mnMinCharPos;
int mnEndCharPos;
int mnLayoutFlags;
int mnUnitsPerPixel;
int mnOrientation;
mutable int mnRefCount;
mutable Point maDrawOffset;
Point maDrawBase;
};
// ------------------
// - MultiSalLayout -
// ------------------
class VCL_DLLPUBLIC MultiSalLayout : public SalLayout
{
public:
virtual void DrawText( SalGraphics& ) const;
virtual int GetTextBreak( long nMaxWidth, long nCharExtra, int nFactor ) const;
virtual long FillDXArray( sal_Int32* pDXArray ) const;
virtual void GetCaretPositions( int nArraySize, sal_Int32* pCaretXArray ) const;
virtual int GetNextGlyphs( int nLen, sal_GlyphId* pGlyphIdxAry, Point& rPos,
int&, sal_Int32* pGlyphAdvAry, int* pCharPosAry ) const;
virtual bool GetOutline( SalGraphics&, ::basegfx::B2DPolyPolygonVector& ) const;
virtual bool GetBoundRect( SalGraphics&, Rectangle& ) const;
// used only by OutputDevice::ImplLayout, TODO: make friend
MultiSalLayout( SalLayout& rBaseLayout,
const ImplFontData* pBaseFont = NULL );
virtual bool AddFallback( SalLayout& rFallbackLayout,
ImplLayoutRuns&, const ImplFontData* pFallbackFont );
virtual bool LayoutText( ImplLayoutArgs& );
virtual void AdjustLayout( ImplLayoutArgs& );
virtual void InitFont() const;
virtual const ImplFontData* GetFallbackFontData( sal_GlyphId ) const;
void SetInComplete(bool bInComplete = true);
protected:
virtual ~MultiSalLayout();
private:
// dummy implementations
virtual void MoveGlyph( int, long ) {}
virtual void DropGlyph( int ) {}
virtual void Simplify( bool ) {}
// enforce proper copy semantic
SAL_DLLPRIVATE MultiSalLayout( const MultiSalLayout& );
SAL_DLLPRIVATE MultiSalLayout& operator=( const MultiSalLayout& );
private:
SalLayout* mpLayouts[ MAX_FALLBACK ];
const ImplFontData* mpFallbackFonts[ MAX_FALLBACK ];
ImplLayoutRuns maFallbackRuns[ MAX_FALLBACK ];
int mnLevel;
bool mbInComplete;
};
// --------------------
// - GenericSalLayout -
// --------------------
struct GlyphItem
{
int mnFlags;
int mnCharPos; // index in string
int mnOrigWidth; // original glyph width
int mnNewWidth; // width after adjustments
sal_GlyphId mnGlyphIndex;
Point maLinearPos; // absolute position of non rotated string
public:
GlyphItem() {}
GlyphItem( int nCharPos, sal_GlyphId nGlyphIndex, const Point& rLinearPos,
long nFlags, int nOrigWidth )
: mnFlags(nFlags), mnCharPos(nCharPos),
mnOrigWidth(nOrigWidth), mnNewWidth(nOrigWidth),
mnGlyphIndex(nGlyphIndex), maLinearPos(rLinearPos)
{}
enum{ FALLBACK_MASK=0xFF, IS_IN_CLUSTER=0x100, IS_RTL_GLYPH=0x200, IS_DIACRITIC=0x400 };
bool IsClusterStart() const { return ((mnFlags & IS_IN_CLUSTER) == 0); }
bool IsRTLGlyph() const { return ((mnFlags & IS_RTL_GLYPH) != 0); }
bool IsDiacritic() const { return ((mnFlags & IS_DIACRITIC) != 0); }
};
// ---------------
typedef std::list<GlyphItem> GlyphList;
typedef std::vector<GlyphItem> GlyphVector;
// ---------------
class VCL_DLLPUBLIC GenericSalLayout : public SalLayout
{
public:
// used by layout engines
void AppendGlyph( const GlyphItem& );
virtual void AdjustLayout( ImplLayoutArgs& );
virtual void ApplyDXArray( ImplLayoutArgs& );
virtual void Justify( long nNewWidth );
void KashidaJustify( long nIndex, int nWidth );
void ApplyAsianKerning( const sal_Unicode*, int nLength );
void SortGlyphItems();
// used by upper layers
virtual long GetTextWidth() const;
virtual long FillDXArray( sal_Int32* pDXArray ) const;
virtual int GetTextBreak( long nMaxWidth, long nCharExtra, int nFactor ) const;
virtual void GetCaretPositions( int nArraySize, sal_Int32* pCaretXArray ) const;
// used by display layers
virtual int GetNextGlyphs( int nLen, sal_GlyphId* pGlyphIdxAry, Point& rPos, int&,
sal_Int32* pGlyphAdvAry = NULL, int* pCharPosAry = NULL ) const;
protected:
GenericSalLayout();
virtual ~GenericSalLayout();
// for glyph+font+script fallback
virtual void MoveGlyph( int nStart, long nNewXPos );
virtual void DropGlyph( int nStart );
virtual void Simplify( bool bIsBase );
bool GetCharWidths( sal_Int32* pCharWidths ) const;
private:
GlyphItem* mpGlyphItems; // TODO: change to GlyphList
int mnGlyphCount;
int mnGlyphCapacity;
mutable Point maBasePoint;
// enforce proper copy semantic
SAL_DLLPRIVATE GenericSalLayout( const GenericSalLayout& );
SAL_DLLPRIVATE GenericSalLayout& operator=( const GenericSalLayout& );
};
#undef SalGraphics
#endif // _SV_SALLAYOUT_HXX
|
