Skip to content

Allow metadata version definition to be surfaced in c++ + UI #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jzaki wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Allow metadata version definition to be surfaced in c++ + UI #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71f9a0e
Wire module through version to c++ definition from metadata
jzaki Jul 8, 2026
2ece983
Update template examples
jzaki Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions cmake/LogosModule.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ Usage:
logos_module(
NAME <module_name>
SOURCES <source_files...>
[VERSION <semver>]
[PROVIDER_HEADER <header_file>]
[EXTERNAL_LIBS <lib_names...>]
[FIND_PACKAGES <package_names...>]
[LINK_LIBRARIES <library_names...>]
Expand All @@ -186,6 +188,13 @@ Usage:
[INCLUDE_DIRS <directories...>]
)

VERSION is optional: it defaults to the `version` field of metadata.json,
falling back to "1.0.0" (the same default as parseMetadata.nix). It is
exposed to the module's code as the LOGOS_MODULE_VERSION compile definition.

PROVIDER_HEADER names a header to run provider-dispatch code generation
against (the LogosProviderBase API).

Example:
logos_module(
NAME my_module
Expand All @@ -207,7 +216,7 @@ function(logos_module)
cmake_parse_arguments(
MODULE
""
"NAME;PROVIDER_HEADER"
"NAME;VERSION;PROVIDER_HEADER"
"SOURCES;EXTERNAL_LIBS;FIND_PACKAGES;LINK_LIBRARIES;LINK_TARGETS;AUTOGEN_DEPENDS;INCLUDE_DIRS"
${ARGN}
)
Expand Down Expand Up @@ -246,6 +255,20 @@ function(logos_module)
set(METADATA_FILE "${CMAKE_CURRENT_BINARY_DIR}/metadata.json")
endif()

# Module version: explicit VERSION arg wins; else metadata.json's
# `version`; else "1.0.0" (same default as parseMetadata.nix).
if(NOT MODULE_VERSION)
set(MODULE_VERSION "1.0.0")
if(EXISTS "${METADATA_FILE}")
file(READ "${METADATA_FILE}" _metadata_json)
string(JSON _meta_version ERROR_VARIABLE _meta_version_err
GET "${_metadata_json}" version)
if(NOT _meta_version_err)
set(MODULE_VERSION "${_meta_version}")
endif()
endif()
endif()

# Find additional packages
foreach(pkg ${MODULE_FIND_PACKAGES})
find_package(${pkg} REQUIRED)
Expand Down Expand Up @@ -374,6 +397,10 @@ function(logos_module)
OUTPUT_NAME "${MODULE_NAME}_plugin"
)

# Expose the module version to the module's own code.
target_compile_definitions(${MODULE_NAME}_module_plugin PRIVATE
LOGOS_MODULE_VERSION="${MODULE_VERSION}")

# Add dependency on code generator for source layout
if(LOGOS_CPP_SDK_IS_SOURCE)
add_dependencies(${MODULE_NAME}_module_plugin run_cpp_generator_${MODULE_NAME})
Expand Down Expand Up @@ -676,5 +703,5 @@ function(logos_module)
OPTIONAL
)

message(STATUS "Logos module ${MODULE_NAME} configured successfully")
message(STATUS "Logos module ${MODULE_NAME} v${MODULE_VERSION} configured successfully")
endfunction()
1 change: 1 addition & 0 deletions templates/CMakeLists.txt.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ logos_module(
SOURCES
@MODULE_SOURCES@
# Uncomment and modify as needed:
# VERSION 1.0.0 (defaults to metadata.json's `version`)
# EXTERNAL_LIBS
# @EXTERNAL_LIBS@
# FIND_PACKAGES
Expand Down
9 changes: 8 additions & 1 deletion templates/minimal-module/src/minimal_impl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
#include "minimal_impl.h"

// LOGOS_MODULE_VERSION is defined by logos_module() from metadata.json's
// `version` field (or an explicit VERSION argument in CMakeLists.txt).
// The fallback keeps IDEs and standalone compiles working.
#ifndef LOGOS_MODULE_VERSION
#define LOGOS_MODULE_VERSION "0.0.0-dev"
#endif

std::string MinimalImpl::greet(const std::string& name)
{
std::string greeting = "Hello, " + name + "! Greetings from the minimal module.";
Expand All @@ -12,5 +19,5 @@ std::string MinimalImpl::greet(const std::string& name)

std::string MinimalImpl::getStatus()
{
return "Minimal module is running.";
return "Minimal module v" LOGOS_MODULE_VERSION " is running.";
}
Loading