/*

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

* All rights reserved.

* This component and the accompanying materials are made available

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

* which accompanies this distribution, and is available

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

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:   Matches Fonts to a criteria and what is available on the product.

*

*/

// INCLUDE FILES

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <uikon/eikdefmacros.h>

#endif

#include <eikenv.h>

#include <featmgr.h> 

#include <gdi.h>

#include <eikenv.h>

#include <eikappui.h>

#include <e32std.h>

#include <languages.hrh>

// This component's "own" header comes from a S60 export from the System Include

#include <AknFontProvider.h>

#include <AknFontSpecification.h>

#include <AknFontProviderSuppliedMetrics.h>

// Used for type TCdlArray, which is used for declaring arrays of static const data

#include <CdlTypes.h> 

// Used for TOpenFontSpec to enable antialising

#include <openfont.h>

// For FontUtils

#include <gulutil.h>

#include <f32file.h>

// CONSTANTS

// General "Wildcard" value. 

#define EAny    -1

// Wildcard specific for the category 

#define EAknFontCategoryAny -1

// Used to request no additional "boldness"

#define ENotBold  EStrokeWeightNormal 

// Used to request bold typeface

#define EBold  EStrokeWeightBold 

// Used to turn antialising off 

#define ENotAntialiase  0

// Used to turn antialising on

#define EAntialiase  1

//

// Font names to be used in the tables

//

_LIT(KS60TCAndHK,"Sans MT  UniT_HKSCS_S60");

_LIT(KS60SC,"Sans MT 936_S60");

_LIT(KS60TCAndHKHiRes,"Sans MT TC Big5HK_S60C");

_LIT(KS60SCHiRes,"Sans MT SC 936_S60C");

_LIT(KJapaneseHensei,"Heisei Kaku Gothic S60");

_LIT(KS60Digital, "Series 60 ZDigi");

_LIT(KS60Sans, "Series 60 Sans");

_LIT(KS60SansTitleSemiBold, "Series 60 Sans TitleSmBd");

_LIT(KS60Korean,"Series 60 Korean");

//chinese adaptation changes

//stroke SC latin 

_LIT(KS60SCSANSRLF, "S60SCSANSRLF");

_LIT(KS60SCSANSSBLF, "S60SCSANSSBLF");

_LIT(KS60SCSANSTTLSMBLDLF, "S60SCSANSTTLSMBLDLF");

//stroke TCHK latin

_LIT(KS60TCHKSANSRLF, "S60TCHKSANSRLF");

_LIT(KS60TCHKSANSSBLF, "S60TCHKSANSSBLF");

_LIT(KS60TCHKSANSTTLSMBLDLF, "S60TCHKSANSTTLSMBLDLF");

//HiRes SC latin

_LIT(KS60SCHRSANSRLF, "S60SCHRSANSRLF");

_LIT(KS60SCHRSANSSBLF, "S60SCHRSANSSBLF");

_LIT(KS60SCHRSANSTTLSMBLDLF, "S60SCHRSANSTTLSMBLDLF");

//HiRes TCHK latin

_LIT(KS60TCHKHRSANSRLF, "S60TCHKHRSANSRLF");

_LIT(KS60TCHKHRSANSSBLF, "S60TCHKHRSANSSBLF");

_LIT(KS60TCHKHRSANSTTLSMBLDLF, "S60TCHKHRSANSTTLSMBLDLF");

//end

// Texts for measuring maximum ascents and descents:

_LIT(KWesternFontMaxExtentText, "\x00C1\x00C7" );

// Language support map

#define ELanguageSupportBasicLatin                  0x00000001

#define ELanguageSupportLatin1Supplement            0x00000002

#define ELanguageSupportLatinExtendedA              0x00000004

#define ELanguageSupportLatinExtendedB              0x00000008

#define ELanguageSupportGreek                       0x00000010

#define ELanguageSupportCyrillic                    0x00000020

#define ELanguageSupportHebrew                      0x00000040

#define ELanguageSupportArabic                      0x00000080

#define ELanguageSupportThai                        0x00001000

#define ELanguageSupportChinesePRC                  0x00002000

#define ELanguageSupportChineseTaiwanHK             0x00004000

#define ELanguageSupportChineseHiRes                0x00008000

#define ELanguageSupportEnclosedCJK                 0x00010000

#define ELanguageSupportCJKUnifiedIdeographsLevel0  0x00020000

#define ELanguageSupportCJKUnifiedIdeographsLevel1  0x00040000

#define ELanguageSupportJapanese                    0x00080000

#define ELanguageSupportKorean                      0x00100000

#define ELanguageSupportHangul                      0x00200000

//chinese adaptation

#define ELanguageSupportChineseFontLinking          0x00400000

//end

#define ELanguageSupportDevanagari                  0x01000000

#define ELanguageSupportS60PrivateUseArea1          0x10000000

// Test characters for language support

// Latin uppercase A

#define KTestCharLatin      0x0041

// Hiragana Letter small A

#define KTestCharHiragana   0x3041

// ye - chosen as a non-trivial and identifiable common chinese character

#define KTestCharChinese    0x4e5f

// Thai character Ko Kai

#define KTestCharThai       0x0e01

// Korean character "o"

#define KTestCharKorean     0x3147

#define EElafLangs (   ELanguageSupportBasicLatin \

                               | ELanguageSupportLatin1Supplement \

                               | ELanguageSupportLatinExtendedA \

                               | ELanguageSupportLatinExtendedB \

                               | ELanguageSupportGreek \

                               | ELanguageSupportCyrillic \

                               | ELanguageSupportHebrew \

                               | ELanguageSupportArabic \

                               | ELanguageSupportS60PrivateUseArea1 )

#define ESouthAndSoutheastAsianCommonLangs (    ELanguageSupportBasicLatin \

                               | ELanguageSupportLatin1Supplement \

                               | ELanguageSupportLatinExtendedA \

                               | ELanguageSupportLatinExtendedB \

                               | ELanguageSupportGreek \

                               | ELanguageSupportCyrillic \

                               | ELanguageSupportHebrew \

                               | ELanguageSupportArabic \

                               | ELanguageSupportS60PrivateUseArea1 )

#define EDevanagariLangs (   ESouthAndSoutheastAsianCommonLangs \

                               | ELanguageSupportDevanagari )

#define EApacCommonLangs ( ELanguageSupportBasicLatin \

                                   | ELanguageSupportLatin1Supplement \

                                   | ELanguageSupportS60PrivateUseArea1 )

#define EThaiLangs        (   EApacCommonLangs \

                                      | ELanguageSupportThai )

#define EJapaneseLangs    (  EApacCommonLangs \

                                     | ELanguageSupportJapanese )

#define EKoreanLangs    (  EApacCommonLangs \

                                     | ELanguageSupportKorean )

#define EChineseLangs     ( EApacCommonLangs \

                                    | ELanguageSupportCJKUnifiedIdeographsLevel0 \

                                    | ELanguageSupportCJKUnifiedIdeographsLevel1 )

#define EChineseLangsPRC     ( EChineseLangs \

                                    | ELanguageSupportChinesePRC )

#define EChineseLangsTaiwanHK     ( EChineseLangs \

                                    | ELanguageSupportChineseTaiwanHK )

#define EChineseLangsPRCHiRes     ( EChineseLangs \

                                    | ELanguageSupportChinesePRC \

                                    | ELanguageSupportChineseHiRes)

#define EChineseLangsTaiwanHKHiRes     ( EChineseLangs \

                                        | ELanguageSupportChineseTaiwanHK \

                                        | ELanguageSupportChineseHiRes)

//chinese adaptation

#define EChineseLangsPRCLF     ( EChineseLangs \

                                    | ELanguageSupportChinesePRC \

                                    | ELanguageSupportChineseFontLinking )

#define EChineseLangsTaiwanHKLF     ( EChineseLangs \

                                    | ELanguageSupportChineseTaiwanHK \

                                    | ELanguageSupportChineseFontLinking )

#define EChineseLangsPRCHiResLF     ( EChineseLangs \

                                    | ELanguageSupportChinesePRC \

                                    | ELanguageSupportChineseHiRes \

                                    | ELanguageSupportChineseFontLinking )

#define EChineseLangsTaiwanHKHiResLF     ( EChineseLangs \

                                        | ELanguageSupportChineseTaiwanHK \

                                        | ELanguageSupportChineseHiRes \

                                        | ELanguageSupportChineseFontLinking )

//end                                    

// Wildcard value for langs (font is to be used for all languages)

#define EAnyLangs           0xffffffff

//chinese adaptation

/**

* For internal use only

* Structure holds info about linked typeface info that needs to be created

* the values here gets populated from link.ink, any configurable info can be added here

* the module which uses this structure can be modified later to make it

* configurable for eg: via centrep keys

*/

struct SLinkedFontDetails

    {

    TBool iCanonical;

    TInt iGroup;

    TBuf<KMaxTypefaceNameLength> iFontName;

    TBuf<KMaxTypefaceNameLength> iLinkFontName;

    TInt iFontCategory;//1 - Regular, 2 - Bold

    };

//end

/**

* 

*/

struct SHeightRequest

    {

    TUint16 iDesignHeight;

    TUint16 iRequestHeight;

    };

/**

* Structure to hold information about the deviation of character range's baselines from the 

* baseline (i.e. ascent) advertised by CFont.  A raising of the bitmap is +ve.

* The raising of the baseline can be given proportionally, as a fraction of the ascent, by providing 

* a non-zero denominator.

* 

* In defining arrays of this structure, there must always be a line defined following any line that is

* to be used.

*/

struct SBaselineDelta 

    {

    TUint iFirstCharacter;

    TInt iRelativeBaselineLift;

    TInt iDenominator;

    };

/**

* Principal structure of the Product font table. 

*/

struct SAknProductFontTableLine

    {

    TInt iCategory;

    TInt iMinSize;

    TInt iMaxSize;

    TInt iBold;

    TInt iItalic;

    TInt iSizeToUse;

    TInt iBoldnessToUse;

    TInt iAntialisingToUse;

    TUint iSupportedLanguagesPattern;

    const TDesC* iTypefaceName;

    const TDesC* iGroupName;

    TCdlArray<SBaselineDelta> const* iBaselineData;

    TCdlArray<SHeightRequest> const* iHeightRequestData;

    const TDesC* iMaxAscentDescentChars;

    };

//

// height request sizes to use for Agfa vector fonts mapped from text pane height:

//

CDL_ARRAY_START( SHeightRequest, latinHeightRequestArray)

    {

        {  2,  2 }, 

        { 10,  8 }, 

        { 11,  9 }, 

        { 13, 11 }, 

        { 14, 12 }, 

        { 14, 13 }, 

        { 16, 14 }, 

        { 18, 15 }, 

        { 19, 16 }, 

        { 24, 21 }, 

        { 25, 22 }, 

        { 26, 24 }, 

        { 27, 25 }, 

        { 28, 26 }, 

        { 29, 26 }, 

        { 30, 27 }, 

        { 79, 72 }, 

        { 218, 200 }, 

    }

CDL_ARRAY_END(SHeightRequest, latinHeightRequestArray);

CDL_ARRAY_START( SHeightRequest, agfaDigitalHeightRequestArray)

    {

        { 5, 5 },

        { 18, 16 },

        { 20, 18 },

        { 22, 20 },

        { 24, 21 },

        { 30, 26 },

        { 32, 29 },

        { 33, 29 },

        { 35, 31 },

        { 40, 35 },

        { 44, 39 },

        { 46, 41 },

        { 470, 430 },

    }

CDL_ARRAY_END(SHeightRequest, agfaDigitalHeightRequestArray);

CDL_ARRAY_START( SHeightRequest, strokeFontHeightRequestArray)

    {

        { 13, 12 }, 

        { 14, 14 }, 

        { 15, 14 }, 

        { 16, 16 }, 

        { 17, 16 }, 

        { 18, 18 }, 

        { 19, 18 }, 

        { 20, 20 }, 

        { 21, 20 }, 

    }

CDL_ARRAY_END(SHeightRequest, strokeFontHeightRequestArray);

//

// Baseline adjustment for APAC fonts

//

CDL_ARRAY_START( SBaselineDelta, apacVectorFontBaselineArray )

    {

        { 0x0000,   1, 6 },

        { 0x0fff,   0, KAknFontProviderBaselineCorrectionIsAbsolute }

    }

CDL_ARRAY_END( SBaselineDelta, apacVectorFontBaselineArray );

CDL_ARRAY_START( SBaselineDelta, heiseiBaselineArray )

    {

        { 0x0000,   1, 7.8 },

        { 0x0fff,   0, KAknFontProviderBaselineCorrectionIsAbsolute }

    }

CDL_ARRAY_END( SBaselineDelta, heiseiBaselineArray );

CDL_ARRAY_START( SBaselineDelta, koreanVectorFontBaselineArray )

    {

        { 0x0000,   -1, 6 },

        { 0x0fff,   0, KAknFontProviderBaselineCorrectionIsAbsolute }

    }    

CDL_ARRAY_END( SBaselineDelta, koreanVectorFontBaselineArray );

CDL_ARRAY_START( SHeightRequest, heiseiFontHeightRequestArray)

    {

        { 13, 12 }, 

        { 14, 14 }, 

        { 15, 14 }, 

        { 16, 16 }, 

        { 17, 16 }, 

        { 18, 18 }, 

        { 19, 18 }, 

        { 20, 20 }, 

        { 21, 20 }, 

    }

CDL_ARRAY_END(SHeightRequest, heiseiFontHeightRequestArray);

CDL_ARRAY_START( SHeightRequest, koreanFontHeightRequestArray)

    {

        { 8, 6 },

        { 9, 6 },

        { 10, 8 },

        { 11, 8 },

        { 12, 10 },

        { 13, 10 },

        { 14, 12 },

        { 15, 12 },

        { 16, 14 },

        { 17, 14 },

        { 18, 16 },

        { 19, 16 },

        { 20, 18 },

        { 21, 18 },

        { 22, 20 },

        { 23, 20 },

        { 24, 22 },

        { 25, 22 },

        { 26, 24 },

        { 27, 24 },

        { 28, 26 }, 

        { 29, 26 }, 

        { 30, 27 }, 

        { 79, 60 }, 

		{ 218, 200 },

    }

CDL_ARRAY_END(SHeightRequest, koreanFontHeightRequestArray);

CDL_ARRAY_START( SHeightRequest, chnlinkedFontHeightRequestArray)

    {

        {  2,  2 }, 

        { 10,  8 }, 

        { 11,  9 }, 

        { 13, 10 }, 

        { 14, 12 }, 

        { 15, 12 }, 

        { 16, 14 }, 

        { 17, 14 }, 

        { 18, 14 }, 

        { 19, 16 }, 

        { 20, 16 }, 

        { 21, 18 }, 

        { 24, 21 }, 

        { 25, 22 }, 

        { 26, 24 }, 

        { 27, 25 }, 

        { 28, 26 }, 

        { 29, 26 }, 

        { 30, 27 }, 

        { 79, 72 }, 

        { 218, 200 }, 

    }

CDL_ARRAY_END(SHeightRequest, chnlinkedFontHeightRequestArray);

// Typeface Aliasing

// Minimum length for alias substring matching

#define KMinAliasLength 2

struct SAknLanguagesAndTypefaceTableLine

    {

    TUint iSupportedLanguagesPattern;

    const TDesC* iTypefaceName;

    };

struct SAknAliasTableLine

    {

    const TDesC* iAlias;

    const TDesC* iGroupName;

    TCdlArray<SAknLanguagesAndTypefaceTableLine> const* iLanguagesAndTypefaceTable;

    TBool iIsAliasGeneric;

    };

// Aliases

_LIT(KSystemOne, "System One");

_LIT(KArial, "arial");

_LIT(KVerdana, "verdana");

_LIT(KSansSerifHyphen, "sans-serif");

_LIT(KSansSerif, "sansserif");

_LIT(KHelvetica, "helvetica");

_LIT(KGeorgia, "georgia");

_LIT(KTimes, "times");

_LIT(KTimesNewRoman, "times new roman");

_LIT(KSerif, "serif");

_LIT(KMonospace, "monospaced");

_LIT(KCourier, "courier");

// Group names

_LIT(KS60Group, "S60Group");

// Default

_LIT(KDefaultGroupName, "S60Group");

/*

* Language and typefaces combinations to use without regard to size and style

*

* First element is language coverage bit pattern

* Second element is the typeface or typeface family to use.  Should be able to handle all sizes on device

*

*/

CDL_ARRAY_START( SAknLanguagesAndTypefaceTableLine, languagesAndTypefaceTable)

    {

        { EElafLangs,  LIT_AS_DESC_PTR(KS60Sans) },

        { EChineseLangsPRC, LIT_AS_DESC_PTR(KS60SC) },

        { EChineseLangsTaiwanHK, LIT_AS_DESC_PTR(KS60TCAndHK) },

        { EJapaneseLangs, LIT_AS_DESC_PTR(KJapaneseHensei) },

        { EChineseLangsPRCHiRes, LIT_AS_DESC_PTR(KS60SCHiRes) },

        { EChineseLangsTaiwanHKHiRes, LIT_AS_DESC_PTR(KS60TCAndHKHiRes) },

        //chinese adaptation

        { EChineseLangsPRCLF, LIT_AS_DESC_PTR(KS60SCSANSRLF) },

        { EChineseLangsTaiwanHKLF, LIT_AS_DESC_PTR(KS60TCHKSANSRLF) },

        { EChineseLangsPRCHiResLF, LIT_AS_DESC_PTR(KS60SCHRSANSRLF) },

        { EChineseLangsTaiwanHKHiResLF, LIT_AS_DESC_PTR(KS60TCHKHRSANSRLF) },

        //end

        { EAnyLangs, LIT_AS_DESC_PTR(KS60Sans) } // Ultimate fallback

    }

CDL_ARRAY_END(SAknLanguagesAndTypefaceTableLine, languagesAndTypefaceTable);

/*

* Main Configuration for Aliasing.  

*

* First element is the alias

* next element is the group matching typeface. This may be NULL. If not NULL it is used to match in the 

*     product font table, in a similar manner to category matching. 

* next element points to the language and typeface table

* next element is a Flag to say if the matching is generic. This is used to see if the aliasing counts 

*     as an exact match or not

*/

static const SAknAliasTableLine aliasTable[] = {

    { LIT_AS_DESC_PTR(KSystemOne) ,LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, ETrue  },

    { LIT_AS_DESC_PTR(KSansSerifHyphen) ,LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, ETrue  },

    { LIT_AS_DESC_PTR(KSansSerif) ,LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, ETrue  },

    { LIT_AS_DESC_PTR(KSerif) ,LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, ETrue  },

    { LIT_AS_DESC_PTR(KMonospace) ,LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, ETrue  },

    { LIT_AS_DESC_PTR(KArial) ,LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, EFalse  },

    { LIT_AS_DESC_PTR(KVerdana),LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, EFalse  },

    { LIT_AS_DESC_PTR(KHelvetica),LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, EFalse  },

    { LIT_AS_DESC_PTR(KGeorgia),LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, EFalse  },

    { LIT_AS_DESC_PTR(KTimes),LIT_AS_DESC_PTR(KS60Group), &languagesAndTypefaceTable, EFalse  },