1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/js/src/shell/jsoptparse.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,294 @@
1.4 +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
1.5 + * vim: set ts=8 sts=4 et sw=4 tw=99:
1.6 + * This Source Code Form is subject to the terms of the Mozilla Public
1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.9 +
1.10 +#ifndef shell_jsoptparse_h
1.11 +#define shell_jsoptparse_h
1.12 +
1.13 +#include <stdio.h>
1.14 +
1.15 +#include "jsalloc.h"
1.16 +#include "jsutil.h"
1.17 +
1.18 +#include "js/Vector.h"
1.19 +
1.20 +namespace js {
1.21 +namespace cli {
1.22 +
1.23 +namespace detail {
1.24 +
1.25 +struct BoolOption;
1.26 +struct MultiStringOption;
1.27 +struct ValuedOption;
1.28 +struct StringOption;
1.29 +struct IntOption;
1.30 +
1.31 +enum OptionKind
1.32 +{
1.33 + OptionKindBool,
1.34 + OptionKindString,
1.35 + OptionKindInt,
1.36 + OptionKindMultiString,
1.37 + OptionKindInvalid
1.38 +};
1.39 +
1.40 +struct Option
1.41 +{
1.42 + const char *longflag;
1.43 + const char *help;
1.44 + OptionKind kind;
1.45 + char shortflag;
1.46 + bool terminatesOptions;
1.47 +
1.48 + Option(OptionKind kind, char shortflag, const char *longflag, const char *help)
1.49 + : longflag(longflag), help(help), kind(kind), shortflag(shortflag), terminatesOptions(false)
1.50 + {}
1.51 +
1.52 + virtual ~Option() = 0;
1.53 +
1.54 + void setTerminatesOptions(bool enabled) { terminatesOptions = enabled; }
1.55 + bool getTerminatesOptions() const { return terminatesOptions; }
1.56 +
1.57 + virtual bool isValued() const { return false; }
1.58 +
1.59 + /* Only some valued options are variadic (like MultiStringOptions). */
1.60 + virtual bool isVariadic() const { return false; }
1.61 +
1.62 + /*
1.63 + * For arguments, the shortflag field is used to indicate whether the
1.64 + * argument is optional.
1.65 + */
1.66 + bool isOptional() { return shortflag; }
1.67 +
1.68 + void setFlagInfo(char shortflag, const char *longflag, const char *help) {
1.69 + this->shortflag = shortflag;
1.70 + this->longflag = longflag;
1.71 + this->help = help;
1.72 + }
1.73 +
1.74 + ValuedOption *asValued();
1.75 + const ValuedOption *asValued() const;
1.76 +
1.77 +#define OPTION_CONVERT_DECL(__cls) \
1.78 + bool is##__cls##Option() const; \
1.79 + __cls##Option *as##__cls##Option(); \
1.80 + const __cls##Option *as##__cls##Option() const;
1.81 +
1.82 + OPTION_CONVERT_DECL(Bool)
1.83 + OPTION_CONVERT_DECL(String)
1.84 + OPTION_CONVERT_DECL(Int)
1.85 + OPTION_CONVERT_DECL(MultiString)
1.86 +};
1.87 +
1.88 +inline Option::~Option() {}
1.89 +
1.90 +struct BoolOption : public Option
1.91 +{
1.92 + size_t argno;
1.93 + bool value;
1.94 +
1.95 + BoolOption(char shortflag, const char *longflag, const char *help)
1.96 + : Option(OptionKindBool, shortflag, longflag, help), value(false)
1.97 + {}
1.98 +
1.99 + virtual ~BoolOption() {}
1.100 +};
1.101 +
1.102 +struct ValuedOption : public Option
1.103 +{
1.104 + const char *metavar;
1.105 +
1.106 + ValuedOption(OptionKind kind, char shortflag, const char *longflag, const char *help,
1.107 + const char *metavar)
1.108 + : Option(kind, shortflag, longflag, help), metavar(metavar)
1.109 + {}
1.110 +
1.111 + virtual ~ValuedOption() = 0;
1.112 + virtual bool isValued() const { return true; }
1.113 +};
1.114 +
1.115 +inline ValuedOption::~ValuedOption() {}
1.116 +
1.117 +struct StringOption : public ValuedOption
1.118 +{
1.119 + const char *value;
1.120 +
1.121 + StringOption(char shortflag, const char *longflag, const char *help, const char *metavar)
1.122 + : ValuedOption(OptionKindString, shortflag, longflag, help, metavar), value(nullptr)
1.123 + {}
1.124 +
1.125 + virtual ~StringOption() {}
1.126 +};
1.127 +
1.128 +struct IntOption : public ValuedOption
1.129 +{
1.130 + int value;
1.131 +
1.132 + IntOption(char shortflag, const char *longflag, const char *help, const char *metavar,
1.133 + int defaultValue)
1.134 + : ValuedOption(OptionKindInt, shortflag, longflag, help, metavar), value(defaultValue)
1.135 + {}
1.136 +
1.137 + virtual ~IntOption() {}
1.138 +};
1.139 +
1.140 +struct StringArg
1.141 +{
1.142 + char *value;
1.143 + size_t argno;
1.144 +
1.145 + StringArg(char *value, size_t argno) : value(value), argno(argno) {}
1.146 +};
1.147 +
1.148 +struct MultiStringOption : public ValuedOption
1.149 +{
1.150 + Vector<StringArg, 0, SystemAllocPolicy> strings;
1.151 +
1.152 + MultiStringOption(char shortflag, const char *longflag, const char *help, const char *metavar)
1.153 + : ValuedOption(OptionKindMultiString, shortflag, longflag, help, metavar)
1.154 + {}
1.155 +
1.156 + virtual ~MultiStringOption() {}
1.157 +
1.158 + virtual bool isVariadic() const { return true; }
1.159 +};
1.160 +
1.161 +} /* namespace detail */
1.162 +
1.163 +class MultiStringRange
1.164 +{
1.165 + typedef detail::StringArg StringArg;
1.166 + const StringArg *cur;
1.167 + const StringArg *end;
1.168 +
1.169 + public:
1.170 + explicit MultiStringRange(const StringArg *cur, const StringArg *end)
1.171 + : cur(cur), end(end) {
1.172 + JS_ASSERT(end - cur >= 0);
1.173 + }
1.174 +
1.175 + bool empty() const { return cur == end; }
1.176 + void popFront() { JS_ASSERT(!empty()); ++cur; }
1.177 + char *front() const { JS_ASSERT(!empty()); return cur->value; }
1.178 + size_t argno() const { JS_ASSERT(!empty()); return cur->argno; }
1.179 +};
1.180 +
1.181 +/*
1.182 + * Builder for describing a command line interface and parsing the resulting
1.183 + * specification.
1.184 + *
1.185 + * - A multi-option is an option that can appear multiple times and still
1.186 + * parse as valid command line arguments.
1.187 + * - An "optional argument" is supported for backwards compatibility with prior
1.188 + * command line interface usage. Once one optional argument has been added,
1.189 + * *only* optional arguments may be added.
1.190 + */
1.191 +class OptionParser
1.192 +{
1.193 + public:
1.194 + enum Result
1.195 + {
1.196 + Okay = 0,
1.197 + Fail, /* As in, allocation fail. */
1.198 + ParseError, /* Successfully parsed but with an error. */
1.199 + ParseHelp /* Aborted on help flag. */
1.200 + };
1.201 +
1.202 + private:
1.203 + typedef Vector<detail::Option *, 0, SystemAllocPolicy> Options;
1.204 + typedef detail::Option Option;
1.205 + typedef detail::BoolOption BoolOption;
1.206 +
1.207 + Options options;
1.208 + Options arguments;
1.209 + BoolOption helpOption;
1.210 + const char *usage;
1.211 + const char *ver;
1.212 + const char *descr;
1.213 + size_t descrWidth;
1.214 + size_t helpWidth;
1.215 + size_t nextArgument;
1.216 +
1.217 + // If '--' is passed, all remaining arguments should be interpreted as the
1.218 + // argument at index 'restArgument'. Defaults to the next unassigned
1.219 + // argument.
1.220 + int restArgument;
1.221 +
1.222 + static const char prognameMeta[];
1.223 +
1.224 + Option *findOption(char shortflag);
1.225 + const Option *findOption(char shortflag) const;
1.226 + Option *findOption(const char *longflag);
1.227 + const Option *findOption(const char *longflag) const;
1.228 + int findArgumentIndex(const char *name) const;
1.229 + Option *findArgument(const char *name);
1.230 + const Option *findArgument(const char *name) const;
1.231 +
1.232 + Result error(const char *fmt, ...);
1.233 + Result extractValue(size_t argc, char **argv, size_t *i, char **value);
1.234 + Result handleArg(size_t argc, char **argv, size_t *i, bool *optsAllowed);
1.235 + Result handleOption(Option *opt, size_t argc, char **argv, size_t *i, bool *optsAllowed);
1.236 +
1.237 + public:
1.238 + explicit OptionParser(const char *usage)
1.239 + : helpOption('h', "help", "Display help information"),
1.240 + usage(usage), ver(nullptr), descr(nullptr), descrWidth(80), helpWidth(80),
1.241 + nextArgument(0), restArgument(-1)
1.242 + {}
1.243 +
1.244 + ~OptionParser();
1.245 +
1.246 + Result parseArgs(int argc, char **argv);
1.247 + Result printHelp(const char *progname);
1.248 +
1.249 + /* Metadata */
1.250 +
1.251 + void setVersion(const char *version) { ver = version; }
1.252 + void setHelpWidth(size_t width) { helpWidth = width; }
1.253 + void setDescriptionWidth(size_t width) { descrWidth = width; }
1.254 + void setDescription(const char *description) { descr = description; }
1.255 + void setHelpOption(char shortflag, const char *longflag, const char *help);
1.256 + void setArgTerminatesOptions(const char *name, bool enabled);
1.257 + void setArgCapturesRest(const char *name);
1.258 +
1.259 + /* Arguments: no further arguments may be added after a variadic argument. */
1.260 +
1.261 + bool addOptionalStringArg(const char *name, const char *help);
1.262 + bool addOptionalMultiStringArg(const char *name, const char *help);
1.263 +
1.264 + const char *getStringArg(const char *name) const;
1.265 + MultiStringRange getMultiStringArg(const char *name) const;
1.266 +
1.267 + /* Options */
1.268 +
1.269 + bool addBoolOption(char shortflag, const char *longflag, const char *help);
1.270 + bool addStringOption(char shortflag, const char *longflag, const char *help,
1.271 + const char *metavar);
1.272 + bool addIntOption(char shortflag, const char *longflag, const char *help,
1.273 + const char *metavar, int defaultValue);
1.274 + bool addMultiStringOption(char shortflag, const char *longflag, const char *help,
1.275 + const char *metavar);
1.276 + bool addOptionalVariadicArg(const char *name);
1.277 +
1.278 + int getIntOption(char shortflag) const;
1.279 + int getIntOption(const char *longflag) const;
1.280 + const char *getStringOption(char shortflag) const;
1.281 + const char *getStringOption(const char *longflag) const;
1.282 + bool getBoolOption(char shortflag) const;
1.283 + bool getBoolOption(const char *longflag) const;
1.284 + MultiStringRange getMultiStringOption(char shortflag) const;
1.285 + MultiStringRange getMultiStringOption(const char *longflag) const;
1.286 +
1.287 + /*
1.288 + * Return whether the help option was present (and thus help was already
1.289 + * displayed during parse_args).
1.290 + */
1.291 + bool getHelpOption() const;
1.292 +};
1.293 +
1.294 +} /* namespace cli */
1.295 +} /* namespace js */
1.296 +
1.297 +#endif /* shell_jsoptparse_h */
