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

**

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

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, 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 qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

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

#ifndef QLINECONTROL_P_H

#define QLINECONTROL_P_H

//

//  W A R N I N G

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

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

//

#include "QtCore/qglobal.h"

#ifndef QT_NO_LINEEDIT

#include "private/qwidget_p.h"

#include "QtGui/qlineedit.h"

#include "QtGui/qtextlayout.h"

#include "QtGui/qstyleoption.h"

#include "QtCore/qpointer.h"

#include "QtGui/qlineedit.h"

#include "QtGui/qclipboard.h"

#include "QtCore/qpoint.h"

#include "QtGui/qcompleter.h"

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

class Q_GUI_EXPORT QLineControl : public QObject

{

    Q_OBJECT

public:

    QLineControl(const QString &txt = QString())

        : m_cursor(0), m_preeditCursor(0), m_cursorWidth(0), m_layoutDirection(Qt::LeftToRight),

        m_hideCursor(false), m_separator(0), m_readOnly(0),

        m_dragEnabled(0), m_echoMode(0), m_textDirty(0), m_selDirty(0),

        m_validInput(1), m_blinkStatus(0), m_blinkPeriod(0), m_blinkTimer(0), m_deleteAllTimer(0),

        m_ascent(0), m_maxLength(32767), m_lastCursorPos(-1),

        m_tripleClickTimer(0), m_maskData(0), m_modifiedState(0), m_undoState(0),

        m_selstart(0), m_selend(0), m_passwordEchoEditing(false)

    {

        init(txt);

    }

    ~QLineControl()

    {

        delete [] m_maskData;

    }

    int nextMaskBlank(int pos);

    int prevMaskBlank(int pos);

    bool isUndoAvailable() const;

    bool isRedoAvailable() const;

    void clearUndo();

    bool isModified() const;

    void setModified(bool modified);

    bool allSelected() const;

    bool hasSelectedText() const;

    int width() const;

    int height() const;

    int ascent() const;

    qreal naturalTextWidth() const;

    void setSelection(int start, int length);

    QString selectedText() const;

    QString textBeforeSelection() const;

    QString textAfterSelection() const;

    int selectionStart() const;

    int selectionEnd() const;

    bool inSelection(int x) const;

    void removeSelection();

    int start() const;

    int end() const;

#ifndef QT_NO_CLIPBOARD

    void copy(QClipboard::Mode mode = QClipboard::Clipboard) const;

    void paste();

#endif

    int cursor() const;

    int preeditCursor() const;

    int cursorWidth() const;

    void setCursorWidth(int value);

    void moveCursor(int pos, bool mark = false);

    void cursorForward(bool mark, int steps);

    void cursorWordForward(bool mark);

    void cursorWordBackward(bool mark);

    void home(bool mark);

    void end(bool mark);

    int xToPos(int x, QTextLine::CursorPosition = QTextLine::CursorBetweenCharacters) const;

    QRect cursorRect() const;

    qreal cursorToX(int cursor) const;

    qreal cursorToX() const;

    bool isReadOnly() const;

    void setReadOnly(bool enable);

    QString text() const;

    void setText(const QString &txt);

    QString displayText() const;

    void backspace();

    void del();

    void deselect();

    void selectAll();

    void insert(const QString &);

    void clear();

    void undo();

    void redo();

    void selectWordAtPos(int);

    uint echoMode() const;

    void setEchoMode(uint mode);

    void setMaxLength(int maxLength);

    int maxLength() const;

#ifndef QT_NO_VALIDATOR

    const QValidator *validator() const;

    void setValidator(const QValidator *);

#endif

#ifndef QT_NO_COMPLETER

    QCompleter *completer() const;

    void setCompleter(const QCompleter*);

    void complete(int key);

#endif

    void setCursorPosition(int pos);

    int cursorPosition() const;

    bool hasAcceptableInput() const;

    bool fixup();

    QString inputMask() const;

    void setInputMask(const QString &mask);

    // input methods

#ifndef QT_NO_IM

    bool composeMode() const;

    void setPreeditArea(int cursor, const QString &text);

#endif

    QString preeditAreaText() const;

    void updatePasswordEchoEditing(bool editing);

    bool passwordEchoEditing() const;

    QChar passwordCharacter() const;

    void setPasswordCharacter(const QChar &character);

    Qt::LayoutDirection layoutDirection() const;

    void setLayoutDirection(Qt::LayoutDirection direction);

    void setFont(const QFont &font);

    void processInputMethodEvent(QInputMethodEvent *event);

    void processMouseEvent(QMouseEvent* ev);

    void processKeyEvent(QKeyEvent* ev);

    int cursorBlinkPeriod() const;

    void setCursorBlinkPeriod(int msec);

    QString cancelText() const;

    void setCancelText(const QString &text);

    const QPalette &palette() const;

    void setPalette(const QPalette &);

    enum DrawFlags {

        DrawText = 0x01,

        DrawSelections = 0x02,

        DrawCursor = 0x04,

        DrawAll = DrawText | DrawSelections | DrawCursor

    };

    void draw(QPainter *, const QPoint &, const QRect &, int flags = DrawAll);

    bool processEvent(QEvent *ev);

private:

    void init(const QString &txt);

    void removeSelectedText();

    void internalSetText(const QString &txt, int pos = -1, bool edited = true);

    void internalInsert(const QString &s);

    void internalDelete(bool wasBackspace = false);

    void internalRemove(int pos);

    inline void internalDeselect()

    {

        m_selDirty |= (m_selend > m_selstart);

        m_selstart = m_selend = 0;

    }

    void internalUndo(int until = -1);

    void internalRedo();

    QString m_text;

    QPalette m_palette;

    int m_cursor;

    int m_preeditCursor;

    int m_cursorWidth;

    Qt::LayoutDirection m_layoutDirection;

    uint m_hideCursor : 1; // used to hide the m_cursor inside preedit areas

    uint m_separator : 1;

    uint m_readOnly : 1;

    uint m_dragEnabled : 1;

    uint m_echoMode : 2;

    uint m_textDirty : 1;

    uint m_selDirty : 1;

    uint m_validInput : 1;

    uint m_blinkStatus : 1;

    int m_blinkPeriod; // 0 for non-blinking cursor

    int m_blinkTimer;

    int m_deleteAllTimer;

    int m_ascent;

    int m_maxLength;

    int m_lastCursorPos;

    QList<int> m_transactions;

    QPoint m_tripleClick;

    int m_tripleClickTimer;

    QString m_cancelText;

    void emitCursorPositionChanged();

    bool finishChange(int validateFromState = -1, bool update = false, bool edited = true);

#ifndef QT_NO_VALIDATOR

    QPointer<QValidator> m_validator;

#endif

    QPointer<QCompleter> m_completer;

#ifndef QT_NO_COMPLETER

    bool advanceToEnabledItem(int dir);

#endif

    struct MaskInputData {

        enum Casemode { NoCaseMode, Upper, Lower };

        QChar maskChar; // either the separator char or the inputmask

        bool separator;

        Casemode caseMode;

    };

    QString m_inputMask;

    QChar m_blank;

    MaskInputData *m_maskData;

    // undo/redo handling

    enum CommandType { Separator, Insert, Remove, Delete, RemoveSelection, DeleteSelection, SetSelection };

    struct Command {

        inline Command() {}

        inline Command(CommandType t, int p, QChar c, int ss, int se) : type(t),uc(c),pos(p),selStart(ss),selEnd(se) {}

        uint type : 4;

        QChar uc;

        int pos, selStart, selEnd;

    };

    int m_modifiedState;

    int m_undoState;

    QVector<Command> m_history;

    void addCommand(const Command& cmd);

    inline void separate() { m_separator = true; }

    // selection

    int m_selstart;

    int m_selend;

    // masking

    void parseInputMask(const QString &maskFields);

    bool isValidInput(QChar key, QChar mask) const;

    bool hasAcceptableInput(const QString &text) const;

    QString maskString(uint pos, const QString &str, bool clear = false) const;

    QString clearString(uint pos, uint len) const;

    QString stripString(const QString &str) const;

    int findInMask(int pos, bool forward, bool findSeparator, QChar searchChar = QChar()) const;

    // complex text layout

    QTextLayout m_textLayout;

    bool m_passwordEchoEditing;

    QChar m_passwordCharacter;

Q_SIGNALS:

    void cursorPositionChanged(int, int);

    void selectionChanged();

    void displayTextChanged(const QString &);

    void textChanged(const QString &);

    void textEdited(const QString &);

    void resetInputContext();

    void accepted();

    void editingFinished();

    void updateNeeded(const QRect &);

#ifdef QT_KEYPAD_NAVIGATION

    void editFocusChange(bool);

#endif

protected:

    virtual void timerEvent(QTimerEvent *event);

private Q_SLOTS:

    void _q_clipboardChanged();

    void _q_deleteSelected();

};

inline int QLineControl::nextMaskBlank(int pos)

{

    int c = findInMask(pos, true, false);

    m_separator |= (c != pos);

    return (c != -1 ?  c : m_maxLength);

}

inline int QLineControl::prevMaskBlank(int pos)

{

    int c = findInMask(pos, false, false);

    m_separator |= (c != pos);

    return (c != -1 ? c : 0);

}

inline bool QLineControl::isUndoAvailable() const

{ 

    return !m_readOnly && m_undoState;

}

inline bool QLineControl::isRedoAvailable() const

{

    return !m_readOnly && m_undoState < (int)m_history.size();

}

inline void QLineControl::clearUndo()

{

    m_history.clear();

    m_modifiedState = m_undoState = 0;

}

inline bool QLineControl::isModified() const

{

    return m_modifiedState != m_undoState;

}

inline void QLineControl::setModified(bool modified)

{

    m_modifiedState = modified ? -1 : m_undoState;

}

inline bool QLineControl::allSelected() const

{

    return !m_text.isEmpty() && m_selstart == 0 && m_selend == (int)m_text.length();

}

inline bool QLineControl::hasSelectedText() const

{

    return !m_text.isEmpty() && m_selend > m_selstart;

}

inline int QLineControl::width() const

{

    return qRound(m_textLayout.lineAt(0).width()) + 1;

}

inline qreal QLineControl::naturalTextWidth() const

{

    return m_textLayout.lineAt(0).naturalTextWidth();

}

inline int QLineControl::height() const

{

    return qRound(m_textLayout.lineAt(0).height()) + 1;

}

inline int QLineControl::ascent() const

{

    return m_ascent;

}

inline QString QLineControl::selectedText() const

{

    if (hasSelectedText())

        return m_text.mid(m_selstart, m_selend - m_selstart);

    return QString();

}

inline QString QLineControl::textBeforeSelection() const

{

    if (hasSelectedText())

        return m_text.left(m_selstart);

    return QString();

}

inline QString QLineControl::textAfterSelection() const

{

    if (hasSelectedText())

        return m_text.mid(m_selend);

    return QString();

}

inline int QLineControl::selectionStart() const

{

    return hasSelectedText() ? m_selstart : -1;

}

inline int QLineControl::selectionEnd() const

{

    return hasSelectedText() ? m_selend : -1;

}

inline int QLineControl::start() const

{

    return 0;

}

inline int QLineControl::end() const

{

    return m_text.length();

}

inline void QLineControl::removeSelection()

{

    int priorState = m_undoState;

    removeSelectedText();

    finishChange(priorState);

}

inline bool QLineControl::inSelection(int x) const

{

    if (m_selstart >= m_selend)

        return false;

    int pos = xToPos(x, QTextLine::CursorOnCharacter);

    return pos >= m_selstart && pos < m_selend;

}

inline int QLineControl::cursor() const

{

    return m_cursor;

}

inline int QLineControl::preeditCursor() const

{

    return m_preeditCursor;

}

inline int QLineControl::cursorWidth() const

{

    return m_cursorWidth;

}

inline void QLineControl::setCursorWidth(int value)

{

    m_cursorWidth = value;

}

inline void QLineControl::cursorForward(bool mark, int steps)

{

    int c = m_cursor;

    if (steps > 0) {

        while (steps--)

            c = m_textLayout.nextCursorPosition(c);

    } else if (steps < 0) {

        while (steps++)

            c = m_textLayout.previousCursorPosition(c);

    }

    moveCursor(c, mark);

}

inline void QLineControl::cursorWordForward(bool mark)

{

    moveCursor(m_textLayout.nextCursorPosition(m_cursor, QTextLayout::SkipWords), mark);