{"id":426,"url":"https://patchwork.libcamera.org/api/patches/426/?format=json","web_url":"https://patchwork.libcamera.org/patch/426/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20190128004109.25860-6-niklas.soderlund@ragnatech.se>","date":"2019-01-28T00:41:08","name":"[libcamera-devel,5/6] cam: options: add a key=value parser","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"75c973de8cdc5a3d2fda7b162a8db1f632baed33","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/?format=json","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/426/mbox/","series":[{"id":149,"url":"https://patchwork.libcamera.org/api/series/149/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=149","date":"2019-01-28T00:41:03","name":"cam: add --format option to configure a stream","version":1,"mbox":"https://patchwork.libcamera.org/series/149/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/426/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/426/checks/","tags":{},"headers":{"Return-Path":"","Received":["from bin-mail-out-05.binero.net (bin-mail-out-05.binero.net\n\t[195.74.38.228])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 0065760DC1\n\tfor ;\n\tMon, 28 Jan 2019 01:41:34 +0100 (CET)","from bismarck.berto.se (unknown [89.233.230.99])\n\tby bin-vsp-out-03.atm.binero.net (Halon) with ESMTPA\n\tid 6853ec7a-2295-11e9-911a-0050569116f7;\n\tMon, 28 Jan 2019 01:41:10 +0100 (CET)"],"X-Halon-ID":"6853ec7a-2295-11e9-911a-0050569116f7","Authorized-sender":"niklas@soderlund.pp.se","From":"=?utf-8?q?Niklas_S=C3=B6derlund?= ","To":"libcamera-devel@lists.libcamera.org","Date":"Mon, 28 Jan 2019 01:41:08 +0100","Message-Id":"<20190128004109.25860-6-niklas.soderlund@ragnatech.se>","X-Mailer":"git-send-email 2.20.1","In-Reply-To":"<20190128004109.25860-1-niklas.soderlund@ragnatech.se>","References":"<20190128004109.25860-1-niklas.soderlund@ragnatech.se>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 5/6] cam: options: add a key=value parser","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Mon, 28 Jan 2019 00:41:35 -0000"},"content":"Some options passed to the cam utility needs to be complex and specify a\nlist of key=value pairs, add a new parser to deal white these options.\nThe new parser is integrated into the existing OptionsParser and the cam\napplication can fully describe all its options in one location and\nperform full parsing of all arguments in one go. The new key=value\nparsers also integrates itself with the usage() printing of the\nOptionsParser.\n\nThe new parser can also be used on it's own to parse key=value pairs\nfrom different data sources then the command line options.\n\nSigned-off-by: Niklas Söderlund \n---\n src/cam/options.cpp | 159 +++++++++++++++++++++++++++++++++++++++++++-\n src/cam/options.h | 35 ++++++++++\n 2 files changed, 193 insertions(+), 1 deletion(-)","diff":"diff --git a/src/cam/options.cpp b/src/cam/options.cpp\nindex d3bff1cd897a5cfb..f63fd3b495e29986 100644\n--- a/src/cam/options.cpp\n+++ b/src/cam/options.cpp\n@@ -30,11 +30,22 @@ bool OptionsParser::addOption(int opt, const char *help, const char *name,\n \tif (optionsMap_.find(opt) != optionsMap_.end())\n \t\treturn false;\n \n-\toptionsMap_[opt] = Option({ opt, name, argument, argumentName, help });\n+\toptionsMap_[opt] = Option({ opt, name, argument, argumentName, help,\n+\t\t\t\t nullptr });\n \n \treturn true;\n }\n \n+void OptionsParser::addOption(int opt, const char *help, KeyValueParser &parser,\n+\t\t\t const char *name)\n+{\n+\tif (!addOption(opt, help, name, ArgumentRequired,\n+\t\t \"key=value[,key=value,...]\"))\n+\t\treturn;\n+\n+\toptionsMap_[opt].keyValueParser = &parser;\n+}\n+\n OptionsParser::Options OptionsParser::parse(int argc, char **argv)\n {\n \tOptionsParser::Options options;\n@@ -103,6 +114,16 @@ OptionsParser::Options OptionsParser::parse(int argc, char **argv)\n \t\t}\n \n \t\toptions.values_[c] = optarg ? optarg : \"\";\n+\n+\t\t/* Parse argument as key=values if needed. */\n+\t\tif (optionsMap_[c].keyValueParser) {\n+\t\t\toptions.keyValues_[c] = optionsMap_[c].keyValueParser->parse(options.values_[c].c_str());\n+\t\t\tif (!options.keyValues_[c].valid()) {\n+\t\t\t\tusage();\n+\t\t\t\toptions.clear();\n+\t\t\t\tbreak;\n+\t\t\t}\n+\t\t}\n \t}\n \n \treturn options;\n@@ -169,5 +190,141 @@ void OptionsParser::usage()\n \t\t\t\tstd::cerr << help << std::endl;\n \t\t\t}\n \t\t}\n+\n+\t\tif (option.keyValueParser)\n+\t\t\toption.keyValueParser->usage(indent);\n+\t}\n+}\n+\n+bool OptionsParser::Options::isKeyValue(int opt)\n+{\n+\treturn keyValues_.find(opt) != keyValues_.end();\n+}\n+\n+KeyValueParser::Options OptionsParser::Options::keyValues(int opt)\n+{\n+\treturn keyValues_.find(opt)->second;\n+}\n+\n+void KeyValueParser::addOption(const char *name,\n+\t\t\t const char *help,\n+\t\t\t OptionArgument argument,\n+\t\t\t const char *argumentName)\n+{\n+\tif (!name)\n+\t\treturn;\n+\tif (!help || help[0] == '\\0')\n+\t\treturn;\n+\tif (argument != ArgumentNone && !argumentName)\n+\t\treturn;\n+\n+\t/* Reject duplicate options. */\n+\tif (optionsMap_.find(name) != optionsMap_.end())\n+\t\treturn;\n+\n+\toptionsMap_[name] = Option({ name, help, argument, argumentName });\n+}\n+\n+KeyValueParser::Options KeyValueParser::parse(const char *arguments)\n+{\n+\tOptions options;\n+\n+\tfor (const char *pair = arguments; *arguments != '\\0'; pair = arguments) {\n+\t\tconst char *comma = strchrnul(arguments, ',');\n+\t\tsize_t len = comma - pair;\n+\n+\t\t/* Skip over the comma. */\n+\t\targuments = *comma == ',' ? comma + 1 : comma;\n+\n+\t\t/* Skip to the next pair if the pair is empty. */\n+\t\tif (!len)\n+\t\t\tcontinue;\n+\n+\t\tstd::string key;\n+\t\tstd::string value;\n+\n+\t\tconst char *separator = static_cast(memchr(pair, '=', len));\n+\t\tif (!separator) {\n+\t\t\tkey = std::string(pair, len);\n+\t\t\tvalue = \"\";\n+\t\t} else {\n+\t\t\tkey = std::string(pair, separator - pair);\n+\t\t\tvalue = std::string(separator + 1, comma - separator - 1);\n+\t\t}\n+\n+\t\t/* The key is mandatory, the value might be optional. */\n+\t\tif (key.empty())\n+\t\t\tcontinue;\n+\n+\t\tif (optionsMap_.find(key) == optionsMap_.end()) {\n+\t\t\tstd::cerr << \"Invalid option \" << key << std::endl;\n+\t\t\toptions.clear();\n+\t\t\tbreak;\n+\t\t}\n+\n+\t\tif (value == \"\" && optionsMap_[key].argument == ArgumentRequired) {\n+\t\t\tstd::cerr << \"Missing argument for option \" << key << std::endl;\n+\t\t\toptions.clear();\n+\t\t\tbreak;\n+\t\t}\n+\n+\t\tif (value != \"\" && optionsMap_[key].argument == ArgumentNone) {\n+\t\t\tstd::cerr << \"Argument specified for option \" << key << std::endl;\n+\t\t\toptions.clear();\n+\t\t\tbreak;\n+\t\t}\n+\n+\t\toptions.values_[key] = value;\n+\t}\n+\n+\treturn options;\n+}\n+\n+void KeyValueParser::usage(int indent)\n+{\n+\tunsigned int space = 0;\n+\n+\tfor (auto const &iter : optionsMap_) {\n+\t\tconst Option &option = iter.second;\n+\t\tunsigned int length = 14;\n+\t\tif (option.argument != ArgumentNone)\n+\t\t\tlength += 1 + strlen(option.argumentName);\n+\t\tif (option.argument == ArgumentOptional)\n+\t\t\tlength += 2;\n+\n+\t\tif (length > space)\n+\t\t\tspace = length;\n+\t}\n+\n+\tspace = (space + 7) / 8 * 8;\n+\n+\tfor (auto const &iter : optionsMap_) {\n+\t\tconst Option &option = iter.second;\n+\n+\t\tstd::string argument = option.name;\n+\n+\t\tif (option.argument != ArgumentNone) {\n+\t\t\tif (option.argument == ArgumentOptional)\n+\t\t\t\targument += \"[=\";\n+\t\t\telse\n+\t\t\t\targument += \"=\";\n+\t\t\targument += option.argumentName;\n+\t\t\tif (option.argument == ArgumentOptional)\n+\t\t\t\targument += \"]\";\n+\t\t}\n+\n+\t\tstd::cerr << std::setw(indent) << std::right << \" \"\n+\t\t\t << std::setw(space) << std::left << argument;\n+\n+\t\tfor (const char *help = option.help, *end = help; end;) {\n+\t\t\tend = strchr(help, '\\n');\n+\t\t\tif (end) {\n+\t\t\t\tstd::cerr << std::string(help, end - help + 1);\n+\t\t\t\tstd::cerr << std::setw(indent + space) << \" \";\n+\t\t\t\thelp = end + 1;\n+\t\t\t} else {\n+\t\t\t\tstd::cerr << help << std::endl;\n+\t\t\t}\n+\t\t}\n \t}\n }\ndiff --git a/src/cam/options.h b/src/cam/options.h\nindex cb7286a0a8005579..91a78406a601d737 100644\n--- a/src/cam/options.h\n+++ b/src/cam/options.h\n@@ -27,20 +27,54 @@ public:\n \n private:\n \tfriend class OptionsParser;\n+\tfriend class KeyValueParser;\n \tstd::map values_;\n \tvoid clear() { values_.clear(); };\n };\n \n+class KeyValueParser\n+{\n+public:\n+\tclass Options : public OptionsBase\n+\t{\n+\t};\n+\n+\tvoid addOption(const char *name, const char *help,\n+\t\t OptionArgument argument = ArgumentNone,\n+\t\t const char *argumentName = nullptr);\n+\n+\tOptions parse(const char *arguments);\n+\tvoid usage(int indent);\n+\n+private:\n+\tstruct Option {\n+\t\tconst char *name;\n+\t\tconst char *help;\n+\t\tOptionArgument argument;\n+\t\tconst char *argumentName;\n+\t};\n+\n+\tstd::map optionsMap_;\n+};\n+\n class OptionsParser\n {\n public:\n \tclass Options : public OptionsBase\n \t{\n+\tpublic:\n+\t\tbool isKeyValue(int opt);\n+\t\tKeyValueParser::Options keyValues(int opt);\n+\tprivate:\n+\t\tfriend class OptionsParser;\n+\t\tstd::map keyValues_;\n \t};\n \n \tbool addOption(int opt, const char *help, const char *name = nullptr,\n \t\t OptionArgument argument = ArgumentNone,\n \t\t const char *argumentName = nullptr);\n+\tvoid addOption(int opt, const char *help, KeyValueParser &parser,\n+\t\t const char *name = nullptr);\n \n \tOptions parse(int argc, char *argv[]);\n \tvoid usage();\n@@ -52,6 +86,7 @@ private:\n \t\tOptionArgument argument;\n \t\tconst char *argumentName;\n \t\tconst char *help;\n+\t\tKeyValueParser *keyValueParser;\n \n \t\tbool hasShortOption() const { return isalnum(opt); }\n \t\tbool hasLongOption() const { return name != nullptr; }\n","prefixes":["libcamera-devel","5/6"]}