ICU 4.8.1.1  4.8.1.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
LayoutEngine.h
Go to the documentation of this file.
1 /*
2  * (C) Copyright IBM Corp. 1998-2011 - All Rights Reserved
3  */
4 
5 #ifndef __LAYOUTENGINE_H
6 #define __LAYOUTENGINE_H
7 
8 #include "LETypes.h"
9 
16 
17 class LEFontInstance;
18 class LEGlyphFilter;
19 class LEGlyphStorage;
20 
65 public:
67  static const le_int32 kTypoFlagKern;
69  static const le_int32 kTypoFlagLiga;
70 
71 protected:
78 
87 
96 
105 
112 
120 
137  LayoutEngine(const LEFontInstance *fontInstance,
138  le_int32 scriptCode,
139  le_int32 languageCode,
140  le_int32 typoFlags,
141  LEErrorCode &success);
142 
150  LayoutEngine();
151 
174  virtual le_int32 characterProcessing(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft,
175  LEUnicode *&outChars, LEGlyphStorage &glyphStorage, LEErrorCode &success);
176 
203  virtual le_int32 computeGlyphs(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft, LEGlyphStorage &glyphStorage, LEErrorCode &success);
204 
218  virtual void positionGlyphs(LEGlyphStorage &glyphStorage, float x, float y, LEErrorCode &success);
219 
240  virtual void adjustGlyphPositions(const LEUnicode chars[], le_int32 offset, le_int32 count, le_bool reverse, LEGlyphStorage &glyphStorage, LEErrorCode &success);
241 
254  virtual const void *getFontTable(LETag tableTag) const;
255 
281  virtual void mapCharsToGlyphs(const LEUnicode chars[], le_int32 offset, le_int32 count, le_bool reverse, le_bool mirror, LEGlyphStorage &glyphStorage, LEErrorCode &success);
282 
295  static void adjustMarkGlyphs(LEGlyphStorage &glyphStorage, LEGlyphFilter *markFilter, LEErrorCode &success);
296 
297 
316  static void adjustMarkGlyphs(const LEUnicode chars[], le_int32 charCount, le_bool reverse, LEGlyphStorage &glyphStorage, LEGlyphFilter *markFilter, LEErrorCode &success);
317 
318 
319 public:
328  virtual ~LayoutEngine();
329 
355  virtual le_int32 layoutChars(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft, float x, float y, LEErrorCode &success);
356 
366  le_int32 getGlyphCount() const;
367 
378  void getGlyphs(LEGlyphID glyphs[], LEErrorCode &success) const;
379 
392  virtual void getGlyphs(le_uint32 glyphs[], le_uint32 extraBits, LEErrorCode &success) const;
393 
404  void getCharIndices(le_int32 charIndices[], LEErrorCode &success) const;
405 
417  void getCharIndices(le_int32 charIndices[], le_int32 indexBase, LEErrorCode &success) const;
418 
430  void getGlyphPositions(float positions[], LEErrorCode &success) const;
431 
446  void getGlyphPosition(le_int32 glyphIndex, float &x, float &y, LEErrorCode &success) const;
447 
455  virtual void reset();
456 
473  static LayoutEngine *layoutEngineFactory(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode, LEErrorCode &success);
474 
479  static LayoutEngine *layoutEngineFactory(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode, le_int32 typo_flags, LEErrorCode &success);
480 
486  virtual UClassID getDynamicClassID() const;
487 
493  static UClassID getStaticClassID();
494 
495 };
496 
498 #endif
uint32_t le_uint32
A type used for unsigned, 32-bit integers.
Definition: LETypes.h:41
le_uint32 LETag
Used for four character tags.
Definition: LETypes.h:93
le_int32 fScriptCode
The script code for the text.
Definition: LayoutEngine.h:95
le_int32 fLanguageCode
The langauge code for the text.
Definition: LayoutEngine.h:104
This class encapsulates the per-glyph storage used by the ICU LayoutEngine.
#define U_LAYOUT_API
Set to export library symbols from inside the layout engine library, and to import them from outside...
Definition: utypes.h:522
This is a virtual base class used to do complex text layout.
Definition: LayoutEngine.h:64
LEGlyphStorage * fGlyphStorage
The object which holds the glyph storage.
Definition: LayoutEngine.h:77
static const le_int32 kTypoFlagLiga
Definition: LayoutEngine.h:69
C API: Basic definitions for the ICU LayoutEngine.
int32_t le_int32
A type used for signed, 32-bit integers.
Definition: LETypes.h:34
UBool le_bool
A type used for boolean values.
Definition: LETypes.h:77
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
This is a virtual base class that serves as the interface between a LayoutEngine and the platform fon...
const LEFontInstance * fFontInstance
The font instance for the text font.
Definition: LayoutEngine.h:86
static const le_int32 kTypoFlagKern
Definition: LayoutEngine.h:67
LEErrorCode
Error codes returned by the LayoutEngine.
Definition: LETypes.h:528
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:215
void * UClassID
UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...
Definition: utypes.h:385
UChar LEUnicode
Used to represent 16-bit Unicode code points.
Definition: LETypes.h:237
le_uint32 LEGlyphID
Used for glyph indices.
Definition: LETypes.h:112
le_int32 fTypoFlags
The typographic control flags.
Definition: LayoutEngine.h:111
le_bool fFilterZeroWidth
TRUE if mapCharsToGlyphs should replace ZWJ / ZWNJ with a glyph with no contours. ...
Definition: LayoutEngine.h:119
virtual UClassID getDynamicClassID() const =0
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.