aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/utils/filestreamermanager.cpp
blob: 9cdfb15c0393abbff8b6e515b6a288bd2516ffcb (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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#include "filestreamermanager.h"

#include "filestreamer.h"
#include "threadutils.h"
#include "utilstr.h"

#include <QMutex>
#include <QMutexLocker>
#include <QThread>
#include <QWaitCondition>

#include <unordered_map>

namespace Utils {

// TODO: destruct the instance before destructing ProjectExplorer::DeviceManager (?)

static FileStreamHandle generateUniqueHandle()
{
    static std::atomic_int handleCounter = 1;
    return FileStreamHandle(handleCounter.fetch_add(1));
}

static QMutex s_mutex = {};
static QWaitCondition s_waitCondition = {};
static std::unordered_map<FileStreamHandle, FileStreamer *> s_fileStreamers = {};

static void addStreamer(FileStreamHandle handle, FileStreamer *streamer)
{
    QMutexLocker locker(&s_mutex);
    const bool added = s_fileStreamers.try_emplace(handle, streamer).second;
    QTC_CHECK(added);
}

static void removeStreamer(FileStreamHandle handle)
{
    QMutexLocker locker(&s_mutex);
    auto it = s_fileStreamers.find(handle);
    QTC_ASSERT(it != s_fileStreamers.end(), return);
    QTC_ASSERT(QThread::currentThread() == it->second->thread(), return);
    s_fileStreamers.erase(it);
    s_waitCondition.wakeAll();
}

static void deleteStreamer(FileStreamHandle handle)
{
    QMutexLocker locker(&s_mutex);
    auto it = s_fileStreamers.find(handle);
    if (it == s_fileStreamers.end())
        return;
    if (QThread::currentThread() == it->second->thread()) {
        delete it->second;
        s_fileStreamers.erase(it);
        s_waitCondition.wakeAll();
    } else {
        QMetaObject::invokeMethod(it->second, [handle] {
            deleteStreamer(handle);
        });
        s_waitCondition.wait(&s_mutex);
        QTC_CHECK(s_fileStreamers.find(handle) == s_fileStreamers.end());
    }
}

static void deleteAllStreamers()
{
    QMutexLocker locker(&s_mutex);
    QTC_ASSERT(Utils::isMainThread(), return);
    while (s_fileStreamers.size()) {
        auto it = s_fileStreamers.begin();
        if (QThread::currentThread() == it->second->thread()) {
            delete it->second;
            s_fileStreamers.erase(it);
            s_waitCondition.wakeAll();
        } else {
            const FileStreamHandle handle = it->first;
            QMetaObject::invokeMethod(it->second, [handle] {
                deleteStreamer(handle);
            });
            s_waitCondition.wait(&s_mutex);
            QTC_CHECK(s_fileStreamers.find(handle) == s_fileStreamers.end());
        }
    }
}

static FileStreamHandle checkHandle(FileStreamHandle handle)
{
    QMutexLocker locker(&s_mutex);
    return s_fileStreamers.find(handle) != s_fileStreamers.end() ? handle : FileStreamHandle(0);
}

FileStreamHandle execute(const std::function<void(FileStreamer *)> &onSetup,
                         const std::function<void(FileStreamer *)> &onDone,
                         QObject *context)
{
    FileStreamer *streamer = new FileStreamer;
    onSetup(streamer);
    const FileStreamHandle handle = generateUniqueHandle();
    QTC_CHECK(context == nullptr || context->thread() == QThread::currentThread());
    if (onDone) {
        QObject *finalContext = context ? context : streamer;
        QObject::connect(streamer, &FileStreamer::done, finalContext, [=] { onDone(streamer); });
    }
    QObject::connect(streamer, &FileStreamer::done, streamer, [=] {
        removeStreamer(handle);
        streamer->deleteLater();
    });
    addStreamer(handle, streamer);
    streamer->start();
    return checkHandle(handle); // The handle could have been already removed
}

FileStreamHandle FileStreamerManager::copy(const FilePath &source, const FilePath &destination,
                                           const CopyContinuation &cont)
{
    return copy(source, destination, nullptr, cont);
}

FileStreamHandle FileStreamerManager::copy(const FilePath &source, const FilePath &destination,
                                           QObject *context, const CopyContinuation &cont)
{
    const auto onSetup = [=](FileStreamer *streamer) {
        streamer->setSource(source);
        streamer->setDestination(destination);
    };
    if (!cont)
        return execute(onSetup, {}, context);

    const auto onDone = [=](FileStreamer *streamer) {
        if (streamer->result() == Tasking::DoneResult::Success)
            cont({});
        else
            cont(make_unexpected(Tr::tr("Failed copying file.")));
    };
    return execute(onSetup, onDone, context);
}

FileStreamHandle FileStreamerManager::read(const FilePath &source, const ReadContinuation &cont)
{
    return read(source, nullptr, cont);
}

FileStreamHandle FileStreamerManager::read(const FilePath &source, QObject *context,
                                           const ReadContinuation &cont)
{
    const auto onSetup = [=](FileStreamer *streamer) {
        streamer->setStreamMode(StreamMode::Reader);
        streamer->setSource(source);
    };
    if (!cont)
        return execute(onSetup, {}, context);

    const auto onDone = [=](FileStreamer *streamer) {
        if (streamer->result() == Tasking::DoneResult::Success)
            cont(streamer->readData());
        else
            cont(make_unexpected(Tr::tr("Failed reading file.")));
    };
    return execute(onSetup, onDone, context);
}

FileStreamHandle FileStreamerManager::write(const FilePath &destination, const QByteArray &data,
                                            const WriteContinuation &cont)
{
    return write(destination, data, nullptr, cont);
}

FileStreamHandle FileStreamerManager::write(const FilePath &destination, const QByteArray &data,
                                            QObject *context, const WriteContinuation &cont)
{
    const auto onSetup = [=](FileStreamer *streamer) {
        streamer->setStreamMode(StreamMode::Writer);
        streamer->setDestination(destination);
        streamer->setWriteData(data);
    };
    if (!cont)
        return execute(onSetup, {}, context);

    const auto onDone = [=](FileStreamer *streamer) {
        if (streamer->result() == Tasking::DoneResult::Success)
            cont(0); // TODO: return write count?
        else
            cont(make_unexpected(Tr::tr("Failed writing file.")));
    };
    return execute(onSetup, onDone, context);
}

void FileStreamerManager::stop(FileStreamHandle handle)
{
    deleteStreamer(handle);
}

void FileStreamerManager::stopAll()
{
    deleteAllStreamers();
}

} // namespace Utils