Files
cppbessot/cmake/dbGenerationCommon.cmake
T

356 lines
14 KiB
CMake
Raw Normal View History

2026-02-28 02:47:18 -04:00
include_guard(GLOBAL)
if(NOT DEFINED CPPBESSOT_WORKDIR)
set(CPPBESSOT_WORKDIR "db" CACHE STRING "CppBeSSOT schema root folder, relative to PROJECT_SOURCE_DIR or absolute path")
endif()
set(_CPPBESSOT_GENERATION_COMMON_DIR "${CMAKE_CURRENT_LIST_DIR}")
2026-02-28 02:47:18 -04:00
function(cppbessot_abs_path out_var input_path)
# Purpose: Resolve a path to an absolute path anchored at PROJECT_SOURCE_DIR
# when the input is relative.
# Inputs:
# - out_var: Name of the parent-scope variable to write.
# - input_path: Relative or absolute input path.
# Outputs:
# - <out_var> (PARENT_SCOPE): Absolute resolved path.
if(IS_ABSOLUTE "${input_path}")
set(_resolved "${input_path}")
else()
set(_resolved "${PROJECT_SOURCE_DIR}/${input_path}")
endif()
get_filename_component(_resolved "${_resolved}" ABSOLUTE)
set(${out_var} "${_resolved}" PARENT_SCOPE)
endfunction()
function(cppbessot_initialize_paths)
# Purpose: Initialize commonly used CppBeSSOT module and workdir paths.
# Inputs:
# - CPPBESSOT_WORKDIR (cache/normal variable): Configured schema root path.
# Outputs:
# - CPPBESSOT_CMAKE_DIR (PARENT_SCOPE): Absolute module directory path.
# - CPPBESSOT_MODULE_ROOT (PARENT_SCOPE): Module root directory path.
# - CPPBESSOT_WORKDIR_ABS (PARENT_SCOPE): Absolute schema root path.
get_filename_component(CPPBESSOT_CMAKE_DIR "${_CPPBESSOT_GENERATION_COMMON_DIR}" ABSOLUTE)
get_filename_component(CPPBESSOT_MODULE_ROOT "${CPPBESSOT_CMAKE_DIR}/.." ABSOLUTE)
2026-02-28 02:47:18 -04:00
cppbessot_abs_path(CPPBESSOT_WORKDIR_ABS "${CPPBESSOT_WORKDIR}")
set(CPPBESSOT_CMAKE_DIR "${CPPBESSOT_CMAKE_DIR}" PARENT_SCOPE)
set(CPPBESSOT_MODULE_ROOT "${CPPBESSOT_MODULE_ROOT}" PARENT_SCOPE)
set(CPPBESSOT_WORKDIR_ABS "${CPPBESSOT_WORKDIR_ABS}" PARENT_SCOPE)
endfunction()
function(cppbessot_require_var var_name)
# Purpose: Fail fast if a required CMake variable is missing/empty.
# Inputs:
# - var_name: Variable name to validate.
# Outputs:
# - No return value; raises FATAL_ERROR on invalid input.
if(NOT DEFINED ${var_name} OR "${${var_name}}" STREQUAL "")
message(FATAL_ERROR "Missing required CMake variable `${var_name}`.")
endif()
endfunction()
function(cppbessot_validate_schema_dir_name schema_dir)
# Purpose: Validate that a schema directory selector is a basename, not a path.
2026-02-28 02:47:18 -04:00
# Inputs:
# - schema_dir: Directory basename under CPPBESSOT_WORKDIR.
2026-02-28 02:47:18 -04:00
# Outputs:
# - No return value; raises FATAL_ERROR if format is invalid.
if("${schema_dir}" STREQUAL "")
message(FATAL_ERROR "Schema directory name must not be empty.")
2026-02-28 02:47:18 -04:00
endif()
if("${schema_dir}" MATCHES "[/\\\\]")
message(FATAL_ERROR
"Schema directory name `${schema_dir}` must be a basename under CPPBESSOT_WORKDIR, not a path.")
endif()
2026-02-28 02:47:18 -04:00
endfunction()
function(cppbessot_get_schema_dir_path out_var schema_dir)
# Purpose: Resolve the absolute folder path for a specific schema directory.
2026-02-28 02:47:18 -04:00
# Inputs:
# - out_var: Parent-scope variable name to receive the path.
# - schema_dir: Schema directory basename under CPPBESSOT_WORKDIR.
2026-02-28 02:47:18 -04:00
# Outputs:
# - <out_var> (PARENT_SCOPE): Absolute `${CPPBESSOT_WORKDIR}/<schema_dir>` path.
cppbessot_validate_schema_dir_name("${schema_dir}")
2026-02-28 02:47:18 -04:00
cppbessot_abs_path(_workdir "${CPPBESSOT_WORKDIR}")
set(${out_var} "${_workdir}/${schema_dir}" PARENT_SCOPE)
2026-02-28 02:47:18 -04:00
endfunction()
function(cppbessot_assert_schema_dir_exists schema_dir)
# Purpose: Assert that a schema directory exists on disk.
2026-02-28 02:47:18 -04:00
# Inputs:
# - schema_dir: Schema directory basename.
2026-02-28 02:47:18 -04:00
# Outputs:
# - No return value; raises FATAL_ERROR if directory is missing.
cppbessot_get_schema_dir_path(_schema_dir_path "${schema_dir}")
if(NOT IS_DIRECTORY "${_schema_dir_path}")
message(FATAL_ERROR "Schema directory does not exist: ${_schema_dir_path}")
2026-02-28 02:47:18 -04:00
endif()
endfunction()
function(cppbessot_assert_openapi_exists schema_dir)
# Purpose: Assert that a schema directory's SSOT OpenAPI file exists on disk.
# Inputs:
# - schema_dir: Schema directory basename.
# Outputs:
# - No return value; raises FATAL_ERROR if file is missing.
cppbessot_get_schema_dir_path(_schema_dir_path "${schema_dir}")
set(_openapi_file "${_schema_dir_path}/openapi/openapi.yaml")
if(NOT EXISTS "${_openapi_file}")
message(FATAL_ERROR "OpenAPI file does not exist: ${_openapi_file}")
endif()
endfunction()
function(cppbessot_get_model_headers_glob out_var schema_dir)
# Purpose: Build a model-header glob expression for a schema directory.
2026-02-28 02:47:18 -04:00
# Inputs:
# - out_var: Parent-scope variable name to receive the glob pattern.
# - schema_dir: Schema directory basename.
2026-02-28 02:47:18 -04:00
# Outputs:
# - <out_var> (PARENT_SCOPE): Glob pattern for generated model headers.
cppbessot_get_schema_dir_path(_schema_dir_path "${schema_dir}")
set(${out_var} "${_schema_dir_path}/generated-cpp-source/include/*/model/*.h" PARENT_SCOPE)
2026-02-28 02:47:18 -04:00
endfunction()
function(_cppbessot_collect_openapi_schema_names out_var openapi_file filter_mode)
# Purpose: Shared OpenAPI components.schemas walker.
# Inputs:
# - out_var: Parent-scope variable for collected schema names.
# - openapi_file: Absolute path to openapi.yaml.
# - filter_mode: ALL (every top-level schema) or ODB_TABLE (x-odbTable only).
# Outputs:
# - <out_var> (PARENT_SCOPE): Collected schema names.
if(NOT "${filter_mode}" STREQUAL "ALL" AND NOT "${filter_mode}" STREQUAL "ODB_TABLE")
message(FATAL_ERROR
"Unsupported OpenAPI schema filter `${filter_mode}`; expected ALL or ODB_TABLE.")
endif()
file(STRINGS "${openapi_file}" _openapi_lines)
set(_schema_names)
set(_current_schema_name)
set(_in_components FALSE)
set(_in_schemas FALSE)
foreach(_line IN LISTS _openapi_lines)
if(_in_schemas)
if(_line MATCHES "^[^ ]" OR _line MATCHES "^ [^ ]")
set(_in_schemas FALSE)
unset(_current_schema_name)
elseif(_line MATCHES "^ ([A-Za-z_][A-Za-z0-9_]*)[ \t]*:[ \t]*$")
set(_current_schema_name "${CMAKE_MATCH_1}")
if("${filter_mode}" STREQUAL "ALL")
list(APPEND _schema_names "${_current_schema_name}")
endif()
elseif("${filter_mode}" STREQUAL "ODB_TABLE"
AND _current_schema_name
AND _line MATCHES "^ x-odbTable:[ \t]*")
list(APPEND _schema_names "${_current_schema_name}")
endif()
endif()
if(_in_components AND NOT _in_schemas)
if(_line MATCHES "^[^ ]")
set(_in_components FALSE)
elseif(_line MATCHES "^ schemas:[ \t]*$")
set(_in_schemas TRUE)
endif()
endif()
if(_line MATCHES "^components:[ \t]*$")
set(_in_components TRUE)
endif()
endforeach()
if(NOT _schema_names)
if("${filter_mode}" STREQUAL "ODB_TABLE")
message(FATAL_ERROR
"No x-odbTable schema names were found in ${openapi_file}.")
else()
message(FATAL_ERROR
"No component schema names were found in ${openapi_file}.")
endif()
endif()
list(REMOVE_DUPLICATES _schema_names)
set(${out_var} "${_schema_names}" PARENT_SCOPE)
endfunction()
function(_cppbessot_get_openapi_file_path out_var schema_dir)
# Purpose: Resolve and validate a schema directory's SSOT OpenAPI file path.
# Inputs:
# - out_var: Parent-scope variable name to receive the absolute OpenAPI path.
# - schema_dir: Schema directory basename.
# Outputs:
# - <out_var> (PARENT_SCOPE): Absolute path to openapi.yaml.
cppbessot_get_schema_dir_path(_schema_dir_path "${schema_dir}")
cppbessot_assert_openapi_exists("${schema_dir}")
set(${out_var} "${_schema_dir_path}/openapi/openapi.yaml" PARENT_SCOPE)
endfunction()
function(cppbessot_get_openapi_schema_names out_var schema_dir)
# Purpose: Parse top-level component schema names from a schema directory's OpenAPI file.
# Inputs:
# - out_var: Parent-scope variable name to receive the schema names.
# - schema_dir: Schema directory basename.
# Outputs:
# - <out_var> (PARENT_SCOPE): List of top-level component schema names.
_cppbessot_get_openapi_file_path(_openapi_file "${schema_dir}")
_cppbessot_collect_openapi_schema_names(_schema_names "${_openapi_file}" "ALL")
set(${out_var} "${_schema_names}" PARENT_SCOPE)
endfunction()
function(cppbessot_get_openapi_odb_table_schema_names out_var schema_dir)
# Purpose: Parse OpenAPI schema names that declare x-odbTable (ODB object models).
# Inputs:
# - out_var: Parent-scope variable name to receive the schema names.
# - schema_dir: Schema directory basename.
# Outputs:
# - <out_var> (PARENT_SCOPE): Schema names with x-odbTable in the OpenAPI file.
_cppbessot_get_openapi_file_path(_openapi_file "${schema_dir}")
_cppbessot_collect_openapi_schema_names(_schema_names "${_openapi_file}" "ODB_TABLE")
set(${out_var} "${_schema_names}" PARENT_SCOPE)
endfunction()
function(cppbessot_get_expected_cpp_model_outputs out_headers_var out_sources_var schema_dir)
# Purpose: Infer generated C++ model headers and sources from OpenAPI schema names.
# Inputs:
# - out_headers_var: Parent-scope variable name to receive expected headers.
# - out_sources_var: Parent-scope variable name to receive expected sources.
# - schema_dir: Schema directory basename.
# Outputs:
# - <out_headers_var> (PARENT_SCOPE): Expected generated model headers.
# - <out_sources_var> (PARENT_SCOPE): Expected generated model sources.
cppbessot_get_schema_dir_path(_schema_dir_path "${schema_dir}")
cppbessot_get_openapi_schema_names(_schema_names "${schema_dir}")
set(_headers)
set(_sources)
foreach(_schema_name IN LISTS _schema_names)
list(APPEND _headers
"${_schema_dir_path}/generated-cpp-source/include/cppbessot/model/${_schema_name}.h")
list(APPEND _sources
"${_schema_dir_path}/generated-cpp-source/src/model/${_schema_name}.cpp")
endforeach()
set(${out_headers_var} "${_headers}" PARENT_SCOPE)
set(${out_sources_var} "${_sources}" PARENT_SCOPE)
endfunction()
function(_cppbessot_build_odb_table_artifact_paths
schema_dir
schema_names
out_model_headers_var
out_sqlite_sources_var
out_pgsql_sources_var)
# Purpose: Build expected ODB model-header and backend source paths from schema names.
# Inputs:
# - schema_dir: Schema directory basename.
# - schema_names: x-odbTable schema names.
# Outputs:
# - <out_model_headers_var> (PARENT_SCOPE): Expected generated ODB model headers.
# - <out_sqlite_sources_var> (PARENT_SCOPE): Expected sqlite `*-odb.cxx` sources.
# - <out_pgsql_sources_var> (PARENT_SCOPE): Expected postgre `*-odb.cxx` sources.
cppbessot_get_schema_dir_path(_schema_dir_path "${schema_dir}")
set(_headers)
set(_sqlite_sources)
set(_pgsql_sources)
foreach(_schema_name IN LISTS schema_names)
list(APPEND _headers
"${_schema_dir_path}/generated-cpp-source/include/cppbessot/model/${_schema_name}.h")
list(APPEND _sqlite_sources
"${_schema_dir_path}/generated-odb-source/sqlite/${_schema_name}-odb.cxx")
list(APPEND _pgsql_sources
"${_schema_dir_path}/generated-odb-source/postgre/${_schema_name}-odb.cxx")
endforeach()
set(${out_model_headers_var} "${_headers}" PARENT_SCOPE)
set(${out_sqlite_sources_var} "${_sqlite_sources}" PARENT_SCOPE)
set(${out_pgsql_sources_var} "${_pgsql_sources}" PARENT_SCOPE)
endfunction()
function(cppbessot_get_expected_odb_outputs out_sqlite_sources_var out_pgsql_sources_var schema_dir)
# Purpose: Infer generated ODB backend source files from x-odbTable OpenAPI schemas.
# Inputs:
# - out_sqlite_sources_var: Parent-scope variable for sqlite `*-odb.cxx`.
# - out_pgsql_sources_var: Parent-scope variable for postgre `*-odb.cxx`.
# - schema_dir: Schema directory basename.
# Outputs:
# - <out_sqlite_sources_var> (PARENT_SCOPE): Expected sqlite ODB sources.
# - <out_pgsql_sources_var> (PARENT_SCOPE): Expected postgre ODB sources.
cppbessot_get_openapi_odb_table_schema_names(_schema_names "${schema_dir}")
_cppbessot_build_odb_table_artifact_paths(
"${schema_dir}"
"${_schema_names}"
_expected_model_headers
_sqlite_sources
_pgsql_sources)
set(${out_sqlite_sources_var} "${_sqlite_sources}" PARENT_SCOPE)
set(${out_pgsql_sources_var} "${_pgsql_sources}" PARENT_SCOPE)
endfunction()
function(cppbessot_get_expected_odb_model_headers out_var schema_dir)
# Purpose: Infer generated C++ model headers for x-odbTable OpenAPI schemas.
# Inputs:
# - out_var: Parent-scope variable name to receive expected ODB model headers.
# - schema_dir: Schema directory basename.
# Outputs:
# - <out_var> (PARENT_SCOPE): Expected generated model headers for ODB objects.
cppbessot_get_openapi_odb_table_schema_names(_schema_names "${schema_dir}")
_cppbessot_build_odb_table_artifact_paths(
"${schema_dir}"
"${_schema_names}"
_headers
_sqlite_sources
_pgsql_sources)
set(${out_var} "${_headers}" PARENT_SCOPE)
endfunction()
function(cppbessot_get_expected_odb_outputs_all out_var schema_dir)
# Purpose: Infer all generated ODB backend `*-odb.cxx` files for both backends.
# Inputs:
# - out_var: Parent-scope variable name to receive expected ODB sources.
# - schema_dir: Schema directory basename.
# Outputs:
# - <out_var> (PARENT_SCOPE): Expected sqlite + postgre ODB sources.
cppbessot_get_expected_odb_outputs(
_expected_sqlite_odb_sources
_expected_pgsql_odb_sources
"${schema_dir}")
set(_combined
${_expected_sqlite_odb_sources}
${_expected_pgsql_odb_sources})
set(${out_var} "${_combined}" PARENT_SCOPE)
endfunction()
function(cppbessot_get_expected_odb_generation_artifacts
out_model_headers_var
out_all_sources_var
schema_dir)
# Purpose: Infer ODB generation dependencies and outputs in a single OpenAPI pass.
# Inputs:
# - out_model_headers_var: Parent-scope variable for expected ODB model headers.
# - out_all_sources_var: Parent-scope variable for expected sqlite + postgre sources.
# - schema_dir: Schema directory basename.
# Outputs:
# - <out_model_headers_var> (PARENT_SCOPE): Expected generated ODB model headers.
# - <out_all_sources_var> (PARENT_SCOPE): Expected sqlite + postgre `*-odb.cxx` sources.
cppbessot_get_openapi_odb_table_schema_names(_schema_names "${schema_dir}")
_cppbessot_build_odb_table_artifact_paths(
"${schema_dir}"
"${_schema_names}"
_headers
_sqlite_sources
_pgsql_sources)
set(_combined ${_sqlite_sources} ${_pgsql_sources})
set(${out_model_headers_var} "${_headers}" PARENT_SCOPE)
set(${out_all_sources_var} "${_combined}" PARENT_SCOPE)
endfunction()