Add polygon puzzle to examples

.codecov.yml

@@ -36,3 +36,4 @@ parsers:
 
 ignore:
   - "tests/"
+  - "examples/"

.fossa.yml

@@ -7,4 +7,5 @@ vendoredDependencies:
     exclude:
       - ".git/**"
       - "tests/**"
+      - "examples/**"
       - "ci/**"

.github/workflows/build.yml

@@ -8,6 +8,7 @@ on:
       - '.github/workflows/build.yml'
       - 'include/**'
       - 'tests/**'
+      - 'examples/**'
       - 'CMakeLists.txt'
       - 'cmake/**'
       - 'nix/**'
@@ -20,6 +21,7 @@ on:
       - '.github/workflows/build.yml'
       - 'include/**'
       - 'tests/**'
+      - 'examples/**'
       - 'CMakeLists.txt'
       - 'cmake/**'
       - 'nix/**'

.github/workflows/coverage.yml

@@ -16,6 +16,8 @@ on:
       - '.codecov.yml'
   workflow_dispatch:
 
+  # examples/** not included in coverage paths intentionally, see also .codecov.yml
+
 jobs:
   coverage:
     runs-on:

.github/workflows/docs.yml

@@ -9,6 +9,7 @@ on:
       - 'docs/**'
       - 'include/**'
       - 'tests/**'
+      - 'examples/**'
       - 'CMakeLists.txt'
       - 'cmake/**'
       - '*.md'

.github/workflows/licence.yml

@@ -8,6 +8,7 @@ on:
       - '.github/workflows/licence.yml'
       - 'include/**'
       - 'tests/**'
+      - 'examples/**'
       - 'CMakeLists.txt'
       - 'cmake/**'
       - '.fossa.yml'
@@ -19,6 +20,7 @@ on:
       - '.github/workflows/licence.yml'
       - 'include/**'
       - 'tests/**'
+      - 'examples/**'
       - 'CMakeLists.txt'
       - 'cmake/**'
       - '.fossa.yml'

CMakeLists.txt

@@ -47,5 +47,7 @@ if(TESTS)
     add_subdirectory(tests)
 endif()
 
+add_subdirectory(examples)
+
 install(FILES README.md LICENSE.md
     DESTINATION share/doc/functional)

cmake/Coverage.cmake

@@ -21,7 +21,7 @@ setup_target_for_coverage_gcovr(
     FORMAT ${CODE_COVERAGE_FORMAT}
     EXECUTABLE ${CODE_COVERAGE_TEST}
     EXECUTABLE_ARGS ${CODE_COVERAGE_TEST_ARGS}
-    EXCLUDE "tests"
+    EXCLUDE "tests" "examples"
     DEPENDENCIES all
 )
 

docs/choice/and_then.md

@@ -23,6 +23,6 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-choice-parse", "// example-choice-checks"]
 }

docs/expected/and_then.md

@@ -23,13 +23,13 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-and_then-value"],
     desc:  "The resulting value is `13` because `ex` does not contain an `Error` and therefore `and_then` is called."
 }
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-and_then-error"],
     desc:  "The result is an `Error` because `ex` already contained an `Error` and therefore `and_then` is not called."
 }

docs/expected/discard.md

@@ -23,7 +23,7 @@ void
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-discard"],
     desc:  "`42` is observed by `inspect` and the value is discarded by `discard` (no warning for discarded result of `inspect`)."
 }

docs/expected/filter.md

@@ -23,13 +23,13 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-filter-value"],
     desc:  "The resulting value is `42` because the filter predicate returns `true` for `42` as it is not less than `42`."
 }
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-filter-error"],
     desc:  "The error is set to `Less than 42` because the predicate returns `false` for `12` since it's less than `42`."
 }

docs/lookup-paths

@@ -1,2 +1,3 @@
 ../tests/
+../examples/
 ../include/

docs/optional/and_then.md

@@ -23,13 +23,13 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-optional-and_then-value"],
     desc:  "The resulting value is `13` because `op` is not a `nullopt` and therefore `and_then` is called."
 }
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-optional-and_then-empty"],
     desc:  "The result is a `nullopt` because `op` was already a `nullopt` and therefore `and_then` is not called."
 }

docs/optional/discard.md

@@ -23,7 +23,7 @@ void
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-error-struct", "// example-optional-discard"],
     desc:  "`42` is observed by `inspect` and the value is discarded by `discard` (no warning for discarded result of `inspect`)."
 }

docs/optional/filter.md

@@ -23,13 +23,13 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-optional-filter-value"],
     desc:  "The resulting value is `42` because the filter predicate returns `true` for `42` as it is not less than `42`."
 }
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp",
+    path:  "simple/main.cpp",
     surroundedBy: ["// example-optional-filter-empty"],
     desc:  "The optional is empty because the predicate returns `false` for `12` since it's less than `42`."
 }

examples/CMakeLists.txt

@@ -0,0 +1,4 @@
+cmake_minimum_required(VERSION 3.25)
+
+add_subdirectory(simple)
+add_subdirectory(polygon)

examples/polygon/CMakeLists.txt

@@ -0,0 +1,24 @@
+cmake_minimum_required(VERSION 3.25)
+project(examples_polygon)
+
+set(CMAKE_CXX_EXTENSIONS OFF)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Pls keep the filenames sorted
+set(TESTS_EXAMPLES_POLYGON_SOURCES
+    main.cpp
+)
+
+# TODO add 20 when we are compatible with C++20
+foreach(mode 23)
+    set(target "examples_polygon_cxx${mode}")
+
+    add_executable("${target}" ${TESTS_EXAMPLES_POLYGON_SOURCES})
+    target_link_libraries("${target}" include_fn)
+    append_compilation_options("${target}" WARNINGS)
+    add_dependencies("cxx${mode}" "${target}")
+    set_property(TARGET "${target}" PROPERTY CXX_STANDARD "${mode}")
+    target_compile_definitions("${target}" PRIVATE LIBFN_MODE=${mode})
+
+    unset(target)
+endforeach()