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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef EXTERNALEDITORS_H
#define EXTERNALEDITORS_H
#include <coreplugin/editormanager/iexternaleditor.h>
#include <coreplugin/id.h>
#include <QStringList>
#include <QMap>
QT_BEGIN_NAMESPACE
class QProcess;
class QTcpSocket;
class QSignalMapper;
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:
virtual QStringList mimeTypes() const;
virtual Core::Id id() const;
virtual QString displayName() const;
protected:
// Member function pointer for a QtVersion function return a string (command)
typedef QString (QtSupport::BaseQtVersion::*QtVersionCommandAccessor)() const;
// Data required to launch the editor
struct EditorLaunchData {
QString binary;
QStringList arguments;
QString workingDirectory;
};
explicit ExternalQtEditor(Core::Id id,
const QString &displayName,
const QString &mimetype,
QObject *parent = 0);
// Try to retrieve the binary of the editor from the Qt version,
// prepare arguments accordingly (Mac "open" if desired)
bool getEditorLaunchData(const QString &fileName,
QtVersionCommandAccessor commandAccessor,
const QString &fallbackBinary,
const QStringList &additionalArguments,
bool useMacOpenCommand,
EditorLaunchData *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 EditorLaunchData &data, QString *errorMessage);
private:
const QStringList m_mimeTypes;
const Core::Id m_id;
const QString m_displayName;
};
// Qt Linguist
class LinguistExternalEditor : public ExternalQtEditor
{
Q_OBJECT
public:
explicit LinguistExternalEditor(QObject *parent = 0);
virtual bool startEditor(const QString &fileName, QString *errorMessage);
};
// Qt Designer on Mac: Make use of the Mac's 'open' mechanism to
// ensure files are opened in the same (per version) instance.
class MacDesignerExternalEditor : public ExternalQtEditor
{
Q_OBJECT
public:
explicit MacDesignerExternalEditor(QObject *parent = 0);
virtual bool startEditor(const QString &fileName, QString *errorMessage);
};
/* 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:
explicit DesignerExternalEditor(QObject *parent = 0);
virtual bool startEditor(const QString &fileName, QString *errorMessage);
private slots:
void processTerminated(const QString &binary);
private:
// A per-binary entry containing the socket
typedef QMap<QString, QTcpSocket*> ProcessCache;
ProcessCache m_processCache;
QSignalMapper *m_terminationMapper;
};
} // namespace Internal
} // namespace QmakeProjectManager
#endif // EXTERNALEDITORS_H
|
