#include <PtiDefs.h>

#include "CPcsDefs.h"

class CPsQuery;

class CPtiEngine;

class CPtiKeyMapData;

    TPtiKey iKey; // key

     * Convert functions to get the key string from query and/or chars string

    void GetMixedKeyStringForQueryL(CPsQuery& aSrcQuery, TDes& aDestStr) const;

    void GetMixedKeyStringForDataL(CPsQuery& aSrcQuery, const TDesC& aSrcData, TDes& aDestStr) const;

     * Returns the numeric key id corresponding to a specific character

    TPtiKey KeyForCharacter(TText aChar, TKeyboardModes aKbMode) const;

     * Returns the pool Id for a key

    TInt PoolIdForCharacter(TChar aChar, TKeyboardModes aKbMode );

     * Returns total number of pools

    /**

     * Returns true if the characters "0" and " " are on the same key

     */

    TBool GetSpaceAndZeroOnSameKey( TKeyboardModes aMode );

     * Set flags to indicate if space and zero are on same key.

     * Keymappings must be constructed before calling this.

     */

    void SetSpaceAndZeroOnSameKey();

    /**

    void ConstructForItutKeyboardL();

    void ConstructForQwertyKeyboardL(TPtiKeyboardType aKbType);

    void AddDataForItutKeyboardL(CPtiKeyMapData* aPtiKeyMapData,

    void AddKeyMapForQwertyKeyboardL(TLanguage aLanguage, TPtiKeyboardType aKbType);

    void AddDataForQwertyKeyboardL(

            CPtiKeyMapData* aPtiKeyMapData, 

            TPtiKeyboardType aKbType, 

            TPtiKey aKey,

     * Create list of PTI keys for the given keyboard type

    void CreateKeyListFromKeyBindingTable( RArray<TPtiKey>& aKeyArray, TPtiKeyboardType aKbType );

     * Select keyboard types according to available physical keyboard(s)

    void SetupKeyboardTypesL();

     * Construct keymaps

    void ConstructConcreteKeyMapL();

    void AddKeyMapforConcreteKeyboardL( TLanguage aLanguage );

    TInt PoolIdForKey(TPtiKey aKey, TKeyboardModes aKbMode) const;

    /**

     * Gets predictive keyboard mapping data for given match mode.

     * @param   aMode      Matching mode for which keymappings are asked. 

     * @return  Mapping table for the given mode. NULL if asked for non-predictive mode.

     */

    const RPointerArray<TKeyMappingData>* KeyMappings( TKeyboardModes aMode ) const;

    /**

     * Resolve any ambiguity from the given keyboard mode.

     * Keyboard mode "predictive default keyboard" will be replaced by 

     * "ITU-T predictive" or "QWERTY predictive", depending on the configuration

     * of the device. Predictive keyboard modes, which can't be supported

     * in this device, are replaced with "non-predictive" mode.

     */

    TKeyboardModes ResolveKeyboardMode( TKeyboardModes aKbMode ) const;

    /**

     * Get the default charcter for the given key in given keyboard.

     * The default character is used to construct the compare string for

     * predictive mode.

     */

    TText DefaultCharForKey( TPtiKey aKey, TKeyboardModes aKbMode ) const;

    /**

     * PTI engine istance. Owned.

     */

    /**

     * Algorithm instacne pointer. NOT owned.

     */

     * Type of keyboard used in ITU-T search mode. Typically this is standard ITU-T

     * 12-key keypad.

    TPtiKeyboardType iItutKeyboardType;

    /**

     * PTI keys of the ITU-T keyboard.

     */

    RArray<TPtiKey> iItutKeys;

    /**

     * Contains all the ITU-T keys and the characters mapped to each key. Owned.

     */

    RPointerArray<TKeyMappingData> iItutKeyMappings;

     * True if "0" and " " are on the same key in the ITU-T mode

     */

    TBool iSpaceAndZeroOnSameKeyOnItut;

    /**

     * Type of keyboard used in QWERTY search mode. Typically this is either 3x11 or 4x10 QWERTY

     * or EPtiKeyboardNone if there's no any kind of QWERTY available. This may also be

     * half-QWERTY.

     */

    TPtiKeyboardType iQwertyKeyboardType;

    /**

     * PTI keys of the QWERTY keyboard.

    RArray<TPtiKey> iQwertyKeys;

    /**

     * Contains all the QWERTY keys and the characters mapped to each key. Owned.

     */

    RPointerArray<TKeyMappingData> iQwertyKeyMappings;

    /**

     * True if "0" and " " are on the same key in the QWERTY mode

     */

    TBool iSpaceAndZeroOnSameKeyOnQwerty;

    /**

     * Flag to indicate if the default multi-matching mode is ITU-T or QWERTY mode.

     * ETrue, if ITU-T is defualt and EFalse if QWERTY is default.

     */

    TBool iItutIsDefault;