validator.h

/*
 * SPDX-FileCopyrightText: (C) 2017-2022 Matthias Fehring <mf@huessenbergnetz.de>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CUTELYSTVALIDATOR_H
#define CUTELYSTVALIDATOR_H

#include <Cutelyst/cutelyst_global.h>
#include <Cutelyst/ParamsMultiMap>
#include <QScopedPointer>
#include "validatorresult.h"

namespace Cutelyst {

class ValidatorPrivate;
class Context;
class Application;
class ValidatorRule;

class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT Validator
{
public:
    enum ValidatorFlag {
        NoSpecialBehavior   =  0,    
        StopOnFirstError    =  1,    
        FillStashOnError    =  2,    
        NoTrimming          =  4,    
        BodyParamsOnly      =  8,    
        QueryParamsOnly     = 16     
    };
    Q_DECLARE_FLAGS(ValidatorFlags, ValidatorFlag)

    
    explicit Validator(QLatin1String translationContext = QLatin1String());

#ifdef Q_COMPILER_INITIALIZER_LISTS

    explicit Validator(std::initializer_list<ValidatorRule*> validators, QLatin1String translationContext = QLatin1String());
#endif

    ~Validator();

    void clear();

    ValidatorResult validate(Context *c, ValidatorFlags flags = NoSpecialBehavior) const;

    ValidatorResult validate(Context *c, const ParamsMultiMap &parameters, ValidatorFlags flags = NoSpecialBehavior) const;

    void addValidator(ValidatorRule *v);

    static void loadTranslations(Application *app);

protected:
    const QScopedPointer<ValidatorPrivate> d_ptr;

private:
    Q_DECLARE_PRIVATE(Validator)
    Q_DISABLE_COPY(Validator)
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(Cutelyst::Validator::ValidatorFlags)

#endif //CUTELYSTVALIDATOR_H