/****************************************************************************

**

** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbPlugins module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** This file may be used under the terms of the GNU Lesser General Public

** License version 2.1 as published by the Free Software Foundation and

** appearing in the file LICENSE.LGPL included in the packaging of this file.

** Please review the following information to ensure the GNU Lesser General

** Public License version 2.1 requirements will be met:

** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at developer.feedback@nokia.com.

**

****************************************************************************/

#include "virtualqwerty.h"

#include <hbapplication.h>

#include <hbaction.h>

#include <hbview.h>

#include <hbmainwindow.h>

#include <QLocale>

#include <hbinputexactwordpopup.h>

#include <hbinputkeymapfactory.h>

#include <hbinputkeymap.h>

#include <hbinputcandidatelist.h>

#include <hbinputsettingproxy.h>

#include <hbinpututils.h>

#include <hbinputvirtualrocker.h>

#include <hbinputsctkeyboard.h>

#include <hbinputeditorinterface.h>

#include <hbinputdef.h>

#include <hbinputvkbhost.h>

#include <hbinputcommondialogs.h>

#include <hbinputpredictionfactory.h>

#include "hbinputbasicqwertyhandler.h"

#include "hbinputpredictionqwertyhandler.h"

#include "hbinputnumericqwertyhandler.h"

#include "hbinputqwerty10x4touchkeyboard.h"

#include "hbinputqwerty11x4touchkeyboard.h"

#include "hbinputqwertynumerictouchkeyboard.h"

const int HbVirtualQwerty4x10MaxKeysCount = 32;

HbVirtualQwerty::HbVirtualQwerty() : mCurrentKeypad(0),

                                     mQwertyAlphaKeypad(0),

                                     mQwerty10x4Keypad(0),

                                     mQwerty11x4Keypad(0),

                                     mQwertyNumericKeypad(0),

                                     mSctKeypad(0),

                                     mKeymap(0),

                                     mExactWordPopup(0),

                                     mCandidatePopup(0),

                                     mOrientationAboutToChange(false),

                                     mShiftKeyState(0),

                                     mVkbHost(0)

{

    initializeModeHandlers();

}

void HbVirtualQwerty::initializeModeHandlers()

{

    // lets construct all the three supported mode handlers.

    mBasicModeHandler = new HbInputBasicQwertyHandler(this);

    mPredictionModeHandler = new HbInputPredictionQwertyHandler(this);

    mNumericModeHandler = new HbInputNumericQwertyHandler(this);

    // bydefault latin basic mode handler is activated.

    mActiveModeHandler = mBasicModeHandler;

    // init will initialize the individual mode handlers.

    mBasicModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionInit);

    mPredictionModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionInit);

    mNumericModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionInit);

    // autocompleter connection

    connect(this, SIGNAL(autoCompletionPopupClosed(QString, int)), mBasicModeHandler, SLOT(autoCompletionPopupClosed(QString, int)));

    connect(HbInputSettingProxy::instance(), SIGNAL(predictiveInputStateChanged(HbKeyboardSettingFlags,bool)), this, SLOT(predictiveInputStateChanged(HbKeyboardSettingFlags,bool)));

}

// ---------------------------------------------------------------------------

// HbVirtualQwerty::~HbVirtualQwerty

//

// ---------------------------------------------------------------------------

//

HbVirtualQwerty::~HbVirtualQwerty()

{

    delete mCandidatePopup;

    mCandidatePopup = 0;

    delete mQwertyAlphaKeypad;

    mQwertyAlphaKeypad = 0;

    delete mQwerty10x4Keypad;

    delete mQwerty11x4Keypad;

    delete mQwertyNumericKeypad;

    mQwertyNumericKeypad = 0;

    delete mSctKeypad;

    mSctKeypad = 0;

    delete mExactWordPopup;

    mExactWordPopup = 0;

    // free mode handlers

    delete mBasicModeHandler;

    mBasicModeHandler = 0;

    delete mPredictionModeHandler;

    mPredictionModeHandler = 0;

    delete mNumericModeHandler;

    mNumericModeHandler = 0;

}

QString HbVirtualQwerty::identifierName()

{

    return QString("HbVirtualQwerty");

}

bool HbVirtualQwerty::isComposing() const

{

    return mActiveModeHandler->isComposing();

}

QString HbVirtualQwerty::language()

{

    return QString();

}

void HbVirtualQwerty::reset()

{

    mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionReset);

}

void HbVirtualQwerty::focusReceived()

{

    /* Update the text case */

    updateState();

    // set input mode to default ABC

    HbInputLanguage language = inputState().language();

    if ((!focusObject()->editorInterface().isNumericEditor() && inputState().inputMode() == HbInputModeNumeric) || !language.isCaseSensitiveLanguage()) {

        HbInputState state = inputState();

        // For Case insensitive languages, the default case should be lowercase.

        if (!language.isCaseSensitiveLanguage())

        {

            state.setTextCase(HbTextCaseLower);

        }

        else if (automaticTextCaseNeeded()) {

            state.setTextCase(HbTextCaseAutomatic);

        }

        state.inputMode() = HbInputModeDefault;

        activateState(state);

        inputStateToEditor(state);

    }

    // load the new keymappings to all keypads and all mode handlers

    loadKeymap(inputState().language());

    // After loadKeyMapData call, mKeyData should have keymappings data of the current language

    if(!mKeymap) {

        return; // could not get keymappings. Just return.

    }

    //Get vkbhost

    mVkbHost = focusObject()->editorInterface().vkbHost();

    HbKeypadMode currentInputType = EModeAbc;

    if (focusObject()->editorInterface().isNumericEditor()) {

        currentInputType = EModeNumeric;

    }

    HbInputVkbWidget* keypadToOpen = 0;

    if (currentInputType == EModeAbc) {

        mQwertyAlphaKeypad = constructKeyboard(EModeAbc);

        keypadToOpen = mQwertyAlphaKeypad;

    } else if(currentInputType == EModeNumeric) {

        if(!mQwertyNumericKeypad) {

            mQwertyNumericKeypad = static_cast<HbQwertyNumericKeyboard*>(constructKeyboard(EModeNumeric));

            mQwertyNumericKeypad->setBackgroundDrawing(true);

        }

        keypadToOpen = mQwertyNumericKeypad;

    }

    if(!keypadToOpen) {

        return; // just return if keypad can not be created

    }

    // inform active mode handler about the focusrecieve event.

    mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionFocusRecieved);

    openKeypad(keypadToOpen);

    if (mVkbHost) {

        connect(&(focusObject()->editorInterface()), SIGNAL(cursorPositionChanged(int, int)), mVkbHost, SLOT(ensureCursorVisibility()));

    }

    if (focusObject()) {

        disconnect(&(focusObject()->editorInterface()), SIGNAL(cursorPositionChanged(int, int)), mActiveModeHandler, SLOT(cursorPositionChanged(int, int)));

        connect(&(focusObject()->editorInterface()), SIGNAL(cursorPositionChanged(int, int)), mActiveModeHandler, SLOT(cursorPositionChanged(int, int)));

    }

}

void HbVirtualQwerty::focusLost(bool focusSwitch)

{

    mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionFocusLost);

    if (focusObject()) {

        disconnect(&(focusObject()->editorInterface()), SIGNAL(cursorPositionChanged(int, int)), mActiveModeHandler, SLOT(cursorPositionChanged(int, int)));

    }

    if (!focusSwitch) {

        if (mVkbHost && mVkbHost->keypadStatus() != HbVkbHost::HbVkbStatusClosed) {

            // Context switch has happened but the keypad is still open.

            // Close it.

            closeKeypad();

        }

    }

}

void HbVirtualQwerty::closeKeypad()

{

    if (mVkbHost && mVkbHost->keypadStatus() != HbVkbHost::HbVkbStatusClosed) {

        mVkbHost->closeKeypad();

        // set mCurrentKeypad to null.

        mCurrentKeypad = 0;

        if (mCandidatePopup) {

            mCandidatePopup->hide();

        }

    }

}

void HbVirtualQwerty::openKeypad(HbInputVkbWidget * keypadToOpen,bool inMinimizedMode )

{

    // if null is sent, just return.

    if(!keypadToOpen) {

        return;

    }

    bool wasKeypadOpen = false;

    // see if we are trying to open a different keypad than what is already opened.

    if (mCurrentKeypad != keypadToOpen) {

        // close currently open keypad. We always close keypad without animation

        // keypad should be closed with animation only when we loses focus and this is handled

        // in focusLost function call.

        if (mVkbHost && mVkbHost->keypadStatus() != HbVkbHost::HbVkbStatusClosed) {

            mVkbHost->closeKeypad(false);

            // when their is a keypad that needs to be closed before opening the new keypad, we don't

            // want to animate the opening of new keypad.

            wasKeypadOpen = true;

        }

    }

    // Close candidate popup if open

    if (mCandidatePopup) {

        mCandidatePopup->hide();

    }

    // assign new keypad to be opened to varable mCurrentKeypad

    mCurrentKeypad =  keypadToOpen;

    if (mVkbHost && mVkbHost->keypadStatus() != HbVkbHost::HbVkbStatusOpened) {

        connect(mVkbHost, SIGNAL(keypadClosed()), this, SLOT(keypadClosed()));

        if (inMinimizedMode) {

            mVkbHost->openMinimizedKeypad(mCurrentKeypad, this);

        } else {

            mVkbHost->openKeypad(mCurrentKeypad, this, !wasKeypadOpen);

        }

        // If previous focused editor was numeric, prediction is disabled.

        // Enable prediction if prediction was set in alpha editor prior

        // to focusing numeric editor.

/*        if (mPrevKeypadMode == EModeAbc && HbInputModeLatinPredictive == mPreviousInputMode) {

            mMode = HbInputModeLatinPredictive;

        } else if (mPrevKeypadMode == EModeNumeric && HbInputModeLatinPredictive == mMode) {

            // If the previous focused editor was alpha and if prediction is

            // on, disable prediction. Store the previous state because if

            // any alpha editor is focused next, the previous prediction state

            // should be enabled.

            mMode = HbInputModeDefault;

            mPreviousInputMode = HbInputModeLatinPredictive;

        }  */

        connect(&(focusObject()->editorInterface()), SIGNAL(cursorPositionChanged(int, int)), mVkbHost, SLOT(ensureCursorVisibility()));

    }

}

HbInputVkbWidget* HbVirtualQwerty::constructKeyboard(HbKeypadMode currentInputType)

{

    HbInputVkbWidget *keyboard = 0;

    if (currentInputType == EModeAbc) {

        const HbKeyboardMap *keyboardMap = mKeymap->keyboard(HbKeyboardVirtualQwerty);

        if (keyboardMap && keyboardMap->keys.count() > HbVirtualQwerty4x10MaxKeysCount) {

            if (mQwerty11x4Keypad) {

                return mQwerty11x4Keypad;

            }

            mQwerty11x4Keypad = new HbQwerty11x4Keyboard(this, mKeymap);

            keyboard = mQwerty11x4Keypad;

        } else {

            if (mQwerty10x4Keypad) {

                return mQwerty10x4Keypad;

            }

            mQwerty10x4Keypad = new HbQwerty10x4Keyboard(this, mKeymap);

            keyboard = mQwerty10x4Keypad;

        }

        connect(keyboard, SIGNAL(smileySelected(QString)), this, SLOT(smileySelected(QString)));

        //FLICKDISABLED connect(keyboard, SIGNAL(flickEvent(HbInputVkbWidget::FlickDirection)), this, SLOT(flickEvent(HbInputVkbWidget::FlickDirection)));

    } else {

        keyboard = new HbQwertyNumericKeyboard(this, mKeymap);

    }    

    connect(keyboard, SIGNAL(keypadCloseEventDetected(HbInputVkbWidget::HbVkbCloseMethod)),

        this, SLOT(keypadCloseEventDetected(HbInputVkbWidget::HbVkbCloseMethod)));

    connect(keyboard, SIGNAL(rockerDirection(int, HbInputVirtualRocker::RockerSelectionMode)),

        this, SLOT(rockerDirection(int, HbInputVirtualRocker::RockerSelectionMode)));

    connect(keyboard, SIGNAL(mouseMovedOutOfButton()), this, SLOT(mouseMovedOutOfButton()));

    keyboard->setRockerVisible(true);

    return keyboard;

}

void HbVirtualQwerty::mouseHandler(int x, QMouseEvent* event)

{

    mActiveModeHandler->mouseHandler(x, event);

}

void HbVirtualQwerty::keypadClosed()

{

    if (mOrientationAboutToChange) {

        mOrientationAboutToChange = false;

    }

}

void HbVirtualQwerty::keypadCloseEventDetected(HbInputVkbWidget::HbVkbCloseMethod vkbCloseMethod)

{

    Q_UNUSED(vkbCloseMethod);

    if (isActiveMethod()) {

        if (mVkbHost && mVkbHost->keypadStatus() != HbVkbHost::HbVkbStatusMinimized) {

            // We need to commit the inline word when we minimize the keypad

            mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionCommit);

            if (mCandidatePopup) {

                mCandidatePopup->hide();

            }

            mVkbHost->minimizeKeypad(!stateChangeInProgress());

        }

    }

}

void HbVirtualQwerty::inputLanguageChanged(const HbInputLanguage &aNewLanguage)

{

    mPredictionModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionCommit);

	if (mExactWordPopup && mExactWordPopup->isVisible())

        closeExactWordPopup();

    // move keypad off screen

    if (mCurrentKeypad){

        mCurrentKeypad->keypadLanguageChangeAnimationUpdate(0);

    }

    // load the new key keymappings for newLanguage to all keypads and all mode handlers

    loadKeymap(aNewLanguage);

    if (mCurrentKeypad && mCurrentKeypad != mQwertyAlphaKeypad

        && mCurrentKeypad != mQwertyNumericKeypad) {

        mCurrentKeypad->animKeyboardChange();

        openKeypad(mQwertyAlphaKeypad);

    }

    mPredictionModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionPrimaryLanguageChanged);

    if (mCurrentKeypad){

        mCurrentKeypad->animKeyboardChange();

    }

}

void HbVirtualQwerty::inputStateActivated(const HbInputState& newState)

{

    if (!isActiveMethod()) {

        return;  // Just to be sure...

    }

    if (newState.inputMode() == HbInputModeNumeric && mQwertyNumericKeypad) {

        mQwertyNumericKeypad->setMode(EModeNumeric, HbModifierNone);

    } else if (mQwertyAlphaKeypad) {

        if (newState.textCase() == HbTextCaseUpper || newState.textCase() == HbTextCaseAutomatic) {

            mQwertyAlphaKeypad->setMode(EModeAbc, HbModifierShiftPressed);

        } else {

            mQwertyAlphaKeypad->setMode(EModeAbc, HbModifierNone);

        }

    }

    HbInputModeHandler *previousModeHandler = mActiveModeHandler;

    if (newState.inputMode() == HbInputModeNumeric) {

        mActiveModeHandler = mNumericModeHandler;

    }  else if (newState.inputMode() == HbInputModeDefault && usePrediction()) {

        mActiveModeHandler = mPredictionModeHandler;

    } else if (newState.inputMode() == HbInputModeDefault) {

        mActiveModeHandler = mBasicModeHandler;

        // Auto completer setup needs following line.

        mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionFocusRecieved);

    }

    if (focusObject()) {

        disconnect(&(focusObject()->editorInterface()), SIGNAL(cursorPositionChanged(int, int)), previousModeHandler, SLOT(cursorPositionChanged(int, int)));

        connect(&(focusObject()->editorInterface()), SIGNAL(cursorPositionChanged(int, int)), mActiveModeHandler, SLOT(cursorPositionChanged(int, int)));

    }

    // load the new keymappings to all keypads and all mode handlers

    loadKeymap(newState.language());

    // if there is a change in the modehandler we need send a commit in previous mode handler.

    if (previousModeHandler != mActiveModeHandler) {

        //Auto Completion part also to be committed on mode change and hide exact word popup.

        previousModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionCommit);

        if (previousModeHandler == mPredictionModeHandler) {

            closeExactWordPopup();

        }

        // lets set candidate list and keypad type to the engine.

        mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionSetCandidateList);

        mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionSetKeypad);

    }

}

/*!

This function loads the keymappings data of the given language to all the keypads and to all mode handlers.

It first checks if we already have keymappings data of given language in mKeyData, if not then gets the

keymappings,loads them to all avaialble keyboards and to all mode handlers

*/

void HbVirtualQwerty::loadKeymap(const HbInputLanguage &newLanguage)

{

    // inform all the mode handler about the language change.

    //dont try to get the keymappings if we ( mKeyData) already have keymappings for newLanguage

    if (!mKeymap || mKeymap->language() != newLanguage) {

        const HbKeymap* keymap = HbKeymapFactory::instance()->keymap(newLanguage);

        if (keymap) {

            mKeymap =  keymap;

            if (mQwertyNumericKeypad) {

                mQwertyNumericKeypad->setKeymap(mKeymap);

            }

            mQwertyAlphaKeypad = constructKeyboard(EModeAbc);

            mQwertyAlphaKeypad->setKeymap(mKeymap);

            if (mSctKeypad) {

                mSctKeypad->setKeymap(mKeymap);

            }

            // inform mode handlers about the language change.

            if (mBasicModeHandler) {

                mBasicModeHandler->setKeymap(mKeymap);

            }

            if (mPredictionModeHandler) {

                mPredictionModeHandler->setKeymap(mKeymap);

            }

            if (mNumericModeHandler) {

                mNumericModeHandler->setKeymap(mKeymap);

            }

        }

    }

}

void HbVirtualQwerty::switchSpecialCharacterTable()

{

    if (mCurrentKeypad != mSctKeypad) {

        displaySpecialCharacterTable(this);

    } else {

        // we always go back to alpha qwerty mode after coming back from sct

        openKeypad(constructKeyboard(EModeAbc));

    }

}

void HbVirtualQwerty::secondaryInputLanguageChanged(const HbInputLanguage &newLanguage)

{

    Q_UNUSED(newLanguage);

    mPredictionModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionSecondaryLanguageChanged);

}

int HbVirtualQwerty::displaySpecialCharacterTable(QObject* aReceiver)

{

    Q_UNUSED(aReceiver);

    if (!mSctKeypad) {

        mSctKeypad = new HbSctKeyboard(this, mKeymap);

        connect(mSctKeypad, SIGNAL(smileySelected(QString)), this, SLOT(smileySelected(QString)));

        connect(mSctKeypad, SIGNAL(keypadCloseEventDetected(HbInputVkbWidget::HbVkbCloseMethod)), this, SLOT(keypadCloseEventDetected(HbInputVkbWidget::HbVkbCloseMethod)));

        connect(mSctKeypad, SIGNAL(rockerDirection(int, HbInputVirtualRocker::RockerSelectionMode)),

            this, SLOT(rockerDirection(int, HbInputVirtualRocker::RockerSelectionMode)));

        mSctKeypad->setRockerVisible(true);

    }

    mSctKeypad->setMode(EModeAbc, HbModifierNone);

    //open the keypad

    openKeypad(mSctKeypad);

    return 0;

}

void HbVirtualQwerty::smileySelected(QString smiley)

{

     mActiveModeHandler->smileySelected(smiley);

}

void HbVirtualQwerty::selectSpecialCharacterTableMode()

{

    mQwertyAlphaKeypad = constructKeyboard(EModeAbc);

    mQwertyAlphaKeypad->showSmileyPicker(4, 10);

}

/*!

Slot used by mode handlers to close the autocompletion popup.

*/

void HbVirtualQwerty::closeAutoCompletionPopup()

{

    if (mCandidatePopup && mCandidatePopup->isVisible()) {

        mCandidatePopup->hide();

    }