626172a16b
Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.
Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment block.
The change was generated with the following script:
----------------------------------------
dirs="include/libcamera src test utils"
declare -rA patterns=(
['c']=' \* '
['cpp']=' \* '
['h']=' \* '
['py']='# '
['sh']='# '
)
for ext in ${!patterns[@]} ; do
files=$(for dir in $dirs ; do find $dir -name "*.${ext}" ; done)
pattern=${patterns[${ext}]}
for file in $files ; do
name=$(basename ${file})
sed -i "s/^\(${pattern}\)${name} - /\1/" "$file"
done
done
----------------------------------------
This misses several files that are out of sync with the comment block
header. Those will be addressed separately and manually.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
158 lines
3.3 KiB
C++
158 lines
3.3 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
/*
|
|
* Copyright (C) 2019, Google Inc.
|
|
*
|
|
* cam - Options parsing
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#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_;
|
|
};
|