3c63675560
The OptionValue toKeyValues() and toArray() functions return a copy of the values. This is unnecessary, and can cause use-after-free issues when taking references to the return values. Return references instead to optimize the implementation and avoid issues. The behaviour of the two functions is now undefined in case of an option type mismatch. The current implementation catches this with an assertion. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
160 lines
3.3 KiB
C++
160 lines
3.3 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
/*
|
|
* Copyright (C) 2019, Google Inc.
|
|
*
|
|
* options.h - cam - Options parsing
|
|
*/
|
|
#ifndef __CAM_OPTIONS_H__
|
|
#define __CAM_OPTIONS_H__
|
|
|
|
#include <ctype.h>
|
|
#include <list>
|
|
#include <map>
|
|
#include <tuple>
|
|
#include <vector>
|
|
|
|
class KeyValueParser;
|
|
class OptionValue;
|
|
struct Option;
|
|
|
|
enum OptionArgument {
|
|
ArgumentNone,
|
|
ArgumentRequired,
|
|
ArgumentOptional,
|
|
};
|
|
|
|
enum OptionType {
|
|
OptionNone,
|
|
OptionInteger,
|
|
OptionString,
|
|
OptionKeyValue,
|
|
};
|
|
|
|
template<typename T>
|
|
class OptionsBase
|
|
{
|
|
public:
|
|
OptionsBase() : valid_(false) {}
|
|
|
|
bool empty() const;
|
|
bool valid() const;
|
|
bool isSet(const T &opt) const;
|
|
const OptionValue &operator[](const T &opt) const;
|
|
|
|
void invalidate();
|
|
|
|
private:
|
|
friend class KeyValueParser;
|
|
friend class OptionsParser;
|
|
|
|
bool parseValue(const T &opt, const Option &option, const char *value);
|
|
|
|
std::map<T, OptionValue> values_;
|
|
bool valid_;
|
|
};
|
|
|
|
class KeyValueParser
|
|
{
|
|
public:
|
|
class Options : public OptionsBase<std::string>
|
|
{
|
|
};
|
|
|
|
KeyValueParser();
|
|
virtual ~KeyValueParser();
|
|
|
|
bool addOption(const char *name, OptionType type, const char *help,
|
|
OptionArgument argument = ArgumentNone);
|
|
|
|
virtual Options parse(const char *arguments);
|
|
|
|
private:
|
|
KeyValueParser(const KeyValueParser &) = delete;
|
|
KeyValueParser &operator=(const KeyValueParser &) = delete;
|
|
|
|
friend class OptionsParser;
|
|
unsigned int maxOptionLength() const;
|
|
void usage(int indent);
|
|
|
|
std::map<std::string, Option> optionsMap_;
|
|
};
|
|
|
|
class OptionsParser
|
|
{
|
|
public:
|
|
class Options : public OptionsBase<int>
|
|
{
|
|
};
|
|
|
|
OptionsParser();
|
|
~OptionsParser();
|
|
|
|
bool addOption(int opt, OptionType type, const char *help,
|
|
const char *name = nullptr,
|
|
OptionArgument argument = ArgumentNone,
|
|
const char *argumentName = nullptr, bool array = false,
|
|
int parent = 0);
|
|
bool addOption(int opt, KeyValueParser *parser, const char *help,
|
|
const char *name = nullptr, bool array = false,
|
|
int parent = 0);
|
|
|
|
Options parse(int argc, char *argv[]);
|
|
void usage();
|
|
|
|
private:
|
|
OptionsParser(const OptionsParser &) = delete;
|
|
OptionsParser &operator=(const OptionsParser &) = delete;
|
|
|
|
void usageOptions(const std::list<Option> &options, unsigned int indent);
|
|
|
|
std::tuple<OptionsParser::Options *, const Option *>
|
|
childOption(const Option *parent, Options *options);
|
|
bool parseValue(const Option &option, const char *arg, Options *options);
|
|
|
|
std::list<Option> options_;
|
|
std::map<unsigned int, Option *> optionsMap_;
|
|
};
|
|
|
|
class OptionValue
|
|
{
|
|
public:
|
|
enum ValueType {
|
|
ValueNone,
|
|
ValueInteger,
|
|
ValueString,
|
|
ValueKeyValue,
|
|
ValueArray,
|
|
};
|
|
|
|
OptionValue();
|
|
OptionValue(int value);
|
|
OptionValue(const char *value);
|
|
OptionValue(const std::string &value);
|
|
OptionValue(const KeyValueParser::Options &value);
|
|
|
|
void addValue(const OptionValue &value);
|
|
|
|
ValueType type() const { return type_; }
|
|
bool empty() const { return type_ == ValueType::ValueNone; }
|
|
|
|
operator int() const;
|
|
operator std::string() const;
|
|
|
|
int toInteger() const;
|
|
std::string toString() const;
|
|
const KeyValueParser::Options &toKeyValues() const;
|
|
const std::vector<OptionValue> &toArray() const;
|
|
|
|
const OptionsParser::Options &children() const;
|
|
|
|
private:
|
|
ValueType type_;
|
|
int integer_;
|
|
std::string string_;
|
|
KeyValueParser::Options keyValues_;
|
|
std::vector<OptionValue> array_;
|
|
OptionsParser::Options children_;
|
|
};
|
|
|
|
#endif /* __CAM_OPTIONS_H__ */
|