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

**

** 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$

**

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

#include "qsplitter.h"

#ifndef QT_NO_SPLITTER

#include "qapplication.h"

#include "qcursor.h"

#include "qdrawutil.h"

#include "qevent.h"

#include "qlayout.h"

#include "qlist.h"

#include "qpainter.h"

#include "qrubberband.h"

#include "qstyle.h"

#include "qstyleoption.h"

#include "qtextstream.h"

#include "qvarlengtharray.h"

#include "qvector.h"

#include "private/qlayoutengine_p.h"

#include "private/qsplitter_p.h"

#include "qtimer.h"

#include "qdebug.h"

#include <ctype.h>

QT_BEGIN_NAMESPACE

//#define QSPLITTER_DEBUG

/*!

    \class QSplitterHandle

    \brief The QSplitterHandle class provides handle functionality of the splitter.

    \ingroup organizers

    QSplitterHandle is typically what people think about when they think about

    a splitter. It is the handle that is used to resize the widgets.

    A typical developer using QSplitter will never have to worry about

    QSplitterHandle. It is provided for developers who want splitter handles

    that provide extra features, such as popup menus.

    The typical way one would create splitter handles is to subclass QSplitter then

    reimplement QSplitter::createHandle() to instantiate the custom splitter

    handle. For example, a minimum QSplitter subclass might look like this:

    \snippet doc/src/snippets/splitterhandle/splitter.h 0

    The \l{QSplitter::}{createHandle()} implementation simply constructs a

    custom splitter handle, called \c Splitter in this example:

    \snippet doc/src/snippets/splitterhandle/splitter.cpp 1

    Information about a given handle can be obtained using functions like

    orientation() and opaqueResize(), and is retrieved from its parent splitter.

    Details like these can be used to give custom handles different appearances

    depending on the splitter's orientation.

    The complexity of a custom handle subclass depends on the tasks that it

    needs to perform. A simple subclass might only provide a paintEvent()

    implementation:

    \snippet doc/src/snippets/splitterhandle/splitter.cpp 0

    In this example, a predefined gradient is set up differently depending on

    the orientation of the handle. QSplitterHandle provides a reasonable

    size hint for the handle, so the subclass does not need to provide a

    reimplementation of sizeHint() unless the handle has special size

    requirements.

    \sa QSplitter

*/

/*!

    Creates a QSplitter handle with the given \a orientation and

    QSplitter \a parent.

*/

QSplitterHandle::QSplitterHandle(Qt::Orientation orientation, QSplitter *parent)

    : QWidget(*new QSplitterHandlePrivate, parent, 0)

{

    Q_D(QSplitterHandle);

    d->s = parent;

    setOrientation(orientation);

}

/*!

    Sets the orientation of the splitter handle to \a orientation.

    This is usually propogated from the QSplitter.

    \sa QSplitter::setOrientation()

*/

void QSplitterHandle::setOrientation(Qt::Orientation orientation)

{

    Q_D(QSplitterHandle);

    d->orient = orientation;

#ifndef QT_NO_CURSOR

    setCursor(orientation == Qt::Horizontal ? Qt::SplitHCursor : Qt::SplitVCursor);

#endif

}

/*!

   Returns the handle's orientation. This is usually propagated from the QSplitter.

   \sa QSplitter::orientation()

*/

Qt::Orientation QSplitterHandle::orientation() const

{

    Q_D(const QSplitterHandle);

    return d->orient;

}

/*!

    Returns true if widgets are resized dynamically (opaquely), otherwise

    returns false. This value is controlled by the QSplitter.

    \sa QSplitter::opaqueResize()

*/

bool QSplitterHandle::opaqueResize() const

{

    Q_D(const QSplitterHandle);

    return d->s->opaqueResize();

}

/*!

    Returns the splitter associated with this splitter handle.

    \sa QSplitter::handle()

*/

QSplitter *QSplitterHandle::splitter() const

{

    return d_func()->s;

}

/*!

    Tells the splitter to move this handle to position \a pos, which is

    the distance from the left or top edge of the widget.

    Note that \a pos is also measured from the left (or top) for

    right-to-left languages. This function will map \a pos to the

    appropriate position before calling QSplitter::moveSplitter().

    \sa QSplitter::moveSplitter() closestLegalPosition()

*/

void QSplitterHandle::moveSplitter(int pos)

{

    Q_D(QSplitterHandle);

    if (d->s->isRightToLeft() && d->orient == Qt::Horizontal)

        pos = d->s->contentsRect().width() - pos;

    d->s->moveSplitter(pos, d->s->indexOf(this));

}

/*!

   Returns the closest legal position to \a pos of the splitter

   handle. The positions are measured from the left or top edge of

   the splitter, even for right-to-left languages.

   \sa QSplitter::closestLegalPosition(), moveSplitter()

*/

int QSplitterHandle::closestLegalPosition(int pos)

{

    Q_D(QSplitterHandle);

    QSplitter *s = d->s;

    if (s->isRightToLeft() && d->orient == Qt::Horizontal) {

        int w = s->contentsRect().width();

        return w - s->closestLegalPosition(w - pos, s->indexOf(this));

    }

    return s->closestLegalPosition(pos, s->indexOf(this));

}

/*!

    \reimp

*/

QSize QSplitterHandle::sizeHint() const

{

    Q_D(const QSplitterHandle);

    int hw = d->s->handleWidth();

    QStyleOption opt(0);

    opt.init(d->s);

    opt.state = QStyle::State_None;

    return parentWidget()->style()->sizeFromContents(QStyle::CT_Splitter, &opt, QSize(hw, hw), d->s)

        .expandedTo(QApplication::globalStrut());

}

/*!

    \reimp

*/

bool QSplitterHandle::event(QEvent *event)

{

    Q_D(QSplitterHandle);

    switch(event->type()) {

    case QEvent::HoverEnter:

        d->hover = true;

        update();

        break;

    case QEvent::HoverLeave:

        d->hover = false;

        update();

        break;

    default:

        break;

    }

    return QWidget::event(event);

}

/*!

    \reimp

*/

void QSplitterHandle::mouseMoveEvent(QMouseEvent *e)

{

    Q_D(QSplitterHandle);

    if (!(e->buttons() & Qt::LeftButton))

        return;

    int pos = d->pick(parentWidget()->mapFromGlobal(e->globalPos()))

                 - d->mouseOffset;

    if (opaqueResize()) {

        moveSplitter(pos);

    } else {

        d->s->setRubberBand(closestLegalPosition(pos));

    }

}

/*!

   \reimp

*/

void QSplitterHandle::mousePressEvent(QMouseEvent *e)

{

    Q_D(QSplitterHandle);

    if (e->button() == Qt::LeftButton) {

        d->mouseOffset = d->pick(e->pos());

        d->pressed = true;

        update();

    }

}

/*!

   \reimp

*/

void QSplitterHandle::mouseReleaseEvent(QMouseEvent *e)

{

    Q_D(QSplitterHandle);

    if (!opaqueResize() && e->button() == Qt::LeftButton) {

        int pos = d->pick(parentWidget()->mapFromGlobal(e->globalPos()))

                     - d->mouseOffset;

        d->s->setRubberBand(-1);

        moveSplitter(pos);

    }

    if (e->button() == Qt::LeftButton) {

        d->pressed = false;

        update();

    }

}

/*!

   \reimp

*/

void QSplitterHandle::paintEvent(QPaintEvent *)

{

    Q_D(QSplitterHandle);

    QPainter p(this);

    QStyleOption opt(0);

    opt.rect = rect();

    opt.palette = palette();

    if (orientation() == Qt::Horizontal)

        opt.state = QStyle::State_Horizontal;

    else

        opt.state = QStyle::State_None;

    if (d->hover)

        opt.state |= QStyle::State_MouseOver;

    if (d->pressed)

        opt.state |= QStyle::State_Sunken;

    if (isEnabled())

        opt.state |= QStyle::State_Enabled;

    parentWidget()->style()->drawControl(QStyle::CE_Splitter, &opt, &p, d->s);

}

int QSplitterLayoutStruct::getWidgetSize(Qt::Orientation orient)

{

    if (sizer == -1) {

        QSize s = widget->sizeHint();

        const int presizer = pick(s, orient);

        const int realsize = pick(widget->size(), orient);

        if (!s.isValid() || (widget->testAttribute(Qt::WA_Resized) && (realsize > presizer))) {

            sizer = pick(widget->size(), orient);

        } else {

            sizer = presizer;

        }

        QSizePolicy p = widget->sizePolicy();

        int sf = (orient == Qt::Horizontal) ? p.horizontalStretch() : p.verticalStretch();

        if (sf > 1)

            sizer *= sf;

    }

    return sizer;

}

int QSplitterLayoutStruct::getHandleSize(Qt::Orientation orient)

{

    return pick(handle->sizeHint(), orient);

}

void QSplitterPrivate::init()

{

    Q_Q(QSplitter);

    QSizePolicy sp(QSizePolicy::Expanding, QSizePolicy::Preferred);

    if (orient == Qt::Vertical)

        sp.transpose();

    q->setSizePolicy(sp);

    q->setAttribute(Qt::WA_WState_OwnSizePolicy, false);

}

void QSplitterPrivate::recalc(bool update)

{

    Q_Q(QSplitter);

    int n = list.count();

    /*

      Splitter handles before the first visible widget or right

      before a hidden widget must be hidden.

    */

    bool first = true;

    bool allInvisible = n != 0;

    for (int i = 0; i < n ; ++i) {

        QSplitterLayoutStruct *s = list.at(i);

        bool widgetHidden = s->widget->isHidden();

        if (allInvisible && !widgetHidden && !s->collapsed)

            allInvisible = false;

        s->handle->setHidden(first || widgetHidden);

        if (!widgetHidden)

            first = false;

    }

    if (allInvisible)

        for (int i = 0; i < n ; ++i) {

            QSplitterLayoutStruct *s = list.at(i);

            if (!s->widget->isHidden()) {

                s->collapsed = false;

                break;

            }

        }

    int fi = 2 * q->frameWidth();

    int maxl = fi;

    int minl = fi;

    int maxt = QWIDGETSIZE_MAX;

    int mint = fi;

    /*

      calculate min/max sizes for the whole splitter

    */

    bool empty = true;

    for (int j = 0; j < n; j++) {

        QSplitterLayoutStruct *s = list.at(j);

        if (!s->widget->isHidden()) {

            empty = false;

            if (!s->handle->isHidden()) {

                minl += s->getHandleSize(orient);

                maxl += s->getHandleSize(orient);

            }

            QSize minS = qSmartMinSize(s->widget);

            minl += pick(minS);

            maxl += pick(s->widget->maximumSize());

            mint = qMax(mint, trans(minS));

            int tm = trans(s->widget->maximumSize());

            if (tm > 0)

                maxt = qMin(maxt, tm);

        }

    }

    if (empty) {

        if (qobject_cast<QSplitter *>(parent)) {

            // nested splitters; be nice

            maxl = maxt = 0;

        } else {

            // QSplitter with no children yet

            maxl = QWIDGETSIZE_MAX;

        }

    } else {

        maxl = qMin<int>(maxl, QWIDGETSIZE_MAX);

    }

    if (maxt < mint)

        maxt = mint;

    if (update) {

        if (orient == Qt::Horizontal) {

            q->setMaximumSize(maxl, maxt);

            if (q->isWindow())

                q->setMinimumSize(minl,mint);

        } else {

            q->setMaximumSize(maxt, maxl);

            if (q->isWindow())

                q->setMinimumSize(mint,minl);

        }

        doResize();

        q->updateGeometry();

    } else {

        firstShow = true;

    }

}

void QSplitterPrivate::doResize()

{

    Q_Q(QSplitter);

    QRect r = q->contentsRect();

    int n = list.count();

    QVector<QLayoutStruct> a(n*2);

    int i;

    bool noStretchFactorsSet = true;

    for (i = 0; i < n; ++i) {

        QSizePolicy p = list.at(i)->widget->sizePolicy();

        int sf = orient == Qt::Horizontal ? p.horizontalStretch() : p.verticalStretch();

        if (sf != 0) {

            noStretchFactorsSet = false;

            break;

        }

    }

    int j=0;

    for (i = 0; i < n; ++i) {

        QSplitterLayoutStruct *s = list.at(i);

#ifdef QSPLITTER_DEBUG

        qDebug("widget %d hidden: %d collapsed: %d handle hidden: %d", i, s->widget->isHidden(),

               s->collapsed, s->handle->isHidden());

#endif

        a[j].init();

        if (s->handle->isHidden()) {

            a[j].maximumSize = 0;

        } else {

            a[j].sizeHint = a[j].minimumSize = a[j].maximumSize = s->getHandleSize(orient);

            a[j].empty = false;

        }

        ++j;

        a[j].init();

        if (s->widget->isHidden() || s->collapsed) {

            a[j].maximumSize = 0;

        } else {

            a[j].minimumSize = pick(qSmartMinSize(s->widget));

            a[j].maximumSize = pick(s->widget->maximumSize());

            a[j].empty = false;

            bool stretch = noStretchFactorsSet;

            if (!stretch) {

                QSizePolicy p = s->widget->sizePolicy();

                int sf = orient == Qt::Horizontal ? p.horizontalStretch() : p.verticalStretch();

                stretch = (sf != 0);

            }

            if (stretch) {

                a[j].stretch = s->getWidgetSize(orient);

                a[j].sizeHint = a[j].minimumSize;

                a[j].expansive = true;

            } else {

                a[j].sizeHint = qMax(s->getWidgetSize(orient), a[j].minimumSize);

            }

        }

        ++j;

    }

    qGeomCalc(a, 0, n*2, pick(r.topLeft()), pick(r.size()), 0);

#ifdef QSPLITTER_DEBUG

    for (i = 0; i < n*2; ++i) {

        qDebug("%*s%d: stretch %d, sh %d, minS %d, maxS %d, exp %d, emp %d -> %d, %d",

               i, "", i,

               a[i].stretch,

               a[i].sizeHint,

               a[i].minimumSize,

               a[i].maximumSize,

               a[i].expansive,

               a[i].empty,

               a[i].pos,

               a[i].size);

    }

#endif

    for (i = 0; i < n; ++i) {

        QSplitterLayoutStruct *s = list.at(i);

        setGeo(s, a[i*2+1].pos, a[i*2+1].size, false);

    }

}

void QSplitterPrivate::storeSizes()

{