sl@0: 
sl@0: /*
sl@0:  * HanLayoutEngine.h: OpenType processing for Han fonts.
sl@0:  *
sl@0:  * (C) Copyright IBM Corp. 1998-2005 - All Rights Reserved.
sl@0:  */
sl@0: 
sl@0: #ifndef __HANLAYOUTENGINE_H
sl@0: #define __HANLAYOUTENGINE_H
sl@0: 
sl@0: #include "LETypes.h"
sl@0: #include "LEFontInstance.h"
sl@0: #include "LayoutEngine.h"
sl@0: #include "OpenTypeLayoutEngine.h"
sl@0: 
sl@0: #include "GlyphSubstitutionTables.h"
sl@0: 
sl@0: U_NAMESPACE_BEGIN
sl@0: 
sl@0: class LEGlyphStorage;
sl@0: 
sl@0: /**
sl@0:  * This class implements OpenType layout for Han fonts. It overrides
sl@0:  * the characerProcessing method to assign the correct OpenType feature
sl@0:  * tags for the CJK language-specific forms.
sl@0:  *
sl@0:  * @internal
sl@0:  */
sl@0: class HanOpenTypeLayoutEngine : public OpenTypeLayoutEngine
sl@0: {
sl@0: public:
sl@0:     /**
sl@0:      * This is the main constructor. It constructs an instance of HanOpenTypeLayoutEngine for
sl@0:      * a particular font, script and language. It takes the GSUB table as a parameter since
sl@0:      * LayoutEngine::layoutEngineFactory has to read the GSUB table to know that it has a
sl@0:      * Han OpenType font.
sl@0:      *
sl@0:      * @param fontInstance - the font
sl@0:      * @param scriptCode - the script
sl@0:      * @param langaugeCode - the language
sl@0:      * @param gsubTable - the GSUB table
sl@0:      *
sl@0:      * @see LayoutEngine::layoutEngineFactory
sl@0:      * @see OpenTypeLayoutEngine
sl@0:      * @see ScriptAndLangaugeTags.h for script and language codes
sl@0:      *
sl@0:      * @internal
sl@0:      */
sl@0:     HanOpenTypeLayoutEngine(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode,
sl@0:                             le_int32 typoFlags, const GlyphSubstitutionTableHeader *gsubTable);
sl@0: 
sl@0: 
sl@0:     /**
sl@0:      * The destructor, virtual for correct polymorphic invocation.
sl@0:      *
sl@0:      * @internal
sl@0:      */
sl@0:     virtual ~HanOpenTypeLayoutEngine();
sl@0: 
sl@0:     /**
sl@0:      * ICU "poor man's RTTI", returns a UClassID for the actual class.
sl@0:      *
sl@0:      * @stable ICU 2.8
sl@0:      */
sl@0:     virtual UClassID getDynamicClassID() const;
sl@0: 
sl@0:     /**
sl@0:      * ICU "poor man's RTTI", returns a UClassID for this class.
sl@0:      *
sl@0:      * @stable ICU 2.8
sl@0:      */
sl@0:     static UClassID getStaticClassID();
sl@0: 
sl@0: protected:
sl@0: 
sl@0:     /**
sl@0:      * This method does Han OpenType character processing. It assigns the OpenType feature
sl@0:      * tags to the characters to generate the correct language-specific variants.
sl@0:      *
sl@0:      * Input parameters:
sl@0:      * @param chars - the input character context
sl@0:      * @param offset - the index of the first character to process
sl@0:      * @param count - the number of characters to process
sl@0:      * @param max - the number of characters in the input context
sl@0:      * @param rightToLeft - <code>TRUE</code> if the characters are in a right to left directional run
sl@0:      * @param glyphStorage - the object holding the glyph storage. The char index and auxillary data arrays will be set.
sl@0:      *
sl@0:      * Output parameters:
sl@0:      * @param outChars - the output character arrayt
sl@0:      * @param charIndices - the output character index array
sl@0:      * @param featureTags - the output feature tag array
sl@0:      * @param success - set to an error code if the operation fails
sl@0:      *
sl@0:      * @return the output character count
sl@0:      *
sl@0:      * @internal
sl@0:      */
sl@0:     virtual le_int32 characterProcessing(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft,
sl@0:             LEUnicode *&outChars, LEGlyphStorage &glyphStorage, LEErrorCode &success);
sl@0: 
sl@0: };
sl@0: 
sl@0: U_NAMESPACE_END
sl@0: #endif