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
|
/****************************************************************************
**
** Copyright (C) 2016 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 <coreplugin/editormanager/iexternaleditor.h>
#include <QStringList>
#include <QMap>
#include <functional>
QT_BEGIN_NAMESPACE
class QTcpSocket;
QT_END_NAMESPACE
namespace QtSupport { class BaseQtVersion; }
namespace QmakeProjectManager {
namespace Internal {
/* Convenience parametrizable base class for Qt editors/binaries
* Provides convenience functions that
* try to retrieve the binary of the editor from the Qt version
* of the project the file belongs to, falling back to path search
* if none is found. On Mac, the "open" mechanism can be optionally be used. */
class ExternalQtEditor : public Core::IExternalEditor
{
Q_OBJECT
public:
// Member function pointer for a QtVersion function return a string (command)
using CommandForQtVersion = std::function<QString(const QtSupport::BaseQtVersion *)>;
static ExternalQtEditor *createLinguistEditor();
static ExternalQtEditor *createDesignerEditor();
QStringList mimeTypes() const override;
Utils::Id id() const override;
QString displayName() const override;
bool startEditor(const QString &fileName, QString *errorMessage) override;
// Data required to launch the editor
struct LaunchData {
QString binary;
QStringList arguments;
QString workingDirectory;
};
protected:
ExternalQtEditor(Utils::Id id,
const QString &displayName,
const QString &mimetype,
const CommandForQtVersion &commandForQtVersion);
// Try to retrieve the binary of the editor from the Qt version,
// prepare arguments accordingly (Mac "open" if desired)
bool getEditorLaunchData(const QString &fileName,
LaunchData *data,
QString *errorMessage) const;
// Create and start a detached GUI process executing in the background.
// Set the project environment if there is one.
bool startEditorProcess(const LaunchData &data, QString *errorMessage);
private:
const QStringList m_mimeTypes;
const Utils::Id m_id;
const QString m_displayName;
const CommandForQtVersion m_commandForQtVersion;
};
/* Qt Designer on the remaining platforms: Uses Designer's own
* Tcp-based communication mechanism to ensure all files are opened
* in one instance (per version). */
class DesignerExternalEditor : public ExternalQtEditor
{
Q_OBJECT
public:
DesignerExternalEditor();
bool startEditor(const QString &fileName, QString *errorMessage) override;
private:
void processTerminated(const QString &binary);
// A per-binary entry containing the socket
using ProcessCache = QMap<QString, QTcpSocket*>;
ProcessCache m_processCache;
};
} // namespace Internal
} // namespace QmakeProjectManager
|
