allow for multiple examples (#33)

* allow for multiple examples

* remove old items from .gitignore

* remove singular form of "example"

Author: dgoffredo

.gitignore

@@ -1,15 +1,3 @@
-/boosty/boost_1_80_0/
-/boosty/cmake-bcp/
-/boosty/boost_1_80_0.tar.gz
-/boosty/example/main
-/boosty/extracted/doc/
-/boosty/extracted/libs/
-/boosty/extracted/boost.png
-
-/example/example
-/example/hasher
-/example/scratch
-
 /bazel-*
 /.build/
 /.coverage/

CMakeLists.txt

@@ -5,7 +5,7 @@ cmake_minimum_required(VERSION 3.24)
 project(dd-trace-cpp)
 
 option(BUILD_COVERAGE "Build code with code coverage profiling instrumentation" OFF)
-option(BUILD_EXAMPLE "Build the example program (example/)" OFF)
+option(BUILD_HASHER_EXAMPLE "Build the example program examples/hasher" OFF)
 option(BUILD_TESTING "Build the unit tests (test/)" OFF)
 option(SANITIZE "Build with address sanitizer and undefined behavior sanitizer" OFF)
 option(FUZZ_W3C_PROPAGATION "Build a fuzzer for W3C propagation" OFF)
@@ -226,6 +226,5 @@ if(BUILD_TESTING)
   add_subdirectory(test)
 endif()
 
-if(BUILD_EXAMPLE)
-  add_subdirectory(example)
-endif()
+# Each example has its own build flag.
+add_subdirectory(examples)

bin/check-format

@@ -1,4 +1,4 @@
 #!/bin/sh
 
-find src/ example/ test/ -type f \( -name '*.h' -o -name '*.cpp' \) -print0 | \
+find src/ examples/ test/ -type f \( -name '*.h' -o -name '*.cpp' \) -print0 | \
     xargs -0 clang-format-14 --style=file --dry-run -Werror

bin/format

@@ -14,7 +14,7 @@ formatter=clang-format-$version
 formatter_options="--style=file -i"
 
 find_sources() {
-    find src/ example/ test/ fuzz/ -type f \( -name '*.h' -o -name '*.cpp' \) "$@"
+    find src/ examples/ test/ fuzz/ -type f \( -name '*.h' -o -name '*.cpp' \) "$@"
 }
 
 # If the correct version of clang-format is installed, then use it and quit.

bin/example bin/hasher-examplebin/example renamed to bin/hasher-example

@@ -19,23 +19,22 @@ cd "$(dirname "$0")"/..
 
 mkdir -p .build
 cd .build
-cmake .. -DBUILD_EXAMPLE=1
+cmake .. -DBUILD_HASHER_EXAMPLE=1
 # shellcheck disable=SC2086
 make -j "$(nproc)" $verbosity_flags
+cd ../
 
 if [ "$build_only" -eq 1 ]; then
     exit
 fi
 
-trap 'docker compose --project-directory ../example down' INT
+trap 'docker compose --project-directory examples/hasher down' INT
 
-echo 'Running example...'
+echo 'Running hasher example...'
 if [ "$DD_API_KEY" = '' ]; then
     >&2 echo "The DD_API_KEY environment variable must be set to a Datadog API key."
     exit 1
 fi
-docker compose --project-directory ../example up --detach --remove-orphans
-# docker compose --project-directory ../example logs --follow &
-./example/example "$@"
-docker compose --project-directory ../example down
-# wait
+docker compose --project-directory examples/hasher up --detach --remove-orphans
+.build/examples/hasher/example "$@"
+docker compose --project-directory examples/hasher down

example/console.png

@@ -0,0 +1,3 @@
+if (BUILD_HASHER_EXAMPLE)
+    add_subdirectory(hasher)
+endif()

examples/CMakeLists.txt

@@ -10,7 +10,7 @@ file or directory encountered.
 The program produces a trace of this calculation, where each file encountered
 is a span whose duration is the time it took to hash the file.
 
-[../bin/example](../bin/example) builds and runs the example.
+[../bin/hasher-example](../bin/hasher-example) builds and runs this example.
 
 ![example console usage](console.png)