LICENSE, copyright, and formatting

.gitignore

@@ -1,2 +1 @@
-build
+build
-.vscode

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "C_Cpp.clang_format_fallbackStyle": "Google",
+    "C_Cpp.clang_format_style": "{ColumnLimit: 100}"
+}

CMakeLists.txt

@@ -1,3 +1,5 @@
+# copyright Carl Pearson, 2022
+
 # 3.0: version
 cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
 

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -16,7 +16,7 @@ Download the latest [`argparse.hpp`](https://raw.githubusercontent.com/cwpearson
 int main(int argc, char **argv) {
 
   // A parser object
-  argparse::Parser p("a cwpearson/argparse-powered CLI app");
+  argparse::Parser p;
 
   // Program data corresponding to flags, options, and positional arguments
   bool verbose = false;
@@ -24,12 +24,10 @@ int main(int argc, char **argv) {
   std::string maybePrint;
   int repeats = 2;
 
-  // Inform the parser of the program data. It will do type-specific conversion
+  // Inform the parser of the program data. It will do type-specific conversionfrom string.
-  // from string.
 
   // An option invoked with `--repeat N`
-  p.add_option(repeats, "--repeat")
+  p.add_option(repeats, "--repeat")->help("how many times to repeat first argument");
-      ->help("how many times to repeat first argument");
   // A flag invoked with `--verbose` or `-v`
   p.add_flag(verbose, "--verbose", "-v");
   // a required positional argument (position 1)
@@ -190,3 +188,9 @@ if (p.need_help()) {
 - [ ] support `--long-option=value`
 - [ ] allow the last positional argument to fill an `std::vector`
 - [ ] improve help formatting
+
+## License and Copyright
+
+Copyright Carl Pearson 2022
+
+Licensed under Apache 2.0 (see LICENSE for details).

examples/CMakeLists.txt

@@ -1,3 +1,5 @@
+# copyright Carl Pearson, 2022
+
 macro(add_args tgt)
 target_compile_options(
   ${tgt}

examples/example1.cpp

@@ -1,3 +1,5 @@
+// copyright Carl Pearson, 2022
+
 #include "argparse/argparse.hpp"
 
 int main(int argc, char **argv) {
@@ -11,12 +13,10 @@ int main(int argc, char **argv) {
   std::string maybePrint;
   int repeats = 2;
 
-  // Inform the parser of the program data. It will do type-specific conversion
+  // Inform the parser of the program data. It will do type-specific conversionfrom string.
-  // from string.
 
   // An option invoked with `--repeat N`
-  p.add_option(repeats, "--repeat")
+  p.add_option(repeats, "--repeat")->help("how many times to repeat first argument");
-      ->help("how many times to repeat first argument");
   // A flag invoked with `--verbose` or `-v`
   p.add_flag(verbose, "--verbose", "-v");
   // a required positional argument (position 1)

include/argparse/argparse.hpp

@@ -1,3 +1,5 @@
+// copyright Carl Pearson, 2022
+
 #pragma once
 
 #include <iostream>
@@ -100,8 +102,7 @@ class Flag {
   bool *val_;
 
 public:
-  Flag(bool &val, const std::string &l, const std::string &s)
+  Flag(bool &val, const std::string &l, const std::string &s) : long_(l), short_(s), val_(&val) {}
-      : long_(l), short_(s), val_(&val) {}
 
   const std::string &long_str() const noexcept { return long_; }
   const std::string &short_str() const noexcept { return short_; }
@@ -153,8 +154,7 @@ public:
 private:
   const char *type_str() override { return detail::type_str<T>(); }
 
-  template <typename C>
+  template <typename C> void get_as(C *, const std::string &val) { // to be overridden
-  void get_as(C *, const std::string &val) { // to be overridden
   }
   void set_val(size_t *, const std::string &val) { // convert to size_t
     *val_ = std::stoull(val);
@@ -222,13 +222,12 @@ class Parser {
 
 public:
   Parser()
-      : description_("an argparse-powered program"), noUnrecognized_(false),
+      : description_("an argparse-powered program"), noUnrecognized_(false), help_(false),
-        help_(false), consume_(true) {
+        consume_(true) {
     add_flag(help_, "--help", "-h")->help("Print help message");
   }
   Parser(const std::string &description)
-      : description_(description), noUnrecognized_(false), help_(false),
+      : description_(description), noUnrecognized_(false), help_(false), consume_(true) {
-        consume_(true) {
     add_flag(help_, "--help", "-h")->help("Print help message");
   }
 
@@ -279,8 +278,8 @@ public:
           ++pi;
         } else {
           newArgv.push_back(argv[i]);
-          std::cerr << "encountered unexpected positional argument " << pi
+          std::cerr << "encountered unexpected positional argument " << pi << ": " << argv[i]
-                    << ": " << argv[i] << "\n";
+                    << "\n";
         }
       }
     }
@@ -303,8 +302,7 @@ public:
   };
 
   template <typename T>
-  OptionBase *add_option(T &val, const std::string &l,
+  OptionBase *add_option(T &val, const std::string &l, const std::string &s = "") {
-                         const std::string &s = "") {
     opts_.push_back(new Option<T>(val, l, s));
     return opts_.back();
   }

test/CMakeLists.txt

@@ -1,3 +1,5 @@
+# copyright Carl Pearson, 2022
+
 macro(add_args tgt)
 target_compile_options(
   ${tgt}

test/test_argparse.cpp

@@ -1,3 +1,5 @@
+// copyright Carl Pearson, 2022
+
 #include "catch2/catch.hpp"
 
 #include <iostream>
@@ -7,7 +9,7 @@
 TEST_CASE("argparse") {
 
   SECTION("no args") {
-    char ** argv = nullptr;
+    char **argv = nullptr;
     int argc = 0;
     argparse::Parser p;
     REQUIRE(p.parse(argc, argv));
@@ -22,10 +24,9 @@ TEST_CASE("argparse") {
 
   SECTION("types") {
     char *argv[] = {
-        "some-exe", "--campi", "--f", "10", "1.7", "1.8",
+        "some-exe",   "--campi", "--f", "10", "1.7", "1.8",
         "--", // stop looking for options
-        "--a string",
+        "--a string", "-6",
-        "-6",
     };
     int argc = sizeof(argv) / sizeof(argv[0]);
 
@@ -58,7 +59,6 @@ TEST_CASE("argparse") {
     REQUIRE(argc == 2); // does not use --f or some-exe
   }
 
-
   SECTION("description") {
     char *argv[] = {
         "some-exe",
@@ -131,7 +131,7 @@ TEST_CASE("argparse") {
     char *argv[] = {"some-exe", "--flag", "--", "--", "aa"};
     int argc = sizeof(argv) / sizeof(argv[0]);
 
-    std::string a,b;
+    std::string a, b;
     bool flag = false;
 
     argparse::Parser p;
@@ -139,14 +139,12 @@ TEST_CASE("argparse") {
     p.add_positional(a);
     p.add_positional(b);
 
-
     REQUIRE(true == p.parse(argc, argv));
     REQUIRE(!p.need_help());
 
     REQUIRE(a == "--");
     REQUIRE(b == "aa");
     REQUIRE(flag == true);
-
   }
 
   SECTION("-- in option") {
@@ -159,13 +157,10 @@ TEST_CASE("argparse") {
     p.add_option(option, "--option");
     p.add_positional(a);
 
-
     REQUIRE(true == p.parse(argc, argv));
     REQUIRE(!p.need_help());
 
     REQUIRE(a == "aa");
     REQUIRE(option == "--");
-
   }
-
 }

test/test_main.cpp

@@ -1,2 +1,4 @@
-#define CATCH_CONFIG_MAIN  // This tells Catch to provide a main() - only do this in one cpp file
+// copyright Carl Pearson, 2022
+
+#define CATCH_CONFIG_MAIN // This tells Catch to provide a main() - only do this in one cpp file
 #include "catch2/catch.hpp"