/****************************************************************************
**
** Copyright (C) 2013 Sandro S. Andrade <sandroandrade@kde.org>
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtUml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qumlexceptionhandler.h"

#include "private/qumlexceptionhandlerobject_p.h"

#include <QtUml/QUmlClassifier>
#include <QtUml/QUmlComment>
#include <QtUml/QUmlExecutableNode>
#include <QtUml/QUmlObjectNode>

QT_BEGIN_NAMESPACE

/*!
    \class QUmlExceptionHandler

    \inmodule QtUml

    \brief An exception handler is an element that specifies a body to execute in case the specified exception occurs during the execution of the protected node.
 */

/*!
    Creates a new QUmlExceptionHandler. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true.
*/
QUmlExceptionHandler::QUmlExceptionHandler(bool createQModelingObject) :
    _exceptionInput(0),
    _handlerBody(0),
    _protectedNode(0)
{
    if (createQModelingObject)
        _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExceptionHandlerObject(this));
}

/*!
    Destroys the QUmlExceptionHandler.
 */
QUmlExceptionHandler::~QUmlExceptionHandler()
{
    QModelingElement::deleteQModelingObject();
}

/*!
    Returns a deep-copied clone of the QUmlExceptionHandler.
*/
QModelingElement *QUmlExceptionHandler::clone() const
{
    QUmlExceptionHandler *c = new QUmlExceptionHandler;
    c->asQModelingObject()->setObjectName(this->asQModelingObject()->objectName());
    c->asQModelingObject()->setProperty("role", this->asQModelingObject()->property("role"));
    foreach (QUmlComment *element, ownedComments())
        c->addOwnedComment(dynamic_cast<QUmlComment *>(element->clone()));
    return c;
}

// OWNED ATTRIBUTES

/*!
    An object node within the handler body. When the handler catches an exception, the exception token is placed in this node, causing the body to execute.
 */
QUmlObjectNode *QUmlExceptionHandler::exceptionInput() const
{
    // This is a read-write association end

    return _exceptionInput;
}

/*!
    Adjusts exceptionInput to \a exceptionInput.
 */
void QUmlExceptionHandler::setExceptionInput(QUmlObjectNode *exceptionInput)
{
    // This is a read-write association end

    if (_exceptionInput != exceptionInput) {
        _exceptionInput = exceptionInput;
        if (exceptionInput && exceptionInput->asQModelingObject() && this->asQModelingObject())
            QObject::connect(exceptionInput->asQModelingObject(), SIGNAL(destroyed()), this->asQModelingObject(), SLOT(setExceptionInput()));
    }
}

/*!
    The kind of instances that the handler catches. If an exception occurs whose type is any of the classifiers in the set, the handler catches the exception and executes its body.

    \sa addExceptionType(), removeExceptionType()
 */
const QSet<QUmlClassifier *> QUmlExceptionHandler::exceptionTypes() const
{
    // This is a read-write association end

    return _exceptionTypes;
}

/*!
    Adds \a exceptionType to exceptionTypes.

    \sa exceptionTypes(), removeExceptionType()
 */
void QUmlExceptionHandler::addExceptionType(QUmlClassifier *exceptionType)
{
    // This is a read-write association end

    if (!_exceptionTypes.contains(exceptionType)) {
        _exceptionTypes.insert(exceptionType);
        if (exceptionType && exceptionType->asQModelingObject() && this->asQModelingObject())
            QObject::connect(exceptionType->asQModelingObject(), SIGNAL(destroyed(QObject*)), this->asQModelingObject(), SLOT(removeExceptionType(QObject *)));
    }
}

/*!
    Removes \a exceptionType from exceptionTypes.

    \sa exceptionTypes(), addExceptionType()
 */
void QUmlExceptionHandler::removeExceptionType(QUmlClassifier *exceptionType)
{
    // This is a read-write association end

    if (_exceptionTypes.contains(exceptionType)) {
        _exceptionTypes.remove(exceptionType);
    }
}

/*!
    A node that is executed if the handler satisfies an uncaught exception.
 */
QUmlExecutableNode *QUmlExceptionHandler::handlerBody() const
{
    // This is a read-write association end

    return _handlerBody;
}

/*!
    Adjusts handlerBody to \a handlerBody.
 */
void QUmlExceptionHandler::setHandlerBody(QUmlExecutableNode *handlerBody)
{
    // This is a read-write association end

    if (_handlerBody != handlerBody) {
        _handlerBody = handlerBody;
        if (handlerBody && handlerBody->asQModelingObject() && this->asQModelingObject())
            QObject::connect(handlerBody->asQModelingObject(), SIGNAL(destroyed()), this->asQModelingObject(), SLOT(setHandlerBody()));
    }
}

/*!
    The node protected by the handler. The handler is examined if an exception propagates to the outside of the node.

    \b {Subsetted property(ies):} QUmlElement::owner().

    \b {Opposite property(ies):} QUmlExecutableNode::handlers().
 */
QUmlExecutableNode *QUmlExceptionHandler::protectedNode() const
{
    // This is a read-write association end

    return _protectedNode;
}

/*!
    Adjusts protectedNode to \a protectedNode.
 */
void QUmlExceptionHandler::setProtectedNode(QUmlExecutableNode *protectedNode)
{
    // This is a read-write association end

    if (_protectedNode != protectedNode) {
        // Adjust subsetted properties

        _protectedNode = protectedNode;
        if (protectedNode && protectedNode->asQModelingObject() && this->asQModelingObject())
            QObject::connect(protectedNode->asQModelingObject(), SIGNAL(destroyed()), this->asQModelingObject(), SLOT(setProtectedNode()));

        // Adjust subsetted properties
        setOwner(protectedNode);
    }
}

QT_END_NAMESPACE