action.h

/*
 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CUTELYST_ACTION_H
#define CUTELYST_ACTION_H
 
#include <Cutelyst/component.h>
#include <Cutelyst/context.h>
#include <Cutelyst/cutelyst_global.h>
 
#include <QtCore/QMetaMethod>
#include <QtCore/QStringList>
 
namespace Cutelyst {
 
class Controller;
class Dispatcher;
class ActionPrivate;
class CUTELYST_LIBRARY Action : public Component
{
    Q_OBJECT
public:
    explicit Action(QObject *parent = nullptr);
 
    virtual ~Action() override = default;
 
    virtual Modifiers modifiers() const override;
 
    [[nodiscard]] ParamsMultiMap attributes() const noexcept;
 
    [[nodiscard]] QString attribute(const QString &name, const QString &defaultValue = {}) const;
 
    void setAttributes(const ParamsMultiMap &attributes);
 
    [[nodiscard]] QString className() const noexcept;
 
    [[nodiscard]] Controller *controller() const noexcept;
 
    inline bool dispatch(Context *c) { return c->execute(this); }
 
    [[nodiscard]] virtual bool match(int numberOfArgs) const noexcept;
 
    [[nodiscard]] virtual bool matchCaptures(int numberOfCaptures) const noexcept;
 
    [[nodiscard]] QString ns() const noexcept;
 
    [[nodiscard]] virtual qint8 numberOfArgs() const;
 
    [[nodiscard]] virtual qint8 numberOfCaptures() const;
 
protected:
    friend class Dispatcher;
    friend class ControllerPrivate;
 
    explicit Action(ActionPrivate *ptr, QObject *parent = nullptr);
 
    bool doExecute(Context *c) override;
 
    void setMethod(const QMetaMethod &method);
 
    void setController(Controller *controller);
 
    void setupAction(const QVariantHash &args, Application *app);
 
private:
    Q_DECLARE_PRIVATE(Action)
};
 
typedef QVector<Action *> ActionList;
 
} // namespace Cutelyst
 
#endif // CUTELYST_ACTION_H