validator.h

/*
 * SPDX-FileCopyrightText: (C) 2017-2025 Matthias Fehring <mf@huessenbergnetz.de>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CUTELYSTVALIDATOR_H
#define CUTELYSTVALIDATOR_H
 
#include "validatorresult.h"
 
#include <Cutelyst/ParamsMultiMap>
#include <Cutelyst/Plugins/Utils/validator_export.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 [[deprecated]] = 2, 
        NoTrimming = 4, 
        BodyParamsOnly =
            8, 
        QueryParamsOnly =
            16 
    };
    Q_DECLARE_FLAGS(ValidatorFlags, ValidatorFlag)
 
    
    explicit Validator(const char *translationContext = nullptr);
 
    Validator(std::initializer_list<ValidatorRule *> validators,
              const char *translationContext = nullptr);
 
    ~Validator();
 
    void clear();
 
    ValidatorResult validate(Context *c, ValidatorFlags flags = NoSpecialBehavior) const;
 
    ValidatorResult validate(Context *c,
                             const ParamsMultiMap &parameters,
                             ValidatorFlags flags = NoSpecialBehavior) const;
 
    AwaitedValidatorResult coValidate(Context *c, ValidatorFlags flags = NoSpecialBehavior) const;
 
    AwaitedValidatorResult coValidate(Context *c,
                                      const ParamsMultiMap &params,
                                      ValidatorFlags flags = NoSpecialBehavior) const;
 
    void addValidator(ValidatorRule *v);
 
    static void loadTranslations(Application *app);
 
private:
    const std::unique_ptr<ValidatorPrivate> d_ptr;
 
    Q_DECLARE_PRIVATE(Validator) // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast)
    Q_DISABLE_COPY(Validator)
};
 
} // namespace Cutelyst
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Cutelyst::Validator::ValidatorFlags)
 
#endif // CUTELYSTVALIDATOR_H