Symaptic: os/textandloc/charconvfw/charconvplugins/src/shared/CnvPictographShared.h@260cb5ec6c19

     1 /*

     2 * Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:         This class is a utitlity class for conversion of Vodafone

    15 *                pictograph.

    16 *

    17 */

    28 #ifndef CNVPICTOGRAPHSHARED_H

    29 #define CNVPICTOGRAPHSHARED_H

    31 //  INCLUDES

    32 #include <e32std.h>

    33 #include <charconv.h>

    34 #include <convutils.h>

    35 #include "PictographObserver.h"

    38 // CONSTANTS

    39 // Count of Vodafone pictograph's pages

    40 const TInt KCountOfPictoPages(6);

    43 // CLASS DECLARATION

    45 /**

    46 *  This class is a utitlity class for conversion of Vodafone pictograph.

    47 *  The conversion data are in each CnvPctograph1 - 6 dll.

    48 *  CnvPictographShared only to be used by ISO2022Jp.cpl, SHIFTJIS_SHARED.dll or

    49 *  something. For example, when CCnvCharacterSetConverter::ConvertFromUnicode()

    50 *  is called, and ConvertFromUnicode() of ISO2022Jp.cpl is called. After that,

    51 *  ISO2022Jp.cpl sets some parameters for the conversion. At that time,

    52 *  CnvPictographShared::SetCharacterSetsForPictograph() is called.

    53 *  In a nut shell, CnvPictographShared is chaind from Japanese conversion

    54 *  plug-ins.

    55 *

    56 *  @lib CnvPictograph1.dll

    57 *  @lib CnvPictograph2.dll

    58 *  @lib CnvPictograph3.dll

    59 *  @lib CnvPictograph4.dll

    60 *  @lib CnvPictograph5.dll

    61 *  @lib CnvPictograph6.dll

    62 *  @since 2.6

    63 */

    64 class CnvPictographShared

    65     {

    66     public:

    67         /**

    68         * It sets parameters to SCharacterSet array.

    69         * It called in ConvertFromUnicode().

    70         * It makes possible that pictograph conversion is called from other

    71         * conversion plug-ins.

    72         * @since 2.6

    73         * @param aArrayOfCharacterSets The conversion table array

    74         */

    75         static void SetCharacterSetsForPictograph(

    76             RArray<CnvUtilities::SCharacterSet>& aArrayOfCharacterSets);

    77         /**

    78         * It sets parameters to SCharacterSet array.

    79         * It called in ConvertFromUnicode().

    80         * It makes possible that pictograph conversion is called from other

    81         * conversion plug-ins.

    82         * @since 2.6

    83         * @param aArrayOfCharacterSets The conversion table array

    84         * @param aOriginalCharset The character set

    85         */

    86         static void SetCharacterSetsForPictograph(

    87             RArray<CnvUtilities::SCharacterSet>& aArrayOfCharacterSets,

    88             TOriginalCharset aOriginalCharset);

    89         /**

    90         * It sets parameters to SMethod array.

    91         * It called in ConvertToUnicode().

    92         * It makes possible that pictograph conversion is called from other

    93         * conversion plug-ins.

    94         * @since 2.6

    95         * @param aArrayOfMethods The conversion table array

    96         * @param aOriginalCharset The character set

    97         */

    98         static void SetMethodsForPictograph(

    99             RArray<CnvUtilities::SMethod>& aArrayOfMethods,

   100             TOriginalCharset aOriginalCharset);

   101         /**

   102         * It sets parameters to SState array.

   103         * It called in ConvertToUnicode().

   104         * It makes possible that pictograph conversion is called from other

   105         * conversion plug-ins.

   106         * @since 2.6

   107         * @param aArrayOfMethods The conversion table array

   108         */

   109         static void SetStatesForPictograph(

   110             RArray<CnvUtilities::SState>& aArrayOfStates);

   112     private:

   113         /**

   114         * It converts from an intermediate buffer to a pictograph code.

   115         * After that, it adds shift-in code(0x0F).

   116         * @since 2.6

   117         * @param aStartPositionInDescriptor The start postion for checking

   118         * @param aDescriptor The descripter has intermidiate buffer.

   119         * @param aNumberOfCharactersThatDroppedOut The number of characters

   120         *                                          that it's dropped out

   121         */

   122         static void ConvertToPictograph1InPlace(

   123             TInt aStartPositionInDescriptor,

   124             TDes8& aDescriptor, TInt& aNumberOfCharactersThatDroppedOut);

   125         /**

   126         * It converts from an intermediate buffer to a pictograph code.

   127         * After that, it adds shift-in code(0x0F).

   128         * @since 2.6

   129         * @param aStartPositionInDescriptor The start postion for checking

   130         * @param aDescriptor The descripter has intermidiate buffer.

   131         * @param aNumberOfCharactersThatDroppedOut The number of characters

   132         *                                          that it's dropped out

   133         */

   134         static void ConvertToPictograph2InPlace(

   135             TInt aStartPositionInDescriptor,

   136             TDes8& aDescriptor, TInt& aNumberOfCharactersThatDroppedOut);

   137         /**

   138         * It converts from an intermediate buffer to a pictograph code.

   139         * After that, it adds shift-in code(0x0F).

   140         * @since 2.6

   141         * @param aStartPositionInDescriptor The start postion for checking

   142         * @param aDescriptor The descripter has intermidiate buffer.

   143         * @param aNumberOfCharactersThatDroppedOut The number of characters

   144         *                                          that it's dropped out

   145         */

   146         static void ConvertToPictograph3InPlace(

   147             TInt aStartPositionInDescriptor,

   148             TDes8& aDescriptor, TInt& aNumberOfCharactersThatDroppedOut);

   149         /**

   150         * It converts from an intermediate buffer to a pictograph code.

   151         * After that, it adds shift-in code(0x0F).

   152         * @since 2.6

   153         * @param aStartPositionInDescriptor The start postion for checking

   154         * @param aDescriptor The descripter has intermidiate buffer.

   155         * @param aNumberOfCharactersThatDroppedOut The number of characters

   156         *                                          that it's dropped out

   157         */

   158         static void ConvertToPictograph4InPlace(

   159             TInt aStartPositionInDescriptor,

   160             TDes8& aDescriptor, TInt& aNumberOfCharactersThatDroppedOut);

   161         /**

   162         * It converts from an intermediate buffer to a pictograph code.

   163         * After that, it adds shift-in code(0x0F).

   164         * @since 2.6

   165         * @param aStartPositionInDescriptor The start postion for checking

   166         * @param aDescriptor The descripter has intermidiate buffer.

   167         * @param aNumberOfCharactersThatDroppedOut The number of characters

   168         *                                          that it's dropped out

   169         */

   170         static void ConvertToPictograph5InPlace(

   171             TInt aStartPositionInDescriptor,

   172             TDes8& aDescriptor, TInt& aNumberOfCharactersThatDroppedOut);

   173         /**

   174         * It converts from an intermediate buffer to a pictograph code.

   175         * After that, it adds shift-in code(0x0F).

   176         * @since 2.6

   177         * @param aStartPositionInDescriptor The start postion for checking

   178         * @param aDescriptor The descripter has intermidiate buffer.

   179         * @param aNumberOfCharactersThatDroppedOut The number of characters

   180         *                                          that it's dropped out

   181         */

   182         static void ConvertToPictograph6InPlace(

   183             TInt aStartPositionInDescriptor,

   184             TDes8& aDescriptor, TInt& aNumberOfCharactersThatDroppedOut);

   186         /**

   187         * It returns a number of bytes that the conversion to pictograph is

   188         * possible in the descriptor.

   189         * @since 2.6

   190         * @param aDescriptor A descriptor has any character code.

   191         * @return Number of bytes that the conversion is possible

   192         */

   193         static TInt NumberOfBytesAbleToConvertSJisDirectMap(const TDesC8& aDescriptor);

   195         /**

   196         * It returns a number of bytes that the conversion to pictograph is

   197         * possible in the descriptor.

   198         * @since 2.6

   199         * @param aDescriptor A descriptor has any character code.

   200         * @return Number of bytes that the conversion is possible

   201         */

   202         static TInt NumberOfBytesAbleToConvertToEucJpDirectMap1(const TDesC8& aDescriptor);

   204         /**

   205         * It returns a number of bytes that the conversion to pictograph is

   206         * possible in the descriptor.

   207         * @since 2.6

   208         * @param aDescriptor A descriptor has any character code.

   209         * @return Number of bytes that the conversion is possible

   210         */

   211         static TInt NumberOfBytesAbleToConvertToEucJpDirectMap2(const TDesC8& aDescriptor);

   213         /**

   214         * It returns a number of bytes that the conversion to pictograph is

   215         * possible in the descriptor.

   216         * @since 2.6

   217         * @param aDescriptor A descriptor has any character code.

   218         * @return Number of bytes that the conversion is possible

   219         */

   220         static TInt NumberOfBytesAbleToConvertToPicto1(

   221             const TDesC8& aDescriptor);

   222         /**

   223         * It returns a number of bytes that the conversion to pictograph is

   224         * possible in the descriptor.

   225         * @since 2.6

   226         * @param aDescriptor A descriptor has any character code.

   227         * @return Number of bytes that the conversion is possible

   228         */

   229         static TInt NumberOfBytesAbleToConvertToPicto2(

   230             const TDesC8& aDescriptor);

   231         /**

   232         * It returns a number of bytes that the conversion to pictograph is

   233         * possible in the descriptor.

   234         * @since 2.6

   235         * @param aDescriptor A descriptor has any character code.

   236         * @return Number of bytes that the conversion is possible

   237         */

   238         static TInt NumberOfBytesAbleToConvertToPicto3(

   239             const TDesC8& aDescriptor);

   240         /**

   241         * It returns a number of bytes that the conversion to pictograph is

   242         * possible in the descriptor.

   243         * @since 2.6

   244         * @param aDescriptor A descriptor has any character code.

   245         * @return Number of bytes that the conversion is possible

   246         */

   247         static TInt NumberOfBytesAbleToConvertToPicto4(

   248             const TDesC8& aDescriptor);

   249         /**

   250         * It returns a number of bytes that the conversion to pictograph is

   251         * possible in the descriptor.

   252         * @since 2.6

   253         * @param aDescriptor A descriptor has any character code.

   254         * @return Number of bytes that the conversion is possible

   255         */

   256         static TInt NumberOfBytesAbleToConvertToPicto5(

   257             const TDesC8& aDescriptor);

   258         /**

   259         * It returns a number of bytes that the conversion to pictograph is

   260         * possible in the descriptor.

   261         * @since 2.6

   262         * @param aDescriptor A descriptor has any character code.

   263         * @return Number of bytes that the conversion is possible

   264         */

   265         static TInt NumberOfBytesAbleToConvertToPicto6(

   266             const TDesC8& aDescriptor);

   267         /**

   268         * It's a common function for checking the number of bytes that

   269         * the conversion to pictograph

   270         * @since 2.6

   271         * @param aDescriptor A descriptor has any character code.

   272         * @param aIntermidiateCode An intermidiate buffer

   273         * @return Number of bytes that the conversion is possible

   274         */

   275         static TInt NumberOfBytesAbleToConvertToPictograph(

   276             const TDesC8& aDescriptor, TInt aIntermidiateCode);

   277         /**

   278         * It converts the string which includes a pictograph's escape sequence

   279         * to unicode.

   280         * @since 2.6

   281         * @param aDescriptor It includes a pictograph's escape sequence

   282         */

   283         static void ConvertToPictographFromUnicode(TDes8& aDescriptor);

   285         /**

   286         * It converts the string which has Unicode with pictograph to EUC-jp

   287         * with direct mapped pictograph

   288         * @since 2.6

   289         * @param aDescriptor It includes a pictograph's escape sequence

   290         */

   291         static void ConvertToPictographFromEucJpPackedInPlace(TDes8& aDescriptor);

   292         /**

   293         * It appends a shift-in code to the descriptor.

   294         * @since 2.6

   295         * @param aDescriptor It's append a shift-in code.

   296         * @param aNumberOfCharactersThatDroppedOut The number of characters

   297         *                                          that it's dropped out

   298         */

   299         static void AppendShiftIn(TDes8& aDescriptor,

   300             TInt& aNumberOfCharactersThatDroppedOut);

   301     };

   303 #endif // CNVPICTOGRAPHSHARED_H

   305 // End of File

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--