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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "shellintegration.h"
#include "terminalsettings.h"
#include <utils/environment.h>
#include <utils/filepath.h>
#include <utils/stringutils.h>
#include <QApplication>
#include <QLoggingCategory>
Q_LOGGING_CATEGORY(integrationLog, "qtc.terminal.shellintegration", QtWarningMsg)
using namespace Utils;
namespace Terminal {
struct FileToCopy
{
FilePath source;
QString destName;
};
// clang-format off
struct
{
struct
{
FilePath rcFile{":/terminal/shellintegrations/shellintegration-bash.sh"};
} bash;
struct
{
QList<FileToCopy> files{
{":/terminal/shellintegrations/shellintegration-env.zsh", ".zshenv"},
{":/terminal/shellintegrations/shellintegration-login.zsh", ".zlogin"},
{":/terminal/shellintegrations/shellintegration-profile.zsh", ".zprofile"},
{":/terminal/shellintegrations/shellintegration-rc.zsh", ".zshrc"}
};
} zsh;
struct
{
FilePath script{":/terminal/shellintegrations/shellintegration.ps1"};
} pwsh;
struct
{
FilePath script{":/terminal/shellintegrations/shellintegration-clink.lua"};
} clink;
struct
{
FilePath script{":/terminal/shellintegrations/shellintegration.fish"};
} fish;
} filesToCopy;
// clang-format on
bool ShellIntegration::canIntegrate(const Utils::CommandLine &cmdLine)
{
if (!cmdLine.executable().isLocal())
return false; // TODO: Allow integration for remote shells
if (cmdLine.executable().baseName() == "zsh")
return true;
if (!cmdLine.arguments().isEmpty() && cmdLine.arguments() != "-l")
return false;
if (cmdLine.executable().baseName() == "bash")
return true;
if (cmdLine.executable().baseName() == "pwsh"
|| cmdLine.executable().baseName() == "powershell") {
return true;
}
if (cmdLine.executable().baseName() == "cmd")
return true;
if (cmdLine.executable().baseName() == "fish")
return true;
return false;
}
static QString unescape(QStringView str)
{
QString result;
result.reserve(str.length());
for (int i = 0; i < str.length(); ++i) {
if (str[i] == '\\' && str.length() > i + 1) {
if (str[i + 1] == '\\') {
// e.g. \\ -> "\"
result.append('\\');
i++;
continue;
} else if (str[i + 1] == 'x' && str.length() > i + 3) {
// e.g.: \x5c -> \ (0x5c is the ASCII code for \)
result.append(QChar(str.sliced(i + 2, 2).toUShort(nullptr, 16)));
i += 3;
continue;
}
}
result.append(str[i]);
}
return result;
}
void ShellIntegration::onOsc(int cmd, std::string_view str, bool initial, bool final)
{
if (initial)
m_oscBuffer.clear();
m_oscBuffer.append(str);
if (!final)
return;
QString d = QString::fromLocal8Bit(m_oscBuffer);
const auto [command, data] = Utils::splitAtFirst(d, ';');
if (cmd == 1337) {
const auto [key, value] = Utils::splitAtFirst(command, '=');
if (key == QStringView(u"CurrentDir"))
emit currentDirChanged(FilePath::fromUserInput(value.toString()).path());
} else if (cmd == 7) {
const QString decoded = QUrl::fromPercentEncoding(d.toUtf8());
emit currentDirChanged(FilePath::fromUserInput(decoded).path());
} else if (cmd == 133) {
qCDebug(integrationLog) << "OSC 133:" << data;
} else if (cmd == 633 && command.length() == 1) {
if (command[0] == 'E') {
const CommandLine cmdLine = CommandLine::fromUserInput(data.toString());
emit commandChanged(cmdLine);
} else if (command[0] == 'D') {
emit commandChanged({});
} else if (command[0] == 'P') {
const auto [key, value] = Utils::splitAtFirst(data, '=');
if (key == QStringView(u"Cwd"))
emit currentDirChanged(unescape(value.toString()));
}
}
}
void ShellIntegration::onBell()
{
if (settings().audibleBell.value())
QApplication::beep();
}
void ShellIntegration::onTitle(const QString &title)
{
emit titleChanged(title);
}
void ShellIntegration::prepareProcess(Utils::Process &process)
{
Environment env = process.environment().hasChanges() ? process.environment()
: Environment::systemEnvironment();
CommandLine cmd = process.commandLine();
if (!canIntegrate(cmd))
return;
env.set("VSCODE_INJECTION", "1");
env.set("TERM_PROGRAM", "vscode");
if (cmd.executable().baseName() == "bash") {
const FilePath rcPath = filesToCopy.bash.rcFile;
const FilePath tmpRc = FilePath::fromUserInput(
m_tempDir.filePath(filesToCopy.bash.rcFile.fileName()));
const Result copyResult = rcPath.copyFile(tmpRc);
QTC_ASSERT_EXPECTED(copyResult, return);
if (cmd.arguments() == "-l")
env.set("VSCODE_SHELL_LOGIN", "1");
cmd = {cmd.executable(), {"--init-file", tmpRc.nativePath()}};
} else if (cmd.executable().baseName() == "zsh") {
for (const FileToCopy &file : filesToCopy.zsh.files) {
const Result copyResult = file.source.copyFile(
FilePath::fromUserInput(m_tempDir.filePath(file.destName)));
QTC_ASSERT_EXPECTED(copyResult, return);
}
const Utils::FilePath originalZdotDir = FilePath::fromUserInput(
env.value_or("ZDOTDIR", QDir::homePath()));
env.set("ZDOTDIR", m_tempDir.path());
env.set("USER_ZDOTDIR", originalZdotDir.nativePath());
} else if (cmd.executable().baseName() == "pwsh"
|| cmd.executable().baseName() == "powershell") {
const FilePath rcPath = filesToCopy.pwsh.script;
const FilePath tmpRc = FilePath::fromUserInput(
m_tempDir.filePath(filesToCopy.pwsh.script.fileName()));
const Result copyResult = rcPath.copyFile(tmpRc);
QTC_ASSERT_EXPECTED(copyResult, return);
cmd.addArgs(QString("-noexit -command try { . '%1' } catch {Write-Host \"Shell "
"integration error:\" $_}")
.arg(tmpRc.nativePath()),
CommandLine::Raw);
} else if (cmd.executable().baseName() == "cmd") {
const FilePath rcPath = filesToCopy.clink.script;
const FilePath tmpRc = FilePath::fromUserInput(
m_tempDir.filePath(filesToCopy.clink.script.fileName()));
const Result copyResult = rcPath.copyFile(tmpRc);
QTC_ASSERT_EXPECTED(copyResult, return);
env.set("CLINK_HISTORY_LABEL", "QtCreator");
env.appendOrSet("CLINK_PATH", tmpRc.parentDir().nativePath());
} else if (cmd.executable().baseName() == "fish") {
FilePath xdgDir = FilePath::fromUserInput(m_tempDir.filePath("fish_xdg_data"));
FilePath subDir = xdgDir.resolvePath(QString("fish/vendor_conf.d"));
QTC_ASSERT(subDir.createDir(), return);
const Result copyResult = filesToCopy.fish.script.copyFile(
subDir.resolvePath(filesToCopy.fish.script.fileName()));
QTC_ASSERT_EXPECTED(copyResult, return);
env.appendOrSet("XDG_DATA_DIRS", xdgDir.toUserOutput());
}
process.setCommand(cmd);
process.setEnvironment(env);
}
void ShellIntegration::onSetClipboard(const QByteArray &text)
{
setClipboardAndSelection(QString::fromLocal8Bit(text));
}
} // namespace Terminal
|
