pax_global_header00006660000000000000000000000064145145234410014515gustar00rootroot0000000000000052 comment=d175438d9b25e6638459efe80f61292178fcd491 docopt.cpp-0.6.3/000077500000000000000000000000001451452344100135745ustar00rootroot00000000000000docopt.cpp-0.6.3/.gitignore000066400000000000000000000006241451452344100155660ustar00rootroot00000000000000# Compiled Object files *.slo *.lo *.o # Compiled Dynamic libraries *.so *.dylib *.dll # Compiled Static libraries *.lai *.la *.a # Compiled examples, as per docs example naval_fate run_testcase run_testcase.exe # CMake temporary files CMakeCache.txt CMakeFiles CPackConfig.cmake CPackSourceConfig.cmake Makefile cmake_install.cmake docopt-config-version.cmake # Files configured by CMake run_tests docopt.cpp-0.6.3/.travis.yml000066400000000000000000000055601451452344100157130ustar00rootroot00000000000000language: cpp sudo: false # Use the new container infrastructure matrix: include: - os: linux env: - COMPILER=g++-7 addons: apt: sources: ['ubuntu-toolchain-r-test'] packages: ["g++-7", "cmake-data", "cmake"] - os: linux env: - COMPILER=g++-8 addons: apt: sources: ['ubuntu-toolchain-r-test'] packages: ["g++-8", "cmake-data", "cmake"] - os: linux env: - COMPILER=g++-9 addons: apt: sources: ['ubuntu-toolchain-r-test'] packages: ["g++-9", "cmake-data", "cmake"] - os: linux env: - COMPILER=g++-9 USE_BOOST_REGEX=ON addons: apt: sources: ['ubuntu-toolchain-r-test'] packages: ["g++-9", "cmake-data", "cmake", "libboost-regex-dev"] - os: linux env: - COMPILER=clang++-3.6 STDLIB=libc++ addons: apt: sources: ['ubuntu-toolchain-r-test', 'llvm-toolchain-precise-3.6', 'george-edison55-precise-backports'] packages: ["clang-3.6", "cmake-data", "cmake"] - os: linux env: - COMPILER=clang++-8 STDLIB=libc++ addons: apt: sources: ['ubuntu-toolchain-r-test', 'llvm-toolchain-trusty-8'] packages: ["clang-8", "cmake-data", "cmake"] - os: osx osx_image: xcode9.4 env: - COMPILER=clang++ V='Apple LLVM 9.1' - COMPILER=clang++ V='Apple LLVM 9.1' WITH_CPP14=true - os: osx osx_image: xcode10.3 env: - COMPILER=clang++ V='Apple LLVM 10.0' - COMPILER=clang++ V='Apple LLVM 10.0' WITH_CPP14=true - os: osx osx_image: xcode11.2 env: - COMPILER=clang++ V='Apple LLVM 11.0' - COMPILER=clang++ V='Apple LLVM 11.0' WITH_CPP14=true - os: osx osx_image: xcode11.2 env: - COMPILER=clang++ V='Apple LLVM 11.0' - COMPILER=clang++ V='Apple LLVM 11.0' WITH_CPP17=true before_install: - CMAKE_CXX_FLAGS+=" -Wall" - | if [[ "${WITH_CPP14}" == "true" ]]; then CMAKE_OPTIONS+=" -DCMAKE_CXX_STANDARD=14" fi - | if [[ "${WITH_CPP17}" == "true" ]]; then CMAKE_OPTIONS+=" -DCMAKE_CXX_STANDARD=17" fi - | if [[ "${USE_BOOST_REGEX}" == "ON" ]]; then CMAKE_OPTIONS+=" -DUSE_BOOST_REGEX=ON" CMAKE_OPTIONS+=" -DBoost_REGEX_LIBRARY_DEBUG=/usr/lib/x86_64-linux-gnu/libboost_regex.so" CMAKE_OPTIONS+=" -DBoost_REGEX_LIBRARY_RELEASE=/usr/lib/x86_64-linux-gnu/libboost_regex.so" fi - | if [[ "${STDLIB}" == "libc++" ]]; then CMAKE_CXX_FLAGS+=" -stdlib=libc++" fi - ${COMPILER} --version before_script: - rm -rf build/ - mkdir build - cd build - cmake -DCMAKE_CXX_COMPILER=${COMPILER} -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS} -DWITH_TESTS=1 -DWITH_EXAMPLE=1 ${CMAKE_OPTIONS} .. script: - cmake --build . - python run_tests docopt.cpp-0.6.3/CMakeLists.txt000066400000000000000000000121461451452344100163400ustar00rootroot00000000000000cmake_minimum_required(VERSION 3.1) project(docopt.cpp VERSION 0.6.2) include(GNUInstallDirs) #============================================================================ # Settable options #============================================================================ option(WITH_TESTS "Build tests." OFF) option(WITH_EXAMPLE "Build example." OFF) option(USE_BOOST_REGEX "Replace std::regex with Boost.Regex" OFF) #============================================================================ # Internal compiler options #============================================================================ # C++ standard set(CMAKE_CXX_STANDARD_REQUIRED ON) set(CMAKE_CXX_EXTENSIONS OFF) if(NOT CMAKE_CXX_STANDARD OR CMAKE_CXX_STANDARD LESS 11) set(CMAKE_CXX_STANDARD 11) endif() #============================================================================ # Sources & headers #============================================================================ set(docopt_SOURCES docopt.cpp) set(docopt_HEADERS docopt.h docopt_private.h docopt_util.h docopt_value.h ) #============================================================================ # Compile targets #============================================================================ add_library(docopt ${docopt_SOURCES} ${docopt_HEADERS}) set_target_properties(docopt PROPERTIES VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION_MAJOR} ) target_include_directories(docopt PUBLIC $ $) if(MSVC AND BUILD_SHARED_LIBS) # DOCOPT_DLL: Must be specified when building *and* when using the DLL. # That's what the "PUBLIC" means. # DOCOPT_EXPORTS: Must use __declspec(dllexport) when building the DLL. # "PRIVATE" means it's only defined when building the DLL. target_compile_definitions(docopt PUBLIC DOCOPT_DLL PRIVATE DOCOPT_EXPORTS) endif() if(USE_BOOST_REGEX) add_definitions("-DDOCTOPT_USE_BOOST_REGEX") # This is needed on Linux, where linking a static library into docopt.so # fails because boost static libs are not compiled with -fPIC set(Boost_USE_STATIC_LIBS OFF) find_package(Boost 1.53 REQUIRED COMPONENTS regex) include_directories(${Boost_INCLUDE_DIRS}) target_link_libraries(docopt ${Boost_LIBRARIES}) endif() #============================================================================ # Examples #============================================================================ if(WITH_EXAMPLE) add_executable(docopt_example examples/naval_fate.cpp) target_link_libraries(docopt_example docopt) endif() #============================================================================ # Tests #============================================================================ if(WITH_TESTS) set(TESTPROG "${CMAKE_CURRENT_BINARY_DIR}/run_testcase") set(TESTCASES "${PROJECT_SOURCE_DIR}/testcases.docopt") add_executable(run_testcase run_testcase.cpp) target_link_libraries(run_testcase docopt) configure_file( "${PROJECT_SOURCE_DIR}/run_tests.py" "${CMAKE_CURRENT_BINARY_DIR}/run_tests" ESCAPE_QUOTES ) add_test("Testcases docopt" ${TESTPROG}) endif() #============================================================================ # Install #============================================================================ set(export_name "docopt-targets") # Runtime package install(TARGETS docopt EXPORT ${export_name} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}) # Development package install(FILES ${docopt_HEADERS} DESTINATION include/docopt) # CMake Package include(CMakePackageConfigHelpers) write_basic_package_version_file("${PROJECT_BINARY_DIR}/docopt-config-version.cmake" COMPATIBILITY SameMajorVersion) install(FILES docopt-config.cmake ${PROJECT_BINARY_DIR}/docopt-config-version.cmake DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/docopt") install(EXPORT ${export_name} DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/docopt") configure_file(${CMAKE_CURRENT_SOURCE_DIR}/docopt.pc.in ${CMAKE_CURRENT_BINARY_DIR}/docopt.pc @ONLY) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/docopt.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) #============================================================================ # CPack #============================================================================ set(CPACK_PACKAGE_NAME "docopt") set(CPACK_DEBIAN_PACKAGE_DEPENDS "") set(CPACK_RPM_PACKAGE_REQUIRES "") set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Beautiful command line interfaces") set(CPACK_PACKAGE_VENDOR "Jared Grubb") set(CPACK_PACKAGE_CONTACT ${CPACK_PACKAGE_VENDOR}) set(CPACK_PACKAGE_DESCRIPTION_FILE "${PROJECT_SOURCE_DIR}/README.rst") set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE-MIT") set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR}) set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR}) set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH}) set(CPACK_DEBIAN_PACKAGE_SECTION "Development") set(CPACK_RPM_PACKAGE_GROUP "Development/Libraries") set(CPACK_RPM_PACKAGE_LICENSE "MIT") set(CPACK_STRIP_FILES TRUE) include(CPack) docopt.cpp-0.6.3/LICENSE-Boost-1.0000066400000000000000000000024721451452344100161660ustar00rootroot00000000000000Boost Software License - Version 1.0 - August 17th, 2003 Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following: The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. docopt.cpp-0.6.3/LICENSE-MIT000066400000000000000000000020761451452344100152350ustar00rootroot00000000000000Copyright (c) 2012 Vladimir Keleshev, Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. docopt.cpp-0.6.3/README.rst000066400000000000000000000424541451452344100152740ustar00rootroot00000000000000``docopt.cpp``: A C++11 Port ============================ Contents -------- .. contents:: :local: :depth: 3 docopt creates *beautiful* command-line interfaces -------------------------------------------------- Isn't it awesome how ``getopt`` (and ``boost::program_options`` for you fancy folk!) generate help messages based on your code?! These timeless functions have been around for decades and have proven we don't need anything better, right? *Hell no!* You know what's awesome? It's when the option parser *is* generated based on the beautiful help message that you write yourself! This way you don't need to write this stupid repeatable parser-code, and instead can write only the help message--*the way you want it*. **docopt** helps you create most beautiful command-line interfaces *easily*: .. code:: c++ #include "docopt.h" #include static const char USAGE[] = R"(Naval Fate. Usage: naval_fate ship new ... naval_fate ship move [--speed=] naval_fate ship shoot naval_fate mine (set|remove) [--moored | --drifting] naval_fate (-h | --help) naval_fate --version Options: -h --help Show this screen. --version Show version. --speed= Speed in knots [default: 10]. --moored Moored (anchored) mine. --drifting Drifting mine. )"; int main(int argc, const char** argv) { std::map args = docopt::docopt(USAGE, { argv + 1, argv + argc }, true, // show help if requested "Naval Fate 2.0"); // version string for(auto const& arg : args) { std::cout << arg.first << arg.second << std::endl; } return 0; } Beat that! The option parser is generated based on the docstring above that is passed to ``docopt::docopt`` function. ``docopt`` parses the usage pattern (``"Usage: ..."``) and option descriptions (lines starting with a dash "``-``") and ensures that the program invocation matches the usage pattern; it parses options, arguments and commands based on that. The basic idea is that *a good help message has all necessary information in it to make a parser*. Getting and using ----------------- To get *docopt.cpp*, the simplest is to use `Conda `_:: conda install -c conda-forge docopt.cpp Alternatively manual installation is done using (unix):: git clone cmake . make install To link *docopt.cpp*, the simplest is to use CMake. The general structure of your ``CMakeLists.txt`` would be as follows:: cmake_minimum_required(VERSION 3.1) project(example) find_package(docopt COMPONENTS CXX REQUIRED) include_directories(${DOCOPT_INCLUDE_DIRS}) add_executable(${PROJECT_NAME} ...) target_link_libraries(${PROJECT_NAME} docopt) C++11 port details ------------------ This is a port of the ``docopt.py`` module (https://github.com/docopt/docopt), and we have tried to maintain full feature parity (and code structure) as the original. This port is written in C++11 and also requires a good C++11 standard library (in particular, one with ``regex`` support). The following compilers are known to work with docopt: - Clang 3.3 and later - GCC 4.9 - Visual C++ 2015 RC GCC-4.8 can work, but the std::regex module needs to be replaced with ``Boost.Regex``. In that case, you will need to define ``DOCTOPT_USE_BOOST_REGEX`` when compiling docopt, and link your code with the appropriated Boost libraries. A relatively recent version of Boost is needed: 1.55 works, but 1.46 does not for example. This port is licensed under the MIT license, just like the original module. However, we are also dual-licensing this code under the Boost License, version 1.0, as this is a popular C++ license. The licenses are similar and you are free to use this code under the terms of either license. The differences from the Python port are: * the addition of a ``docopt_parse`` function, which does not terminate the program on error * a ``docopt::value`` type to hold the various value types that can be parsed. We considered using boost::variant, but it seems better to have no external dependencies (beyond a good STL). * because C++ is statically-typed and Python is not, we had to make some changes to the interfaces of the internal parse tree types. * because ``std::regex`` does not have an equivalent to Python's regex.split, some of the regex's had to be restructured and additional loops used. API --- .. code:: c++ docopt::docopt(doc, argv, help /* =true */, version /* ="" */, options_first /* =false */) ``docopt`` takes 2 required and 3 optional arguments: - ``doc`` is a string that contains a **help message** that will be parsed to create the option parser. The simple rules of how to write such a help message are given in next sections. Here is a quick example of such a string (note that this example uses the "raw string literal" feature that was added to C++11): .. code:: c++ R"(Usage: my_program [-hso FILE] [--quiet | --verbose] [INPUT ...] -h --help show this -s --sorted sorted output -o FILE specify output file [default: ./test.txt] --quiet print less text --verbose print more text )" - ``argv`` is a vector of strings representing the args passed. Although main usually takes a ``(int argc, const char** argv)`` pair, you can pass the value ``{argv+1, argv+argc}`` to generate the vector automatically. (Note we skip the argv[0] argument!) Alternatively you can supply a list of strings like ``{ "--verbose", "-o", "hai.txt" }``. - ``help``, by default ``true``, specifies whether the parser should automatically print the help message (supplied as ``doc``) and terminate, in case ``-h`` or ``--help`` option is encountered (options should exist in usage pattern, more on that below). If you want to handle ``-h`` or ``--help`` options manually (as other options), set ``help=false``. - ``version``, by default empty, is an optional argument that specifies the version of your program. If supplied, then, (assuming ``--version`` option is mentioned in usage pattern) when parser encounters the ``--version`` option, it will print the supplied version and terminate. ``version`` could be any printable object, but most likely a string, e.g. ``"2.1.0rc1"``. Note, when ``docopt`` is set to automatically handle ``-h``, ``--help`` and ``--version`` options, you still need to mention them in usage pattern for this to work (also so your users to know about them!) - ``options_first``, by default ``false``. If set to ``true`` will disallow mixing options and positional argument. I.e. after first positional argument, all arguments will be interpreted as positional even if the look like options. This can be used for strict compatibility with POSIX, or if you want to dispatch your arguments to other programs. The **return** value is a ``map`` with options, arguments and commands as keys, spelled exactly like in your help message. Long versions of options are given priority. For example, if you invoke the top example as:: naval_fate ship Guardian move 100 150 --speed=15 the return dictionary will be: .. code:: python {"--drifting": false, "mine": false, "--help": false, "move": true, "--moored": false, "new": false, "--speed": "15", "remove": false, "--version": false, "set": false, "": ["Guardian"], "ship": true, "": "100", "shoot": false, "": "150"} If any parsing error (in either the usage, or due to incorrect user inputs) is encountered, the program will exit with exit code -1. Note that there is another function that does not exit on error, and instead will propagate an exception that you can catch and process as you like. See the docopt.h file for information on the exceptions and usage: .. code:: c++ docopt::docopt_parse(doc, argv, help /* =true */, version /* =true */, options_first /* =false) Help message format ------------------- Help message consists of 2 parts: - Usage pattern, e.g.:: Usage: my_program [-hso FILE] [--quiet | --verbose] [INPUT ...] - Option descriptions, e.g.:: -h --help show this -s --sorted sorted output -o FILE specify output file [default: ./test.txt] --quiet print less text --verbose print more text Their format is described below; other text is ignored. Usage pattern format -------------------- **Usage pattern** is a substring of ``doc`` that starts with ``usage:`` (case *insensitive*) and ends with a *visibly* empty line. Minimum example: .. code:: python """Usage: my_program """ The first word after ``usage:`` is interpreted as your program's name. You can specify your program's name several times to signify several exclusive patterns: .. code:: python """Usage: my_program FILE my_program COUNT FILE """ Each pattern can consist of the following elements: - ****, **ARGUMENTS**. Arguments are specified as either upper-case words, e.g. ``my_program CONTENT-PATH`` or words surrounded by angular brackets: ``my_program ``. - **--options**. Options are words started with dash (``-``), e.g. ``--output``, ``-o``. You can "stack" several of one-letter options, e.g. ``-oiv`` which will be the same as ``-o -i -v``. The options can have arguments, e.g. ``--input=FILE`` or ``-i FILE`` or even ``-iFILE``. However it is important that you specify option descriptions if you want your option to have an argument, a default value, or specify synonymous short/long versions of the option (see next section on option descriptions). - **commands** are words that do *not* follow the described above conventions of ``--options`` or ```` or ``ARGUMENTS``, plus two special commands: dash "``-``" and double dash "``--``" (see below). Use the following constructs to specify patterns: - **[ ]** (brackets) **optional** elements. e.g.: ``my_program [-hvqo FILE]`` - **( )** (parens) **required** elements. All elements that are *not* put in **[ ]** are also required, e.g.: ``my_program --path= ...`` is the same as ``my_program (--path= ...)``. (Note, "required options" might be not a good idea for your users). - **|** (pipe) **mutually exclusive** elements. Group them using **( )** if one of the mutually exclusive elements is required: ``my_program (--clockwise | --counter-clockwise) TIME``. Group them using **[ ]** if none of the mutually exclusive elements are required: ``my_program [--left | --right]``. - **...** (ellipsis) **one or more** elements. To specify that arbitrary number of repeating elements could be accepted, use ellipsis (``...``), e.g. ``my_program FILE ...`` means one or more ``FILE``-s are accepted. If you want to accept zero or more elements, use brackets, e.g.: ``my_program [FILE ...]``. Ellipsis works as a unary operator on the expression to the left. - **[options]** (case sensitive) shortcut for any options. You can use it if you want to specify that the usage pattern could be provided with any options defined below in the option-descriptions and do not want to enumerate them all in usage-pattern. - "``[--]``". Double dash "``--``" is used by convention to separate positional arguments that can be mistaken for options. In order to support this convention add "``[--]``" to your usage patterns. - "``[-]``". Single dash "``-``" is used by convention to signify that ``stdin`` is used instead of a file. To support this add "``[-]``" to your usage patterns. "``-``" acts as a normal command. If your pattern allows to match argument-less option (a flag) several times:: Usage: my_program [-v | -vv | -vvv] then number of occurrences of the option will be counted. I.e. ``args['-v']`` will be ``2`` if program was invoked as ``my_program -vv``. Same works for commands. If your usage pattern allows to match same-named option with argument or positional argument several times, the matched arguments will be collected into a list:: Usage: my_program --path=... I.e. invoked with ``my_program file1 file2 --path=./here --path=./there`` the returned dict will contain ``args[''] == ['file1', 'file2']`` and ``args['--path'] == ['./here', './there']``. Option descriptions format -------------------------- **Option descriptions** consist of a list of options that you put below your usage patterns. It is necessary to list option descriptions in order to specify: - synonymous short and long options, - if an option has an argument, - if option's argument has a default value. The rules are as follows: - Every line in ``doc`` that starts with ``-`` or ``--`` (not counting spaces) is treated as an option description, e.g.:: Options: --verbose # GOOD -o FILE # GOOD Other: --bad # BAD, line does not start with dash "-" - To specify that option has an argument, put a word describing that argument after space (or equals "``=``" sign) as shown below. Follow either or UPPER-CASE convention for options' arguments. You can use comma if you want to separate options. In the example below, both lines are valid. However you are recommended to stick to a single style.:: -o FILE --output=FILE # without comma, with "=" sign -i , --input # with comma, without "=" sing - Use two spaces to separate options with their informal description:: --verbose More text. # BAD, will be treated as if verbose option had # an argument "More", so use 2 spaces instead -q Quit. # GOOD -o FILE Output file. # GOOD --stdout Use stdout. # GOOD, 2 spaces - If you want to set a default value for an option with an argument, put it into the option-description, in form ``[default: ]``:: --coefficient=K The K coefficient [default: 2.95] --output=FILE Output file [default: test.txt] --directory=DIR Some directory [default: ./] - If the option is not repeatable, the value inside ``[default: ...]`` will be interpreted as string. If it *is* repeatable, it will be split into a list on whitespace:: Usage: my_program [--repeatable= --repeatable=] [--another-repeatable=]... [--not-repeatable=] # will be ['./here', './there'] --repeatable= [default: ./here ./there] # will be ['./here'] --another-repeatable= [default: ./here] # will be './here ./there', because it is not repeatable --not-repeatable= [default: ./here ./there] Examples -------- We have an extensive list of `examples `_ which cover every aspect of functionality of **docopt**. Try them out, read the source if in doubt. There are also very interesting applications and ideas at that page. Check out the sister project for more information! Subparsers, multi-level help and *huge* applications (like git) --------------------------------------------------------------- If you want to split your usage-pattern into several, implement multi-level help (with separate help-screen for each subcommand), want to interface with existing scripts that don't use **docopt**, or you're building the next "git", you will need the new ``options_first`` parameter (described in API section above). To get you started quickly we implemented a subset of git command-line interface as an example: `examples/git `_ Compiling the example / Running the tests ----------------------------------------- The original Python module includes some language-agnostic unit tests, and these can be run with this port as well. The tests are a Python driver that uses the testcases.docopt file to then invoke a C++ test case runner (run_testcase.cpp):: $ clang++ --std=c++11 --stdlib=libc++ docopt.cpp run_testcase.cpp -o run_testcase $ python run_tests.py PASS (175) You can also compile the example shown at the start (included as example.cpp):: $ clang++ --std=c++11 --stdlib=libc++ -I . docopt.cpp examples/naval_fate.cpp -o naval_fate $ ./naval_fate --help [ ... ] $ ./naval_fate ship Guardian move 100 150 --speed=15 --drifting: false --help: false --moored: false --speed: "15" --version: false : ["Guardian"] : "100" : "150" mine: false move: true new: false remove: false set: false ship: true shoot: false Development ----------- Comments and suggestions are *very* welcome! If you find issues, please file them and help improve our code! Please note, however, that we have tried to stay true to the original Python code. If you have any major patches, structural changes, or new features, we might want to first negotiate these changes into the Python code first. However, bring it up! Let's hear it! Changelog --------- **docopt** follows `semantic versioning `_. The first release with stable API will be 1.0.0 (soon). - 0.6.2 Bugfix release (still based on docopt 0.6.1) - 0.6.1 The initial C++ port of docopt.py (based on docopt 0.6.1) docopt.cpp-0.6.3/docopt-config.cmake000066400000000000000000000000721451452344100173300ustar00rootroot00000000000000include("${CMAKE_CURRENT_LIST_DIR}/docopt-targets.cmake") docopt.cpp-0.6.3/docopt.cpp000066400000000000000000000451211451452344100155730ustar00rootroot00000000000000// // docopt.cpp // docopt // // Created by Jared Grubb on 2013-11-03. // Copyright (c) 2013 Jared Grubb. All rights reserved. // #include "docopt.h" #include "docopt_util.h" #include "docopt_private.h" #include "docopt_value.h" #include #include #include #include #include #include #include #include using namespace docopt; DOCOPT_INLINE std::ostream& docopt::operator<<(std::ostream& os, value const& val) { if (val.isBool()) { bool b = val.asBool(); os << (b ? "true" : "false"); } else if (val.isLong()) { long v = val.asLong(); os << v; } else if (val.isString()) { std::string const& str = val.asString(); os << '"' << str << '"'; } else if (val.isStringList()) { auto const& list = val.asStringList(); os << "["; bool first = true; for(auto const& el : list) { if (first) { first = false; } else { os << ", "; } os << '"' << el << '"'; } os << "]"; } else { os << "null"; } return os; } #if 0 #pragma mark - #pragma mark Parsing stuff #endif class Tokens { public: Tokens(std::vector tokens, bool isParsingArgv = true) : fTokens(std::move(tokens)), fIsParsingArgv(isParsingArgv) {} explicit operator bool() const { return fIndex < fTokens.size(); } static Tokens from_pattern(std::string const& source) { static const std::regex re_separators { "(?:\\s*)" // any spaces (non-matching subgroup) "(" "[\\[\\]\\(\\)\\|]" // one character of brackets or parens or pipe character "|" "\\.\\.\\." // elipsis ")" }; static const std::regex re_strings { "(?:\\s*)" // any spaces (non-matching subgroup) "(" "\\S*<.*?>" // strings, but make sure to keep "< >" strings together "|" "[^<>\\s]+" // string without <> ")" }; // We do two stages of regex matching. The '[]()' and '...' are strong delimeters // and need to be split out anywhere they occur (even at the end of a token). We // first split on those, and then parse the stuff between them to find the string // tokens. This is a little harder than the python version, since they have regex.split // and we dont have anything like that. std::vector tokens; std::for_each(std::sregex_iterator{ source.begin(), source.end(), re_separators }, std::sregex_iterator{}, [&](std::smatch const& match) { // handle anything before the separator (this is the "stuff" between the delimeters) if (match.prefix().matched) { std::for_each(std::sregex_iterator{match.prefix().first, match.prefix().second, re_strings}, std::sregex_iterator{}, [&](std::smatch const& m) { tokens.push_back(m[1].str()); }); } // handle the delimter token itself if (match[1].matched) { tokens.push_back(match[1].str()); } }); return Tokens(tokens, false); } std::string const& current() const { if (*this) return fTokens[fIndex]; static std::string const empty; return empty; } std::string the_rest() const { if (!*this) return {}; return join(fTokens.begin()+static_cast(fIndex), fTokens.end(), " "); } std::string pop() { return std::move(fTokens.at(fIndex++)); } bool isParsingArgv() const { return fIsParsingArgv; } struct OptionError : std::runtime_error { using runtime_error::runtime_error; }; private: std::vector fTokens; size_t fIndex = 0; bool fIsParsingArgv; }; // Get all instances of 'T' from the pattern template std::vector flat_filter(Pattern& pattern) { std::vector flattened = pattern.flat([](Pattern const* p) -> bool { return dynamic_cast(p) != nullptr; }); // now, we're guaranteed to have T*'s, so just use static_cast std::vector ret; std::transform(flattened.begin(), flattened.end(), std::back_inserter(ret), [](Pattern* p) { return static_cast(p); }); return ret; } static std::vector parse_section(std::string const& name, std::string const& source) { // ECMAScript regex only has "?=" for a non-matching lookahead. In order to make sure we always have // a newline to anchor our matching, we have to avoid matching the final newline of each grouping. // Therefore, our regex is adjusted from the docopt Python one to use ?= to match the newlines before // the following lines, rather than after. std::regex const re_section_pattern { "(?:^|\\n)" // anchored at a linebreak (or start of string) "(" "[^\\n]*" + name + "[^\\n]*(?=\\n?)" // a line that contains the name "(?:\\n[ \\t].*?(?=\\n|$))*" // followed by any number of lines that are indented ")", std::regex::icase }; std::vector ret; std::for_each(std::sregex_iterator(source.begin(), source.end(), re_section_pattern), std::sregex_iterator(), [&](std::smatch const& match) { ret.push_back(trim(match[1].str())); }); return ret; } static bool is_argument_spec(std::string const& token) { if (token.empty()) return false; if (token[0]=='<' && token[token.size()-1]=='>') return true; if (std::all_of(token.begin(), token.end(), &::isupper)) return true; return false; } template std::vector longOptions(I iter, I end) { std::vector ret; std::transform(iter, end, std::back_inserter(ret), [](typename I::reference opt) { return opt->longOption(); }); return ret; } static PatternList parse_long(Tokens& tokens, std::vector