Merge branch 'main' into feature/update-clang-format-and-tidy

Author: StephanKa

.github/workflows/build_cmake.yml

@@ -65,7 +65,7 @@ jobs:
       # We need to source the profile file to make sure conan is in PATH
       run: |
         source ~/.profile
-        cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE
+        cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCPP_STARTER_USE_SML=ON -DCPP_STARTER_USE_BOOST_BEAST=ON -DCPP_STARTER_USE_CROW=ON
 
     - name: Build
       working-directory: ${{runner.workspace}}/build

.travis.yml

@@ -1,12 +1,23 @@
 CMAKE_MINIMUM_REQUIRED(VERSION 3.15)
 
 # Set the project name to your project name, my project isn't very descriptive
-PROJECT(myproject CXX)
+PROJECT(myproject
+        LANGUAGES CXX
+        VERSION 0.0.1)
+
 INCLUDE(cmake/StandardProjectSettings.cmake)
 INCLUDE(cmake/PreventInSourceBuilds.cmake)
-
 INCLUDE(cmake/CodeFormat.cmake)
 
+EXECUTE_PROCESS(
+        COMMAND git log -1 --format=%h
+        WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
+        OUTPUT_VARIABLE GIT_HASH
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+CONFIGURE_FILE("templates/version.hpp.in" "${CMAKE_BINARY_DIR}/generated/include/version.hpp" ESCAPE_QUOTES)
+
 # Link this 'library' to set the c++ standard / compile-time options requested
 ADD_LIBRARY(project_options INTERFACE)
 TARGET_COMPILE_FEATURES(project_options INTERFACE cxx_std_17)

CMakeLists.txt

@@ -7,25 +7,15 @@ With this project, we want to provide an example and starting point for C++ proj
 The project has initially been forked/copied from [Jason Turner's cpp_starter_project](https://github.com/lefticus/cpp_starter_project).
 
 
-<hr>
-## original README:
-
-# cpp_starter_project
-
-[![codecov](https://codecov.io/gh/lefticus/cpp_starter_project/branch/master/graph/badge.svg)](https://codecov.io/gh/lefticus/cpp_starter_project)
-
-[![Build Status](https://travis-ci.org/lefticus/cpp_starter_project.svg?branch=master)](https://travis-ci.org/lefticus/cpp_starter_project)
-
-[![Build status](https://ci.appveyor.com/api/projects/status/ro4lbfoa7n0sy74c/branch/master?svg=true)](https://ci.appveyor.com/project/lefticus/cpp-starter-project/branch/master)
-
-![CMake](https://github.com/lefticus/cpp_starter_project/workflows/CMake/badge.svg)
+## Build Status
 
+![CMake](https://github.com/Zuehlke/cpp_example_project/workflows/CMake/badge.svg)
 
 ## Getting Started
 
 ### Use the Github template
 First, click the green `Use this template` button near the top of this page.
-This will take you to Github's ['Generate Repository'](https://github.com/lefticus/cpp_starter_project/generate) page.
+This will take you to Github's ['Generate Repository'](https://github.com/Zuehlke/cpp_example_project/generate) page.
 Fill in a repository name and short description, and click 'Create repository from template'.
 This will allow you to create a new repository in your Github account,
 prepopulated with the contents of this project.
@@ -227,30 +217,6 @@ The following compilers should work:
 	https://github.com/include-what-you-use/include-what-you-use#how-to-install
 	</details>
 
-#### GUI libraries
-This project can be made to work with several optional GUI frameworks.
-
-If desired, you should install the following optional dependencies as
-directed by their documentation, linked here:
-
-- [FLTK](https://www.fltk.org/doc-1.4/index.html)
-- [GTKMM](https://www.gtkmm.org/en/documentation.html)
-- [QT](https://doc.qt.io/)
-
-The following dependencies can be downloaded automatically by CMake and Conan.
-All you need to do to install them is to turn on a CMake flag during
-configuration.
-If you run into difficulty using them, please refer to their documentation,
-linked here:
-
-- [NANA](http://nanapro.org/en-us/documentation/)
-- [SDL](http://wiki.libsdl.org/FrontPage)
-- [IMGUI](https://github.com/ocornut/imgui/tree/master/docs):
-  This framework depends on SFML, and if you are using Linux, you may need
-  to install several of SFML's dependencies using your package manager. See
-  [the SFML build tutorial](https://www.sfml-dev.org/tutorials/2.5/compile-with-cmake.php)
-  for specifics.
-
 ## Build Instructions
 
 ### Build directory

README.md

@@ -18,6 +18,7 @@ macro(run_conan)
     sml/1.1.5
     nlohmann_json/3.10.5
     boost/1.78.0
+    crowcpp-crow/1.0+1
     OPTIONS
     ${CONAN_EXTRA_OPTIONS}
     gtest:build_gmock=True

appveyor.yml

@@ -1,5 +1,6 @@
 OPTION(CPP_STARTER_USE_SML "Enable compilation of SML sample" OFF)
 OPTION(CPP_STARTER_USE_BOOST_BEAST "Enable compilation of boost beast sample" OFF)
+OPTION(CPP_STARTER_USE_CROW "Enable compilation of crow sample" OFF)
 
 # SML
 IF(CPP_STARTER_USE_SML)
@@ -13,6 +14,12 @@ IF(CPP_STARTER_USE_BOOST_BEAST)
     ADD_SUBDIRECTORY(boost.beast)
 ENDIF()
 
+# Crow
+IF(CPP_STARTER_USE_CROW)
+    MESSAGE("Using Crow")
+    ADD_SUBDIRECTORY(crow)
+ENDIF()
+
 
 # Generic test that uses conan libs
 ADD_EXECUTABLE(intro main.cpp)
@@ -24,3 +31,4 @@ TARGET_LINK_LIBRARIES(
         CONAN_PKG::fmt
         CONAN_PKG::spdlog)
 
+TARGET_INCLUDE_DIRECTORIES(intro PRIVATE ${CMAKE_BINARY_DIR}/generated)

cmake/Conan.cmake

@@ -0,0 +1,2 @@
+ADD_EXECUTABLE(test_crow main.cpp)
+TARGET_LINK_LIBRARIES(test_crow PRIVATE CONAN_PKG::crowcpp-crow CONAN_PKG::spdlog)

src/CMakeLists.txt

@@ -0,0 +1,49 @@
+/* example usage of crow-cpp http://crowcpp.org/ */
+#include "crow.h"
+
+class a : public crow::returnable
+{
+public:
+  a() : returnable("text/plain"){};
+
+  std::string dump() const override
+  {
+    return "ABCDF";
+  }
+};
+
+int main()
+{
+  constexpr uint16_t port = 8080;
+  std::vector<int> values;
+  crow::SimpleApp app;
+
+  CROW_ROUTE(app, "/")
+  ([]() {
+    return "Hello world";
+  });
+
+  CROW_ROUTE(app, "/json")
+  ([] {
+    return crow::json::wvalue({ { "message", "Hello, World!" }, {"message2", "Hello, World.. Again!"} });
+  });
+
+  CROW_ROUTE(app, "/custom")
+  ([]() {
+    return a();
+  });
+
+  CROW_ROUTE(app, "/hello/<int>").methods(crow::HTTPMethod::POST)([&values](int count) {
+    values.push_back(count);
+    return crow::response(std::to_string(count));
+  });
+
+  CROW_ROUTE(app, "/hello/").methods(crow::HTTPMethod::GET)([&values]() {
+    crow::json::wvalue returnValue;
+    returnValue["values"] = values;
+    return returnValue;
+  });
+
+  app.port(port).run();
+  return 0;
+}

src/crow/CMakeLists.txt

@@ -1,6 +1,7 @@
 #include <functional>
 #include <iostream>
-
+#include <string>
+#include "include/version.hpp"
 #include <docopt/docopt.h>
 #include <spdlog/spdlog.h>
 
@@ -24,14 +25,20 @@ static constexpr auto USAGE =
 
 int main(int argc, const char **argv)
 {
+    fmt::print(R"(Version
+    Major {}
+    Minor {}
+    Patch {}
+    Git Hash {}
+)", Version::Major, Version::Minor, Version::Patch, Version::GitHash);
+
     std::map<std::string, docopt::value> args = docopt::docopt(USAGE,
       { std::next(argv), std::next(argv, argc) },
       true,// show help if requested
       "Naval Fate 2.0");// version string
 
     for (auto const &arg : args) { std::cout << arg.first << arg.second << std::endl; }
 
-
     // Use the default logger (stdout, multi-threaded, colored)
     spdlog::info("Hello, {}!", "World");