aboutsummaryrefslogtreecommitdiff
path: root/include/smolbote/filterinterface.hpp
blob: 3bbddf2dcdae30d936aa02fe2b4907e0dd9c3d9b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*
 * This file is part of smolbote. It's copyrighted by the contributors recorded
 * in the version control history of the file, available from its original
 * location: https://library.iserlohn-fortress.net/aqua/smolbote.git
 *
 * SPDX-License-Identifier: MIT
 */

#ifndef SMOLBOTE_SMOLBLOK_INTERFACE_HPP
#define SMOLBOTE_SMOLBLOK_INTERFACE_HPP

#include <QWebEngineUrlRequestInfo>
#include <QtPlugin>
#include <QIODevice>

class FilterList
{
public:
    virtual ~FilterList() = default;

    [[nodiscard]] virtual bool filter(QWebEngineUrlRequestInfo &info) const = 0;
    [[nodiscard]] virtual bool isUpToDate() const = 0;
};

// A class to provide filter interfaces
class FilterPlugin
{
public:
    virtual ~FilterPlugin() = default;

    virtual FilterList *load(QIODevice&) const = 0;
    virtual bool parse(FilterList *list, QIODevice &) const = 0;
};

#define FilterPluginIid "net.iserlohn-fortress.smolbote.FilterPlugin"
Q_DECLARE_INTERFACE(FilterPlugin, FilterPluginIid)

#endif // SMOLBOTE_SMOLBLOK_INTERFACE_HPP