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

**

** 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 "virtual12key.h"

//Required Qt headers

#include <QLocale>

//Required Hb headers

#include <hbinputkeymapfactory.h>

#include <hbinputkeymap.h>

#include <hbinputsettingproxy.h>

#include <hbinpututils.h>

#include <hbinputsctkeyboard.h>

#include <hbinputeditorinterface.h>

#include <hbinputcandidatelist.h>

#include <hbinputpredictionfactory.h>

#include <hbinputpredictionengine.h>

#include <hbinputsettingproxy.h>

#include <hbmainwindow.h>

#include <hbaction.h>

#include <hbview.h>

#include <hbinputvkbhost.h>

#include <hbinputcommondialogs.h>

#include <hbinputbutton.h>

#include <hbdeviceprofile.h>

//User includes

#include "hbinput12keytouchkeyboard.h"

#include "hbinputbasic12keyhandler.h"

#include "hbinputprediction12keyhandler.h"

#include "hbinputnumeric12keyhandler.h"

/*!

\class HbVirtual12Key

\brief Input method implementations for virtual ITU-T mode in HbInputs framework.

It implements the HbInputMethod interface from HbInput framework. This particular

input method supports input of predictive and multi-tap input.

\sa HbInputMethod

*/

HbVirtual12Key::HbVirtual12Key()

              : mCurrentKeypad(0),

                mItutKeypad(0),

                mSctKeypad(0),

                mKeymap(0),

                mCandidatePopup(0),

                mCurrentlyFocused(0),

{

    initializeModeHandlers();

}

void HbVirtual12Key::initializeModeHandlers()

{

    mBasicModeHandler = new HbInputBasic12KeyHandler(this);

    mPredictionModeHandler = new HbInputPrediction12KeyHandler(this);

    mNumericModeHandler = new HbInputNumeric12KeyHandler(this);

    mActiveModeHandler = mBasicModeHandler;

    mBasicModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionInit);

    mPredictionModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionInit);

    mNumericModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionInit);

    // let's connect prediction mode handler with latin basic mode handler. It is required incase we Qt::key_0 is pressed in prediction mode

    // key

    connect(mPredictionModeHandler, SIGNAL(passFilterEvent(const QKeyEvent *)),

            mBasicModeHandler, SLOT(filterEvent(const QKeyEvent *)));

    connect(mPredictionModeHandler, SIGNAL(passActionHandler(HbInputModeAction )),

            mBasicModeHandler, SLOT(actionHandler(HbInputModeAction )));

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

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

    mPredictionModeHandler->setAutocompletionStatus(HbInputSettingProxy::instance()->isAutocompletionEnabled(HbKeyboardSetting12key));

}

bool HbVirtual12Key::isSctModeActive() const

{

    return (mCurrentKeypad == mSctKeypad);

}

/*!

Destructor for HbVirtual12Key. Responsible for clean up of the class.

\sa HbInputMethod::~HbInputMethod

*/

HbVirtual12Key::~HbVirtual12Key()

{

    delete mItutKeypad;

    mItutKeypad = 0;

    delete mSctKeypad;

    mSctKeypad = 0;

    delete mCandidatePopup;

    mCandidatePopup = 0;

    // free mode handlers

    delete mBasicModeHandler;

    mBasicModeHandler = 0;

    delete mPredictionModeHandler;

    mPredictionModeHandler = 0;

    delete mNumericModeHandler;

}

/*!

Implementation of the pure virtual QInputContext::identifierName()

Returns a string which specifies an identifier for the input method.

*/

QString HbVirtual12Key::identifierName()

{

    return QString("HbVirtual12Key");

}

/*!

Implementation of the pure virtual QInputContext::isComposing()

*/

bool HbVirtual12Key::isComposing() const

{

    return mActiveModeHandler->isComposing();

}

/*!

Implementation of the pure virtual QInputContext::language()

Returns the currently active language for the input method. The language

name returned is in the format language-code_country-code e.g. zh_CN.

*/

QString HbVirtual12Key::language()

{

    QLocale::Language activeLanguage;

    activeLanguage = (QLocale::Language)HbInputSettingProxy::instance()->globalInputLanguage().language();

    QLocale locale(activeLanguage);

    return locale.name();

}

/*!

Implementation of the pure virtual QInputContext::reset()

Resets the input method. This could be called by the widgets for reseting the

state of the input method.

*/

void HbVirtual12Key::reset()

{

    mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionReset);

    // close candidate popup if visible

    closeCandidatePopup();

}

Hb12KeyTouchKeyboard *HbVirtual12Key::construct12Keyboard()

{

    Hb12KeyTouchKeyboard *tempKeypad = new Hb12KeyTouchKeyboard(this, mKeymap);

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

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

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

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

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

    connect(tempKeypad, SIGNAL(settingsListClosed()), this, SLOT(restorePreviousState()));

    return tempKeypad;

}

/*!

Virtual 12-key specific implementation of HbInputMethod::focusReceived().

Up on reception of focus, the framework switches the input context and calls this

method indicating the gain of focus to the input method.

With focus received, the virtual 12-key input method, refreshes the special character

table as it needs to be based on the focused editor. It also opens the virtual keypad

and stops the timer which is used for multi tapping and detecting long key press events.

*/

void HbVirtual12Key::focusReceived()

{

    /* Update the text case */

    updateState();

    // 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. Does not make sense to continue

    }

    //Get vkbhost

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

    if(!mItutKeypad){

        mItutKeypad = construct12Keyboard();

    }

    if (!mItutKeypad) {

        // Something has caused keypad QPointers to zero themselves, no point to go on...

        return;

    }

    // inform active mode handler about the focusrecieve event.

    mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionFocusRecieved);

    if (mCurrentlyFocused != focusObject()) {

        mCurrentlyFocused = focusObject();

        // Focus changed from one editor to another.

        closeCandidatePopup();

    }

    openKeypad(mItutKeypad);

    if (focusObject() && 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)));

        disconnect(focusObject(), SIGNAL(orientationChanged()), this, SLOT(orientationChanged()));

        connect(focusObject(), SIGNAL(orientationChanged()), this, SLOT(orientationChanged()));

    }

    HbInputAbstractMethod::focusReceived();

}

/*!

\reimp

*/

void HbVirtual12Key::focusLost(bool focusSwitch)

{

    if(mActiveModeHandler) {

        // inform the active mode handler about the focus lost event.

        mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionFocusLost);

    }

    if (focusObject()) {

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

                   mActiveModeHandler, SLOT(cursorPositionChanged(int, int)));

    }

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

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

        // Close it. First notify handler by sending an event and give it changes to

        // do any closing related things.

        // Then make sure that keypad closes.

        closeKeypad();

        mVkbHost = 0;

    }

    HbInputAbstractMethod::focusLost();

}

/*!

Closes the keypad if it is open.

*/

void HbVirtual12Key::closeKeypad()

{

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

        mVkbHost->closeKeypad(!stateChangeInProgress());

        // set mCurrentKeypad to null.

        mCurrentKeypad = 0;

        closeCandidatePopup();

    }

}

/*!

Opens the virtual keypad for input.

*/

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

{

    // if null is sent, just return.

    if(!keypadToOpen || !focusObject()) {

        return;

    }

    bool disableAnimation = 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.

            disableAnimation = true;

        }

    }

    // Close candidate popup if open

    closeCandidatePopup();

    QObject::disconnect(mCurrentKeypad,SIGNAL(aboutToActivateCustomAction(HbAction*)),

        this,SLOT(aboutToActivateCustomAction(HbAction*)));

    QObject::connect(keypadToOpen,SIGNAL(aboutToActivateCustomAction(HbAction*)),

        this,SLOT(aboutToActivateCustomAction(HbAction*)));

    // assign new keypad to be opened to varable mCurrentKeypad

    mCurrentKeypad =  keypadToOpen;

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

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

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

        if (inMinimizedMode) {

            mVkbHost->openMinimizedKeypad(mCurrentKeypad, this);

        } else {

            mVkbHost->openKeypad(mCurrentKeypad, this, (!stateChangeInProgress() && !disableAnimation));

        }

        if (focusObject()) {

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

                    mVkbHost, SLOT(ensureCursorVisibility()));

        }

    }

    if(mActiveModeHandler) {

        mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionSetKeypad);

    }

}

/*!

vkb widget is about to call a custom action that is mapped to one of the keypad buttons.

*/

void HbVirtual12Key::aboutToActivateCustomAction(HbAction *custAction)

{

    Q_UNUSED(custAction);

    mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionCommit);

}

/*!

The mouse event handler for the input method. Launches the candidate list if the mouse is clicked on the

pre-editing text.

*/

void HbVirtual12Key::mouseHandler(int cursorPosition, QMouseEvent* mouseEvent)

{

    mActiveModeHandler->mouseHandler(cursorPosition, mouseEvent);

}

/*!

The framework calls this method when the predictive input status changes.

*/

void HbVirtual12Key::predictiveInputStateChanged(HbKeyboardSettingFlags keyboardType, bool newStatus)

{

    Q_UNUSED(newStatus);

    if (keyboardType & HbKeyboardSetting12key) {

        HbInputFocusObject *focusedObject = focusObject();

        if (focusedObject) {

            // Just refresh the situation.

            inputStateActivated(inputState());

        }

    }

}

void HbVirtual12Key::autocompletionStateChanged(HbKeyboardSettingFlags keyboardType, bool newState)

{

    if ( isActiveMethod() && (keyboardType & HbKeyboardSetting12key) ) {

        mPredictionModeHandler->setAutocompletionStatus(newState);

    }

}

/*!

Call back indicating that the keypad is closed.

*/

void HbVirtual12Key::keypadClosed()

{

}

/*!

Call back indicating that the keypad is opened.

*/

void HbVirtual12Key::keypadOpened()

{

}

/*!

The call back from the VKB keypad widget before it closes the keypad.

*/

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

{

    Q_UNUSED(vkbCloseMethod);

    if (isActiveMethod()) {

        if (mVkbHost) {

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

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

                mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionCommit);

                // close candiatelist popup if visisble.

                closeCandidatePopup();

                // Close input.

                QInputContext* ic = qApp->inputContext();

                if (ic) {

                    QEvent *closeEvent = new QEvent(QEvent::CloseSoftwareInputPanel);

                    ic->filterEvent(closeEvent);

                    delete closeEvent;

                }

            }

        }

    }

}

/*!

Notification from the generic input method framework indicating a change of input language.

The VKB keypad needs to refreshed to show the renewed key mapping.

*/

void HbVirtual12Key::inputLanguageChanged(const HbInputLanguage &newLanguage)

{

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

    mPredictionModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionCommit);

    // move keypad off screen

    if (mCurrentKeypad) {

        mCurrentKeypad->keypadLanguageChangeAnimationUpdate(0);

    }

    loadKeymap(newLanguage);

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

    mPredictionModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionPrimaryLanguageChanged);

    if (focusObject() && mCurrentKeypad) {

        mCurrentKeypad->animKeyboardChange();

    }

}

/*!

Notification from the generic input method framework that there has been a flick event

*/

void HbVirtual12Key::flickEvent(HbInputVkbWidget::HbFlickDirection direction)

{

    Q_UNUSED(direction);

}

/*!

Notification from the generic input method framework that the mouse moved out of the button pressed.

*/

void HbVirtual12Key::mouseMovedOutOfButton()

{

    qDebug("HbVirtual12Key::mouseMovedOutOfButton()");

    mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionCancelButtonPress);

}

/*!

Notification from the generic input method framework to indicate the activation of a state.

*/

void HbVirtual12Key::inputStateActivated(const HbInputState& newState)

{

        return;  // Just to be sure...

    }

    if (mItutKeypad) {

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

            // Numeric mode is activated, set numeric mode to itu-t keypad

                mItutKeypad->setMode(EModeNumeric, HbModifierNone);

        } else if (newState.inputMode() != HbInputModeNumeric) {

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

                mItutKeypad->setMode(EModeAbc, HbModifierShiftPressed);

            } else {

                mItutKeypad->setMode(EModeAbc, HbModifierNone);

            }

        }

    }

    HbInputModeHandler *previousModeHandler = mActiveModeHandler;

        mActiveModeHandler = mPredictionModeHandler;        

        // by passing HbInputModeActionFocusRecieved we will be setting the candidate list and keypad

        mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionFocusRecieved);

        mPredictionModeHandler->setAutocompletionStatus(HbInputSettingProxy::instance()->isAutocompletionEnabled(HbKeyboardSetting12key));

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

        mActiveModeHandler = mBasicModeHandler;

        // Auto completer setup needs following line.

        mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionFocusRecieved);

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

        mActiveModeHandler = mNumericModeHandler;

    }

    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 needs to be committed as well on mode change.

        previousModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionCommit);

        if (mActiveModeHandler == mPredictionModeHandler) {

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

            mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionSetCandidateList);

            mActiveModeHandler->actionHandler(HbInputModeHandler::HbInputModeActionSetKeypad);

        }

    }