mirror of
https://github.com/iriselia/xgmsv.git
synced 2025-04-04 15:58:26 +08:00
95 lines
3.7 KiB
C++
95 lines
3.7 KiB
C++
//
|
|
// docopt.h
|
|
// docopt
|
|
//
|
|
// Created by Jared Grubb on 2013-11-03.
|
|
// Copyright (c) 2013 Jared Grubb. All rights reserved.
|
|
//
|
|
|
|
#ifndef docopt__docopt_h_
|
|
#define docopt__docopt_h_
|
|
|
|
#include "docopt_value.h"
|
|
|
|
#include <map>
|
|
#include <vector>
|
|
#include <string>
|
|
|
|
#ifdef DOCOPT_HEADER_ONLY
|
|
#define DOCOPT_INLINE inline
|
|
#define DOCOPT_API
|
|
#else
|
|
#define DOCOPT_INLINE
|
|
|
|
// With Microsoft Visual Studio, export certain symbols so they
|
|
// are available to users of docopt.dll (shared library). The DOCOPT_DLL
|
|
// macro should be defined if building a DLL (with Visual Studio),
|
|
// and by clients using the DLL. The CMakeLists.txt and the
|
|
// docopt-config.cmake it generates handle this.
|
|
#ifdef DOCOPT_DLL
|
|
// Whoever is *building* the DLL should define DOCOPT_EXPORTS.
|
|
// The CMakeLists.txt that comes with docopt does this.
|
|
// Clients of docopt.dll should NOT define DOCOPT_EXPORTS.
|
|
#ifdef DOCOPT_EXPORTS
|
|
#define DOCOPT_API __declspec(dllexport)
|
|
#else
|
|
#define DOCOPT_API __declspec(dllimport)
|
|
#endif
|
|
#else
|
|
#define DOCOPT_API
|
|
#endif
|
|
#endif
|
|
|
|
namespace docopt {
|
|
|
|
// Usage string could not be parsed (ie, the developer did something wrong)
|
|
struct DocoptLanguageError : std::runtime_error { using runtime_error::runtime_error; };
|
|
|
|
// Arguments passed by user were incorrect (ie, developer was good, user is wrong)
|
|
struct DocoptArgumentError : std::runtime_error { using runtime_error::runtime_error; };
|
|
|
|
// Arguments contained '--help' and parsing was aborted early
|
|
struct DocoptExitHelp : std::runtime_error { DocoptExitHelp() : std::runtime_error("Docopt --help argument encountered"){} };
|
|
|
|
// Arguments contained '--version' and parsing was aborted early
|
|
struct DocoptExitVersion : std::runtime_error { DocoptExitVersion() : std::runtime_error("Docopt --version argument encountered") {} };
|
|
|
|
/// Parse user options from the given option string.
|
|
///
|
|
/// @param doc The usage string
|
|
/// @param argv The user-supplied arguments
|
|
/// @param help Whether to end early if '-h' or '--help' is in the argv
|
|
/// @param version Whether to end early if '--version' is in the argv
|
|
/// @param options_first Whether options must precede all args (true), or if args and options
|
|
/// can be arbitrarily mixed.
|
|
///
|
|
/// @throws DocoptLanguageError if the doc usage string had errors itself
|
|
/// @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,
|
|
std::vector<std::string> const& argv,
|
|
bool help = true,
|
|
bool version = true,
|
|
bool options_first = false);
|
|
|
|
/// Parse user options from the given string, and exit appropriately
|
|
///
|
|
/// Calls 'docopt_parse' and will terminate the program if any of the exceptions above occur:
|
|
/// * DocoptLanguageError - print error and terminate (with exit code -1)
|
|
/// * 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,
|
|
std::vector<std::string> const& argv,
|
|
bool help = true,
|
|
std::string const& version = {},
|
|
bool options_first = false) noexcept;
|
|
}
|
|
|
|
#ifdef DOCOPT_HEADER_ONLY
|
|
#include "docopt.cpp"
|
|
#endif
|
|
|
|
#endif /* defined(docopt__docopt_h_) */
|