aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/haskell/ghcmod.h
blob: 978b58e988ead9254202c9a34b4b830a8639f52d (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
/****************************************************************************
**
** Copyright (C) 2017 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 "filecache.h"

#include <utils/fileutils.h>
#include <utils/optional.h>
#include <utils/synchronousprocess.h>
#include <utils/variant.h>

#include <QFuture>
#include <QMutex>
#include <QThread>

#include <memory>

QT_BEGIN_NAMESPACE
class QProcess;
QT_END_NAMESPACE

namespace Haskell {
namespace Internal {

class Error {
public:
    enum class Type {
        FailedToStartStack,
        Other // TODO get rid of it
    };
    Type type;
    QString details;
};

class SymbolInfo {
public:
    QStringList definition;
    QStringList additionalInfo;
    Utils::FileName file;
    int line = -1;
    int col = -1;
    QString module;
};

using QByteArrayOrError = Utils::variant<QByteArray, Error>;
using QStringOrError = Utils::variant<QString, Error>;
using SymbolInfoOrError = Utils::variant<SymbolInfo, Error>;

template <typename T> class ghcmod_deleter;
template <> class ghcmod_deleter<QProcess>
{
public:
    void operator()(QProcess *p) { Utils::SynchronousProcess::stopProcess(*p); delete p; }
};
using unique_ghcmod_process = std::unique_ptr<QProcess, ghcmod_deleter<QProcess>>;

class GhcMod
{
public:
    GhcMod(const Utils::FileName &path);
    ~GhcMod();

    Utils::FileName basePath() const;
    void setFileMap(const QHash<Utils::FileName, Utils::FileName> &fileMap);

    SymbolInfoOrError findSymbol(const Utils::FileName &filePath, const QString &symbol);
    QStringOrError typeInfo(const Utils::FileName &filePath, int line, int col);

    QByteArrayOrError runQuery(const QString &query);

    QByteArrayOrError runFindSymbol(const Utils::FileName &filePath, const QString &symbol);
    QByteArrayOrError runTypeInfo(const Utils::FileName &filePath, int line, int col);

    static SymbolInfoOrError parseFindSymbol(const QByteArrayOrError &response);
    static QStringOrError parseTypeInfo(const QByteArrayOrError &response);

   static void setStackExecutable(const Utils::FileName &filePath);

private:
    Utils::optional<Error> ensureStarted();
    void shutdown();
    void log(const QString &message);

    static Utils::FileName m_stackExecutable;
    static QMutex m_mutex;

    Utils::FileName m_path;
    unique_ghcmod_process m_process; // kills process on reset
    QHash<Utils::FileName, Utils::FileName> m_fileMap;
};

class AsyncGhcMod : public QObject
{
    Q_OBJECT

public:
    struct Operation {
        Operation() = default;
        Operation(const std::function<QByteArrayOrError()> &op);
        mutable QFutureInterface<QByteArrayOrError> fi;
        std::function<QByteArrayOrError()> op;
    };

    AsyncGhcMod(const Utils::FileName &path);
    ~AsyncGhcMod();

    Utils::FileName basePath() const;

    QFuture<SymbolInfoOrError> findSymbol(const Utils::FileName &filePath, const QString &symbol);
    QFuture<QStringOrError> typeInfo(const Utils::FileName &filePath, int line, int col);

private slots:
    void updateCache(); // called through QMetaObject::invokeMethod

private:
    void reduceQueue();

    QThread m_thread;
    QObject m_threadTarget; // used to run methods in m_thread
    GhcMod m_ghcmod; // only use in m_thread
    FileCache m_fileCache; // only update through reduceQueue
    QVector<Operation> m_queue;
    QMutex m_mutex;
};

} // Internal
} // Haskell