ianemitter.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/
 
#pragma once
 
#include <variant>
#include <QtPlugin>
#include <QVariant>
#include <QStringList>
 
namespace LC
{
    struct ANFieldData
    {
        QString ID_;
 
        QString Name_;
 
        QString Description_;
 
        QVariant::Type Type_;
 
        QStringList EventTypes_;
 
        QVariantList AllowedValues_;
 
        ANFieldData ()
        : Type_ (QVariant::Invalid)
        {
        }
 
        ANFieldData (const QString& id,
                const QString& name,
                const QString& description,
                QVariant::Type type,
                const QStringList& events,
                const QVariantList& values = {})
        : ID_ (id)
        , Name_ (name)
        , Description_ (description)
        , Type_ (type)
        , EventTypes_ (events)
        , AllowedValues_ (values)
        {
        }
    };
 
    struct ANBoolFieldValue
    {
        bool IsSet_;
    };
 
    inline bool operator== (const ANBoolFieldValue& left, const ANBoolFieldValue& right)
    {
        return left.IsSet_ == right.IsSet_;
    }
 
    struct ANIntFieldValue
    {
        int Boundary_;
 
        enum Operation
        {
            OGreater = 0x01,
 
            OLess = 0x02,
 
            OEqual = 0x04
        };
 
        Q_DECLARE_FLAGS (Operations, Operation)
 
        
        Operations Ops_;
    };
 
    inline bool operator== (const ANIntFieldValue& left, const ANIntFieldValue& right)
    {
        return left.Boundary_ == right.Boundary_ &&
                left.Ops_ == right.Ops_;
    }
 
    struct ANStringFieldValue
    {
        QRegExp Rx_;
 
        bool Contains_;
 
        ANStringFieldValue (const QRegExp& rx, bool contains)
        : Rx_ { rx }
        , Contains_ { contains }
        {
        }
 
        ANStringFieldValue (const QString& str, bool contains = true)
        : Rx_ { str, Qt::CaseSensitive, QRegExp::FixedString }
        , Contains_ { contains }
        {
        }
    };
 
    inline bool operator== (const ANStringFieldValue& left, const ANStringFieldValue& right)
    {
        return left.Contains_ == right.Contains_ &&
                left.Rx_ == right.Rx_;
    }
 
    typedef std::variant<ANBoolFieldValue, ANIntFieldValue, ANStringFieldValue> ANFieldValue;
}
 
class Q_DECL_EXPORT IANEmitter
{
public:
    virtual ~IANEmitter () {}
 
    virtual QList<LC::ANFieldData> GetANFields () const = 0;
};
 
Q_DECLARE_INTERFACE (IANEmitter, "org.Deviant.LeechCraft.IANEmitter/1.0")
Q_DECLARE_METATYPE (LC::ANFieldData)
Q_DECLARE_METATYPE (LC::ANFieldValue)
Q_DECLARE_METATYPE (QList<LC::ANFieldValue>)
 
Q_DECLARE_OPERATORS_FOR_FLAGS (LC::ANIntFieldValue::Operations)