├── .clang-format ├── .gitattributes ├── .gitignore ├── .travis.yml ├── CMakeLists.txt ├── LICENSE ├── LICENSE.Apache-2.0-with-LLVM-Exception ├── LICENSE.GPL-3.0 ├── README.md ├── argparse.h ├── example.cpp └── tests.cpp /.clang-format: -------------------------------------------------------------------------------- 1 | BasedOnStyle: Google 2 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text eol=lf 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | #vs code 2 | .vscode/* 3 | .vs/* 4 | 5 | #cmake 6 | CMakeCache.txt 7 | CMakeFiles 8 | CMakeScripts 9 | Testing 10 | Makefile 11 | cmake_install.cmake 12 | install_manifest.txt 13 | compile_commands.json 14 | CTestTestfile.cmake 15 | bin/* 16 | lib/* 17 | build/* 18 | 19 | #cpp 20 | # Prerequisites 21 | *.d 22 | 23 | # Compiled Object files 24 | *.slo 25 | *.lo 26 | *.o 27 | *.obj 28 | 29 | # Precompiled Headers 30 | *.gch 31 | *.pch 32 | 33 | # Compiled Dynamic libraries 34 | *.so 35 | *.dylib 36 | *.dll 37 | 38 | # Fortran module files 39 | *.mod 40 | *.smod 41 | 42 | # Compiled Static libraries 43 | *.lai 44 | *.la 45 | *.a 46 | *.lib 47 | 48 | # Executables 49 | *.exe 50 | *.out 51 | *.app 52 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | dist: bionic 2 | sudo: require 3 | language: cpp 4 | compiler: 5 | - gcc 6 | - clang 7 | addons: 8 | apt: 9 | sources: 10 | - ubuntu-toolchain-r-test 11 | - cmake-data 12 | - cmake 13 | script: 14 | - cmake --version 15 | - $CC --version && $CXX --version 16 | - mkdir build && cd build 17 | - cmake ../ 18 | - make 19 | - make test -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.2 FATAL_ERROR) 2 | cmake_policy(VERSION 3.2) 3 | 4 | set(ARGPARSE_VERSION "0.1.2") 5 | project(argparse VERSION ${ARGPARSE_VERSION} LANGUAGES CXX) 6 | 7 | set(CMAKE_CXX_STANDARD 11) 8 | set(CMAKE_CXX_STANDARD_REQUIRED ON) 9 | option(ARGPARSE_TEST_ENABLE "Build unit tests" ON) 10 | option(ARGPARSE_BUILD_EXAMPLE "Build example" ON) 11 | if(WIN32) 12 | if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang") 13 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4 /Wall /WX -Wno-c++98-compat -Wno-c++98-compat-pedantic \ 14 | -Wno-gnu-zero-variadic-macro-arguments" 15 | ) 16 | elseif(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC") 17 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4 /Wall /WX") 18 | elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU") 19 | set( 20 | CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic -pedantic-errors -Wall -Wextra \ 21 | -Wcast-align -Wcast-qual -Wctor-dtor-privacy -Wdisabled-optimization -Wformat=2 \ 22 | -Winit-self -Wlogical-op -Wmissing-declarations -Wmissing-include-dirs -Wnoexcept \ 23 | -Wold-style-cast -Woverloaded-virtual -Wredundant-decls -Wshadow \ 24 | -Wsign-conversion -Wsign-promo -Wstrict-null-sentinel -Wstrict-overflow=5 \ 25 | -Wswitch-default -Wundef -Werror -Wno-unused -Winline -Wconversion -Wfloat-equal\ 26 | -Weffc++" 27 | ) 28 | endif() 29 | elseif(UNIX) 30 | set( 31 | CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic -pedantic-errors -Wall -Wextra \ 32 | -Wcast-align -Wcast-qual -Wctor-dtor-privacy -Wdisabled-optimization -Wformat=2 \ 33 | -Winit-self -Wmissing-declarations -Wmissing-include-dirs \ 34 | -Wold-style-cast -Woverloaded-virtual -Wredundant-decls -Wshadow \ 35 | -Wsign-conversion -Wsign-promo -Wstrict-overflow=5 \ 36 | -Wswitch-default -Wundef -Werror -Wno-unused -Winline -Wconversion -Wfloat-equal\ 37 | -Weffc++" 38 | ) 39 | if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU") 40 | set( 41 | CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wlogical-op -Wnoexcept -Wstrict-null-sentinel" 42 | ) 43 | elseif (CMAKE_CXX_COMPILER_ID STREQUAL "Clang") 44 | set( 45 | CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-gnu-zero-variadic-macro-arguments" 46 | ) 47 | endif() 48 | endif() 49 | 50 | enable_testing() 51 | 52 | add_library(argparse INTERFACE) 53 | target_include_directories(argparse INTERFACE .) 54 | 55 | if(ARGPARSE_BUILD_EXAMPLE) 56 | add_executable(example example.cpp) 57 | target_link_libraries(example PRIVATE argparse) 58 | endif(ARGPARSE_BUILD_EXAMPLE) 59 | 60 | if(ARGPARSE_TEST_ENABLE) 61 | add_executable(tests tests.cpp) 62 | add_test( 63 | NAME tests 64 | COMMAND $) 65 | target_link_libraries(tests PRIVATE argparse) 66 | endif(ARGPARSE_TEST_ENABLE) -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache-2.0-with-LLVM-Exception or GPL-3.0 2 | -------------------------------------------------------------------------------- /LICENSE.Apache-2.0-with-LLVM-Exception: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2020 Jesse C. Laning 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | 204 | --- LLVM Exceptions to the Apache 2.0 License ---- 205 | 206 | As an exception, if, as a result of your compiling your source code, portions 207 | of this Software are embedded into an Object form of such source code, you 208 | may redistribute such embedded portions in such Object form without complying 209 | with the conditions of Sections 4(a), 4(b) and 4(d) of the License. 210 | 211 | In addition, if you combine or link compiled forms of this Software with 212 | software that is licensed under the GPLv2 ("Combined Software") and if a 213 | court of competent jurisdiction determines that the patent provision (Section 214 | 3), the indemnity provision (Section 9) or other Section of the License 215 | conflicts with the conditions of the GPLv2, you may retroactively and 216 | prospectively choose to deem waived or otherwise exclude such Section(s) of 217 | the License, but only in their entirety and only with respect to the Combined 218 | Software. 219 | 220 | -------------------------------------------------------------------------------- /LICENSE.GPL-3.0: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # argparse 2 | A simple header only command line argument parser 3 | 4 | |Master|Develop| 5 | |:-:|:-:| 6 | |[![Build Status](https://travis-ci.com/jamolnng/argparse.svg?branch=master)](https://travis-ci.com/jamolnng/argparse)|[![Build Status](https://travis-ci.com/jamolnng/argparse.svg?branch=develop)](https://travis-ci.com/jamolnng/argparse)| 7 | 8 | ## Table of Contents 9 | - [Building With Git and CMake](#Building-With-Git-and-CMake) 10 | * [Make](#build-make) 11 | * [VSCode and CMake Tools](#build-vscode) 12 | * [Visual Studio](#build-vsc) 13 | - [Example](#Example) 14 | - [Usage](#Usage) 15 | - [Running Tests](#Running-Tests) 16 | * [Make](#test-make) 17 | * [VSCode and CMake Tools](#test-vscode) 18 | * [Visual Studio](#test-vsc) 19 | - [Contributing](#Contributing) 20 | - [License](#License) 21 | 22 | ## Building With Git and CMake 23 | [Git](https://git-scm.com) and [CMake](https://cmake.org/) 24 | ### Make 25 | [Make](https://www.gnu.org/software/make/) 26 | ```bash 27 | git clone https://github.com/jamolnng/argparse.git 28 | cd argparse 29 | mkdir build && cd build 30 | cmake .. 31 | make 32 | ``` 33 | ### VSCode and CMake Tools 34 | [VSCode](https://code.visualstudio.com/) and [CMake Tools extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) 35 | 36 | TODO 37 | ### Visual Studio 38 | [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/) 39 | 40 | TODO 41 | ## Example 42 | ```cpp 43 | #include 44 | #include 45 | 46 | #include "argparse.h" 47 | 48 | using namespace argparse; 49 | 50 | int main(int argc, const char* argv[]) { 51 | ArgumentParser parser("example", "Argument parser example"); 52 | parser.add_argument() 53 | .names({"-v", "--verbose"}) 54 | .description("verbose level") 55 | .required(true); 56 | parser.add_argument("-t", "--test", "test", true) 57 | .position(ArgumentParser::Argument::Position::LAST); 58 | parser.add_argument("-d", "--dtest", "dtest", true).position(0); 59 | parser.enable_help(); 60 | auto err = parser.parse(argc, argv); 61 | if (err) { 62 | std::cout << err << std::endl; 63 | return -1; 64 | } 65 | 66 | if (parser.exists("help")) { 67 | parser.print_help(); 68 | return 0; 69 | } 70 | 71 | if (parser.exists("v")) { 72 | switch (parser.get("v")) { 73 | case 2: 74 | std::cout << "an even more verbose string" << std::endl; 75 | #ifdef __clang__ 76 | [[clang::fallthrough]]; 77 | #endif 78 | // fall through 79 | case 1: 80 | std::cout << "a verbose string" << std::endl; 81 | #ifdef __clang__ 82 | [[clang::fallthrough]]; 83 | #endif 84 | // fall through 85 | default: 86 | std::cout << "some verbosity" << std::endl; 87 | } 88 | } 89 | 90 | if (parser.exists("test")) { 91 | std::cout << parser.get("test") << std::endl; 92 | } 93 | 94 | if (parser.exists("dtest")) { 95 | std::cout << parser.get("dtest") << std::endl; 96 | } 97 | } 98 | ``` 99 | Example output: 100 | ``` 101 | > program "something" -v 2 "something else" 102 | an even more verbose string 103 | a verbose string 104 | some verbosity 105 | something else 106 | something 107 | 108 | > program "something" -v=1 "something else" 109 | a verbose string 110 | some verbosity 111 | something else 112 | something 113 | 114 | > program "something" --verbose "something else" 115 | some verbosity 116 | something else 117 | something 118 | 119 | > program -h 120 | Usage: example [options...] [t] [d] 121 | Options: 122 | -v, --verbose verbose level (Required) 123 | -t, --test test (Required) 124 | -d, --dtest dtest (Required) 125 | -h, --help Shows this page 126 | 127 | > program 128 | Required argument not found: -v 129 | ``` 130 | ## Usage 131 | TODO 132 | ## TODO 133 | - [ ] Positional argumeents 134 | - [ ] More error checking 135 | - [ ] Think of more things to do 136 | ## Running Tests 137 | ### Make 138 | ```bash 139 | make test 140 | ``` 141 | ### 142 | ### VSCode and CMake Tools 143 | TODO 144 | ### Visual Studio 145 | TODO 146 | 147 | ## Contributing 148 | Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. 149 | 150 | Please make sure to update tests as appropriate. 151 | 152 | ## License 153 | [Apache-2.0-with-LLVM-Exception](./LICENSE.Apache-2.0-with-LLVM-Exception) or [GPL-3.0](./LICENSE.GPL-3.0) 154 | -------------------------------------------------------------------------------- /argparse.h: -------------------------------------------------------------------------------- 1 | /** 2 | * License: Apache 2.0 with LLVM Exception or GPL v3 3 | * 4 | * Author: Jesse Laning 5 | */ 6 | 7 | #ifndef ARGPARSE_H 8 | #define ARGPARSE_H 9 | 10 | #include 11 | #include 12 | #include 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | 24 | namespace argparse { 25 | namespace detail { 26 | static inline bool _not_space(int ch) { return !std::isspace(ch); } 27 | static inline void _ltrim(std::string &s, bool (*f)(int) = _not_space) { 28 | s.erase(s.begin(), std::find_if(s.begin(), s.end(), f)); 29 | } 30 | static inline void _rtrim(std::string &s, bool (*f)(int) = _not_space) { 31 | s.erase(std::find_if(s.rbegin(), s.rend(), f).base(), s.end()); 32 | } 33 | static inline void _trim(std::string &s, bool (*f)(int) = _not_space) { 34 | _ltrim(s, f); 35 | _rtrim(s, f); 36 | } 37 | static inline std::string _ltrim_copy(std::string s, 38 | bool (*f)(int) = _not_space) { 39 | _ltrim(s, f); 40 | return s; 41 | } 42 | static inline std::string _rtrim_copy(std::string s, 43 | bool (*f)(int) = _not_space) { 44 | _rtrim(s, f); 45 | return s; 46 | } 47 | static inline std::string _trim_copy(std::string s, 48 | bool (*f)(int) = _not_space) { 49 | _trim(s, f); 50 | return s; 51 | } 52 | template 53 | static inline std::string _join(InputIt begin, InputIt end, 54 | const std::string &separator = " ") { 55 | std::ostringstream ss; 56 | if (begin != end) { 57 | ss << *begin++; 58 | } 59 | while (begin != end) { 60 | ss << separator; 61 | ss << *begin++; 62 | } 63 | return ss.str(); 64 | } 65 | static inline bool _is_number(const std::string &arg) { 66 | std::istringstream iss(arg); 67 | float f; 68 | iss >> std::noskipws >> f; 69 | return iss.eof() && !iss.fail(); 70 | } 71 | 72 | static inline int _find_equal(const std::string &s) { 73 | for (size_t i = 0; i < s.length(); ++i) { 74 | // if find graph symbol before equal, end search 75 | // i.e. don't accept --asd)f=0 arguments 76 | // but allow --asd_f and --asd-f arguments 77 | if (std::ispunct(static_cast(s[i]))) { 78 | if (s[i] == '=') { 79 | return static_cast(i); 80 | } else if (s[i] == '_' || s[i] == '-') { 81 | continue; 82 | } 83 | return -1; 84 | } 85 | } 86 | return -1; 87 | } 88 | 89 | static inline size_t _find_name_end(const std::string &s) { 90 | size_t i; 91 | for (i = 0; i < s.length(); ++i) { 92 | if (std::ispunct(static_cast(s[i]))) { 93 | break; 94 | } 95 | } 96 | return i; 97 | } 98 | 99 | namespace is_vector_impl { 100 | template 101 | struct is_vector : std::false_type {}; 102 | template 103 | struct is_vector> : std::true_type {}; 104 | } // namespace is_vector_impl 105 | 106 | // type trait to utilize the implementation type traits as well as decay the 107 | // type 108 | template 109 | struct is_vector { 110 | static constexpr bool const value = 111 | is_vector_impl::is_vector::type>::value; 112 | }; 113 | } // namespace detail 114 | 115 | class ArgumentParser { 116 | private: 117 | public: 118 | class Argument; 119 | 120 | class Result { 121 | public: 122 | Result() {} 123 | Result(std::string err) noexcept : _error(true), _what(err) {} 124 | 125 | operator bool() const { return _error; } 126 | 127 | friend std::ostream &operator<<(std::ostream &os, const Result &dt); 128 | 129 | const std::string &what() const { return _what; } 130 | 131 | private: 132 | bool _error{false}; 133 | std::string _what{}; 134 | }; 135 | 136 | class Argument { 137 | public: 138 | enum Position : int { LAST = -1, DONT_CARE = -2 }; 139 | enum Count : int { ANY = -1 }; 140 | 141 | Argument &name(const std::string &name) { 142 | _names.push_back(name); 143 | return *this; 144 | } 145 | 146 | Argument &names(std::vector names) { 147 | _names.insert(_names.end(), names.begin(), names.end()); 148 | return *this; 149 | } 150 | 151 | Argument &description(const std::string &description) { 152 | _desc = description; 153 | return *this; 154 | } 155 | 156 | Argument &required(bool req) { 157 | _required = req; 158 | return *this; 159 | } 160 | 161 | Argument &position(int position) { 162 | if (position != Position::LAST) { 163 | // position + 1 because technically argument zero is the name of the 164 | // executable 165 | _position = position + 1; 166 | } else { 167 | _position = position; 168 | } 169 | return *this; 170 | } 171 | 172 | Argument &count(int count) { 173 | _count = count; 174 | return *this; 175 | } 176 | 177 | bool found() const { return _found; } 178 | 179 | template 180 | typename std::enable_if::value, T>::type get() { 181 | T t = T(); 182 | typename T::value_type vt; 183 | for (auto &s : _values) { 184 | std::istringstream in(s); 185 | in >> vt; 186 | t.push_back(vt); 187 | } 188 | return t; 189 | } 190 | 191 | template 192 | typename std::enable_if::value, T>::type get() { 193 | std::istringstream in(get()); 194 | T t = T(); 195 | in >> t >> std::ws; 196 | return t; 197 | } 198 | 199 | private: 200 | Argument(const std::string &name, const std::string &desc, 201 | bool required = false) 202 | : _desc(desc), _required(required) { 203 | _names.push_back(name); 204 | } 205 | 206 | Argument() {} 207 | 208 | friend class ArgumentParser; 209 | int _position{Position::DONT_CARE}; 210 | int _count{Count::ANY}; 211 | std::vector _names{}; 212 | std::string _desc{}; 213 | bool _found{false}; 214 | bool _required{false}; 215 | int _index{-1}; 216 | 217 | std::vector _values{}; 218 | }; 219 | 220 | ArgumentParser(const std::string &bin, const std::string &desc) 221 | : _bin(bin), _desc(desc) {} 222 | 223 | Argument &add_argument() { 224 | _arguments.push_back({}); 225 | _arguments.back()._index = static_cast(_arguments.size()) - 1; 226 | return _arguments.back(); 227 | } 228 | 229 | Argument &add_argument(const std::string &name, const std::string &long_name, 230 | const std::string &desc, const bool required = false) { 231 | _arguments.push_back(Argument(name, desc, required)); 232 | _arguments.back()._names.push_back(long_name); 233 | _arguments.back()._index = static_cast(_arguments.size()) - 1; 234 | return _arguments.back(); 235 | } 236 | 237 | Argument &add_argument(const std::string &name, const std::string &desc, 238 | const bool required = false) { 239 | _arguments.push_back(Argument(name, desc, required)); 240 | _arguments.back()._index = static_cast(_arguments.size()) - 1; 241 | return _arguments.back(); 242 | } 243 | 244 | void print_help(size_t count = 0, size_t page = 0) { 245 | if (page * count > _arguments.size()) { 246 | return; 247 | } 248 | if (page == 0) { 249 | std::cout << "Usage: " << _bin; 250 | if (_positional_arguments.empty()) { 251 | std::cout << " [options...]" << std::endl; 252 | } else { 253 | int current = 1; 254 | for (auto &v : _positional_arguments) { 255 | if (v.first != Argument::Position::LAST) { 256 | for (; current < v.first; current++) { 257 | std::cout << " [" << current << "]"; 258 | } 259 | std::cout 260 | << " [" 261 | << detail::_ltrim_copy( 262 | _arguments[static_cast(v.second)]._names[0], 263 | [](int c) -> bool { return c != static_cast('-'); }) 264 | << "]"; 265 | } 266 | } 267 | auto it = _positional_arguments.find(Argument::Position::LAST); 268 | if (it == _positional_arguments.end()) { 269 | std::cout << " [options...]"; 270 | } else { 271 | std::cout 272 | << " [options...] [" 273 | << detail::_ltrim_copy( 274 | _arguments[static_cast(it->second)]._names[0], 275 | [](int c) -> bool { return c != static_cast('-'); }) 276 | << "]"; 277 | } 278 | std::cout << std::endl; 279 | } 280 | std::cout << "Options:" << std::endl; 281 | } 282 | if (count == 0) { 283 | page = 0; 284 | count = _arguments.size(); 285 | } 286 | for (size_t i = page * count; 287 | i < std::min(page * count + count, _arguments.size()); i++) { 288 | Argument &a = _arguments[i]; 289 | std::string name = a._names[0]; 290 | for (size_t n = 1; n < a._names.size(); ++n) { 291 | name.append(", " + a._names[n]); 292 | } 293 | std::cout << " " << std::setw(23) << std::left << name << std::setw(23) 294 | << a._desc; 295 | if (a._required) { 296 | std::cout << " (Required)"; 297 | } 298 | std::cout << std::endl; 299 | } 300 | } 301 | 302 | Result parse(int argc, const char *argv[]) { 303 | Result err; 304 | if (argc > 1) { 305 | // build name map 306 | for (auto &a : _arguments) { 307 | for (auto &n : a._names) { 308 | std::string name = detail::_ltrim_copy( 309 | n, [](int c) -> bool { return c != static_cast('-'); }); 310 | if (_name_map.find(name) != _name_map.end()) { 311 | return Result("Duplicate of argument name: " + n); 312 | } 313 | _name_map[name] = a._index; 314 | } 315 | if (a._position >= 0 || a._position == Argument::Position::LAST) { 316 | _positional_arguments[a._position] = a._index; 317 | } 318 | } 319 | if (err) { 320 | return err; 321 | } 322 | 323 | // parse 324 | std::string current_arg; 325 | size_t arg_len; 326 | for (int argv_index = 1; argv_index < argc; ++argv_index) { 327 | current_arg = std::string(argv[argv_index]); 328 | arg_len = current_arg.length(); 329 | if (arg_len == 0) { 330 | continue; 331 | } 332 | if (_help_enabled && (current_arg == "-h" || current_arg == "--help")) { 333 | _arguments[static_cast(_name_map["help"])]._found = true; 334 | } else if (argv_index == argc - 1 && 335 | _positional_arguments.find(Argument::Position::LAST) != 336 | _positional_arguments.end()) { 337 | err = _end_argument(); 338 | Result b = err; 339 | err = _add_value(current_arg, Argument::Position::LAST); 340 | if (b) { 341 | return b; 342 | } 343 | if (err) { 344 | return err; 345 | } 346 | } else if (arg_len >= 2 && 347 | !detail::_is_number(current_arg)) { // ignores the case if 348 | // the arg is just a - 349 | // look for -a (short) or --arg (long) args 350 | if (current_arg[0] == '-') { 351 | err = _end_argument(); 352 | if (err) { 353 | return err; 354 | } 355 | // look for --arg (long) args 356 | if (current_arg[1] == '-') { 357 | err = _begin_argument(current_arg.substr(2), true, argv_index); 358 | if (err) { 359 | return err; 360 | } 361 | } else { // short args 362 | err = _begin_argument(current_arg.substr(1), false, argv_index); 363 | if (err) { 364 | return err; 365 | } 366 | } 367 | } else { // argument value 368 | err = _add_value(current_arg, argv_index); 369 | if (err) { 370 | return err; 371 | } 372 | } 373 | } else { // argument value 374 | err = _add_value(current_arg, argv_index); 375 | if (err) { 376 | return err; 377 | } 378 | } 379 | } 380 | } 381 | if (_help_enabled && exists("help")) { 382 | return Result(); 383 | } 384 | err = _end_argument(); 385 | if (err) { 386 | return err; 387 | } 388 | for (auto &p : _positional_arguments) { 389 | Argument &a = _arguments[static_cast(p.second)]; 390 | if (a._values.size() > 0 && a._values[0][0] == '-') { 391 | std::string name = detail::_ltrim_copy(a._values[0], [](int c) -> bool { 392 | return c != static_cast('-'); 393 | }); 394 | if (_name_map.find(name) != _name_map.end()) { 395 | if (a._position == Argument::Position::LAST) { 396 | return Result( 397 | "Poisitional argument expected at the end, but argument " + 398 | a._values[0] + " found instead"); 399 | } else { 400 | return Result("Poisitional argument expected in position " + 401 | std::to_string(a._position) + ", but argument " + 402 | a._values[0] + " found instead"); 403 | } 404 | } 405 | } 406 | } 407 | for (auto &a : _arguments) { 408 | if (a._required && !a._found) { 409 | return Result("Required argument not found: " + a._names[0]); 410 | } 411 | if (a._position >= 0 && argc >= a._position && !a._found) { 412 | return Result("Argument " + a._names[0] + " expected in position " + 413 | std::to_string(a._position)); 414 | } 415 | } 416 | return Result(); 417 | } 418 | 419 | void enable_help() { 420 | add_argument("-h", "--help", "Shows this page", false); 421 | _help_enabled = true; 422 | } 423 | 424 | bool exists(const std::string &name) const { 425 | std::string n = detail::_ltrim_copy( 426 | name, [](int c) -> bool { return c != static_cast('-'); }); 427 | auto it = _name_map.find(n); 428 | if (it != _name_map.end()) { 429 | return _arguments[static_cast(it->second)]._found; 430 | } 431 | return false; 432 | } 433 | 434 | template 435 | T get(const std::string &name) { 436 | auto t = _name_map.find(name); 437 | if (t != _name_map.end()) { 438 | return _arguments[static_cast(t->second)].get(); 439 | } 440 | return T(); 441 | } 442 | 443 | private: 444 | Result _begin_argument(const std::string &arg, bool longarg, int position) { 445 | auto it = _positional_arguments.find(position); 446 | if (it != _positional_arguments.end()) { 447 | Result err = _end_argument(); 448 | Argument &a = _arguments[static_cast(it->second)]; 449 | a._values.push_back((longarg ? "--" : "-") + arg); 450 | a._found = true; 451 | return err; 452 | } 453 | if (_current != -1) { 454 | return Result("Current argument left open"); 455 | } 456 | size_t name_end = detail::_find_name_end(arg); 457 | std::string arg_name = arg.substr(0, name_end); 458 | if (longarg) { 459 | int equal_pos = detail::_find_equal(arg); 460 | auto nmf = _name_map.find(arg_name); 461 | if (nmf == _name_map.end()) { 462 | return Result("Unrecognized command line option '" + arg_name + "'"); 463 | } 464 | _current = nmf->second; 465 | _arguments[static_cast(nmf->second)]._found = true; 466 | if (equal_pos == 0 || 467 | (equal_pos < 0 && 468 | arg_name.length() < arg.length())) { // malformed argument 469 | return Result("Malformed argument: " + arg); 470 | } else if (equal_pos > 0) { 471 | std::string arg_value = arg.substr(name_end + 1); 472 | _add_value(arg_value, position); 473 | } 474 | } else { 475 | Result r; 476 | if (arg_name.length() == 1) { 477 | return _begin_argument(arg, true, position); 478 | } else { 479 | for (char &c : arg_name) { 480 | r = _begin_argument(std::string(1, c), true, position); 481 | if (r) { 482 | return r; 483 | } 484 | r = _end_argument(); 485 | if (r) { 486 | return r; 487 | } 488 | } 489 | } 490 | } 491 | return Result(); 492 | } 493 | 494 | Result _add_value(const std::string &value, int location) { 495 | if (_current >= 0) { 496 | Result err; 497 | Argument &a = _arguments[static_cast(_current)]; 498 | if (a._count >= 0 && static_cast(a._values.size()) >= a._count) { 499 | err = _end_argument(); 500 | if (err) { 501 | return err; 502 | } 503 | goto unnamed; 504 | } 505 | a._values.push_back(value); 506 | if (a._count >= 0 && static_cast(a._values.size()) >= a._count) { 507 | err = _end_argument(); 508 | if (err) { 509 | return err; 510 | } 511 | } 512 | return Result(); 513 | } else { 514 | unnamed: 515 | auto it = _positional_arguments.find(location); 516 | if (it != _positional_arguments.end()) { 517 | Argument &a = _arguments[static_cast(it->second)]; 518 | a._values.push_back(value); 519 | a._found = true; 520 | } 521 | // TODO 522 | return Result(); 523 | } 524 | } 525 | 526 | Result _end_argument() { 527 | if (_current >= 0) { 528 | Argument &a = _arguments[static_cast(_current)]; 529 | _current = -1; 530 | if (static_cast(a._values.size()) < a._count) { 531 | return Result("Too few arguments given for " + a._names[0]); 532 | } 533 | if (a._count >= 0) { 534 | if (static_cast(a._values.size()) > a._count) { 535 | return Result("Too many arguments given for " + a._names[0]); 536 | } 537 | } 538 | } 539 | return Result(); 540 | } 541 | 542 | bool _help_enabled{false}; 543 | int _current{-1}; 544 | std::string _bin{}; 545 | std::string _desc{}; 546 | std::vector _arguments{}; 547 | std::map _positional_arguments{}; 548 | std::map _name_map{}; 549 | }; 550 | 551 | std::ostream &operator<<(std::ostream &os, const ArgumentParser::Result &r) { 552 | os << r.what(); 553 | return os; 554 | } 555 | template <> 556 | inline std::string ArgumentParser::Argument::get() { 557 | return detail::_join(_values.begin(), _values.end()); 558 | } 559 | template <> 560 | inline std::vector 561 | ArgumentParser::Argument::get>() { 562 | return _values; 563 | } 564 | 565 | } // namespace argparse 566 | #endif 567 | -------------------------------------------------------------------------------- /example.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * License: Apache 2.0 with LLVM Exception or GPL v3 3 | * 4 | * Author: Jesse Laning 5 | */ 6 | 7 | #include 8 | #include 9 | 10 | #include "argparse.h" 11 | 12 | using namespace argparse; 13 | 14 | int main(int argc, const char* argv[]) { 15 | ArgumentParser parser("example", "Argument parser example"); 16 | parser.add_argument() 17 | .names({"-v", "--verbose"}) 18 | .description("verbose level") 19 | .required(true); 20 | parser.add_argument("-t", "--test", "test", true) 21 | .position(ArgumentParser::Argument::Position::LAST); 22 | parser.add_argument("-d", "--dtest", "dtest", true).position(0); 23 | parser.enable_help(); 24 | auto err = parser.parse(argc, argv); 25 | if (err) { 26 | std::cout << err << std::endl; 27 | return -1; 28 | } 29 | 30 | if (parser.exists("help")) { 31 | parser.print_help(); 32 | return 0; 33 | } 34 | 35 | if (parser.exists("v")) { 36 | switch (parser.get("v")) { 37 | case 2: 38 | std::cout << "an even more verbose string" << std::endl; 39 | #ifdef __clang__ 40 | [[clang::fallthrough]]; 41 | #endif 42 | // fall through 43 | case 1: 44 | std::cout << "a verbose string" << std::endl; 45 | #ifdef __clang__ 46 | [[clang::fallthrough]]; 47 | #endif 48 | // fall through 49 | default: 50 | std::cout << "some verbosity" << std::endl; 51 | } 52 | } 53 | 54 | if (parser.exists("test")) { 55 | std::cout << parser.get("test") << std::endl; 56 | } 57 | 58 | if (parser.exists("dtest")) { 59 | std::cout << parser.get("dtest") << std::endl; 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /tests.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * License: Apache 2.0 with LLVM Exception or GPL v3 3 | * 4 | * Author: Jesse Laning 5 | */ 6 | 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | 13 | #include "argparse.h" 14 | 15 | using namespace argparse; 16 | 17 | struct result { 18 | bool pass; 19 | int line; 20 | std::string condition; 21 | std::string msg; 22 | std::string test; 23 | }; 24 | 25 | #define TASSERT(condition, msg) \ 26 | if (!(condition)) { \ 27 | return {false, __LINE__, #condition, msg, ""}; \ 28 | } 29 | 30 | #define TEST(name, code, ...) \ 31 | result name(); \ 32 | result name() { \ 33 | const char* argv[] = {#name, ##__VA_ARGS__}; \ 34 | int argc = sizeof(argv) / sizeof(argv[0]); \ 35 | ArgumentParser parser(#name, #name); \ 36 | code; \ 37 | return {true, 0, "", "", ""}; \ 38 | } 39 | 40 | TEST( 41 | no_args, { 42 | auto err = parser.parse(argc, argv); 43 | TASSERT(!err, err.what()) 44 | }, ) 45 | 46 | TEST( 47 | short_optional_flag_exists, 48 | { 49 | parser.add_argument("-f", "a flag", false); 50 | 51 | auto err = parser.parse(argc, argv); 52 | TASSERT(!err, err.what()) 53 | 54 | TASSERT(parser.exists("f"), "flag not found") 55 | }, 56 | "-f") 57 | 58 | TEST( 59 | short_optional_flag_does_not_exist, { 60 | parser.add_argument("-f", "a flag", false); 61 | 62 | auto err = parser.parse(argc, argv); 63 | TASSERT(!err, err.what()) 64 | 65 | TASSERT(!parser.exists("f"), "flag found") 66 | }, ) 67 | 68 | TEST( 69 | short_required_flag_exists, 70 | { 71 | parser.add_argument("-f", "a flag", true); 72 | 73 | auto err = parser.parse(argc, argv); 74 | TASSERT(!err, err.what()) 75 | 76 | TASSERT(parser.exists("f"), "required flag not found") 77 | }, 78 | "-f") 79 | 80 | TEST( 81 | short_required_flag_does_not_exist, { 82 | parser.add_argument("-f", "a flag", true); 83 | 84 | auto err = parser.parse(argc, argv); 85 | TASSERT(err, err.what()) 86 | }, ) 87 | 88 | TEST( 89 | long_optional_flag_exists, 90 | { 91 | parser.add_argument("--flag", "a flag", false); 92 | 93 | auto err = parser.parse(argc, argv); 94 | TASSERT(!err, err.what()) 95 | 96 | TASSERT(parser.exists("flag"), "flag not found") 97 | }, 98 | "--flag") 99 | 100 | TEST( 101 | long_required_flag_exists, 102 | { 103 | parser.add_argument("--flag", "a flag", true); 104 | 105 | auto err = parser.parse(argc, argv); 106 | TASSERT(!err, err.what()) 107 | 108 | TASSERT(parser.exists("flag"), "required flag not found") 109 | }, 110 | "--flag") 111 | 112 | TEST( 113 | long_required_flag_does_not_exist, { 114 | parser.add_argument("--flag", "a flag", true); 115 | 116 | auto err = parser.parse(argc, argv); 117 | TASSERT(err, err.what()) 118 | }, ) 119 | 120 | TEST( 121 | long_short_optional_flag_pair_exists, 122 | { 123 | parser.add_argument("-f", "--flag", "a flag", false); 124 | parser.add_argument("-t", "--test", "a flag", false); 125 | 126 | auto err = parser.parse(argc, argv); 127 | TASSERT(!err, err.what()) 128 | 129 | TASSERT(parser.exists("flag"), "flag not found") 130 | TASSERT(parser.exists("f"), "flag not found") 131 | TASSERT(parser.exists("test"), "flag not found") 132 | TASSERT(parser.exists("t"), "flag not found") 133 | }, 134 | "--flag", "-t") 135 | 136 | TEST( 137 | short_combined_flags, 138 | { 139 | parser.add_argument("-f", "a flag", false); 140 | parser.add_argument("-g", "a flag", false); 141 | 142 | parser.add_argument("-i", "a flag", false); 143 | parser.add_argument("-j", "a flag", false); 144 | 145 | auto err = parser.parse(argc, argv); 146 | TASSERT(!err, err.what()) 147 | 148 | TASSERT(parser.exists("f"), "f flag not found") 149 | TASSERT(parser.exists("g"), "g flag not found") 150 | TASSERT(parser.exists("i"), "f flag not found") 151 | TASSERT(parser.exists("j"), "g flag not found") 152 | }, 153 | "-fg", "-ji") 154 | 155 | TEST( 156 | vector_flag_empty, 157 | { 158 | parser.add_argument("-v", "a flag", false); 159 | 160 | auto err = parser.parse(argc, argv); 161 | TASSERT(!err, err.what()) 162 | 163 | TASSERT(parser.exists("v"), "flag not found") 164 | auto v = parser.get>("v"); 165 | TASSERT(v.size() == 0, "wrong vector values") 166 | }, 167 | "-v") 168 | 169 | TEST( 170 | vector_flag, 171 | { 172 | parser.add_argument("-v", "a flag", false); 173 | 174 | auto err = parser.parse(argc, argv); 175 | TASSERT(!err, err.what()) 176 | 177 | TASSERT(parser.exists("v"), "flag not found") 178 | auto v = parser.get>("v"); 179 | TASSERT(v.size() == 5, "wrong vector values") 180 | }, 181 | "-v", "1", "2", "3", "4", "5") 182 | 183 | TEST( 184 | short_and_vector_flag, 185 | { 186 | parser.add_argument("-v", "a flag", false); 187 | parser.add_argument("-b", "a flag", false); 188 | parser.add_argument("-f", "a flag", false); 189 | 190 | auto err = parser.parse(argc, argv); 191 | TASSERT(!err, err.what()) 192 | 193 | TASSERT(parser.exists("b"), "flag not found") 194 | TASSERT(parser.exists("v"), "flag not found") 195 | TASSERT(parser.exists("f"), "flag not found") 196 | auto v = parser.get>("v"); 197 | TASSERT(v.size() == 5, "wrong vector values") 198 | }, 199 | "-b", "0", "-v", "1", "2", "3", "4", "5", "-f", "6", "7", "8") 200 | 201 | TEST( 202 | short_help_flag, 203 | { 204 | parser.enable_help(); 205 | auto err = parser.parse(argc, argv); 206 | TASSERT(!err, err.what()) 207 | TASSERT(parser.exists("h"), "help not found") 208 | parser.print_help(); 209 | }, 210 | "-h") 211 | 212 | TEST( 213 | long_help_flag, 214 | { 215 | parser.enable_help(); 216 | auto err = parser.parse(argc, argv); 217 | TASSERT(!err, err.what()) 218 | TASSERT(parser.exists("help"), "help not found") 219 | parser.print_help(); 220 | }, 221 | "--help") 222 | 223 | TEST( 224 | flag_values, 225 | { 226 | parser.add_argument("-f", "--flag", "a flag", true); 227 | parser.add_argument("-t", "--test", "a flag", true); 228 | parser.add_argument("-g", "a flag", true); 229 | 230 | auto err = parser.parse(argc, argv); 231 | TASSERT(!err, err.what()) 232 | 233 | TASSERT(parser.exists("flag"), "flag not found") 234 | TASSERT(parser.get("flag") == 2, "wrong flag value") 235 | TASSERT(parser.exists("t"), "flag not found") 236 | TASSERT(parser.get("t") == 3, "wrong flag value") 237 | TASSERT(parser.exists("g"), "flag not found") 238 | TASSERT(std::abs(parser.get("g") - 0.125) < 0.0000000001, 239 | "wrong flag value") 240 | }, 241 | "-f", "2", "--test", "3", "-g", "0.125") 242 | 243 | TEST( 244 | arg_count, 245 | { 246 | size_t c = 4; 247 | parser.add_argument("-f", "--flag", "a flag", true) 248 | .count(static_cast(c)); 249 | 250 | auto err = parser.parse(argc, argv); 251 | TASSERT(!err, err.what()) 252 | 253 | TASSERT(parser.get>("f").size() == c, 254 | "Wrong vector count") 255 | }, 256 | "-f", "a", "b", "1", "2") 257 | 258 | TEST( 259 | arg_count_more, 260 | { 261 | // This test should pass because it will treat the last argument as a 262 | // free/positional argument 263 | size_t c = 4; 264 | parser.add_argument("-f", "--flag", "a flag", true) 265 | .count(static_cast(c)); 266 | 267 | auto err = parser.parse(argc, argv); 268 | TASSERT(!err, err.what()) 269 | 270 | TASSERT(parser.get>("f").size() == c, 271 | "Wrong vector count") 272 | }, 273 | "-f", "a", "b", "1", "2", "3") 274 | 275 | TEST( 276 | arg_count_less, 277 | { 278 | size_t c = 4; 279 | parser.add_argument("-f", "--flag", "a flag", true) 280 | .count(static_cast(c)); 281 | parser.add_argument("-b", "--bbbb", "a flag", true).count(1); 282 | 283 | auto err = parser.parse(argc, argv); 284 | TASSERT(err, err.what()) 285 | 286 | TASSERT(parser.get>("f").size() == c - 1 && 287 | parser.get>("b").size() == 0, 288 | "Wrong vector count") 289 | }, 290 | "-f", "a", "b", "1", "-b") 291 | 292 | TEST( 293 | arg_count_zero, 294 | { 295 | parser.add_argument("-f", "--flag", "a flag", true).count(0); 296 | parser.add_argument("-b", "--bbbb", "a flag", true).count(0); 297 | parser.add_argument("-c", "--cccc", "a flag", true).count(0); 298 | 299 | auto err = parser.parse(argc, argv); 300 | TASSERT(!err, err.what()) 301 | 302 | TASSERT(parser.get>("f").size() == 0, 303 | "Wrong vector count") 304 | TASSERT(parser.get>("b").size() == 0, 305 | "Wrong vector count") 306 | TASSERT(parser.get>("c").size() == 0, 307 | "Wrong vector count") 308 | }, 309 | "-f", "a", "b", "1", "-b", "a", "-c") 310 | 311 | TEST( 312 | positional_argument_found, 313 | { 314 | parser.add_argument("-f", "--flag", "a flag", true).count(0); 315 | parser.add_argument().name("--file").position(3); 316 | 317 | auto err = parser.parse(argc, argv); 318 | TASSERT(!err, err.what()) 319 | 320 | TASSERT(parser.get("file") == "myfile", 321 | "Positional argument error") 322 | }, 323 | "-f", "1", "2", "myfile", "asdf") 324 | 325 | TEST( 326 | positional_argument_not_found, 327 | { 328 | parser.add_argument("-f", "--flag", "a flag", true).count(0); 329 | parser.add_argument().name("--file").position(3).required(true); 330 | 331 | auto err = parser.parse(argc, argv); 332 | TASSERT(err, err.what()) 333 | }, 334 | "-f", "1", "2") 335 | 336 | TEST( 337 | positional_argument_overrun, 338 | { 339 | parser.add_argument("-f", "--flag", "a flag", true).count(3); 340 | parser.add_argument().name("--file").position(3).required(true); 341 | 342 | auto err = parser.parse(argc, argv); 343 | TASSERT(err, err.what()) 344 | }, 345 | "-f", "1", "2", "myfile", "asdf") 346 | 347 | TEST( 348 | positional_argument_last, 349 | { 350 | parser.add_argument("-f", "--flag", "a flag", true).count(1); 351 | parser.add_argument() 352 | .name("--file") 353 | .position(ArgumentParser::Argument::Position::LAST) 354 | .required(true); 355 | 356 | auto err = parser.parse(argc, argv); 357 | TASSERT(!err, err.what()) 358 | 359 | TASSERT(parser.get("file") == "asdf", 360 | "Positional argument error") 361 | }, 362 | "-f", "1", "2", "myfile", "asdf") 363 | 364 | TEST( 365 | positional_argument_last_override, 366 | { 367 | parser.add_argument("-f", "--flag", "a flag", true).count(4); 368 | parser.add_argument() 369 | .name("--file") 370 | .position(ArgumentParser::Argument::Position::LAST) 371 | .required(true); 372 | 373 | auto err = parser.parse(argc, argv); 374 | TASSERT(err, err.what()) 375 | 376 | TASSERT(parser.get("file") == "asdf", 377 | "Positional argument error") 378 | }, 379 | "-f", "1", "2", "myfile", "asdf") 380 | 381 | #define TT(name) \ 382 | { #name, name } 383 | using test = std::function; 384 | 385 | int main(int argc, const char* argv[]) { 386 | std::unordered_map tests{ 387 | TT(no_args), 388 | TT(short_optional_flag_exists), 389 | TT(short_optional_flag_does_not_exist), 390 | TT(short_required_flag_exists), 391 | TT(short_required_flag_does_not_exist), 392 | TT(long_optional_flag_exists), 393 | TT(long_short_optional_flag_pair_exists), 394 | TT(short_combined_flags), 395 | TT(vector_flag_empty), 396 | TT(vector_flag), 397 | TT(short_and_vector_flag), 398 | TT(long_required_flag_exists), 399 | TT(long_required_flag_does_not_exist), 400 | TT(short_help_flag), 401 | TT(long_help_flag), 402 | TT(flag_values), 403 | TT(arg_count), 404 | TT(arg_count_more), 405 | TT(arg_count_less), 406 | TT(arg_count_zero), 407 | TT(positional_argument_found), 408 | TT(positional_argument_not_found), 409 | TT(positional_argument_overrun), 410 | TT(positional_argument_last), 411 | TT(positional_argument_last_override)}; 412 | 413 | std::vector results; 414 | size_t passed = 0; 415 | if (argc > 1) { 416 | for (auto i = 1; i < argc; i++) { 417 | auto t = tests.find(argv[i]); 418 | if (t != tests.end()) { 419 | std::cout << t->first << std::endl; 420 | result r = t->second(); 421 | r.test = t->first; 422 | if (!r.pass) { 423 | std::cout << "***********************FAILURE***********************" 424 | << std::endl 425 | << "Line " << r.line << ": " << r.condition << std::endl 426 | << r.msg << std::endl 427 | << "*****************************************************" 428 | << std::endl 429 | << std::endl; 430 | } 431 | results.push_back(r); 432 | passed += static_cast(r.pass); 433 | } 434 | } 435 | } else { 436 | for (auto& t : tests) { 437 | std::cout << t.first << std::endl; 438 | result r = t.second(); 439 | r.test = t.first; 440 | if (!r.pass) { 441 | std::cout << "***********************FAILURE***********************" 442 | << std::endl 443 | << "Line " << r.line << ": " << r.condition << std::endl 444 | << r.msg << std::endl 445 | << "*****************************************************" 446 | << std::endl 447 | << std::endl; 448 | } 449 | results.push_back(r); 450 | passed += static_cast(r.pass); 451 | } 452 | } 453 | std::cout << "Passed: " << passed << "/" << results.size() << std::endl; 454 | return static_cast(results.size() - passed); 455 | } 456 | --------------------------------------------------------------------------------