Add cmake command ystdlib_cpp_library and update cmake linting exclusion paths

Author: Bill-hbrhbr

CMake/ystdlib-cpp-helpers.cmake

@@ -0,0 +1,48 @@
+# ystdlib_cpp_library()
+#
+# CMake function to imitate Bazel's cc_library rule.
+#
+# Parameters:
+# NAME: name of target (see Note)
+# HDRS: List of public header files for the library
+# PUBLIC: Add this so that this library will be exported under ystdlib::
+# PRIVATE: Add this to make the library internal to ystdlib-cpp
+#
+# Note:
+# When included as a subdirectory, ystdlib_cpp_library will always create a library named
+# ystdlib_${NAME} and alias target ystdlib::${NAME}. The ystdlib:: form should always be used to
+# reduce namespace pollution.
+function(ystdlib_cpp_library)
+    set(options
+        PUBLIC
+        PRIVATE
+    )
+    set(oneValueArgs NAME)
+    set(multiValueArgs HDRS)
+    cmake_parse_arguments(
+        arg_ystdlib_cpp_lib
+        "${options}"
+        "${oneValueArgs}"
+        "${multiValueArgs}"
+        ${ARGN}
+    )
+
+    if(YSTDLIB_CPP_ENABLE_INSTALL)
+        set(_TARGET_LIB_NAME "${arg_ystdlib_cpp_lib_NAME}")
+    else()
+        set(_TARGET_LIB_NAME "ystdlib_${arg_ystdlib_cpp_lib_NAME}")
+    endif()
+
+    # TODO: add build process for libraries with source files
+    add_library(${_TARGET_LIB_NAME} INTERFACE)
+    target_include_directories(
+        ${_TARGET_LIB_NAME}
+        INTERFACE
+            "$<BUILD_INTERFACE:${YSTDLIB_CPP_BUILD_INCLUDE_DIRS}>"
+            "$<INSTALL_INTERFACE:${YSTDLIB_CPP_INSTALL_INCLUDE_DIRS}>"
+    )
+    target_compile_features(${_TARGET_LIB_NAME} INTERFACE cxx_std_20)
+    add_library(ystdlib::${arg_ystdlib_cpp_lib_NAME} ALIAS ${_TARGET_LIB_NAME})
+
+    # TODO: install header files into target locations
+endfunction()

CMakeLists.txt

@@ -1,8 +1,21 @@
 cmake_minimum_required(VERSION 3.16.3)
 project(YSTDLIB_CPP LANGUAGES CXX)
 
+# Static everything for now
+option(BUILD_SHARED_LIBS OFF)
+option(YSTDLIB_CPP_USE_STATIC_LIBS ON)
+unset(YSTDLIB_CPP_SOVERSION)
+
 set(YSTDLIB_CPP_VERSION "0.0.1" CACHE STRING "Project version.")
 
+# When ystdlib-cpp is included as subproject (i.e. using add_subdirectory(ystdlib-cpp)) in the
+# source tree of a project that uses it, install rules are disabled.
+if(NOT CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
+    option(YSTDLIB_CPP_ENABLE_INSTALL "Enable installation rules" OFF)
+else()
+    option(YSTDLIB_CPP_ENABLE_INSTALL "Enable installation rules" ON)
+endif()
+
 # Enable exporting compile commands
 set(CMAKE_EXPORT_COMPILE_COMMANDS
     ON
@@ -11,6 +24,23 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS
     FORCE
 )
 
+# Configure include paths for building ystdlib-cpp.
+list(APPEND YSTDLIB_CPP_BUILD_INCLUDE_DIRS ${PROJECT_SOURCE_DIR}/src)
+
+# Configure include paths for projects using ystdlib-cpp after it has been installed.
+if(YSTDLIB_CPP_ENABLE_INSTALL)
+    message(WARNING "Currently only supports using ystdlib-cpp as a subdirectory to a project.")
+    list(APPEND YSTDLIB_CPP_INSTALL_INCLUDE_DIRS ${YSTDLIB_CPP_BUILD_INCLUDE_DIRS})
+else()
+    list(APPEND YSTDLIB_CPP_INSTALL_INCLUDE_DIRS ${YSTDLIB_CPP_BUILD_INCLUDE_DIRS})
+endif()
+
+# Import CMake helper functions
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/CMake)
+include(ystdlib-cpp-helpers)
+
+add_subdirectory(src/ystdlib)
+
 add_executable(dummy)
 target_sources(dummy PRIVATE src/ystdlib/hello.cpp)
 target_compile_features(dummy PRIVATE cxx_std_20)

src/ystdlib/hello.cpp

@@ -1,3 +1,4 @@
+#include <ystdlib/array/Array.hpp>
 #include <iostream>
 
 [[nodiscard]] auto main() -> int {

taskfiles/lint-cmake.yaml

@@ -10,6 +10,8 @@ tasks:
       - "{{.ROOT_DIR}}/**/CMakeLists.txt"
       - "{{.TASKFILE}}"
       - exclude: "{{.ROOT_DIR}}/**/build/*"
+      - exclude: "{{.ROOT_DIR}}/**/cmake_install.cmake"
+      - exclude: "{{.ROOT_DIR}}/**/CMakeFiles/*"
       - exclude: "{{.ROOT_DIR}}/**/submodules/*"
       - exclude: "{{.ROOT_DIR}}/**/tools/*"
     deps:
@@ -44,7 +46,8 @@ tasks:
       - |-
         . "{{.G_LINT_VENV_DIR}}/bin/activate"
         find . \
-          \( -path '**/build' -o -path '**/submodules' -o -path '**/tools' \) -prune -o \
+          \( -path '**/build' -o -path '**/CMakeFiles' -o -path '**/submodules' -o -path '**/tools' \) -prune -o \
+          ! -path "**/cmake_install.cmake" \
           \( -iname "CMakeLists.txt" -o -iname "*.cmake" -o -iname "*.cmake.in" \) \
           -print0 | \
             xargs -0 gersemi {{.FLAGS}}