summaryrefslogtreecommitdiff
path: root/vcl/unx/gtk3_kde5/gtk3_kde5_filepicker_ipc.hxx
blob: 90ec4e1d55abf98501094bf6f42fa7ed51ce1810 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#pragma once

#include <cppuhelper/compbase.hxx>

#include <osl/conditn.hxx>
#include <osl/mutex.hxx>
#include <osl/process.h>

#include <rtl/ustrbuf.hxx>

#include "filepicker_ipc_commands.hxx"

#include <functional>
#include <future>
#include <mutex>
#include <thread>
#include <sstream>

OUString getResString(const char* pResId);

class Gtk3KDE5FilePickerIpc
{
protected:
    oslProcess m_process;
    oslFileHandle m_inputWrite;
    oslFileHandle m_outputRead;
    // simple multiplexing: every command gets its own ID that can be used to
    // read the corresponding response
    uint64_t m_msgId = 1;
    std::mutex m_mutex;
    uint64_t m_incomingResponse = 0;
    std::string m_responseBuffer;
    std::stringstream m_responseStream;

public:
    explicit Gtk3KDE5FilePickerIpc();
    ~Gtk3KDE5FilePickerIpc();

    sal_Int16 execute();

    void writeResponseLine(const std::string& line);

    template <typename... Args> uint64_t sendCommand(Commands command, const Args&... args)
    {
        auto id = m_msgId;
        ++m_msgId;
        std::stringstream stream;
        sendIpcArgs(stream, id, command, args...);
        writeResponseLine(stream.str());
        return id;
    }

    std::string readResponseLine();

    // workaround gcc <= 4.8 bug: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=55914
    template <int...> struct seq
    {
    };
    template <int N, int... S> struct gens : gens<N - 1, N - 1, S...>
    {
    };
    template <int... S> struct gens<0, S...>
    {
        typedef seq<S...> type;
    };
    template <typename... Args> struct ArgsReader
    {
        ArgsReader(Args&... args)
            : m_args(args...)
        {
        }

        void operator()(std::istream& stream)
        {
            callFunc(stream, typename gens<sizeof...(Args)>::type());
        }

    private:
        template <int... S> void callFunc(std::istream& stream, seq<S...>)
        {
            readIpcArgs(stream, std::get<S>(m_args)...);
        }

        std::tuple<Args&...> m_args;
    };

    template <typename... Args> void readResponse(uint64_t id, Args&... args)
    {
        // read synchronously from a background thread and run the eventloop until the value becomes available
        // this allows us to keep the GUI responsive and also enables access to the LO clipboard
        ArgsReader<Args...> argsReader(args...);
        await(std::async(std::launch::async, [&]() {
            while (true)
            {
                // only let one thread read at any given time
                std::lock_guard<std::mutex> lock(m_mutex);

                // check if we need to read (and potentially wait) a response ID
                if (m_incomingResponse == 0)
                {
                    m_responseStream.clear();
                    m_responseStream.str(readResponseLine());
                    readIpcArgs(m_responseStream, m_incomingResponse);
                }

                if (m_incomingResponse == id)
                {
                    // the response we are waiting for came in
                    argsReader(m_responseStream);
                    m_incomingResponse = 0;
                    break;
                }
                else
                {
                    // the next response answers some other request, yield
                    std::this_thread::yield();
                }
            }
        }));
    }

private:
    std::function<void()> blockMainWindow();

    static void await(const std::future<void>& future);
};

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */