dispatchtype.h

/*
 * SPDX-FileCopyrightText: (C) 2013-2023 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#pragma once
 
#include <Cutelyst/cutelyst_export.h>
 
#include <QtCore/qobject.h>
#include <QtCore/qstringlist.h>
 
namespace Cutelyst {
 
class Context;
class Action;
class Request;
class CUTELYST_EXPORT DispatchType : public QObject
{
    Q_OBJECT
public:
    enum MatchType {
        NoMatch = 0,
        PartialMatch,
        ExactMatch,
    };
    Q_ENUM(MatchType)
 
    
    explicit DispatchType(QObject *parent = nullptr);

    virtual ~DispatchType();

    virtual QByteArray list() const = 0;

    [[nodiscard]] virtual MatchType
        match(Context *c, QStringView path, const QStringList &args) const = 0;

    [[nodiscard]] virtual QString uriForAction(Action *action,
                                               const QStringList &captures) const = 0;

    [[nodiscard]] virtual Action *expandAction(const Context *c, Action *action) const;

    virtual bool registerAction(Action *action);

    virtual bool inUse() = 0;

    virtual bool isLowPrecedence() const;
 
protected:
    friend class Dispatcher;
    friend class Application;

    void setupMatchedAction(Context *c, Action *action) const;
};
 
} // namespace Cutelyst