aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/qmldesigner/designercore/include/synchronousimagecache.h
blob: 7f6573cf6eff81943e18bce231ec905fb35c7a2e (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
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include "imagecacheauxiliarydata.h"

#include <utils/smallstring.h>

#include <QIcon>
#include <QImage>

#include <condition_variable>
#include <functional>
#include <mutex>
#include <thread>

namespace QmlDesigner {

class TimeStampProviderInterface;
class ImageCacheStorageInterface;
class ImageCacheGeneratorInterface;
class ImageCacheCollectorInterface;

class SynchronousImageCache
{
public:
    using CaptureImageCallback = std::function<void(const QImage &)>;
    using AbortCallback = std::function<void()>;

    SynchronousImageCache(ImageCacheStorageInterface &storage,
                          TimeStampProviderInterface &timeStampProvider,
                          ImageCacheCollectorInterface &collector)
        : m_storage(storage)
        , m_timeStampProvider(timeStampProvider)
        , m_collector(collector)
    {}

    QImage image(Utils::PathString filePath,
                 Utils::SmallString extraId = {},
                 const ImageCache::AuxiliaryData &auxiliaryData = {});
    QImage smallImage(Utils::PathString filePath,
                      Utils::SmallString extraId = {},
                      const ImageCache::AuxiliaryData &auxiliaryData = {});
    QIcon icon(Utils::PathString filePath,
               Utils::SmallString extraId = {},
               const ImageCache::AuxiliaryData &auxiliaryData = {});

private:
    ImageCacheStorageInterface &m_storage;
    TimeStampProviderInterface &m_timeStampProvider;
    ImageCacheCollectorInterface &m_collector;
};

} // namespace QmlDesigner