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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
|
#include "clicommandsyntax.h"
#include "commands/clicommand.h"
#include "commands/clicommandfactory.h"
#include "cli.h"
#include <QDebug>
CliCommandSyntax::CliCommandSyntax()
{
}
CliCommandSyntax::~CliCommandSyntax()
{
for (Argument* arg : arguments)
delete arg;
arguments.clear();
argumentMap.clear();
for (Option* opt : options)
delete opt;
optionMap.clear();
optionsLongNameMap.clear();
optionsShortNameMap.clear();
options.clear();
}
void CliCommandSyntax::addArgument(int id, const QString& name, bool mandatory)
{
addArgumentInternal(id, {name}, mandatory, Argument::REGULAR);
}
void CliCommandSyntax::addStrictArgument(int id, const QStringList& values, bool mandatory)
{
addArgumentInternal(id, values, mandatory, Argument::STRICT);
}
void CliCommandSyntax::addAlternatedArgument(int id, const QStringList& names, bool mandatory)
{
addArgumentInternal(id, names, mandatory, Argument::ALTERNATED);
}
void CliCommandSyntax::addOptionShort(int id, const QString& shortName)
{
addOptionInternal(id, shortName, QString(), QString());
}
void CliCommandSyntax::addOptionLong(int id, const QString& longName)
{
addOptionInternal(id, QString(), longName, QString());
}
void CliCommandSyntax::addOption(int id, const QString& shortName, const QString& longName)
{
addOptionInternal(id, shortName, longName, QString());
}
void CliCommandSyntax::addOptionWithArgShort(int id, const QString& shortName, const QString& argName)
{
addOptionInternal(id, shortName, QString(), argName);
}
void CliCommandSyntax::addOptionWithArgLong(int id, const QString& longName, const QString& argName)
{
addOptionInternal(id, QString(), longName, argName);
}
void CliCommandSyntax::addOptionWithArg(int id, const QString& shortName, const QString& longName, const QString& argName)
{
addOptionInternal(id, shortName, longName, argName);
}
CliCommandSyntax::Argument* CliCommandSyntax::addArgumentInternal(int id, const QStringList& names, bool mandatory, Argument::Type type)
{
checkNewArgument(mandatory);
Argument* arg = new Argument;
arg->mandatory = mandatory;
arg->id = id;
arg->type = type;
arg->names = names;
arguments << arg;
argumentMap[id] = arg;
return arg;
}
CliCommandSyntax::Option* CliCommandSyntax::addOptionInternal(int id, const QString& shortName, const QString& longName, const QString& argName)
{
Option* opt = new Option;
opt->shortName = shortName;
opt->longName = longName;
opt->id = id;
opt->argName = argName;
optionMap[id] = opt;
options << opt;
optionsShortNameMap[shortName] = opt;
optionsLongNameMap[longName] = opt;
return opt;
}
bool CliCommandSyntax::getStrictArgumentCount() const
{
return strictArgumentCount;
}
void CliCommandSyntax::setStrictArgumentCount(bool value)
{
strictArgumentCount = value;
}
bool CliCommandSyntax::parse(const QStringList& args)
{
pastOptions = (options.size() == 0);
lastParsedOption = nullptr;
QString arg;
bool res = false;
int argCnt = args.size();
for (int argIdx = 0; argIdx < argCnt; argIdx++)
{
arg = args[argIdx];
if (arg == "--help")
{
CliCommand* help = CliCommandFactory::getCommand("help");
help->setup(CLI::getInstance());
help->parseArgs({getName()});
help->execute();
return false;
}
else if (pastOptions)
{
res = parseArg(arg);
}
else if (arg == "--")
{
pastOptions = true;
res = true;
}
else if (arg.startsWith("-"))
{
res = parseOpt(arg, args, argIdx);
}
else
{
pastOptions = true;
res = parseArg(arg);
}
if (!res)
return false;
}
if (strictArgumentCount && argPosition < requiredArguments())
{
parsingErrorText = QObject::tr("Insufficient number of arguments.");
return false;
}
return true;
}
QString CliCommandSyntax::getErrorText() const
{
return parsingErrorText;
}
QStringList CliCommandSyntax::getStrictArgumentCandidates()
{
QStringList results;
if (!pastOptions)
{
if (lastParsedOption && !lastParsedOption->argName.isEmpty())
return results; // this case is covered by getRegularArgumentCandidates()
for (Option* opt : options)
{
if (opt->requested)
continue;
if (!opt->shortName.isEmpty())
results << "-"+opt->shortName;
if (!opt->longName.isEmpty())
results << "--"+opt->longName;
}
results << "--";
}
if (argPosition < arguments.size() && arguments[argPosition]->type == Argument::STRICT)
results += arguments[argPosition]->names;
return results;
}
QList<int> CliCommandSyntax::getRegularArgumentCandidates()
{
QList<int> results;
if (!pastOptions && lastParsedOption && !lastParsedOption->argName.isEmpty())
{
// We're exactly at the spot where the option argument is expected
results << lastParsedOption->id;
return results;
}
if (argPosition < arguments.size())
{
switch (arguments[argPosition]->type)
{
case Argument::REGULAR:
case Argument::ALTERNATED:
results << arguments[argPosition]->id;
break;
case Argument::STRICT:
break;
}
}
return results;
}
void CliCommandSyntax::addAlias(const QString& alias)
{
aliases << alias;
}
QStringList CliCommandSyntax::getAliases() const
{
return aliases;
}
QString CliCommandSyntax::getSyntaxDefinition() const
{
return getSyntaxDefinition(name);
}
QString CliCommandSyntax::getSyntaxDefinition(const QString& usedName) const
{
static const QString mandatoryArgTempl = "<%1>";
static const QString optionalArgTempl = "[<%1>]";
static const QString mandatoryStrictTempl = "%1";
static const QString optionalStrictTempl = "[%1]";
static const QString optionTempl = "[%1]";
static const QString optionWithArgTempl = "[%1 <%2>]";
QStringList words;
words << usedName;
QString optName;
QStringList optNameParts;
for (Option* opt : options)
{
optNameParts.clear();;
if (!opt->shortName.isEmpty())
optNameParts << "-"+opt->shortName;
if (!opt->longName.isEmpty())
optNameParts += "--"+opt->longName;
optName = optNameParts.join("|");
words << (opt->argName.isEmpty() ? optionTempl.arg(optName) : optionWithArgTempl.arg(optName).arg(opt->argName));
}
QString templ;
QString argName;
for (Argument* arg : arguments)
{
templ = (arg->mandatory ? mandatoryArgTempl : optionalArgTempl);
switch (arg->type)
{
case CliCommandSyntax::Argument::ALTERNATED:
argName = arg->names.join("|");
break;
case CliCommandSyntax::Argument::REGULAR:
argName = arg->names.first();
break;
case CliCommandSyntax::Argument::STRICT:
argName = arg->names.join("|");
templ = (arg->mandatory ? mandatoryStrictTempl : optionalStrictTempl);
break;
}
words << templ.arg(argName);
}
return words.join(" ");
}
bool CliCommandSyntax::isArgumentSet(int id) const
{
if (!argumentMap.contains(id))
return false;
return argumentMap[id]->defined;
}
QString CliCommandSyntax::getArgument(int id) const
{
if (!argumentMap.contains(id))
return QString();
return argumentMap[id]->value;
}
bool CliCommandSyntax::isOptionSet(int id) const
{
if (!optionMap.contains(id))
return false;
return optionMap[id]->requested;
}
QString CliCommandSyntax::getOptionValue(int id) const
{
if (!optionMap.contains(id))
return QString();
return optionMap[id]->value;
}
bool CliCommandSyntax::parseArg(const QString& arg)
{
if (strictArgumentCount && arguments.size() < (argPosition + 1))
{
parsingErrorText = QObject::tr("Too many arguments.");
return false;
}
switch (arguments[argPosition]->type)
{
case CliCommandSyntax::Argument::ALTERNATED:
{
arguments[argPosition]->value = arg;
arguments[argPosition]->defined = true;
break;
}
case CliCommandSyntax::Argument::REGULAR:
{
arguments[argPosition]->value = arg;
arguments[argPosition]->defined = true;
break;
}
case CliCommandSyntax::Argument::STRICT:
{
if (!arguments[argPosition]->names.contains(arg))
{
parsingErrorText = QObject::tr("Invalid argument value: %1.\nExpected one of: %2").arg(arg)
.arg(arguments[argPosition]->names.join(", "));
return false;
}
arguments[argPosition]->value = arg;
arguments[argPosition]->defined = true;
break;
}
default:
qCritical() << "Invalid argument type in CliCommandSyntax:" << arguments[argPosition]->type;
return false;
}
argPosition++;
return true;
}
bool CliCommandSyntax::parseOpt(const QString& arg, const QStringList& args, int& argIdx)
{
Option* opt = nullptr;
if (arg.startsWith("--"))
{
QString longName = arg.mid(2);
if (optionsLongNameMap.contains(longName))
opt = optionsLongNameMap.value(longName);
}
else
{
QString shortName = arg.mid(1);
if (optionsShortNameMap.contains(shortName))
opt = optionsShortNameMap.value(shortName);
}
if (!opt)
{
parsingErrorText = QObject::tr("Unknown option: %1", "CLI command syntax").arg(arg);
return false;
}
opt->requested = true;
lastParsedOption = opt;
if (!opt->argName.isEmpty())
{
if (args.size() <= (argIdx + 1))
{
parsingErrorText = QObject::tr("Option %1 requires an argument.", "CLI command syntax").arg(arg);
return false;
}
argIdx++;
opt->value = args[argIdx];
}
return true;
}
int CliCommandSyntax::requiredArguments() const
{
int cnt = 0;
for (Argument* arg : arguments)
{
if (arg->mandatory)
cnt++;
}
return cnt;
}
void CliCommandSyntax::checkNewArgument(bool mandatory)
{
if (arguments.size() > 0 && !arguments.last()->mandatory && mandatory)
{
qWarning() << "Adding mandatory CLI command argument after optional argument. This will result in invalid syntax definition. The command is:"
<< this->name;
}
}
QString CliCommandSyntax::getName() const
{
return name;
}
void CliCommandSyntax::setName(const QString& value)
{
name = value;
}
|