component.h

/*
 * SPDX-FileCopyrightText: (C) 2014-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CUTELYST_COMPONENT_H
#define CUTELYST_COMPONENT_H
 
#include <Cutelyst/cutelyst_global.h>
 
#include <QtCore/qobject.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; 
};
 
} // namespace Cutelyst
 
#endif // CUTELYST_COMPONENT_H