feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

QtcProcess: Introduce a QtcProcess::Arguments class

Browse Source 
This is used to get a platform-agnostic handle on "command line
arguments". It essentially wraps a single QString on Windows,
and a QStringList everywhere else.

As a consequence, several occurrences of #ifdef Q_OS_*
can be removed from the codebase.

Change-Id: Ic93118c1bd0bce0ebb58f416d395dbaebb861772
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
This commit is contained in:
hjk
2014-02-05 10:43:21 +01:00
committed by Eike Ziller
parent a0d29eeb03
commit c68ebeed2e
14 changed files with 1257 additions and 1196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/libs/utils/consoleprocess_unix.cpp
View File

@@ -75,7 +75,8 @@ bool ConsoleProcess::start(const QString &program, const QString &args)
return false; return false;
QtcProcess::SplitError perr; QtcProcess::SplitError perr;
QStringList pargs = QtcProcess::prepareArgs(args, &perr, &d->m_environment, &d->m_workingDir); QtcProcess::Arguments pargs = QtcProcess::prepareArgs(args, &perr, HostOsInfo::hostOs(),
&d->m_environment, &d->m_workingDir);
QString pcmd; QString pcmd;
if (perr == QtcProcess::SplitOk) { if (perr == QtcProcess::SplitOk) {
pcmd = program; pcmd = program;
@@ -91,12 +92,15 @@ bool ConsoleProcess::start(const QString &program, const QString &args)
return false; return false;
} }
pcmd = QLatin1String("/bin/sh"); pcmd = QLatin1String("/bin/sh");
pargs << QLatin1String("-c") << (QtcProcess::quoteArg(program) + QLatin1Char(' ') + args); pargs = QtcProcess::Arguments::createUnixArgs(QStringList()
<< QLatin1String("-c")
<< (QtcProcess::quoteArg(program) + QLatin1Char(' ') + args));
} }
QtcProcess::SplitError qerr; QtcProcess::SplitError qerr;
QStringList xtermArgs = QtcProcess::prepareArgs(terminalEmulator(d->m_settings), &qerr, QtcProcess::Arguments xtermArgs = QtcProcess::prepareArgs(terminalEmulator(d->m_settings), &qerr,
&d->m_environment, &d->m_workingDir); HostOsInfo::hostOs(),
&d->m_environment, &d->m_workingDir);
if (qerr != QtcProcess::SplitOk) { if (qerr != QtcProcess::SplitOk) {
emit processError(qerr == QtcProcess::BadQuoting emit processError(qerr == QtcProcess::BadQuoting
? tr("Quoting error in terminal command.") ? tr("Quoting error in terminal command.")
@@ -134,23 +138,23 @@ bool ConsoleProcess::start(const QString &program, const QString &args)
} }
} }
if (Utils::HostOsInfo::isMacHost()) { QString stubPath = QCoreApplication::applicationDirPath();
xtermArgs << (QCoreApplication::applicationDirPath() if (Utils::HostOsInfo::isMacHost())
+ QLatin1String("/../Resources/qtcreator_process_stub")); stubPath.append(QLatin1String("/../Resources/qtcreator_process_stub"));
} else { else
xtermArgs << (QCoreApplication::applicationDirPath() stubPath.append(QLatin1String("/qtcreator_process_stub"));
+ QLatin1String("/qtcreator_process_stub"));
} QStringList allArgs = xtermArgs.toUnixArgs();
xtermArgs allArgs << stubPath
<< modeOption(d->m_mode) << modeOption(d->m_mode)
<< d->m_stubServer.fullServerName() << d->m_stubServer.fullServerName()
<< msgPromptToClose() << msgPromptToClose()
<< workingDirectory() << workingDirectory()
<< (d->m_tempFile ? d->m_tempFile->fileName() : QString()) << (d->m_tempFile ? d->m_tempFile->fileName() : QString())
<< pcmd << pargs; << pcmd << pargs.toUnixArgs();
QString xterm = xtermArgs.takeFirst(); QString xterm = allArgs.takeFirst();
d->m_process.start(xterm, xtermArgs); d->m_process.start(xterm, allArgs);
if (!d->m_process.waitForStarted()) { if (!d->m_process.waitForStarted()) {
stubServerShutdown(); stubServerShutdown();
emit processError(tr("Cannot start the terminal emulator '%1', change the setting in the " emit processError(tr("Cannot start the terminal emulator '%1', change the setting in the "

5
src/libs/utils/consoleprocess_win.cpp
View File

@@ -75,7 +75,10 @@ bool ConsoleProcess::start(const QString &program, const QString &args)
pcmd = program; pcmd = program;
pargs = args; pargs = args;
} else { } else {
QtcProcess::prepareCommand(program, args, &pcmd, &pargs, &d->m_environment, &d->m_workingDir); QtcProcess::Arguments outArgs;
QtcProcess::prepareCommand(program, args, &pcmd, &outArgs, OsTypeWindows,
&d->m_environment, &d->m_workingDir);
pargs = outArgs.toWindowsArgs();
} }
const QString err = stubServerListen(); const QString err = stubServerListen();

1369
src/libs/utils/qtcprocess.cpp
View File

File diff suppressed because it is too large Load Diff

63
src/libs/utils/qtcprocess.h
View File

@@ -56,6 +56,22 @@ public:
void terminate(); void terminate();
void interrupt(); void interrupt();
class QTCREATOR_UTILS_EXPORT Arguments
{
public:
static Arguments createWindowsArgs(const QString &args);
static Arguments createUnixArgs(const QStringList &args);
QString toWindowsArgs() const;
QStringList toUnixArgs() const;
QString toString() const;
private:
QString m_windowsArgs;
QStringList m_unixArgs;
bool m_isWindows;
};
enum SplitError { enum SplitError {
SplitOk = 0, //! All went just fine SplitOk = 0, //! All went just fine
BadQuoting, //! Command contains quoting errors BadQuoting, //! Command contains quoting errors
@@ -64,45 +80,33 @@ public:
//! Quote a single argument for usage in a unix shell command //! Quote a single argument for usage in a unix shell command
static QString quoteArgUnix(const QString &arg); static QString quoteArgUnix(const QString &arg);
//! Quote a single argument and append it to a unix shell command
static void addArgUnix(QString *args, const QString &arg);
//! Join an argument list into a unix shell command
static QString joinArgsUnix(const QStringList &args);
#ifdef Q_OS_WIN
//! Quote a single argument for usage in a shell command //! Quote a single argument for usage in a shell command
static QString quoteArg(const QString &arg); static QString quoteArg(const QString &arg, OsType osType = HostOsInfo::hostOs());
//! Quote a single argument and append it to a shell command //! Quote a single argument and append it to a shell command
static void addArg(QString *args, const QString &arg); static void addArg(QString *args, const QString &arg, OsType osType = HostOsInfo::hostOs());
//! Join an argument list into a shell command //! Join an argument list into a shell command
static QString joinArgs(const QStringList &args); static QString joinArgs(const QStringList &args, OsType osType = HostOsInfo::hostOs());
//! Prepare argument of a shell command for feeding into QProcess //! Prepare argument of a shell command for feeding into QProcess
static QString prepareArgs(const QString &cmd, SplitError *err, static Arguments prepareArgs(const QString &cmd, SplitError *err,
const Environment *env = 0, const QString *pwd = 0); OsType osType = HostOsInfo::hostOs(),
const Environment *env = 0, const QString *pwd = 0);
//! Prepare a shell command for feeding into QProcess //! Prepare a shell command for feeding into QProcess
static void prepareCommand(const QString &command, const QString &arguments,
QString *outCmd, QString *outArgs,
const Environment *env = 0, const QString *pwd = 0);
#else
static QString quoteArg(const QString &arg) { return quoteArgUnix(arg); }
static void addArg(QString *args, const QString &arg) { addArgUnix(args, arg); }
static QString joinArgs(const QStringList &args) { return joinArgsUnix(args); }
static QStringList prepareArgs(const QString &cmd, SplitError *err,
const Environment *env = 0, const QString *pwd = 0)
{ return splitArgs(cmd, true, err, env, pwd); }
static bool prepareCommand(const QString &command, const QString &arguments, static bool prepareCommand(const QString &command, const QString &arguments,
QString *outCmd, QStringList *outArgs, QString *outCmd, Arguments *outArgs, OsType osType = HostOsInfo::hostOs(),
const Environment *env = 0, const QString *pwd = 0); const Environment *env = 0, const QString *pwd = 0);
#endif
//! Quote and append each argument to a shell command //! Quote and append each argument to a shell command
static void addArgs(QString *args, const QStringList &inArgs); static void addArgs(QString *args, const QStringList &inArgs);
//! Append already quoted arguments to a shell command //! Append already quoted arguments to a shell command
static void addArgs(QString *args, const QString &inArgs); static void addArgs(QString *args, const QString &inArgs);
//! Split a shell command into separate arguments. ArgIterator is usually a better choice. //! Split a shell command into separate arguments. ArgIterator is usually a better choice.
static QStringList splitArgs(const QString &cmd, bool abortOnMeta = false, SplitError *err = 0, static QStringList splitArgs(const QString &cmd, OsType osType = HostOsInfo::hostOs(),
bool abortOnMeta = false, SplitError *err = 0,
const Environment *env = 0, const QString *pwd = 0); const Environment *env = 0, const QString *pwd = 0);
//! Safely replace the expandos in a shell command //! Safely replace the expandos in a shell command
static bool expandMacros(QString *cmd, AbstractMacroExpander *mx); static bool expandMacros(QString *cmd, AbstractMacroExpander *mx,
static QString expandMacros(const QString &str, AbstractMacroExpander *mx); OsType osType = HostOsInfo::hostOs());
static QString expandMacros(const QString &str, AbstractMacroExpander *mx,
OsType osType = HostOsInfo::hostOs());
/*! Iterate over arguments from a command line. /*! Iterate over arguments from a command line.
* Assumes that the name of the actual command is *not* part of the line. * Assumes that the name of the actual command is *not* part of the line.
@@ -110,7 +114,9 @@ public:
*/ */
class QTCREATOR_UTILS_EXPORT ArgIterator { class QTCREATOR_UTILS_EXPORT ArgIterator {
public: public:
ArgIterator(QString *str) : m_str(str), m_pos(0), m_prev(-1) {} ArgIterator(QString *str, OsType osType = HostOsInfo::hostOs())
: m_str(str), m_pos(0), m_prev(-1), m_osType(osType)
{}
//! Get the next argument. Returns false on encountering end of first command. //! Get the next argument. Returns false on encountering end of first command.
bool next(); bool next();
//! True iff the argument is a plain string, possibly after unquoting. //! True iff the argument is a plain string, possibly after unquoting.
@@ -126,11 +132,14 @@ public:
QString *m_str, m_value; QString *m_str, m_value;
int m_pos, m_prev; int m_pos, m_prev;
bool m_simple; bool m_simple;
OsType m_osType;
}; };
class QTCREATOR_UTILS_EXPORT ConstArgIterator { class QTCREATOR_UTILS_EXPORT ConstArgIterator {
public: public:
ConstArgIterator(const QString &str) : m_str(str), m_ait(&m_str) {} ConstArgIterator(const QString &str, OsType osType = HostOsInfo::hostOs())
: m_str(str), m_ait(&m_str, osType)
{}
bool next() { return m_ait.next(); } bool next() { return m_ait.next(); }
bool isSimple() const { return m_ait.isSimple(); } bool isSimple() const { return m_ait.isSimple(); }
QString value() const { return m_ait.value(); } QString value() const { return m_ait.value(); }

7
src/plugins/coreplugin/fileutils.cpp
View File

@@ -121,13 +121,14 @@ void FileUtils::openTerminal(const QString &path)
// Get terminal application // Get terminal application
QString terminalEmulator; QString terminalEmulator;
QStringList args; QStringList args;
if (HostOsInfo::isWindowsHost()) { const OsType hostOs = HostOsInfo::hostOs();
if (hostOs == OsTypeWindows) {
terminalEmulator = ConsoleProcess::defaultTerminalEmulator(); terminalEmulator = ConsoleProcess::defaultTerminalEmulator();
} else if (HostOsInfo::isMacHost()) { } else if (hostOs == OsTypeMac) {
terminalEmulator = ICore::resourcePath() terminalEmulator = ICore::resourcePath()
+ QLatin1String("/scripts/openTerminal.command"); + QLatin1String("/scripts/openTerminal.command");
} else { } else {
args = QtcProcess::splitArgs(ConsoleProcess::terminalEmulator(ICore::settings())); args = QtcProcess::splitArgs(ConsoleProcess::terminalEmulator(ICore::settings()), hostOs);
terminalEmulator = args.takeFirst(); terminalEmulator = args.takeFirst();
args.append(QString::fromLocal8Bit(qgetenv("SHELL"))); args.append(QString::fromLocal8Bit(qgetenv("SHELL")));
} }

25
src/plugins/debugger/gdb/gdbengine.cpp
View File

@@ -4771,19 +4771,20 @@ void GdbEngine::write(const QByteArray &data)
bool GdbEngine::prepareCommand() bool GdbEngine::prepareCommand()
{ {
#ifdef Q_OS_WIN if (HostOsInfo::isWindowsHost()) {
Utils::QtcProcess::SplitError perr; DebuggerStartParameters &sp = startParameters();
startParameters().processArgs = Utils::QtcProcess::prepareArgs( QtcProcess::SplitError perr;
startParameters().processArgs, &perr, sp.processArgs = QtcProcess::prepareArgs(sp.processArgs, &perr,
&startParameters().environment, &startParameters().workingDirectory); Utils::HostOsInfo::hostOs(),
if (perr != Utils::QtcProcess::SplitOk) { &sp.environment, &sp.workingDirectory).toWindowsArgs();
// perr == BadQuoting is never returned on Windows if (perr != Utils::QtcProcess::SplitOk) {
// FIXME? QTCREATORBUG-2809 // perr == BadQuoting is never returned on Windows
handleAdapterStartFailed(QCoreApplication::translate("DebuggerEngine", // Same message in CdbEngine // FIXME? QTCREATORBUG-2809
"Debugging complex command lines is currently not supported on Windows."), Core::Id()); handleAdapterStartFailed(QCoreApplication::translate("DebuggerEngine", // Same message in CdbEngine
return false; "Debugging complex command lines is currently not supported on Windows."), Core::Id());
return false;
}
} }
#endif
return true; return true;
} }

12
src/plugins/debugger/lldb/lldbengine.cpp
View File

@@ -201,11 +201,7 @@ void LldbEngine::setupInferior()
const DebuggerStartParameters &sp = startParameters(); const DebuggerStartParameters &sp = startParameters();
QString executable; QString executable;
#ifdef Q_OS_WIN Utils::QtcProcess::Arguments args;
QString args;
#else
QStringList args;
#endif
Utils::QtcProcess::prepareCommand(QFileInfo(sp.executable).absoluteFilePath(), Utils::QtcProcess::prepareCommand(QFileInfo(sp.executable).absoluteFilePath(),
sp.processArgs, &executable, &args); sp.processArgs, &executable, &args);
@@ -213,12 +209,8 @@ void LldbEngine::setupInferior()
cmd.arg("executable", executable); cmd.arg("executable", executable);
cmd.arg("startMode", sp.startMode); // directly relying on this is brittle wrt. insertions, so check it here cmd.arg("startMode", sp.startMode); // directly relying on this is brittle wrt. insertions, so check it here
cmd.beginList("processArgs"); cmd.beginList("processArgs");
#ifdef Q_OS_WIN foreach (const QString &arg, args.toUnixArgs())
// fixme?
#else
foreach (const QString &arg, args)
cmd.arg(arg.toUtf8().toHex()); cmd.arg(arg.toUtf8().toHex());
#endif
cmd.endList(); cmd.endList();
// it is better not to check the start mode on the python sid (as we would have to duplicate the // it is better not to check the start mode on the python sid (as we would have to duplicate the

2
src/plugins/git/gitclient.cpp
View File

@@ -2990,7 +2990,7 @@ bool GitClient::tryLauchingGitK(const QProcessEnvironment &env,
VcsBase::VcsBaseOutputWindow *outwin = VcsBase::VcsBaseOutputWindow::instance(); VcsBase::VcsBaseOutputWindow *outwin = VcsBase::VcsBaseOutputWindow::instance();
const QString gitkOpts = settings()->stringValue(GitSettings::gitkOptionsKey); const QString gitkOpts = settings()->stringValue(GitSettings::gitkOptionsKey);
if (!gitkOpts.isEmpty()) if (!gitkOpts.isEmpty())
arguments.append(Utils::QtcProcess::splitArgs(gitkOpts)); arguments.append(Utils::QtcProcess::splitArgs(gitkOpts, Utils::HostOsInfo::hostOs()));
if (!fileName.isEmpty()) if (!fileName.isEmpty())
arguments << QLatin1String("--") << fileName; arguments << QLatin1String("--") << fileName;
outwin->appendCommand(workingDirectory, binary, arguments); outwin->appendCommand(workingDirectory, binary, arguments);

33
src/plugins/ios/iosrunconfiguration.cpp
View File

@@ -51,6 +51,7 @@
using namespace ProjectExplorer; using namespace ProjectExplorer;
using namespace QmakeProjectManager; using namespace QmakeProjectManager;
using namespace Utils;
namespace Ios { namespace Ios {
namespace Internal { namespace Internal {
@@ -341,27 +342,27 @@ QString IosRunConfigurationWidget::argListToString(const QStringList &args) cons
QStringList IosRunConfigurationWidget::stringToArgList(const QString &args) const QStringList IosRunConfigurationWidget::stringToArgList(const QString &args) const
{ {
Utils::QtcProcess::SplitError err; QtcProcess::SplitError err;
QStringList res = Utils::QtcProcess::splitArgs(args, false, &err); QStringList res = QtcProcess::splitArgs(args, OsTypeMac, false, &err);
switch (err) { switch (err) {
case Utils::QtcProcess::SplitOk: case QtcProcess::SplitOk:
break; break;
case Utils::QtcProcess::BadQuoting: case QtcProcess::BadQuoting:
if (args.at(args.size()-1) == QLatin1Char('\\')) { if (args.at(args.size()-1) == QLatin1Char('\\')) {
res = Utils::QtcProcess::splitArgs(args + QLatin1Char('\\'), false, &err); res = QtcProcess::splitArgs(args + QLatin1Char('\\'), OsTypeMac, false, &err);
if (err != Utils::QtcProcess::SplitOk) if (err != QtcProcess::SplitOk)
res = Utils::QtcProcess::splitArgs(args + QLatin1Char('\\') + QLatin1Char('\''), res = QtcProcess::splitArgs(args + QLatin1Char('\\') + QLatin1Char('\''),
false, &err); OsTypeMac, false, &err);
if (err != Utils::QtcProcess::SplitOk) if (err != QtcProcess::SplitOk)
res = Utils::QtcProcess::splitArgs(args + QLatin1Char('\\') + QLatin1Char('\"'), res = QtcProcess::splitArgs(args + QLatin1Char('\\') + QLatin1Char('\"'),
false, &err); OsTypeMac, false, &err);
} }
if (err != Utils::QtcProcess::SplitOk) if (err != QtcProcess::SplitOk)
res = Utils::QtcProcess::splitArgs(args + QLatin1Char('\''), false, &err); res = QtcProcess::splitArgs(args + QLatin1Char('\''), OsTypeMac, false, &err);
if (err != Utils::QtcProcess::SplitOk) if (err != QtcProcess::SplitOk)
res = Utils::QtcProcess::splitArgs(args + QLatin1Char('\"'), false, &err); res = QtcProcess::splitArgs(args + QLatin1Char('\"'), OsTypeMac, false, &err);
break; break;
case Utils::QtcProcess::FoundMeta: case QtcProcess::FoundMeta:
qDebug() << "IosRunConfigurationWidget FoundMeta (should not happen)"; qDebug() << "IosRunConfigurationWidget FoundMeta (should not happen)";
break; break;
} }

9
src/plugins/projectexplorer/gcctoolchain.cpp
View File

@@ -928,13 +928,14 @@ void GccToolChainConfigWidget::makeReadOnlyImpl()
QStringList GccToolChainConfigWidget::splitString(const QString &s) QStringList GccToolChainConfigWidget::splitString(const QString &s)
{ {
QtcProcess::SplitError splitError; QtcProcess::SplitError splitError;
QStringList res = QtcProcess::splitArgs(s, false, &splitError); const OsType osType = HostOsInfo::hostOs();
QStringList res = QtcProcess::splitArgs(s, osType, false, &splitError);
if (splitError != QtcProcess::SplitOk){ if (splitError != QtcProcess::SplitOk){
res = QtcProcess::splitArgs(s + QLatin1Char('\\'), false, &splitError); res = QtcProcess::splitArgs(s + QLatin1Char('\\'), osType, false, &splitError);
if (splitError != QtcProcess::SplitOk){ if (splitError != QtcProcess::SplitOk){
res = QtcProcess::splitArgs(s + QLatin1Char('"'), false, &splitError); res = QtcProcess::splitArgs(s + QLatin1Char('"'), osType, false, &splitError);
if (splitError != QtcProcess::SplitOk) if (splitError != QtcProcess::SplitOk)
res = QtcProcess::splitArgs(s + QLatin1Char('\''), false, &splitError); res = QtcProcess::splitArgs(s + QLatin1Char('\''), osType, false, &splitError);
} }
} }
return res; return res;

14
src/plugins/projectexplorer/processparameters.cpp
View File

@@ -169,20 +169,12 @@ QString ProcessParameters::prettyArguments() const
{ {
QString margs = effectiveArguments(); QString margs = effectiveArguments();
QString workDir = effectiveWorkingDirectory(); QString workDir = effectiveWorkingDirectory();
#ifdef Q_OS_WIN
QString args;
#else
QStringList args;
#endif
Utils::QtcProcess::SplitError err; Utils::QtcProcess::SplitError err;
args = Utils::QtcProcess::prepareArgs(margs, &err, &m_environment, &workDir); Utils::QtcProcess::Arguments args =
Utils::QtcProcess::prepareArgs(margs, &err, Utils::HostOsInfo::hostOs(), &m_environment, &workDir);
if (err != Utils::QtcProcess::SplitOk) if (err != Utils::QtcProcess::SplitOk)
return margs; // Sorry, too complex - just fall back. return margs; // Sorry, too complex - just fall back.
#ifdef Q_OS_WIN return args.toString();
return args;
#else
return Utils::QtcProcess::joinArgs(args);
#endif
} }
QString ProcessParameters::summary(const QString &displayName) const QString ProcessParameters::summary(const QString &displayName) const

2
src/plugins/remotelinux/linuxdeviceprocess.cpp
View File

@@ -69,7 +69,7 @@ QString LinuxDeviceProcess::fullCommandLine() const
fullCommandLine.append(quote(executable())); fullCommandLine.append(quote(executable()));
if (!arguments().isEmpty()) { if (!arguments().isEmpty()) {
fullCommandLine.append(QLatin1Char(' ')); fullCommandLine.append(QLatin1Char(' '));
fullCommandLine.append(Utils::QtcProcess::joinArgsUnix(arguments())); fullCommandLine.append(Utils::QtcProcess::joinArgs(arguments(), Utils::OsTypeLinux));
} }
return fullCommandLine; return fullCommandLine;
} }

2
src/plugins/remotelinux/remotelinuxrunconfiguration.cpp
View File

@@ -207,7 +207,7 @@ QString RemoteLinuxRunConfiguration::remoteExecutableFilePath() const
void RemoteLinuxRunConfiguration::setArguments(const QString &args) void RemoteLinuxRunConfiguration::setArguments(const QString &args)
{ {
d->arguments = QtcProcess::splitArgs(args); // TODO: Widget should be list-based. d->arguments = QtcProcess::splitArgs(args, OsTypeLinux); // TODO: Widget should be list-based.
} }
QString RemoteLinuxRunConfiguration::workingDirectory() const QString RemoteLinuxRunConfiguration::workingDirectory() const

876
tests/auto/qtcprocess/tst_qtcprocess.cpp
View File

File diff suppressed because it is too large Load Diff