Make fetch contentable (#27)

lefticus · web-flow · commit 2139ecda6ab8 · 2023-04-20T07:06:46.000-06:00
* Better namespacing of functions
* Make template more fetchable
* Make sure dependencies file is updated
diff --git a/.github/template/template_name b/.github/template/template_name
@@ -1 +1 @@
-ftxui_template
+cmake_template
diff --git a/.github/template/template_repository b/.github/template/template_repository
@@ -1 +1 @@
-cpp-best-practices/ftxui_template
+cpp-best-practices/cmake_template
diff --git a/.github/workflows/template-janitor.yml b/.github/workflows/template-janitor.yml
@@ -74,7 +74,7 @@ jobs:
       - name: Insert new org and project
         run: |
           # rename the CMake project to match the github project
-          find src include test fuzz_test -type f -exec sed -i "s/myproject/${{ env.NEW_SAFE_PROJECT }}/gi" CMakeLists.txt ProjectOptions.cmake .github/workflows/ci.yml .github/workflows/codeql-analysis.yml configured_files/config.hpp.in {} +
+          find src include test fuzz_test cmake -type f -exec sed -i "s/myproject/${{ env.NEW_SAFE_PROJECT }}/gi" CMakeLists.txt Dependencies.cmake ProjectOptions.cmake .github/workflows/ci.yml .github/workflows/codeql-analysis.yml configured_files/config.hpp.in {} +
 
           # Update URL placeholders for project
           sed -i "s|%%myurl%%|${{ fromJson(steps.get_repo_meta.outputs.data).html_url }}|gi" CMakeLists.txt
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -25,13 +25,14 @@ project(
 include(cmake/PreventInSourceBuilds.cmake)
 include(ProjectOptions.cmake)
 
-setup_options()
 
-global_options()
+myproject_setup_options()
+
+myproject_global_options()
 include(Dependencies.cmake)
-setup_dependencies()
+myproject_setup_dependencies()
 
-local_options()
+myproject_local_options()
 
 # don't know if this should be set globally from here or not...
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)
@@ -97,7 +98,7 @@ include(cmake/PackageProject.cmake)
 
 # Add other targets that you want installed here, by default we just package the one executable
 # we know we want to ship
-package_project(
+myproject_package_project(
   TARGETS
   intro
   myproject_options
diff --git a/Dependencies.cmake b/Dependencies.cmake
@@ -3,7 +3,7 @@ include(cmake/CPM.cmake)
 # Done as a function so that updates to variables like
 # CMAKE_CXX_FLAGS don't propagate out to other
 # targets
-function(setup_dependencies)
+function(myproject_setup_dependencies)
 
   # For each dependency, see if it's
   # already been provided to us by a parent project
@@ -35,4 +35,9 @@ function(setup_dependencies)
   if(NOT TARGET ftxui::screen)
     cpmaddpackage("gh:ArthurSonzogni/FTXUI#e23dbc7473654024852ede60e2121276c5aab660")
   endif()
+
+  if(NOT TARGET tools::tools)
+    cpmaddpackage("gh:lefticus/tools#update_build_system")
+  endif()
+
 endfunction()
diff --git a/ProjectOptions.cmake b/ProjectOptions.cmake
@@ -4,7 +4,7 @@ include(CMakeDependentOption)
 include(CheckCXXCompilerFlag)
 
 
-macro(setup_options)
+macro(myproject_setup_options)
   option(myproject_ENABLE_HARDENING "Enable hardening" ON)
   option(myproject_ENABLE_COVERAGE "Enable coverage reporting" OFF)
   cmake_dependent_option(
@@ -27,7 +27,7 @@ macro(setup_options)
     set(SUPPORTS_ASAN ON)
   endif()
 
-  check_libfuzzer_support(LIBFUZZER_SUPPORTED)
+  myproject_check_libfuzzer_support(LIBFUZZER_SUPPORTED)
   option(myproject_BUILD_FUZZ_TESTS "Enable fuzz testing executable" ${LIBFUZZER_SUPPORTED})
 
 
@@ -80,27 +80,29 @@ macro(setup_options)
   endif()
 endmacro()
 
-macro(global_options)
+macro(myproject_global_options)
   if(myproject_ENABLE_IPO)
     include(cmake/InterproceduralOptimization.cmake)
-    enable_ipo()
+    myproject_enable_ipo()
   endif()
 
   if(myproject_ENABLE_HARDENING AND myproject_ENABLE_GLOBAL_HARDENING)
     include(cmake/Hardening.cmake)
     set(ENABLE_UBSAN_MINIMAL_RUNTIME NOT myproject_ENABLE_SANITIZER_UNDEFINED)
-    enable_hardening(myproject_options ON ${ENABLE_UBSAN_MINIMAL_RUNTIME})
+    myproject_enable_hardening(myproject_options ON ${ENABLE_UBSAN_MINIMAL_RUNTIME})
   endif()
 endmacro()
 
-macro(local_options)
-  include(cmake/StandardProjectSettings.cmake)
+macro(myproject_local_options)
+  if (PROJECT_IS_TOP_LEVEL)
+    include(cmake/StandardProjectSettings.cmake)
+  endif()
 
   add_library(myproject_warnings INTERFACE)
   add_library(myproject_options INTERFACE)
 
   include(cmake/CompilerWarnings.cmake)
-  set_project_warnings(
+  myproject_set_project_warnings(
     myproject_warnings
     ${myproject_WARNINGS_AS_ERRORS}
     ""
@@ -114,7 +116,7 @@ macro(local_options)
   endif()
 
   include(cmake/Sanitizers.cmake)
-  enable_sanitizers(
+  myproject_enable_sanitizers(
     myproject_options
     ${myproject_ENABLE_SANITIZER_ADDRESS}
     ${myproject_ENABLE_SANITIZER_LEAK}
@@ -135,22 +137,22 @@ macro(local_options)
 
   if(myproject_ENABLE_CACHE)
     include(cmake/Cache.cmake)
-    enable_cache()
+    myproject_enable_cache()
   endif()
 
   include(cmake/StaticAnalyzers.cmake)
   if(myproject_ENABLE_CLANG_TIDY)
-    enable_clang_tidy(myproject_options ${myproject_WARNINGS_AS_ERRORS})
+    myproject_enable_clang_tidy(myproject_options ${myproject_WARNINGS_AS_ERRORS})
   endif()
 
   if(myproject_ENABLE_CPPCHECK)
-    enable_cppcheck(${myproject_WARNINGS_AS_ERRORS} "" # override cppcheck options
+    myproject_enable_cppcheck(${myproject_WARNINGS_AS_ERRORS} "" # override cppcheck options
     )
   endif()
 
   if(myproject_ENABLE_COVERAGE)
     include(cmake/Tests.cmake)
-    enable_coverage(myproject_options)
+    myproject_enable_coverage(myproject_options)
   endif()
 
   if(myproject_WARNINGS_AS_ERRORS)
@@ -164,7 +166,7 @@ macro(local_options)
   if(myproject_ENABLE_HARDENING AND NOT myproject_ENABLE_GLOBAL_HARDENING)
     include(cmake/Hardening.cmake)
     set(ENABLE_UBSAN_MINIMAL_RUNTIME NOT myproject_ENABLE_SANITIZER_UNDEFINED)
-    enable_hardening(myproject_options OFF ${ENABLE_UBSAN_MINIMAL_RUNTIME})
+    myproject_enable_hardening(myproject_options OFF ${ENABLE_UBSAN_MINIMAL_RUNTIME})
   endif()
 
 endmacro()
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
-# ftxui_template
+# cmake_template
 
-[![ci](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/ci.yml/badge.svg)](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/ci.yml)
-[![codecov](https://codecov.io/gh/cpp-best-practices/ftxui_template/branch/main/graph/badge.svg)](https://codecov.io/gh/cpp-best-practices/ftxui_template)
-[![Language grade: C++](https://img.shields.io/lgtm/grade/cpp/github/cpp-best-practices/ftxui_template)](https://lgtm.com/projects/g/cpp-best-practices/ftxui_template/context:cpp)
-[![CodeQL](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/codeql-analysis.yml)
+[![ci](https://github.com/cpp-best-practices/cmake_template/actions/workflows/ci.yml/badge.svg)](https://github.com/cpp-best-practices/cmake_template/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/cpp-best-practices/cmake_template/branch/main/graph/badge.svg)](https://codecov.io/gh/cpp-best-practices/cmake_template)
+[![Language grade: C++](https://img.shields.io/lgtm/grade/cpp/github/cpp-best-practices/cmake_template)](https://lgtm.com/projects/g/cpp-best-practices/cmake_template/context:cpp)
+[![CodeQL](https://github.com/cpp-best-practices/cmake_template/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/cpp-best-practices/cmake_template/actions/workflows/codeql-analysis.yml)
 
-## About ftxui_template
+## About cmake_template
 
 **NOTE** This is undergoing a major overhaul on a new branch currently.
 
@@ -38,7 +38,7 @@ This project gets you started with a simple example of using FTXUI, which happen
 
 ### 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/cpp-best-practices/ftxui_template/generate) page.
+This will take you to Github's ['Generate Repository'](https://github.com/cpp-best-practices/cmake_template/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.
diff --git a/cmake/Cache.cmake b/cmake/Cache.cmake
@@ -1,5 +1,5 @@
 # Enable cache if available
-function(enable_cache)
+function(myproject_enable_cache)
   set(CACHE_OPTION
       "ccache"
       CACHE STRING "Compiler cache to be used")
diff --git a/cmake/CompilerWarnings.cmake b/cmake/CompilerWarnings.cmake
@@ -3,7 +3,7 @@
 # https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md
 
 function(
-  set_project_warnings
+  myproject_set_project_warnings
   project_name
   WARNINGS_AS_ERRORS
   MSVC_WARNINGS
diff --git a/cmake/Cuda.cmake b/cmake/Cuda.cmake
@@ -7,7 +7,7 @@
 # target_link_libraries(main_cuda PRIVATE project_options project_warnings)
 # target_link_cuda(main_cuda)
 #
-macro(target_link_cuda target)
+macro(myproject_target_link_cuda target)
   # optional named CUDA_WARNINGS
   set(oneValueArgs CUDA_WARNINGS)
   cmake_parse_arguments(
diff --git a/cmake/Doxygen.cmake b/cmake/Doxygen.cmake
@@ -1,5 +1,5 @@
 # Enable doxygen doc builds of source
-function(enable_doxygen DOXYGEN_THEME)
+function(myproject_enable_doxygen DOXYGEN_THEME)
   # If not specified, use the top readme file as the first page
   if((NOT DOXYGEN_USE_MDFILE_AS_MAINPAGE) AND EXISTS "${PROJECT_SOURCE_DIR}/README.md")
     set(DOXYGEN_USE_MDFILE_AS_MAINPAGE "${PROJECT_SOURCE_DIR}/README.md")
diff --git a/cmake/Hardening.cmake b/cmake/Hardening.cmake
@@ -1,7 +1,7 @@
 include(CheckCXXCompilerFlag)
 
 macro(
-  enable_hardening
+  myproject_enable_hardening
   target
   global
   ubsan_minimal_runtime)
diff --git a/cmake/InterproceduralOptimization.cmake b/cmake/InterproceduralOptimization.cmake
@@ -1,4 +1,4 @@
-macro(enable_ipo)
+macro(myproject_enable_ipo)
   include(CheckIPOSupported)
   check_ipo_supported(RESULT result OUTPUT output)
   if(result)
diff --git a/cmake/LibFuzzer.cmake b/cmake/LibFuzzer.cmake
@@ -1,4 +1,4 @@
-function(check_libfuzzer_support var_name)
+function(myproject_check_libfuzzer_support var_name)
   set(LibFuzzerTestSource
       "
 #include <cstdint>
diff --git a/cmake/Linker.cmake b/cmake/Linker.cmake
@@ -1,4 +1,4 @@
-macro(configure_linker project_name)
+macro(myproject_configure_linker project_name)
   include(CheckCXXCompilerFlag)
 
   set(USER_LINKER_OPTION
diff --git a/cmake/PackageProject.cmake b/cmake/PackageProject.cmake
@@ -1,6 +1,6 @@
 # Uses ycm (permissive BSD-3-Clause license) and ForwardArguments (permissive MIT license)
 
-function(package_project)
+function(myproject_package_project)
   cmake_policy(SET CMP0103 NEW) # disallow multiple calls with the same NAME
 
   set(_options ARCH_INDEPENDENT # default to false
diff --git a/cmake/PreventInSourceBuilds.cmake b/cmake/PreventInSourceBuilds.cmake
@@ -1,7 +1,7 @@
 #
 # This function will prevent in-source builds
 #
-function(assure_out_of_source_builds)
+function(myproject_assure_out_of_source_builds)
   # make sure the user doesn't play dirty with symlinks
   get_filename_component(srcdir "${CMAKE_SOURCE_DIR}" REALPATH)
   get_filename_component(bindir "${CMAKE_BINARY_DIR}" REALPATH)
@@ -16,4 +16,4 @@ function(assure_out_of_source_builds)
   endif()
 endfunction()
 
-assure_out_of_source_builds()
+myproject_assure_out_of_source_builds()
diff --git a/cmake/Sanitizers.cmake b/cmake/Sanitizers.cmake
@@ -1,5 +1,5 @@
 function(
-  enable_sanitizers
+  myproject_enable_sanitizers
   project_name
   ENABLE_SANITIZER_ADDRESS
   ENABLE_SANITIZER_LEAK
diff --git a/cmake/StandardProjectSettings.cmake b/cmake/StandardProjectSettings.cmake
@@ -40,10 +40,6 @@ else()
 endif()
 
 
-
-include("${CMAKE_CURRENT_LIST_DIR}/Standards.cmake")
-set_standards()
-
 # run vcvarsall when msvc is used
 include("${CMAKE_CURRENT_LIST_DIR}/VCEnvironment.cmake")
 run_vcvarsall()
diff --git a/cmake/Standards.cmake b/cmake/Standards.cmake
diff --git a/cmake/StaticAnalyzers.cmake b/cmake/StaticAnalyzers.cmake
@@ -1,4 +1,4 @@
-macro(enable_cppcheck WARNINGS_AS_ERRORS CPPCHECK_OPTIONS)
+macro(myproject_enable_cppcheck WARNINGS_AS_ERRORS CPPCHECK_OPTIONS)
   find_program(CPPCHECK cppcheck)
   if(CPPCHECK)
 
@@ -46,7 +46,7 @@ macro(enable_cppcheck WARNINGS_AS_ERRORS CPPCHECK_OPTIONS)
   endif()
 endmacro()
 
-macro(enable_clang_tidy target WARNINGS_AS_ERRORS)
+macro(myproject_enable_clang_tidy target WARNINGS_AS_ERRORS)
 
   find_program(CLANGTIDY clang-tidy)
   if(CLANGTIDY)
@@ -99,7 +99,7 @@ macro(enable_clang_tidy target WARNINGS_AS_ERRORS)
   endif()
 endmacro()
 
-macro(enable_include_what_you_use)
+macro(myproject_enable_include_what_you_use)
   find_program(INCLUDE_WHAT_YOU_USE include-what-you-use)
   if(INCLUDE_WHAT_YOU_USE)
     set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE ${INCLUDE_WHAT_YOU_USE})
diff --git a/cmake/Tests.cmake b/cmake/Tests.cmake
@@ -1,4 +1,4 @@
-function(enable_coverage project_name)
+function(myproject_enable_coverage project_name)
   if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
     target_compile_options(${project_name} INTERFACE --coverage -O0 -g)
     target_link_libraries(${project_name} INTERFACE --coverage)
diff --git a/src/ftxui_sample/CMakeLists.txt b/src/ftxui_sample/CMakeLists.txt
@@ -2,15 +2,16 @@ add_executable(intro main.cpp)
 
 target_link_libraries(
   intro
-  PRIVATE myproject_options
-          myproject_warnings)
+  PRIVATE myproject::myproject_options
+          myproject::myproject_warnings)
 
 target_link_system_libraries(
   intro
   PRIVATE
           CLI11::CLI11
           fmt::fmt
           spdlog::spdlog
+          lefticus::tools
           ftxui::screen
           ftxui::dom
           ftxui::component)
diff --git a/src/ftxui_sample/main.cpp b/src/ftxui_sample/main.cpp

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-cpp-best-practices/ftxui_template`
	`1`	`+cpp-best-practices/cmake_template`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`# target_link_libraries(main_cuda PRIVATE project_options project_warnings)`
`8`	`8`	`# target_link_cuda(main_cuda)`
`9`	`9`	`#`
`10`		`-macro(target_link_cuda target)`
	`10`	`+macro(myproject_target_link_cuda target)`
`11`	`11`	`# optional named CUDA_WARNINGS`
`12`	`12`	`set(oneValueArgs CUDA_WARNINGS)`
`13`	`13`	`cmake_parse_arguments(`