1ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 2ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru/* 3ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 459d709d503bab6e2b61931737e662dd293b40578ccornelius * (C) Copyright IBM Corp. 1998-2013 - All Rights Reserved 5ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 6ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru */ 7ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 8ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#ifndef __HANGULAYOUTENGINE_H 9ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#define __HANGULAYOUTENGINE_H 10ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 11ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#include "LETypes.h" 12ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#include "LEFontInstance.h" 13ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#include "LEGlyphFilter.h" 14ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#include "LayoutEngine.h" 15ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#include "OpenTypeLayoutEngine.h" 16ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 17ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#include "GlyphSubstitutionTables.h" 18ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#include "GlyphDefinitionTables.h" 19ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#include "GlyphPositioningTables.h" 20ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 21ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste QueruU_NAMESPACE_BEGIN 22ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 23ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queruclass MPreFixups; 24ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queruclass LEGlyphStorage; 25ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 26ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru/** 27ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * This class implements OpenType layout for Old Hangul OpenType fonts, as 28ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * specified by Microsoft in "Creating and Supporting OpenType Fonts for 29ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * The Korean Hangul Script" (http://www.microsoft.com/typography/otfntdev/hangulot/default.htm) 30ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 31ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * This class overrides the characterProcessing method to do Hangul character processing. 32ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * (See the MS spec. for more details) 33ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 34ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @internal 35ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru */ 36ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queruclass HangulOpenTypeLayoutEngine : public OpenTypeLayoutEngine 37ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru{ 38ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Querupublic: 39ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru /** 40ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * This is the main constructor. It constructs an instance of HangulOpenTypeLayoutEngine for 41ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * a particular font, script and language. It takes the GSUB table as a parameter since 42ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * LayoutEngine::layoutEngineFactory has to read the GSUB table to know that it has an 43ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * Hangul OpenType font. 44ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 45ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param fontInstance - the font 46ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param scriptCode - the script 47ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param langaugeCode - the language 48ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param gsubTable - the GSUB table 4985bf2e2fbc60a9f938064abc8127d61da7d19882Claire Ho * @param success - set to an error code if the operation fails 50ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 51ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @see LayoutEngine::layoutEngineFactory 52ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @see OpenTypeLayoutEngine 53ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @see ScriptAndLangaugeTags.h for script and language codes 54ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 55ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @internal 56ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru */ 57ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru HangulOpenTypeLayoutEngine(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode, 5859d709d503bab6e2b61931737e662dd293b40578ccornelius le_int32 typoFlags, const LEReferenceTo<GlyphSubstitutionTableHeader> &gsubTable, LEErrorCode &success); 59ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 60ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru /** 61ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * This constructor is used when the font requires a "canned" GSUB table which can't be known 62ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * until after this constructor has been invoked. 63ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 64ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param fontInstance - the font 65ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param scriptCode - the script 66ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param langaugeCode - the language 6785bf2e2fbc60a9f938064abc8127d61da7d19882Claire Ho * @param success - set to an error code if the operation fails 68ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 69ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @see OpenTypeLayoutEngine 70ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @see ScriptAndLangaugeTags.h for script and language codes 71ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 72ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @internal 73ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru */ 74ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru HangulOpenTypeLayoutEngine(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode, 7585bf2e2fbc60a9f938064abc8127d61da7d19882Claire Ho le_int32 typoFlags, LEErrorCode &success); 76ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 77ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru /** 78ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * The destructor, virtual for correct polymorphic invocation. 79ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 80ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @internal 81ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru */ 82ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru virtual ~HangulOpenTypeLayoutEngine(); 83ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 84ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru /** 85ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * ICU "poor man's RTTI", returns a UClassID for the actual class. 86ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 87ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @stable ICU 2.8 88ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru */ 89ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru virtual UClassID getDynamicClassID() const; 90ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 91ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru /** 92ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * ICU "poor man's RTTI", returns a UClassID for this class. 93ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 94ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @stable ICU 2.8 95ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru */ 96ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru static UClassID getStaticClassID(); 97ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 98ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queruprotected: 99ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 100ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru /** 101ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * This method does Hangul OpenType character processing. It assigns the OpenType feature 102ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * tags to the characters, and may compose a character sequence into a modern Hangul syllable, 103ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * or decompose a modern Hangul syllable if it forms part of an old Hangul syllable. 104ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 105ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * Input parameters: 106ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param chars - the input character context 107ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param offset - the index of the first character to process 108ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param count - the number of characters to process 109ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param max - the number of characters in the input context 110ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param rightToLeft - <code>TRUE</code> if the characters are in a right to left directional run 111ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param glyphStorage - the glyph storage object. The glyph and character index arrays will be set. 112ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * the auxillary data array will be set to the feature tags. 113ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 114ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * Output parameters: 115ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @param success - set to an error code if the operation fails 116ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 117ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @return the output character count 118ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * 119ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru * @internal 120ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru */ 121ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru virtual le_int32 characterProcessing(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft, 122ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru LEUnicode *&outChars, LEGlyphStorage &glyphStorage, LEErrorCode &success); 123ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru}; 124ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 125ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste QueruU_NAMESPACE_END 126ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru#endif 127ac04d0bbe12b3ef54518635711412f178cb4d16Jean-Baptiste Queru 128