Add options type-alias

Author: indianakernick

docopt.cpp

@@ -609,7 +609,7 @@ static std::pair<Required, std::vector<Option>> create_pattern_tree(std::string
 }
 
 DOCOPT_INLINE
-std::map<std::string, value>
+docopt::options
 docopt::docopt_parse(std::string const& doc,
 		     std::vector<std::string> const& argv,
 		     bool help,
@@ -636,7 +636,7 @@ docopt::docopt_parse(std::string const& doc,
 	std::vector<std::shared_ptr<LeafPattern>> collected;
 	bool matched = pattern.fix().match(argv_patterns, collected);
 	if (matched && argv_patterns.empty()) {
-		std::map<std::string, value> ret;
+		options ret;
 
 		// (a.name, a.value) for a in (pattern.flat() + collected)
 		for (auto* p : pattern.leaves()) {
@@ -659,7 +659,7 @@ docopt::docopt_parse(std::string const& doc,
 }
 
 DOCOPT_INLINE
-std::map<std::string, value>
+docopt::options
 docopt::docopt(std::string const& doc,
 	       std::vector<std::string> const& argv,
 	       bool help,

docopt.h

@@ -54,6 +54,9 @@ namespace docopt {
 
 	// Arguments contained '--version' and parsing was aborted early
 	struct DocoptExitVersion : std::runtime_error { DocoptExitVersion() : std::runtime_error("Docopt --version argument encountered") {} };
+
+	/// A map of options set by the user
+	using options = std::map<std::string, value>;
 
 	/// Parse user options from the given option string.
 	///
@@ -68,7 +71,7 @@ namespace docopt {
 	/// @throws DocoptExitHelp if 'help' is true and the user has passed the '--help' argument
 	/// @throws DocoptExitVersion if 'version' is true and the user has passed the '--version' argument
 	/// @throws DocoptArgumentError if the user's argv did not match the usage patterns
-	std::map<std::string, value> DOCOPT_API docopt_parse(std::string const& doc,
+	options DOCOPT_API docopt_parse(std::string const& doc,
 					    std::vector<std::string> const& argv,
 					    bool help = true,
 					    bool version = true,
@@ -81,7 +84,7 @@ namespace docopt {
 	///  * DocoptExitHelp - print usage string and terminate (with exit code 0)
 	///  * DocoptExitVersion - print version and terminate (with exit code 0)
 	///  * DocoptArgumentError - print error and usage string and terminate (with exit code -1)
-	std::map<std::string, value> DOCOPT_API docopt(std::string const& doc,
+	options DOCOPT_API docopt(std::string const& doc,
 					    std::vector<std::string> const& argv,
 					    bool help = true,
 					    std::string const& version = {},