component.h

/*
 * Copyright (C) 2014-2017 Daniel Nicoletti <dantti12@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef CUTELYST_COMPONENT_H
#define CUTELYST_COMPONENT_H

#include <QtCore/qobject.h>

#include <Cutelyst/cutelyst_global.h>

namespace Cutelyst {

class Application;
class Context;
class Controller;
class Dispatcher;
class ComponentPrivate;

class CUTELYST_LIBRARY Component : public QObject
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(Component)
    Q_FLAGS(Modifiers)
public:
    enum Modifier {
        None          = 0 << 1,
        OnlyExecute   = 1 << 1,
        BeforeExecute = 2 << 1,
        AroundExecute = 3 << 1,
        AfterExecute  = 4 << 1,
    };
    Q_ENUM(Modifier)
    Q_DECLARE_FLAGS(Modifiers, Modifier)

    explicit Component(QObject *parent = nullptr);
    virtual ~Component() override;

    virtual Modifiers modifiers() const;

    QString name() const;

    void setName(const QString &name);

    QString reverse() const;

    void setReverse(const QString &reverse);

    virtual bool init(Application *application, const QVariantHash &args);

    bool execute(Context *c);

protected:
    explicit Component(ComponentPrivate *d, QObject *parent = nullptr);

    virtual bool beforeExecute(Context *c);

    virtual bool aroundExecute(Context *c, QStack<Component *> stack);

    virtual bool afterExecute(Context *c);

    virtual bool doExecute(Context *c);

    void applyRoles(const QStack<Component *> &roles);

    virtual bool dispatcherReady(const Dispatcher *dispatch, Controller *controller);

protected:
    friend class Controller;
    ComponentPrivate *d_ptr; 
};

}

#endif // CUTELYST_COMPONENT_H