/* This file is part of the KDE project
 * Copyright (C) 2007-2008 Jan Hambrecht <jaham@gmx.net>
 * Copyright (C) 2010 Thorsten Zachmann <zachmann@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#include "KarbonGradientEditStrategy.h"

#include <KoFlake.h>
#include <KoShape.h>
#include <KoViewConverter.h>
#include <KoShapeBackgroundCommand.h>
#include <KoShapeStrokeCommand.h>
#include <KoGradientBackground.h>
#include <KoGradientHelper.h>

#include <QBrush>
#include <QGradient>
#include <kundo2command.h>
#include <QPainter>

#include <math.h>

int GradientStrategy::m_handleRadius = 3;
int GradientStrategy::m_grabSensitivity = 3;

const qreal stopDistance = 15.0;

/// Returns scalar product of two given vectors
qreal GradientStrategy::scalarProduct(const QPointF &p1, const QPointF &p2)
{
    return p1.x() * p2.x() + p1.y() * p2.y();
}


GradientStrategy::GradientStrategy(KoShape *shape, const QGradient * gradient, Target target)
        : m_shape(shape)
        , m_editing(false), m_target(target)
        , m_gradientLine(0, 1), m_selection(None)
        , m_selectionIndex(0), m_type(gradient->type())
{
    if (m_target == Fill) {
        QSharedPointer<KoGradientBackground>  fill = qSharedPointerDynamicCast<KoGradientBackground>(m_shape->background());
        if (fill)
            m_matrix = fill->transform() * m_shape->absoluteTransformation(0);
    } else {
        KoShapeStroke * stroke = dynamic_cast<KoShapeStroke*>(m_shape->stroke());
        if (stroke)
            m_matrix = stroke->lineBrush().transform() * m_shape->absoluteTransformation(0);
    }
    m_stops = gradient->stops();
}

void GradientStrategy::setEditing(bool on)
{
    m_editing = on;
    // if we are going into editing mode, save the old background
    // for use inside the command emitted when finished
    if (on) {
        if (m_target == Fill) {
            QSharedPointer<KoGradientBackground>  fill = qSharedPointerDynamicCast<KoGradientBackground>(m_shape->background());
            if (fill) {
                m_oldBrush = QBrush(*fill->gradient());
                m_oldBrush.setTransform(fill->transform());
            }
        } else {
            KoShapeStroke * stroke = dynamic_cast<KoShapeStroke*>(m_shape->stroke());
            if (stroke) {
                m_oldStroke = *stroke;
                m_oldBrush = stroke->lineBrush();
            }
        }
        m_newBrush = m_oldBrush;
    }
}

bool GradientStrategy::hitHandle(const QPointF &mousePos, const KoViewConverter &converter, bool select)
{
    QRectF roi = grabRect(converter);

    int handleIndex = 0;
    // There exists a problem on msvc with for(each) and QVector<QPointF>
    for (int i = 0; i < m_handles.count(); ++i) {
        const QPointF &handle(m_handles[i]);
        roi.moveCenter(m_matrix.map(handle));
        if (roi.contains(mousePos)) {
            if (select)
                setSelection(Handle, handleIndex);
            return true;
        }
        handleIndex++;
    }

    if (select)
        setSelection(None);

    return false;
}

bool GradientStrategy::hitLine(const QPointF &mousePos, const KoViewConverter &converter, bool select)
{
    qreal maxDistance = converter.viewToDocumentX(grabSensitivity());
    if (mouseAtLineSegment(mousePos, maxDistance)) {
        m_lastMousePos = mousePos;
        if (select)
            setSelection(Line);
        return true;
    }

    if (select)
        setSelection(None);

    return false;
}

bool GradientStrategy::hitStop(const QPointF &mousePos, const KoViewConverter &converter, bool select)
{
    QRectF roi = grabRect(converter);

    QList<StopHandle> handles = stopHandles(converter);

    int stopCount = m_stops.count();
    for (int i = 0; i < stopCount; ++i) {
        roi.moveCenter(handles[i].second);
        if (roi.contains(mousePos)) {
            if (select)
                setSelection(Stop, i);
            m_lastMousePos = mousePos;
            return true;
        }
    }

    if (select)
        setSelection(None);

    return false;
}

void GradientStrategy::paintHandle(QPainter &painter, const KoViewConverter &converter, const QPointF &position)
{
    QRectF hr = handleRect(converter);
    hr.moveCenter(position);
    painter.drawRect(hr);
}

void GradientStrategy::paintStops(QPainter &painter, const KoViewConverter &converter)
{
    painter.save();

    QRectF hr = handleRect(converter);

    QPen defPen = painter.pen();
    QList<StopHandle> handles = stopHandles(converter);
    int stopCount = m_stops.count();
    for (int i = 0; i < stopCount; ++i) {
        hr.moveCenter(handles[i].second);

        painter.setPen(defPen);
        painter.drawLine(handles[i].first, handles[i].second);
        painter.setBrush(m_stops[i].second);
        painter.setPen(QPen(invertedColor(m_stops[i].second), 0));
        if (m_selection == Stop && m_selectionIndex == i) {
            QTransform m;
            m.translate(hr.center().x(), hr.center().y());
            m.rotate(45.0);
            m.translate(-hr.center().x(), -hr.center().y());
            painter.save();
            painter.setWorldTransform(m, true);
            painter.drawRect(hr);
            painter.restore();
        } else
            painter.drawEllipse(hr);
    }

    painter.restore();
}

void GradientStrategy::paint(QPainter &painter, const KoViewConverter &converter, bool selected)
{
    m_shape->applyConversion(painter, converter);

    QPointF startPoint = m_matrix.map(m_handles[m_gradientLine.first]);
    QPointF stopPoint = m_matrix.map(m_handles[m_gradientLine.second]);

    // draw the gradient line
    painter.drawLine(startPoint, stopPoint);

    // draw the gradient stops
    if (selected)
        paintStops(painter, converter);

    // draw the gradient handles
    // There exists a problem on msvc with for(each) and QVector<QPointF>
    for (int i = 0; i < m_handles.count(); ++i) {
        const QPointF &handle(m_handles[i]);
        paintHandle(painter, converter, m_matrix.map(handle));
    }
}

qreal GradientStrategy::projectToGradientLine(const QPointF &point)
{
    QPointF startPoint = m_matrix.map(m_handles[m_gradientLine.first]);
    QPointF stopPoint = m_matrix.map(m_handles[m_gradientLine.second]);
    QPointF diff = stopPoint - startPoint;
    qreal diffLength = sqrt(diff.x() * diff.x() + diff.y() * diff.y());
    if (diffLength == 0.0f)
        return 0.0f;
    // project mouse position relative to stop position on gradient line
    qreal scalar = scalarProduct(point - startPoint, diff / diffLength);
    return scalar /= diffLength;
}

bool GradientStrategy::mouseAtLineSegment(const QPointF &mousePos, qreal maxDistance)
{
    qreal scalar = projectToGradientLine(mousePos);
    if (scalar < 0.0 || scalar > 1.0)
        return false;
    // calculate vector between relative mouse position and projected mouse position
    QPointF startPoint = m_matrix.map(m_handles[m_gradientLine.first]);
    QPointF stopPoint = m_matrix.map(m_handles[m_gradientLine.second]);
    QPointF distVec = startPoint + scalar * (stopPoint - startPoint) - mousePos;
    qreal dist = distVec.x() * distVec.x() + distVec.y() * distVec.y();
    if (dist > maxDistance*maxDistance)
        return false;

    return true;
}

void GradientStrategy::handleMouseMove(const QPointF &mouseLocation, Qt::KeyboardModifiers modifiers)
{
    Q_UNUSED(modifiers)

    QTransform invMatrix = m_matrix.inverted();
    switch (m_selection) {
    case Line: {
        uint handleCount = m_handles.count();
        QPointF delta = invMatrix.map(mouseLocation) - invMatrix.map(m_lastMousePos);
        for (uint i = 0; i < handleCount; ++i)
            m_handles[i] += delta;
        m_lastMousePos = mouseLocation;
        break;
    }
    case Handle:
        m_handles[m_selectionIndex] = invMatrix.map(mouseLocation);
        break;
    case Stop: {
        qreal scalar = projectToGradientLine(mouseLocation);
        scalar = qMax(qreal(0.0), scalar);
        scalar = qMin(scalar, qreal(1.0));
        m_stops[m_selectionIndex].first = scalar;
        m_lastMousePos = mouseLocation;
        break;
    }
    default:
        return;
    }

    applyChanges();
}

bool GradientStrategy::handleDoubleClick(const QPointF &mouseLocation)
{
    if (m_selection == Line) {
        // double click on gradient line inserts a new gradient stop

        qreal scalar = projectToGradientLine(mouseLocation);
        // calculate distance to gradient line
        QPointF startPoint = m_matrix.map(m_handles[m_gradientLine.first]);
        QPointF stopPoint = m_matrix.map(m_handles[m_gradientLine.second]);
        QPointF diff = stopPoint - startPoint;
        QPointF diffToLine = startPoint + scalar * diff - mouseLocation;
        qreal distToLine = diffToLine.x() * diffToLine.x() + diffToLine.y() * diffToLine.y();
        if (distToLine > m_handleRadius*m_handleRadius)
            return false;

        QColor newColor = KoGradientHelper::colorAt(scalar, m_stops);
        m_stops.append(QGradientStop(scalar, newColor));
    } else if (m_selection == Stop) {
        // double click on stop handle removes gradient stop

        // do not allow removing one of the last two stops
        if (m_stops.count() <= 2)
            return false;
        m_stops.remove(m_selectionIndex);
        setSelection(None);
    } else
        return false;

    applyChanges();

    return true;
}

void GradientStrategy::applyChanges()
{
    m_newBrush = brush();
    if (m_target == Fill) {
        QSharedPointer<KoGradientBackground>  fill = qSharedPointerDynamicCast<KoGradientBackground>(m_shape->background());
        if (fill) {
            fill->setGradient(*m_newBrush.gradient());
            fill->setTransform(m_newBrush.transform());
        }
    } else {
        KoShapeStroke * stroke = dynamic_cast<KoShapeStroke*>(m_shape->stroke());
        if (stroke)
            stroke->setLineBrush(m_newBrush);
    }
}

KUndo2Command * GradientStrategy::createCommand(KUndo2Command * parent)
{
    if (m_newBrush == m_oldBrush)
        return 0;

    if (m_target == Fill) {
        QSharedPointer<KoGradientBackground>  fill = qSharedPointerDynamicCast<KoGradientBackground>(m_shape->background());
        if (fill) {
            QSharedPointer<KoGradientBackground> newFill(new KoGradientBackground(*fill->gradient(), fill->transform()));
            fill->setGradient(*m_oldBrush.gradient());
            fill->setTransform(m_oldBrush.transform());
            return new KoShapeBackgroundCommand(m_shape, newFill, parent);
        }
    } else {
        KoShapeStroke * stroke = dynamic_cast<KoShapeStroke*>(m_shape->stroke());
        if (stroke) {
            *stroke = m_oldStroke;
            KoShapeStroke * newStroke = new KoShapeStroke(*stroke);
            newStroke->setLineBrush(m_newBrush);
            return new KoShapeStrokeCommand(m_shape, newStroke, parent);
        }
    }

    return 0;
}

QRectF GradientStrategy::boundingRect(const KoViewConverter &converter) const
{
    // calculate the bounding rect of the handles
    QRectF bbox(m_matrix.map(m_handles[0]), QSize(0, 0));
    for (int i = 1; i < m_handles.count(); ++i) {
        QPointF handle = m_matrix.map(m_handles[i]);
        bbox.setLeft(qMin(handle.x(), bbox.left()));
        bbox.setRight(qMax(handle.x(), bbox.right()));
        bbox.setTop(qMin(handle.y(), bbox.top()));
        bbox.setBottom(qMax(handle.y(), bbox.bottom()));
    }
    QList<StopHandle> handles = stopHandles(converter);
    foreach(const StopHandle & stopHandle, handles) {
        QPointF handle = stopHandle.second;
        bbox.setLeft(qMin(handle.x(), bbox.left()));
        bbox.setRight(qMax(handle.x(), bbox.right()));
        bbox.setTop(qMin(handle.y(), bbox.top()));
        bbox.setBottom(qMax(handle.y(), bbox.bottom()));
    }
    // quick hack for gradient stops
    //bbox.adjust( -stopDistance, -stopDistance, stopDistance, stopDistance );
    return bbox.adjusted(-m_handleRadius, -m_handleRadius, m_handleRadius, m_handleRadius);
}

void GradientStrategy::repaint(const KoViewConverter &converter) const
{
    QRectF gradientRect = boundingRect(converter).adjusted(-1, -1, 1, 1);
    m_shape->update(m_shape->documentToShape(gradientRect));
    m_shape->update();
}

const QGradient * GradientStrategy::gradient()
{
    if (m_target == Fill) {
        QSharedPointer<KoGradientBackground>  fill = qSharedPointerDynamicCast<KoGradientBackground>(m_shape->background());
        if (! fill)
            return 0;
        return fill->gradient();
    } else {
        KoShapeStroke * stroke = dynamic_cast<KoShapeStroke*>(m_shape->stroke());
        if (! stroke)
            return 0;
        return stroke->lineBrush().gradient();
    }
}

GradientStrategy::Target GradientStrategy::target() const
{
    return m_target;
}

void GradientStrategy::startDrawing(const QPointF &mousePos)
{
    QTransform invMatrix = m_matrix.inverted();

    int handleCount = m_handles.count();
    for (int handleId = 0; handleId < handleCount; ++handleId)
        m_handles[handleId] = invMatrix.map(mousePos);

    setSelection(Handle, handleCount - 1);
    setEditing(true);
}

bool GradientStrategy::hasSelection() const
{
    return m_selection != None;
}

KoShape * GradientStrategy::shape()
{
    return m_shape;
}

QGradient::Type GradientStrategy::type() const
{
    return m_type;
}

void GradientStrategy::updateStops()
{
    QBrush brush;
    if (m_target == Fill) {
        QSharedPointer<KoGradientBackground>  fill = qSharedPointerDynamicCast<KoGradientBackground>(m_shape->background());
        if (fill)
            m_stops = fill->gradient()->stops();
    } else {
        KoShapeStroke * stroke = dynamic_cast<KoShapeStroke*>(m_shape->stroke());
        if (stroke) {
            brush = stroke->lineBrush();
            if (brush.gradient())
                m_stops = brush.gradient()->stops();
        }
    }
}

int GradientStrategy::selectedColorStop() const
{
    if (m_selection == Stop)
        return m_selectionIndex;
    else
        return -1;
}

GradientStrategy::SelectionType GradientStrategy::selection() const
{
    return m_selection;
}

void GradientStrategy::setGradientLine(int start, int stop)
{
    m_gradientLine = QPair<int, int>(start, stop);
}

QRectF GradientStrategy::handleRect(const KoViewConverter &converter) const
{
    return converter.viewToDocument(QRectF(0, 0, 2*m_handleRadius, 2*m_handleRadius));
}

QRectF GradientStrategy::grabRect(const KoViewConverter &converter) const
{
    return converter.viewToDocument(QRectF(0, 0, 2*m_grabSensitivity, 2*m_grabSensitivity));
}

void GradientStrategy::setSelection(SelectionType selection, int index)
{
    m_selection = selection;
    m_selectionIndex = index;
}

QColor GradientStrategy::invertedColor(const QColor &color)
{
    return QColor(255 - color.red(), 255 - color.green(), 255 - color.blue());
}

QList<GradientStrategy::StopHandle> GradientStrategy::stopHandles(const KoViewConverter &converter) const
{
    // get the gradient line start and end point in document coordinates
    QPointF start = m_matrix.map(m_handles[m_gradientLine.first]);
    QPointF stop = m_matrix.map(m_handles[m_gradientLine.second]);

    // calculate orthogonal vector to the gradient line
    // using the cross product of the line vector and the negative z-axis
    QPointF diff = stop - start;
    QPointF ortho(-diff.y(), diff.x());
    qreal orthoLength = sqrt(ortho.x() * ortho.x() + ortho.y() * ortho.y());
    if (orthoLength == 0.0)
        ortho = QPointF(stopDistance, 0.0f);
    else
        ortho *= stopDistance / orthoLength;

    // make handles have always the same distance to the gradient line
    // independent of actual zooming
    ortho = converter.viewToDocument(ortho);

    QList<StopHandle> handles;
    foreach(const QGradientStop & stop, m_stops) {
        QPointF base = start + stop.first * diff;
        handles.append(StopHandle(base, base + ortho));
    }

    return handles;
}

/////////////////////////////////////////////////////////////////
// strategy implementations
/////////////////////////////////////////////////////////////////
LinearGradientStrategy::LinearGradientStrategy(KoShape *shape, const QLinearGradient *gradient, Target target)
        : GradientStrategy(shape, gradient, target)
{
    Q_ASSERT(gradient->coordinateMode() == QGradient::ObjectBoundingMode);
    QSizeF size(shape->size());
    m_handles.append(KoFlake::toAbsolute(gradient->start(), size));
    m_handles.append(KoFlake::toAbsolute(gradient->finalStop(), size));
}

QBrush LinearGradientStrategy::brush()
{
    QSizeF size(m_shape->size());
    QLinearGradient gradient(KoFlake::toRelative(m_handles[start], size), KoFlake::toRelative(m_handles[stop], size));
    gradient.setCoordinateMode(QGradient::ObjectBoundingMode);
    gradient.setStops(m_stops);
    gradient.setSpread(m_oldBrush.gradient()->spread());
    QBrush brush = QBrush(gradient);
    brush.setTransform(m_oldBrush.transform());
    return brush;
}

RadialGradientStrategy::RadialGradientStrategy(KoShape *shape, const QRadialGradient *gradient, Target target)
        : GradientStrategy(shape, gradient, target)
{
    Q_ASSERT(gradient->coordinateMode() == QGradient::ObjectBoundingMode);
    QSizeF size(shape->size());
    QPointF absoluteCenter(KoFlake::toAbsolute(gradient->center(), size));
    qreal radius = gradient->radius() * size.width();

    m_handles.append(absoluteCenter);
    m_handles.append(KoFlake::toAbsolute(gradient->focalPoint(), size));
    m_handles.append(absoluteCenter + QPointF(radius, 0));
    setGradientLine(0, 2);
}

QBrush RadialGradientStrategy::brush()
{
    QSizeF size(m_shape->size());
    QPointF relativeCenter(KoFlake::toRelative(m_handles[center], size));
    QPointF d = KoFlake::toRelative(m_handles[radius], size) - relativeCenter;
    qreal r = sqrt(d.x()*d.x() + d.y()*d.y());
    QRadialGradient gradient(relativeCenter, r, KoFlake::toRelative(m_handles[focal], size));
    gradient.setCoordinateMode(QGradient::ObjectBoundingMode);
    gradient.setStops(m_stops);
    gradient.setSpread(m_oldBrush.gradient()->spread());
    QBrush brush = QBrush(gradient);
    brush.setTransform(m_oldBrush.transform());
    return brush;
}

ConicalGradientStrategy::ConicalGradientStrategy(KoShape *shape, const QConicalGradient *gradient, Target target)
        : GradientStrategy(shape, gradient, target)
{
    Q_ASSERT(gradient->coordinateMode() == QGradient::ObjectBoundingMode);
    QSizeF size(m_shape->size());
    qreal scale = 0.25 * (size.height() + size.width());
    qreal angle = gradient->angle() * M_PI / 180.0;
    QPointF center(KoFlake::toAbsolute(gradient->center(), size));
    m_handles.append(center);
    m_handles.append(center + scale * QPointF(cos(angle), -sin(angle)));
}

QBrush ConicalGradientStrategy::brush()
{
    QPointF d = m_handles[direction] - m_handles[center];
    qreal angle = atan2(-d.y(), d.x()) / M_PI * 180.0;
    if (angle < 0.0)
        angle += 360;
    QConicalGradient gradient(KoFlake::toRelative( m_handles[center], m_shape->size()), angle);
    gradient.setCoordinateMode(QGradient::ObjectBoundingMode);
    gradient.setStops(m_stops);
    gradient.setSpread(m_oldBrush.gradient()->spread());
    QBrush brush = QBrush(gradient);
    brush.setTransform(m_oldBrush.transform());
    return brush;
}
