validator.h

/*
 * Copyright (C) 2017-2018 Matthias Fehring <kontakt@buschmann23.de>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
#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