summaryrefslogtreecommitdiffstats
path: root/common/pipeline.h
blob: 6b847f5f01e2d7e42c9ffc6f2ca6a4eb252757bc (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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
 * Copyright (C) 2014 Aaron Seigo <aseigo@kde.org>
 *
 * 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) version 3, or any
 * later version accepted by the membership of KDE e.V. (or its
 * successor approved by the membership of KDE e.V.), which shall
 * act as a proxy defined in Section 6 of version 3 of the license.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <flatbuffers/flatbuffers.h>

#include <QSharedDataPointer>
#include <QObject>

#include <akonadi2common_export.h>
#include <storage.h>
#include <clientapi.h> //For domain types

#include "entity_generated.h"

namespace Akonadi2
{

class PipelineState;
class Preprocessor;

class AKONADI2COMMON_EXPORT Pipeline : public QObject
{
    Q_OBJECT

public:
    enum Type { NullPipeline, NewPipeline, ModifiedPipeline, DeletedPipeline };

    Pipeline(const QString &storagePath, QObject *parent = 0);
    ~Pipeline();

    Storage &storage() const;

    // template <typename T>
    // Storage &storage() const;

    template <typename T>
    void setPreprocessors(Type type, const QVector<Preprocessor *> &preprocessors)
    {
        setPreprocessors(Akonadi2::Domain::getTypeName<T>(), type, preprocessors);
    }

    void null();

    template <typename T>
    void newEntity(const QByteArray &key, void *resourceBufferData, size_t size)
    {
        newEntity(Akonadi2::Domain::getTypeName<T>(), key, resourceBufferData, size);
    }

    template <typename T>
    void modifiedEntity(const QByteArray &key, void *data, size_t size)
    {
        modifiedEntity(Akonadi2::Domain::getTypeName<T>(), key, data, size);
    }

    template <typename T>
    void deletedEntity(const QByteArray &key)
    {
        deletedEntity(Akonadi2::Domain::getTypeName<T>(), key);
    }

Q_SIGNALS:
    void revisionUpdated();
    void pipelinesDrained();

private Q_SLOTS:
    void stepPipelines();

private:
    void setPreprocessors(const QString &entityType, Type pipelineType, const QVector<Preprocessor *> &preprocessors);
    void newEntity(const QString &entityType, const QByteArray &key, void *resourceBufferData, size_t size);
    void modifiedEntity(const QString &entityType, const QByteArray &key, void *data, size_t size);
    void deletedEntity(const QString &entityType, const QByteArray &key);
    void pipelineStepped(const PipelineState &state);
    void pipelineCompleted(const PipelineState &state);
    void scheduleStep();

    friend class PipelineState;

    class Private;
    Private * const d;
};

class AKONADI2COMMON_EXPORT PipelineState
{
public:
    PipelineState();
    PipelineState(Pipeline *pipeline, Pipeline::Type type, const QByteArray &key, const QVector<Preprocessor *> &filters);
    PipelineState(const PipelineState &other);
    ~PipelineState();

    PipelineState &operator=(const PipelineState &rhs);
    bool operator==(const PipelineState &rhs);

    bool isIdle() const;
    QByteArray key() const;
    Pipeline::Type type() const;

    void step();
    void processingCompleted(Preprocessor *filter);

private:
    class Private;
    QExplicitlySharedDataPointer<Private> d;
};

class AKONADI2COMMON_EXPORT Preprocessor
{
public:
    Preprocessor();
    virtual ~Preprocessor();

    virtual void process(PipelineState state, const Akonadi2::Entity &);

protected:
    void processingCompleted(PipelineState state);

private:
    class Private;
    Private * const d;
};

} // namespace Akonadi2