[WIP] argparse

Author: toroidal-code

.vscode/launch.json

@@ -3,9 +3,10 @@
   "configurations": [
     {
       "type": "lldb",
+      "preLaunchTask": "CMake: build",
       "request": "launch",
       "name": "Launch",
-      "program": "${workspaceFolder}/build/spec/spec_runner.exe",
+      "program": "${workspaceFolder}/build/examples/sample/jasmine_intro.exe",
       "args": [],
       "cwd": "${workspaceFolder}"
     },

CMakeLists.txt

@@ -1,4 +1,5 @@
 cmake_minimum_required(VERSION 3.27 FATAL_ERROR)
+
 if(IWYU)
   find_program(iwyu_path NAMES include-what-you-use iwyu)
 endif(IWYU)
@@ -11,31 +12,30 @@ cmake_policy(SET CMP0135 NEW)
 
 include(FetchContent)
 
-# FetchContent_Declare(argparse
-#   GIT_REPOSITORY https://github.com/p-ranav/argparse/
-#   GIT_TAG        v2.9
-# )
-# FetchContent_MakeAvailable(argparse)
+FetchContent_Declare(argparse
+  GIT_REPOSITORY https://github.com/p-ranav/argparse/
+  GIT_TAG v2.9
+)
+FetchContent_MakeAvailable(argparse)
 
 FetchContent_Declare(cxx-prettyprint
   GIT_REPOSITORY https://github.com/louisdx/cxx-prettyprint
-  GIT_TAG        master
+  GIT_TAG master
 )
 FetchContent_MakeAvailable(cxx-prettyprint)
 
 add_library(cxx-prettyprint INTERFACE)
 target_sources(cxx-prettyprint INTERFACE ${cxx-prettyprint_SOURCE_DIR}/prettyprint.hpp)
 target_include_directories(cxx-prettyprint INTERFACE ${cxx-prettyprint_SOURCE_DIR})
 
-
 add_library(c++spec INTERFACE)
 target_include_directories(c++spec INTERFACE
   $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/>
   $<INSTALL_INTERFACE:include/cppspec/> # <prefix>/include/cppspec
 )
 target_link_libraries(c++spec INTERFACE
   cxx-prettyprint
-#  argparse
+  argparse
 )
 
 FILE(GLOB_RECURSE c++spec_headers ${CMAKE_CURRENT_LIST_DIR}/include/*.hpp)
@@ -62,47 +62,46 @@ if(BUILD_EXAMPLES)
   endif()
 endif(BUILD_EXAMPLES)
 
-
 # ##### Documentation generation #######
 # check if Doxygen is installed
 find_package(Doxygen
     OPTIONAL_COMPONENTS dot mscgen dia
 )
 
 if(DOXYGEN_FOUND)
-    if(NOT ${DOXYGEN_HAVE_DOT})
-        message(
-            "Can't find GraphViz DOT tool for generating images."
-            "Make sure it's on your PATH or install GraphViz")
-    endif()
-    
-    FetchContent_Declare(doxygen-awesome-css
-      URL      https://github.com/jothepro/doxygen-awesome-css/archive/refs/tags/v2.2.1.tar.gz
+  if(NOT ${DOXYGEN_HAVE_DOT})
+    message(
+      "Can't find GraphViz DOT tool for generating images."
+      "Make sure it's on your PATH or install GraphViz")
+  endif()
+
+  FetchContent_Declare(doxygen-awesome-css
+      URL https://github.com/jothepro/doxygen-awesome-css/archive/refs/tags/v2.2.1.tar.gz
       URL_HASH MD5=340d3a206794ac01a91791c2a513991f
-    )
-    FetchContent_MakeAvailable(doxygen-awesome-css)
+  )
+  FetchContent_MakeAvailable(doxygen-awesome-css)
 
-    set(DOXYGEN_PROJECT_NAME "C++Spec")
-    set(DOXYGEN_PROJECT_BRIEF "BDD testing for C++")
-    set(DOXYGEN_RECURSIVE YES)
-    set(DOXYGEN_EXAMPLE_RECURSIVE YES)
-    set(DOXYGEN_EXCLUDE_PATTERNS "*/cxx-prettyprint/*")
-    set(DOXYGEN_NUM_PROC_THREADS ${HOST_NUM_CORES})
+  set(DOXYGEN_PROJECT_NAME "C++Spec")
+  set(DOXYGEN_PROJECT_BRIEF "BDD testing for C++")
+  set(DOXYGEN_RECURSIVE YES)
+  set(DOXYGEN_EXAMPLE_RECURSIVE YES)
+  set(DOXYGEN_EXCLUDE_PATTERNS "*/cxx-prettyprint/*")
+  set(DOXYGEN_NUM_PROC_THREADS ${HOST_NUM_CORES})
 
-    # From doxygen-awesome
-    set(DOXYGEN_GENERATE_TREEVIEW YES)
-    set(DOXYGEN_DISABLE_INDEX NO)
-    set(DOXYGEN_FULL_SIDEBAR NO)
-    set(DOXYGEN_HTML_COLORSTYLE LIGHT)
-    set(DOXYGEN_HTML_EXTRA_STYLESHEET "${doxygen-awesome-css_SOURCE_DIR}/doxygen-awesome.css")
+  # From doxygen-awesome
+  set(DOXYGEN_GENERATE_TREEVIEW YES)
+  set(DOXYGEN_DISABLE_INDEX NO)
+  set(DOXYGEN_FULL_SIDEBAR NO)
+  set(DOXYGEN_HTML_COLORSTYLE LIGHT)
+  set(DOXYGEN_HTML_EXTRA_STYLESHEET "${doxygen-awesome-css_SOURCE_DIR}/doxygen-awesome.css")
 
-    set(DOXYGEN_USE_MDFILE_AS_MAINPAGE README.md)
+  set(DOXYGEN_USE_MDFILE_AS_MAINPAGE README.md)
 
-    file(GLOB markdown_SOURCES *.md)
+  file(GLOB markdown_SOURCES *.md)
 
-    doxygen_add_docs(doxygen ${markdown_SOURCES} include)
+  doxygen_add_docs(doxygen ${markdown_SOURCES} include)
 else(DOXYGEN_FOUND)
-    message(WARNING
-        "Doxygen needs to be installed to generate documentation."
-        "Please install from https://github.com/doxygen/doxygen/releases")
+  message(WARNING
+    "Doxygen needs to be installed to generate documentation."
+    "Please install from https://github.com/doxygen/doxygen/releases")
 endif(DOXYGEN_FOUND)

examples/sample/example_spec.cpp

@@ -3,6 +3,7 @@
 #include <cstring>
 #include <list>
 #include "cppspec.hpp"
+#include "formatters/verbose.hpp"
 
 describe bool_spec("Some Tests", $ {
   context("true is", _ {
@@ -192,12 +193,12 @@ describe list_spec("A list spec", $ {
 
 /* Here is the declaration of fabs description defined in an other file (fabs_spec.c in this sample)*/
 int main(){
-  return CppSpec::Runner(CppSpec::Formatters::verbose)
+  return CppSpec::Runner()
              .add_spec(bool_spec)
              .add_spec(abs_spec)
              .add_spec(strcmp_spec)
              .add_spec(vector_spec)
              .add_spec(let_spec)
              .add_spec(list_spec)
-             .exec() ? EXIT_SUCCESS : EXIT_FAILURE;
+             .exec<CppSpec::Formatters::Verbose>() ? EXIT_SUCCESS : EXIT_FAILURE;
 }

examples/sample/jasmine_intro.cpp

@@ -1,6 +1,7 @@
 // Copyright 2016 Katherine Whitlock
 
 #include "cppspec.hpp"
+#include "formatters/verbose.hpp"
 
 describe a_suite("A suite", $ {
   it("contains a spec with an expectation", _ {
@@ -244,7 +245,7 @@ describe a_spec_nesting("A spec", $ {
 
 // TODO: pending specs
 
-describe to_include_matcher("to contain", $ {
+auto to_include_matcher = describe("to contain", $ {
   let(foo, ([]() -> std::vector<int> { return {1,2,3,4}; }));
 
   it("matches arrays with some of the values", _ {
@@ -253,8 +254,8 @@ describe to_include_matcher("to contain", $ {
   });
 });
 
-int main() {
-  return CppSpec::Runner(CppSpec::Formatters::verbose)
+int main(int argc, char** argv) {
+  return CppSpec::Runner()
              .add_spec(a_suite)
              .add_spec(suite_object)
              .add_spec(to_be_compare)
@@ -265,5 +266,5 @@ int main() {
              .add_spec(a_spec_before_each)
              .add_spec(a_spec_nesting)
              .add_spec(to_include_matcher)
-             .exec() ? EXIT_SUCCESS : EXIT_FAILURE;
+             .exec<CppSpec::Formatters::Verbose>() ? EXIT_SUCCESS : EXIT_FAILURE;
 }

include/argparse.hpp

@@ -0,0 +1,67 @@
+#pragma once
+
+#include <argparse/argparse.hpp>
+#include <string_view>
+
+#include "argparse.hpp"
+#include "formatters/formatters_base.hpp"
+
+namespace CppSpec {
+constexpr std::string file_name(std::string_view path) {
+  std::string_view file = path;
+  for (size_t i = 0; i < path.size(); ++i) {
+    if (path[i] == '/') {
+      file = &path[i + 1];
+    }
+  }
+  return std::string{file};
+}
+
+enum class Formatter {
+  Progress,
+  TAP,
+  Detail
+};
+
+struct RuntimeOpts {
+  bool verbose = false;
+  Formatter format = Formatter::Progress;
+};
+
+inline RuntimeOpts parse(int argc, char** argv) {
+  argparse::ArgumentParser program(file_name(__FILE__));
+
+  program.add_argument("-f", "--format")
+      .default_value(std::string{"p"})
+      .required()
+      .help("set the output format");
+
+  program.add_argument("--verbose")
+      .help("increase output verbosity")
+      .default_value(false)
+      .implicit_value(true);
+
+  try {
+    program.parse_args(argc, argv);
+  } catch (const std::runtime_error& err) {
+    std::cerr << err.what() << std::endl;
+    std::cerr << program;
+    std::exit(1);
+  }
+
+  RuntimeOpts opts;
+
+  if (program["--verbose"] == true) {
+    opts.verbose = true;
+  }
+
+  auto format_string  = program.get<std::string>("--format");
+  if (format_string == "p" || format_string == "progress") {
+    opts.format = Formatter::Progress;
+  } else if (format_string == "t" || format_string == "tap") {
+    opts.format = Formatter::TAP;
+  } else if (format_string == "d" || format_string == "detail") {
+    opts.format = Formatter::Detail;
+  }
+}
+}  // namespace CppSpec

include/cppspec.hpp

@@ -6,9 +6,6 @@
 #define CPPSPEC_HPP
 #pragma once
 
-#ifndef CPPSPEC_DEBUG
-#define CPPSPEC_DEBUG false
-#endif
 #include "runner.hpp"
 
 /*>>>>>>>>>>>>>>>>>>>> MACROS <<<<<<<<<<<<<<<<<<<<<<*/
@@ -41,7 +38,7 @@
 
 /*>>>>>>>>>>>>>>>>>>> TYPEDEFS <<<<<<<<<<<<<<<<<<<<<*/
 
-typedef CppSpec::Description describe;
+using describe = CppSpec::Description;
 
 template <class T>
 using describe_a = CppSpec::ClassDescription<T>;

include/description.hpp

@@ -6,12 +6,13 @@
 #define CPPSPEC_DESCRIPTION_HPP
 #pragma once
 
-#include <string>
 #include <deque>
-#include <queue>
 #include <forward_list>
-#include "it.hpp"
+#include <queue>
+#include <string>
+
 #include "class_description.hpp"
+#include "it.hpp"
 
 namespace CppSpec {
 
@@ -45,21 +46,20 @@ class Description : public Runnable {
       : description(description) {}
 
   Description(const Child &parent, std::string description,
-              Block block) noexcept : Runnable(parent),
-                                      block(block),
-                                      description(description) {}
+              Block block) noexcept
+      : Runnable(parent), block(block), description(description) {}
 
   void exec_before_eaches();
   void exec_after_eaches();
 
  public:
   // Copy constructor
   Description(const Description &copy) = default;
+  Description(Description &&copy) = default;
 
   // Primary constructor. Entry of all specs.
   Description(std::string description, Block block) noexcept
-      : block(block),
-        description(description) {}
+      : block(block), description(description) {}
 
   /********* Specify/It *********/
 
@@ -68,7 +68,7 @@ class Description : public Runnable {
 
   /********* Context ***********/
 
-  template <class T=std::nullptr_t>
+  template <class T = std::nullptr_t>
   Result context(std::string name, Block body);
 
   template <class T>
@@ -103,6 +103,9 @@ class Description : public Runnable {
   /********* Run *********/
 
   Result run(Formatters::BaseFormatter &printer) override;
+  // std::function<int(int, char **)>
+  template <typename Formatter>
+  inline auto as_main();
 };
 
 using Context = Description;

include/formatters/term_colors.hpp

@@ -2,24 +2,25 @@
 #ifndef CPPSPEC_TERM_COLORS_HPP
 #define CPPSPEC_TERM_COLORS_HPP
 #pragma once
+#include <string_view>
 
 // the following are Unix/BASH ONLY terminal color codes.
-#define RESET std::string("\033[0m")
-#define BLACK std::string("\033[30m")              /* Black */
-#define RED std::string("\033[31m")                /* Red */
-#define GREEN std::string("\033[32m")              /* Green */
-#define YELLOW std::string("\033[33m")             /* Yellow */
-#define BLUE std::string("\033[34m")               /* Blue */
-#define MAGENTA std::string("\033[35m")            /* Magenta */
-#define CYAN std::string("\033[36m")               /* Cyan */
-#define WHITE std::string("\033[37m")              /* White */
-#define BOLDBLACK std::string("\033[1m\033[30m")   /* Bold Black */
-#define BOLDRED std::string("\033[1m\033[31m")     /* Bold Red */
-#define BOLDGREEN std::string("\033[1m\033[32m")   /* Bold Green */
-#define BOLDYELLOW std::string("\033[1m\033[33m")  /* Bold Yellow */
-#define BOLDBLUE std::string("\033[1m\033[34m")    /* Bold Blue */
-#define BOLDMAGENTA std::string("\033[1m\033[35m") /* Bold Magenta */
-#define BOLDCYAN std::string("\033[1m\033[36m")    /* Bold Cyan */
-#define BOLDWHITE std::string("\033[1m\033[37m")   /* Bold White */
+constexpr std::string_view RESET("\033[0m");
+constexpr std::string_view BLACK("\033[30m");              /* Black */
+constexpr std::string_view RED("\033[31m");                /* Red */
+constexpr std::string_view GREEN("\033[32m");              /* Green */
+constexpr std::string_view YELLOW("\033[33m");             /* Yellow */
+constexpr std::string_view BLUE("\033[34m");               /* Blue */
+constexpr std::string_view MAGENTA("\033[35m");            /* Magenta */
+constexpr std::string_view CYAN("\033[36m");               /* Cyan */
+constexpr std::string_view WHITE("\033[37m");              /* White */
+constexpr std::string_view BOLDBLACK("\033[1m\033[30m");   /* Bold Black */
+constexpr std::string_view BOLDRED("\033[1m\033[31m");     /* Bold Red */
+constexpr std::string_view BOLDGREEN("\033[1m\033[32m");   /* Bold Green */
+constexpr std::string_view BOLDYELLOW("\033[1m\033[33m");  /* Bold Yellow */
+constexpr std::string_view BOLDBLUE("\033[1m\033[34m");    /* Bold Blue */
+constexpr std::string_view BOLDMAGENTA("\033[1m\033[35m"); /* Bold Magenta */
+constexpr std::string_view BOLDCYAN("\033[1m\033[36m");    /* Bold Cyan */
+constexpr std::string_view BOLDWHITE("\033[1m\033[37m");   /* Bold White */
 
-#endif //CPPSPEC_TERM_COLORS_HPP
+#endif  // CPPSPEC_TERM_COLORS_HPP