Merge pull request #50 from connectivecpp/develop

Merging develop into master for Windows builds

Author: cliffg-softwarelibre

CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright 2019 by Cliff Green
+# Copyright 2019-2020 by Cliff Green
 #
 # https://github.com/connectivecpp/chops-net-ip
 #
@@ -11,18 +11,29 @@ cmake_minimum_required ( VERSION 3.8 )
 
 option ( CHOPS_NET_IP_OPT_BUILD_TESTS  "Build and perform chops-net-ip tests" ON )
 option ( CHOPS_NET_IP_OPT_BUILD_EXAMPLES  "Build and perform chops-net-ip examples" ON )
+option ( CHOPS_NET_IP_OPT_BUILD_DOCS  "Build doxygen documentation" OFF )
+
+set ( OPTIONS "" )
+set ( DEFINITIONS "" )
 
 project ( chops-net-ip VERSION 1.0 LANGUAGES CXX )
 
 set ( package_name "chops-net-ip" )
 
 set ( include_source_dir "${CMAKE_SOURCE_DIR}/include" )
+set ( utility_rack_dir "${CMAKE_SOURCE_DIR}/../utility-rack" )
+set ( utility_rack_include_source_dir "${utility_rack_dir}/include" )
+set ( third_party_include_source_dir "${utility_rack_dir}/third_party" )
+set ( cmake_include_dir "${CMAKE_SOURCE_DIR}/cmake" )
+set ( cmake_all_repos_include_dir "${utility_rack_dir}/cmake/all_repos" )
+
 
 # Interface library:
 
 add_library ( ${package_name} INTERFACE )
 
 target_include_directories ( ${package_name} INTERFACE ${include_source_dir} )
+target_include_directories ( ${package_name} INTERFACE ${third_party_include_source_dir} )
 target_compile_features ( ${package_name} INTERFACE cxx_std_17)
 
 if ( CHOPS_NET_IP_OPT_BUILD_TESTS )
@@ -31,9 +42,12 @@ if ( CHOPS_NET_IP_OPT_BUILD_TESTS )
 endif()
 
 if ( CHOPS_NET_IP_OPT_BUILD_EXAMPLES )
-  enable_testing()
   add_subdirectory ( example )
 endif()
 
+if ( CHOPS_NET_IP_OPT_BUILD_DOCS )
+  add_subdirectory ( doc )
+endif()
+
 # end of file
 

README.md

@@ -1,9 +1,3 @@
-Branch | Status
-|---|---|
-**Master** | [![Build Status](https://travis-ci.org/connectivecpp/chops-net-ip.svg?branch=master)](https://travis-ci.org/connectivecpp/chops-net-ip)
-**Develop** | [![Build Status](https://travis-ci.org/connectivecpp/chops-net-ip.svg?branch=develop)](https://travis-ci.org/connectivecpp/chops-net-ip)
-
-
 # Chops Net IP - Connective Handcrafted Openwork Software for Asynchronous IP Networking
 
 Chops Net IP is a C++ library that makes asynchronous networking programming fun. Or at least if not fun, it makes network programming easier and safer, without significantly sacrificing performance. Chops Net IP handles Internet Protocol (IP) communications including TCP, UDP, and UDP multicast. It is written using modern C++ design idioms and the latest (2017) C++ standard.
@@ -12,23 +6,26 @@ Chops Net IP is not like any other high-level, general purpose C++ socket librar
 
 Chops Net IP is layered on top of the Asio asynchronous networking library, taking advantage of the portability and functionality that Asio provides. However, it simplifies network programming compared to coding against the Asio API, while providing easy scalability through the asynchronous facilities.
 
-# License
-
-[![Licence](https://img.shields.io/badge/license-boost-4480cc.svg)](http://www.boost.org/LICENSE_1_0.txt)
+# Build and Release Status, License Info
 
-This project is distributed under the [Boost Software License](LICENSE.txt).
+Branch | Status
+|---|---|
+**Master** | [![Build Status](https://travis-ci.org/connectivecpp/chops-net-ip.svg?branch=master)](https://travis-ci.org/connectivecpp/chops-net-ip)
+**Develop** | [![Build Status](https://travis-ci.org/connectivecpp/chops-net-ip.svg?branch=develop)](https://travis-ci.org/connectivecpp/chops-net-ip)
 
-## Chops Net IP Release Status
+**Latest tag:** ![Latest Tag](https://img.shields.io/github/v/tag/connectivecpp/chops-net-ip)
 
 Release 1.0 is under development as of January 2020, awaiting CMake enhancements, a comprehensive tutorial, and additional testing under multiple compilers and platforms.
 
 Release notes and upcoming development plans are [available here](doc/release.md).
 
+This project is distributed under the [Boost Software License](LICENSE.txt): [![Licence](https://img.shields.io/badge/license-boost-4480cc.svg)](http://www.boost.org/LICENSE_1_0.txt)
+
 # Overview
 
 For many software developers, asynchronous network programming in C++ is not easy. It is complex, has many pitfalls, and requires designing C++ code in a way that is not natural, even for those with years of experience. Chops Net IP ("C"onnective "H"andcrafted "Op"enwork "S"oftware, Networking over Internet Protocol) simplifies asynchronous network programming and provides useful (and tasty!) abstractions for many types of communication patterns.
 
-Chops Net IP is layered on top of Chris Kohlhoff's Asio library (see [References](doc/references.md)) allowing it to be portable across many compilers and platforms. When the C++ Networking TS is standardized (possibly C++ 23 but more likely C++ 26) Chops Net IP will directly use the networking facilities of the C++ standard library.
+Chops Net IP is layered on top of Chris Kohlhoff's Asio library (see [References](https://connectivecpp.github.io/doc/references.html)) allowing it to be portable across many compilers and platforms. When the C++ Networking TS is standardized (possibly C++ 23 but more likely C++ 26) Chops Net IP will directly use the networking facilities of the C++ standard library.
 
 Chops Net IP simplifies application code that processes data on multiple simultaneous TCP connections or UDP endpoints. All Chops Net IP operations (from the application viewpoint) are no-wait (i.e. there are no blocking methods) and all network processing operations are performed asynchronously.
 
@@ -79,18 +76,10 @@ A detailed overview, a C++ socket library comparison, and a FAQ is [available he
 
 # C++ Language Requirements and Alternatives
 
-C++ 17 is the primary standards baseline for this repository. There is also one future C++ facility in use (`std::expected`, allowing error handling without using exceptions).
-
-A significant number of C++ 11 features are in the implementation and API. There are also C++ 14 and 17 features in use such as `std::byte`, `std::optional`, `std::variant` and `auto` parameters in lambda functions. For users that don't want to use the latest C++ compilers or compile with C++ 17 flags, Martin Moene provides an excellent set of header-only libraries that implement many useful C++ 17 library features (for older compilers or standards), as well as future C++ features (see [References](doc/references.md)).
-
-While the main production branch will always be developed and tested with C++ 17 features (and relatively current compilers), alternative branches and forks for older compiler versions are welcome. In particular, a branch using Martin's libraries and general C++ 11 (or C++ 14) conformance would be useful. A branch supporting a pre-C++ 11 compiler or language conformance is not likely to be directly supported through this repository (since it would require so many changes that it would result in a defacto different codebase).
+C++ 17 is the primary baseline for this repository. Additional notes on possible alternatives are [available here](https://connectivecpp.github.io/).
 
 # External Dependencies
 
-The libraries and API's have minimal (as possible) library dependencies (there are heavy dependencies on the C++ standard library in all of the code). There are more dependencies in the test code than in the production code.
-
-All the dependencies listed below have links that will take you to the library or repository.
-
 Production external dependencies:
 
 - Version 1.13 (or later) of Chris Kohlhoff's [`asio`](https://github.com/chriskohlhoff/asio) library is required. Note that it is the stand-alone Asio library, not the Boost Asio version.
@@ -104,7 +93,7 @@ There are single file headers that have been copied into the `third_party` direc
 
 - Martin Moene's [`expected-lite`](https://github.com/martinmoene/expected-lite) library.
 
-See [References](doc/references.md) for additional details.
+See [References](https://connectivecpp.github.io/doc/references.html) for additional details.
 
 # Supported Compilers and Platforms
 
@@ -121,9 +110,11 @@ Chops Net IP is header-only, so installation consists of downloading or cloning
 
 # References
 
-See [References](doc/references.md) for details on dependencies and inspirations for Chops Net IP.
+See [References](https://connectivecpp.github.io/doc/references.html) for details on dependencies and inspirations for Chops Net IP.
 
 # About
 
-Team member information is [available here](https://connectivecpp.github.io/), and a few random author comments are [available here](doc/about.md).
+Team member information is [available here](https://connectivecpp.github.io/).
+
+A few "Cliff Notes" are [available here](doc/cliff_notes.md).
 

cmake/add_target_dependencies.cmake

@@ -0,0 +1,30 @@
+# Copyright 2020 by Cliff Green
+#
+# https://github.com/connectivecpp/utility-rack
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+# Still learning find_package and related ways to bring in third party dependent include directories,
+# so don't judge, instead please help.
+
+set ( catch2_include_dir "${CMAKE_SOURCE_DIR}/../Catch2/single_include" )
+if ( NOT $ENV{CATCH2_INCLUDE_DIR} STREQUAL "" )
+    set ( catch2_include_dir $ENV{CATCH2_INCLUDE_DIR}} )
+endif()
+set ( asio_include_dir "${CMAKE_SOURCE_DIR}/../asio/asio/include" )
+if ( NOT $ENV{ASIO_INCLUDE_DIR} STREQUAL "" )
+    set ( asio_include_dir $ENV{ASIO_INCLUDE_DIR}} )
+endif()
+
+function ( add_target_dependencies target )
+#    find_package ( Catch2 REQUIRED )
+#    target_include_directories ( ${target} PRIVATE ${Catch2_INCLUDE_DIRS} )
+    target_include_directories ( ${target} PRIVATE ${catch2_include_dir} )
+#    find_package ( asio REQUIRED )
+#    target_include_directories ( ${target} PRIVATE ${asio_INCLUDE_DIRS} )
+    target_include_directories ( ${target} PRIVATE ${asio_include_dir} )
+endfunction()
+
+# end of file
+

cmake/header_dirs_var.cmake

@@ -0,0 +1,15 @@
+# Copyright 2020 by Cliff Green
+#
+# https://github.com/connectivecpp/utility-rack
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+set ( header_dirs
+    "${include_source_dir}"
+    "${utility_rack_include_source_dir}"
+    "${third_party_include_source_dir}"
+    )
+
+# end of file
+

doc/CMakeLists.txt

@@ -0,0 +1,16 @@
+# Copyright 2020 by Cliff Green
+#
+# https://github.com/connectivecpp/chops-net-ip
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+cmake_minimum_required ( VERSION 3.9 )
+
+project ( chops-net-ip-doc VERSION 1.0 LANGUAGES CXX )
+
+set ( doxygen_proj_name "Chops Net IP Reference" )
+include ( "${cmake_all_repos_include_dir}/doxygen_gen.cmake" )
+
+# end of file
+

doc/about.md renamed to doc/cliff_notes.md

@@ -1,5 +1,3 @@
-# Author Notes and Contributor Information
-
 ## A Cliff Note on the Chops Name
 
 >(from Cliff, 2018) Yes, the name / acronym is a stretch. Quite a stretch. I like the word "chops", which is a jazz term for strong technique, so I decided on that for a name. For example, "Check out Tal Wilkenfeld, she's got mad chops."
@@ -16,6 +14,6 @@
 
 >Even though I didn't use "openhearted" in the name, it's an aspect that I aspire to in every part of my life. I fall short, very often, but not because of lack of effort or desire.
 
->I mentioned Tal earlier in this note, so here are two representative YouTube videos of her playing with Jeff Beck, who I consider one of the all time best guitarists. The first video is a blend of jazz, rock, and funk, the second is the two of them playing one of my favorite rock / jazz fusion ballads: https://www.youtube.com/watch?v=jVb-izZVCwQ, https://www.youtube.com/watch?v=blp7hPFaIfU
+>I mentioned Tal earlier in this note, so here is a representative YouTube video of her playing with Jeff Beck, who I consider one of the all time best guitarists. It is a blend of jazz, rock, and funk - https://www.youtube.com/watch?v=jVb-izZVCwQ.
 
->And since I'm on a music digression, an artist I often listen to while writing code is Helios. His music is instrumental, space music'ey, ambient, contains a nice amount of harmonic and rhythmic complexity, and is very melodic. Most important it doesn't interfere with my concentration. A good album to start with is Eingya: https://www.youtube.com/watch?v=fud-Lz76MHg
+>And since I'm on a music digression, an artist I often listen to while writing code is Helios. His music is instrumental, space music'ey, ambient, contains a nice amount of harmonic and rhythmic complexity, and is very melodic. Most important it doesn't interfere with my concentration. A good album to start with is Eingya.

doc/html/README.md

@@ -0,0 +1,3 @@
+# Chops Net IP Doxygen Pages
+
+This directory contains HTML pages generated by Doxygen. The content is extracted from the source code.

doc/references.md

@@ -2,7 +2,13 @@
 
 ## Release 1.0
 
-Release 1.0 is under development, expected in the first part of 2020. Additional platform and compiler testing is under way, in-depth tutorials are under development, and the marshalling library in the `utility-rack` repository needs to be completed.
+Release 1.0 is under development, expected in the first part of 2020. The functionality is already well tested under g++ and clang++ on Linux, MacOS, and Raspbian, but needs additional testing on other compilers and platforms including VC++ on Windows.
+
+### Next Steps, ToDo's, Problems, and Constraints:
+
+- The CMake files (CMakeLists.txts, etc) are working but enhancements and improvements are needed. CMake is relatively new for the Connective C++ team and enhancement requests are welcome.
+- Code coverage tools have not been used on the codebase.
+- The Doxygen annotation is mostly complete, but additional tutorial content is needed.
 
 ## Release 0.3
 

doc/release.md

@@ -1,4 +1,4 @@
-# Copyright 2019 by Cliff Green
+# Copyright 2019-2020 by Cliff Green
 #
 # https://github.com/connectivecpp/chops-net-ip
 #
@@ -11,6 +11,8 @@ project ( chops-net-ip-example VERSION 1.0 LANGUAGES CXX )
 
 set ( example_source_dir "${CMAKE_SOURCE_DIR}/example" )
 
+include ( "${cmake_include_dir}/header_dirs_var.cmake" )
+
 set ( example_sources 
     "${example_source_dir}/local_echo_demo.cpp"
     "${example_source_dir}/chat_server_demo.cpp"
@@ -20,57 +22,15 @@ set ( example_sources
     "${example_source_dir}/udp_broadcast_demo.cpp"
     "${example_source_dir}/udp_receiver_demo.cpp" )
 
-set ( OPTIONS "" )
-set ( DEFINITIONS "" )
-
-set ( header_dirs
-    "${include_source_dir}"
-#    "${test_include_dir}"
-    )
-
-# Still learning find_package and related ways to bring in third party dependent include directories,
-# so don't judge, instead please help.
-
-set ( utility_rack_include_dir
-     "${CMAKE_SOURCE_DIR}/../utility-rack/include"
-     "${CMAKE_SOURCE_DIR}/../utility-rack/third_party"
-    )
-if ( NOT $ENV{UTILITY_RACK_INCLUDE_DIR} STREQUAL "" )
-    set ( utility_rack_include_dir $ENV{UTILITY_RACK_INCLUDE_DIR}} )
-endif()
-set ( asio_include_dir "${CMAKE_SOURCE_DIR}/../asio/asio/include" )
-if ( NOT $ENV{ASIO_INCLUDE_DIR} STREQUAL "" )
-    set ( asio_include_dir $ENV{ASIO_INCLUDE_DIR}} )
-endif()
-
-function ( add_target_dependencies target )
-#    find_package ( utility-rack REQUIRED )
-#    target_include_directories ( ${target} PRIVATE ${utility-rack_INCLUDE_DIRS} )
-    target_include_directories ( ${target} PRIVATE ${utility_rack_include_dir} )
-#    find_package ( asio REQUIRED )
-#    target_include_directories ( ${target} PRIVATE ${asio_INCLUDE_DIRS} )
-    target_include_directories ( ${target} PRIVATE ${asio_include_dir} )
-endfunction()
-
-function ( add_target_info target )
-    target_compile_features    ( ${target} PRIVATE cxx_std_17 )
-    target_compile_options     ( ${target} PRIVATE ${OPTIONS} )
-    target_compile_definitions ( ${target} PRIVATE ${DEFINITIONS} )
-    target_include_directories ( ${target} PRIVATE ${header_dirs} )
-    add_target_dependencies    ( ${target} )
-endfunction()
+include ( "${cmake_include_dir}/add_target_dependencies.cmake" )
 
-function ( make_exe target src )
-    add_executable        ( ${target} ${src} )
-    add_target_info       ( ${target} )
-    target_link_libraries ( ${target} PRIVATE pthread )
-    message ( "Example executable to create: ${target}" )
-endfunction()
+include ( "${cmake_all_repos_include_dir}/add_target_info_func.cmake" )
+include ( "${cmake_all_repos_include_dir}/target_exe_func.cmake" )
 
 foreach ( example_src IN LISTS example_sources )
     get_filename_component ( targ ${example_src} NAME_WE )
-    message ( "Calling make_exe for: ${targ}" )
-    make_exe ( ${targ} ${example_src} )
+    message ( "Calling target_exe for: ${targ}" )
+    target_exe ( ${targ} ${example_src} )
 endforeach()
 
 # end of file