sneedmc/logic/Commandline.cpp

483 lines
11 KiB
C++
Raw Normal View History

2015-02-02 22:25:30 +00:00
/* Copyright 2013-2015 MultiMC Contributors
2013-02-19 23:07:52 +00:00
*
* Authors: Orochimarufan <orochimarufan.x3@gmail.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
2015-10-04 23:47:27 +00:00
#include "Commandline.h"
2013-02-19 23:07:52 +00:00
/**
* @file libutil/src/cmdutils.cpp
2013-02-19 23:07:52 +00:00
*/
namespace Commandline
{
2013-02-19 23:07:52 +00:00
// commandline splitter
QStringList splitArgs(QString args)
{
QStringList argv;
QString current;
bool escape = false;
QChar inquotes;
for (int i = 0; i < args.length(); i++)
{
QChar cchar = args.at(i);
// \ escaped
if (escape)
{
current += cchar;
escape = false;
// in "quotes"
}
else if (!inquotes.isNull())
{
if (cchar == 0x5C)
escape = true;
else if (cchar == inquotes)
inquotes = 0;
else
current += cchar;
// otherwise
}
else
{
if (cchar == 0x20)
{
if (!current.isEmpty())
{
argv << current;
current.clear();
}
}
else if (cchar == 0x22 || cchar == 0x27)
inquotes = cchar;
else
current += cchar;
}
}
if (!current.isEmpty())
argv << current;
return argv;
}
2013-02-25 20:44:36 +00:00
Parser::Parser(FlagStyle::Enum flagStyle, ArgumentStyle::Enum argStyle)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
m_flagStyle = flagStyle;
m_argStyle = argStyle;
2013-02-19 23:07:52 +00:00
}
// styles setter/getter
2013-02-25 20:44:36 +00:00
void Parser::setArgumentStyle(ArgumentStyle::Enum style)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
m_argStyle = style;
2013-02-19 23:07:52 +00:00
}
2013-02-25 20:44:36 +00:00
ArgumentStyle::Enum Parser::argumentStyle()
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
return m_argStyle;
2013-02-19 23:07:52 +00:00
}
2013-02-25 20:44:36 +00:00
void Parser::setFlagStyle(FlagStyle::Enum style)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
m_flagStyle = style;
2013-02-19 23:07:52 +00:00
}
2013-02-25 20:44:36 +00:00
FlagStyle::Enum Parser::flagStyle()
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
return m_flagStyle;
2013-02-19 23:07:52 +00:00
}
// setup methods
void Parser::addSwitch(QString name, bool def)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
if (m_params.contains(name))
throw "Name not unique";
2013-02-25 20:44:36 +00:00
OptionDef *param = new OptionDef;
param->type = otSwitch;
2013-02-25 20:44:36 +00:00
param->name = name;
param->metavar = QString("<%1>").arg(name);
param->def = def;
2013-02-25 20:44:36 +00:00
m_options[name] = param;
m_params[name] = (CommonDef *)param;
m_optionList.append(param);
2013-02-19 23:07:52 +00:00
}
void Parser::addOption(QString name, QVariant def)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
if (m_params.contains(name))
throw "Name not unique";
2013-02-25 20:44:36 +00:00
OptionDef *param = new OptionDef;
param->type = otOption;
2013-02-25 20:44:36 +00:00
param->name = name;
param->metavar = QString("<%1>").arg(name);
param->def = def;
2013-02-25 20:44:36 +00:00
m_options[name] = param;
m_params[name] = (CommonDef *)param;
m_optionList.append(param);
2013-02-19 23:07:52 +00:00
}
void Parser::addArgument(QString name, bool required, QVariant def)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
if (m_params.contains(name))
throw "Name not unique";
2013-02-25 20:44:36 +00:00
PositionalDef *param = new PositionalDef;
param->name = name;
param->def = def;
param->required = required;
param->metavar = name;
2013-02-25 20:44:36 +00:00
m_positionals.append(param);
m_params[name] = (CommonDef *)param;
2013-02-19 23:07:52 +00:00
}
void Parser::addDocumentation(QString name, QString doc, QString metavar)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
if (!m_params.contains(name))
throw "Name does not exist";
2013-02-25 20:44:36 +00:00
CommonDef *param = m_params[name];
param->doc = doc;
if (!metavar.isNull())
param->metavar = metavar;
2013-02-19 23:07:52 +00:00
}
void Parser::addShortOpt(QString name, QChar flag)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
if (!m_params.contains(name))
throw "Name does not exist";
if (!m_options.contains(name))
throw "Name is not an Option or Swtich";
2013-02-25 20:44:36 +00:00
OptionDef *param = m_options[name];
m_flags[flag] = param;
param->flag = flag;
2013-02-19 23:07:52 +00:00
}
// help methods
QString Parser::compileHelp(QString progName, int helpIndent, bool useFlags)
{
2013-02-25 20:44:36 +00:00
QStringList help;
help << compileUsage(progName, useFlags) << "\r\n";
2013-02-25 20:44:36 +00:00
// positionals
if (!m_positionals.isEmpty())
{
help << "\r\n";
help << "Positional arguments:\r\n";
QListIterator<PositionalDef *> it2(m_positionals);
while (it2.hasNext())
2013-02-25 20:44:36 +00:00
{
PositionalDef *param = it2.next();
help << " " << param->metavar;
help << " " << QString(helpIndent - param->metavar.length() - 1, ' ');
help << param->doc << "\r\n";
}
}
2013-02-25 20:44:36 +00:00
// Options
if (!m_optionList.isEmpty())
{
help << "\r\n";
QString optPrefix, flagPrefix;
getPrefix(optPrefix, flagPrefix);
2013-02-25 20:44:36 +00:00
help << "Options & Switches:\r\n";
QListIterator<OptionDef *> it(m_optionList);
while (it.hasNext())
2013-02-25 20:44:36 +00:00
{
OptionDef *option = it.next();
help << " ";
int nameLength = optPrefix.length() + option->name.length();
if (!option->flag.isNull())
{
nameLength += 3 + flagPrefix.length();
help << flagPrefix << option->flag << ", ";
}
help << optPrefix << option->name;
if (option->type == otOption)
2013-02-25 20:44:36 +00:00
{
QString arg = QString("%1%2").arg(
((m_argStyle == ArgumentStyle::Equals) ? "=" : " "), option->metavar);
2013-02-25 20:44:36 +00:00
nameLength += arg.length();
help << arg;
}
help << " " << QString(helpIndent - nameLength - 1, ' ');
help << option->doc << "\r\n";
}
}
2013-02-25 20:44:36 +00:00
return help.join("");
2013-02-19 23:07:52 +00:00
}
QString Parser::compileUsage(QString progName, bool useFlags)
{
2013-02-25 20:44:36 +00:00
QStringList usage;
usage << "Usage: " << progName;
2013-02-25 20:44:36 +00:00
QString optPrefix, flagPrefix;
getPrefix(optPrefix, flagPrefix);
2013-02-25 20:44:36 +00:00
// options
QListIterator<OptionDef *> it(m_optionList);
while (it.hasNext())
2013-02-25 20:44:36 +00:00
{
OptionDef *option = it.next();
usage << " [";
if (!option->flag.isNull() && useFlags)
usage << flagPrefix << option->flag;
else
usage << optPrefix << option->name;
if (option->type == otOption)
usage << ((m_argStyle == ArgumentStyle::Equals) ? "=" : " ") << option->metavar;
2013-02-25 20:44:36 +00:00
usage << "]";
}
2013-02-25 20:44:36 +00:00
// arguments
QListIterator<PositionalDef *> it2(m_positionals);
while (it2.hasNext())
2013-02-25 20:44:36 +00:00
{
PositionalDef *param = it2.next();
usage << " " << (param->required ? "<" : "[");
usage << param->metavar;
usage << (param->required ? ">" : "]");
}
2013-02-25 20:44:36 +00:00
return usage.join("");
2013-02-19 23:07:52 +00:00
}
// parsing
QHash<QString, QVariant> Parser::parse(QStringList argv)
2013-02-19 23:07:52 +00:00
{
2013-02-25 20:44:36 +00:00
QHash<QString, QVariant> map;
2013-02-25 20:44:36 +00:00
QStringListIterator it(argv);
QString programName = it.next();
2013-02-25 20:44:36 +00:00
QString optionPrefix;
QString flagPrefix;
QListIterator<PositionalDef *> positionals(m_positionals);
QStringList expecting;
2013-02-25 20:44:36 +00:00
getPrefix(optionPrefix, flagPrefix);
2013-02-25 20:44:36 +00:00
while (it.hasNext())
{
QString arg = it.next();
2013-02-25 20:44:36 +00:00
if (!expecting.isEmpty())
// we were expecting an argument
2013-02-25 20:44:36 +00:00
{
QString name = expecting.first();
/*
2013-02-25 20:44:36 +00:00
if (map.contains(name))
throw ParsingError(
QString("Option %2%1 was given multiple times").arg(name, optionPrefix));
*/
2013-02-25 20:44:36 +00:00
map[name] = QVariant(arg);
2013-02-25 20:44:36 +00:00
expecting.removeFirst();
continue;
}
2013-02-25 20:44:36 +00:00
if (arg.startsWith(optionPrefix))
// we have an option
2013-02-25 20:44:36 +00:00
{
// qDebug("Found option %s", qPrintable(arg));
2013-02-25 20:44:36 +00:00
QString name = arg.mid(optionPrefix.length());
QString equals;
if ((m_argStyle == ArgumentStyle::Equals ||
m_argStyle == ArgumentStyle::SpaceAndEquals) &&
name.contains("="))
2013-02-25 20:44:36 +00:00
{
int i = name.indexOf("=");
equals = name.mid(i + 1);
2013-02-25 20:44:36 +00:00
name = name.left(i);
}
2013-02-25 20:44:36 +00:00
if (m_options.contains(name))
{
/*
2013-02-25 20:44:36 +00:00
if (map.contains(name))
throw ParsingError(QString("Option %2%1 was given multiple times")
.arg(name, optionPrefix));
*/
2013-02-25 20:44:36 +00:00
OptionDef *option = m_options[name];
if (option->type == otSwitch)
2013-02-25 20:44:36 +00:00
map[name] = true;
else // if (option->type == otOption)
2013-02-25 20:44:36 +00:00
{
if (m_argStyle == ArgumentStyle::Space)
expecting.append(name);
else if (!equals.isNull())
map[name] = equals;
else if (m_argStyle == ArgumentStyle::SpaceAndEquals)
expecting.append(name);
else
throw ParsingError(QString("Option %2%1 reqires an argument.")
.arg(name, optionPrefix));
2013-02-25 20:44:36 +00:00
}
2013-02-25 20:44:36 +00:00
continue;
}
2013-02-25 20:44:36 +00:00
throw ParsingError(QString("Unknown Option %2%1").arg(name, optionPrefix));
}
2013-02-25 20:44:36 +00:00
if (arg.startsWith(flagPrefix))
// we have (a) flag(s)
2013-02-25 20:44:36 +00:00
{
// qDebug("Found flags %s", qPrintable(arg));
2013-02-25 20:44:36 +00:00
QString flags = arg.mid(flagPrefix.length());
QString equals;
if ((m_argStyle == ArgumentStyle::Equals ||
m_argStyle == ArgumentStyle::SpaceAndEquals) &&
flags.contains("="))
2013-02-25 20:44:36 +00:00
{
int i = flags.indexOf("=");
equals = flags.mid(i + 1);
2013-02-25 20:44:36 +00:00
flags = flags.left(i);
}
2013-02-25 20:44:36 +00:00
for (int i = 0; i < flags.length(); i++)
{
QChar flag = flags.at(i);
2013-02-25 20:44:36 +00:00
if (!m_flags.contains(flag))
throw ParsingError(QString("Unknown flag %2%1").arg(flag, flagPrefix));
2013-02-25 20:44:36 +00:00
OptionDef *option = m_flags[flag];
/*
2013-02-25 20:44:36 +00:00
if (map.contains(option->name))
throw ParsingError(QString("Option %2%1 was given multiple times")
.arg(option->name, optionPrefix));
*/
if (option->type == otSwitch)
2013-02-25 20:44:36 +00:00
map[option->name] = true;
else // if (option->type == otOption)
2013-02-25 20:44:36 +00:00
{
if (m_argStyle == ArgumentStyle::Space)
expecting.append(option->name);
else if (!equals.isNull())
if (i == flags.length() - 1)
2013-02-25 20:44:36 +00:00
map[option->name] = equals;
else
throw ParsingError(QString("Flag %4%2 of Argument-requiring Option "
"%1 not last flag in %4%3")
.arg(option->name, flag, flags, flagPrefix));
2013-02-25 20:44:36 +00:00
else if (m_argStyle == ArgumentStyle::SpaceAndEquals)
expecting.append(option->name);
else
throw ParsingError(QString("Option %1 reqires an argument. (flag %3%2)")
.arg(option->name, flag, flagPrefix));
2013-02-25 20:44:36 +00:00
}
}
2013-02-25 20:44:36 +00:00
continue;
}
2013-02-25 20:44:36 +00:00
// must be a positional argument
if (!positionals.hasNext())
throw ParsingError(QString("Don't know what to do with '%1'").arg(arg));
2013-02-25 20:44:36 +00:00
PositionalDef *param = positionals.next();
2013-02-25 20:44:36 +00:00
map[param->name] = arg;
}
2013-02-25 20:44:36 +00:00
// check if we're missing something
if (!expecting.isEmpty())
throw ParsingError(QString("Was still expecting arguments for %2%1").arg(
expecting.join(QString(", ") + optionPrefix), optionPrefix));
2013-02-25 20:44:36 +00:00
while (positionals.hasNext())
{
PositionalDef *param = positionals.next();
if (param->required)
throw ParsingError(
QString("Missing required positional argument '%1'").arg(param->name));
2013-02-25 20:44:36 +00:00
else
map[param->name] = param->def;
}
2013-02-25 20:44:36 +00:00
// fill out gaps
QListIterator<OptionDef *> iter(m_optionList);
while (iter.hasNext())
{
OptionDef *option = iter.next();
if (!map.contains(option->name))
map[option->name] = option->def;
}
2013-02-25 20:44:36 +00:00
return map;
2013-02-19 23:07:52 +00:00
}
// clear defs
2013-02-19 23:07:52 +00:00
void Parser::clear()
{
2013-02-25 20:44:36 +00:00
m_flags.clear();
m_params.clear();
m_options.clear();
2013-02-25 20:44:36 +00:00
QMutableListIterator<OptionDef *> it(m_optionList);
while (it.hasNext())
2013-02-25 20:44:36 +00:00
{
OptionDef *option = it.next();
it.remove();
delete option;
}
2013-02-25 20:44:36 +00:00
QMutableListIterator<PositionalDef *> it2(m_positionals);
while (it2.hasNext())
2013-02-25 20:44:36 +00:00
{
PositionalDef *arg = it2.next();
it2.remove();
delete arg;
}
2013-02-19 23:07:52 +00:00
}
// Destructor
2013-02-19 23:07:52 +00:00
Parser::~Parser()
{
2013-02-25 20:44:36 +00:00
clear();
2013-02-19 23:07:52 +00:00
}
// getPrefix
2013-02-19 23:07:52 +00:00
void Parser::getPrefix(QString &opt, QString &flag)
{
2013-02-25 20:44:36 +00:00
if (m_flagStyle == FlagStyle::Windows)
opt = flag = "/";
else if (m_flagStyle == FlagStyle::Unix)
opt = flag = "-";
// else if (m_flagStyle == FlagStyle::GNU)
else
{
2013-02-25 20:44:36 +00:00
opt = "--";
flag = "-";
}
2013-02-19 23:07:52 +00:00
}
// ParsingError
ParsingError::ParsingError(const QString &what) : std::runtime_error(what.toStdString())
2013-02-19 23:07:52 +00:00
{
}
2015-10-04 23:47:27 +00:00
}