validatorrule.h

/*
 * SPDX-FileCopyrightText: (C) 2017-2025 Matthias Fehring <mf@huessenbergnetz.de>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CUTELYSTVALIDATORRULE_H
#define CUTELYSTVALIDATORRULE_H
 
#include <Cutelyst/Plugins/Utils/validator_export.h>
#include <Cutelyst/context.h>
#include <Cutelyst/paramsmultimap.h>
#include <functional>
 
#include <QLoggingCategory>
#include <QPointer>
#include <QScopedPointer>
#include <QVariant>
 
Q_DECLARE_LOGGING_CATEGORY(C_VALIDATOR)
 
namespace Cutelyst {

 
class Context;

struct CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorReturnType {
    QString errorMessage; 
    QVariant value;       
    QVariant extra; 

    explicit operator bool() const noexcept { return errorMessage.isNull(); }

    [[nodiscard]] bool isValid() const noexcept { return errorMessage.isNull(); }
};

using ValidatorRtFn = std::function<void(ValidatorReturnType &&result)>;

struct CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorMessages {
    ValidatorMessages() = default;
    explicit ValidatorMessages(const char *customLabel,
                               const char *customValidationError     = nullptr,
                               const char *customParsingError        = nullptr,
                               const char *customValidationDataError = nullptr)
        : label(customLabel)
        , validationError(customValidationError)
        , parsingError(customParsingError)
        , validationDataError(customValidationDataError)
    {
    }
    const char *label = nullptr; 
    const char *validationError     = nullptr; 
    const char *parsingError        = nullptr; 
    const char *validationDataError = nullptr; 
};
 
class ValidatorRulePrivate;

class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorRule
{
public:
    explicit ValidatorRule(const QString &field,
                           const ValidatorMessages &messages = {},
                           const QString &defValKey          = {},
                           QByteArrayView validatorName      = nullptr);

    virtual ~ValidatorRule();
 
protected:
    // shared d-pointer
    // NOLINTNEXTLINE(cppcoreguidelines-non-private-member-variables-in-classes)
    const std::unique_ptr<ValidatorRulePrivate> d_ptr;
    explicit ValidatorRule(ValidatorRulePrivate &dd);

    virtual ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const = 0;

    virtual void validateCb(Context *c, const ParamsMultiMap &params, ValidatorRtFn cb) const;

    [[nodiscard]] QString field() const noexcept;

    [[nodiscard]] QString label(const Context *c) const;

    [[nodiscard]] QString value(const ParamsMultiMap &params) const;

    [[nodiscard]] bool trimBefore() const noexcept;

    [[nodiscard]] QString validationError(Context *c, const QVariant &errorData = {}) const;

    virtual QString genericValidationError(Context *c, const QVariant &errorData = {}) const;

    [[nodiscard]] QString parsingError(Context *c, const QVariant &errorData = {}) const;

    virtual QString genericParsingError(Context *c, const QVariant &errorData = {}) const;

    [[nodiscard]] QString validationDataError(Context *c, const QVariant &errorData = {}) const;

    virtual QString genericValidationDataError(Context *c, const QVariant &errorData = {}) const;

    void defaultValue(Context *c, ValidatorReturnType *result) const;

    void defaultValue(Context *c, ValidatorRtFn cb) const;

    [[nodiscard]] QString debugString(const Context *c) const;
 
private:
    Q_DECLARE_PRIVATE(ValidatorRule) // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast)
    Q_DISABLE_COPY(ValidatorRule)
 
    
    void setTranslationContext(const char *trContext) noexcept;

    void setTrimBefore(bool trimBefore) noexcept;
 
    friend class Validator;
    friend class ValidatorPrivate;
    friend class AsyncValidator;
};
 
} // namespace Cutelyst
 
#endif // CUTELYSTVALIDATORRULE_H