HanLayoutEngine.h revision 1693
5286N/A/*
5286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5286N/A *
5286N/A * This code is free software; you can redistribute it and/or modify it
5286N/A * under the terms of the GNU General Public License version 2 only, as
5286N/A * published by the Free Software Foundation. Sun designates this
5286N/A * particular file as subject to the "Classpath" exception as provided
5286N/A * by Sun in the LICENSE file that accompanied this code.
5286N/A *
5286N/A * This code is distributed in the hope that it will be useful, but WITHOUT
5286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
5286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
5286N/A * version 2 for more details (a copy is included in the LICENSE file that
5286N/A * accompanied this code).
5286N/A *
5286N/A * You should have received a copy of the GNU General Public License version
5286N/A * 2 along with this work; if not, write to the Free Software Foundation,
5286N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
5286N/A *
5286N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
5286N/A * CA 95054 USA or visit www.sun.com if you need additional information or
5286N/A * have any questions.
5286N/A *
5286N/A */
5286N/A
5286N/A
5853N/A/*
5286N/A * HanLayoutEngine.h: OpenType processing for Han fonts.
5286N/A *
5853N/A * (C) Copyright IBM Corp. 1998-2005 - All Rights Reserved.
5286N/A */
5286N/A
5286N/A#ifndef __HANLAYOUTENGINE_H
5286N/A#define __HANLAYOUTENGINE_H
5286N/A
5286N/A#include "LETypes.h"
5286N/A#include "LEFontInstance.h"
5286N/A#include "LayoutEngine.h"
5286N/A#include "OpenTypeLayoutEngine.h"
5286N/A
5286N/A#include "GlyphSubstitutionTables.h"
5286N/A
5286N/AU_NAMESPACE_BEGIN
5286N/A
5286N/Aclass LEGlyphStorage;
5286N/A
5286N/A/**
5286N/A * This class implements OpenType layout for Han fonts. It overrides
5286N/A * the characerProcessing method to assign the correct OpenType feature
5286N/A * tags for the CJK language-specific forms.
5286N/A *
5286N/A * @internal
5286N/A */
5286N/Aclass HanOpenTypeLayoutEngine : public OpenTypeLayoutEngine
5286N/A{
5286N/Apublic:
5286N/A /**
5286N/A * This is the main constructor. It constructs an instance of HanOpenTypeLayoutEngine for
5286N/A * a particular font, script and language. It takes the GSUB table as a parameter since
5286N/A * LayoutEngine::layoutEngineFactory has to read the GSUB table to know that it has a
5286N/A * Han OpenType font.
5286N/A *
5286N/A * @param fontInstance - the font
5286N/A * @param scriptCode - the script
5286N/A * @param langaugeCode - the language
5286N/A * @param gsubTable - the GSUB table
5286N/A *
5286N/A * @see LayoutEngine::layoutEngineFactory
5286N/A * @see OpenTypeLayoutEngine
5286N/A * @see ScriptAndLangaugeTags.h for script and language codes
5286N/A *
5286N/A * @internal
5286N/A */
5286N/A HanOpenTypeLayoutEngine(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode,
5286N/A le_int32 typoFlags, const GlyphSubstitutionTableHeader *gsubTable);
5286N/A
5286N/A
5286N/A /**
5286N/A * The destructor, virtual for correct polymorphic invocation.
5286N/A *
5286N/A * @internal
5286N/A */
5286N/A virtual ~HanOpenTypeLayoutEngine();
5286N/A
5286N/A /**
5286N/A * ICU "poor man's RTTI", returns a UClassID for the actual class.
5286N/A *
5286N/A * @stable ICU 2.8
5286N/A */
5286N/A virtual UClassID getDynamicClassID() const;
5286N/A
5286N/A /**
5286N/A * ICU "poor man's RTTI", returns a UClassID for this class.
5286N/A *
5286N/A * @stable ICU 2.8
*/
static UClassID getStaticClassID();
protected:
/**
* This method does Han OpenType character processing. It assigns the OpenType feature
* tags to the characters to generate the correct language-specific variants.
*
* Input parameters:
* @param chars - the input character context
* @param offset - the index of the first character to process
* @param count - the number of characters to process
* @param max - the number of characters in the input context
* @param rightToLeft - <code>TRUE</code> if the characters are in a right to left directional run
* @param glyphStorage - the object holding the glyph storage. The char index and auxillary data arrays will be set.
*
* Output parameters:
* @param outChars - the output character arrayt
* @param charIndices - the output character index array
* @param featureTags - the output feature tag array
* @param success - set to an error code if the operation fails
*
* @return the output character count
*
* @internal
*/
virtual le_int32 characterProcessing(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft,
LEUnicode *&outChars, LEGlyphStorage &glyphStorage, LEErrorCode &success);
};
U_NAMESPACE_END
#endif