capicxx-import-tools

[kheaactua]

Over the last few years I've developed some CMake and Android tools to help use the generators and build CommonAPI apps. I've finally got around to putting them all together at capicxx-import-tools. I'd like to know what the community thinks. And while the one-repo demonstration mightn't map well to any current Covesa repository, I think some solution could be worked out to move this into the Covesa GitHub organization so the entire community can benefit.

Not the replace the package's README too much, but this package has three things (see below.) All these code snippets are from the include example-app

Components

CMake utilities (capicxx-cmake-modules)

• One high level CMake Find Script that creates the full CommonAPI target. Example:

find_package(CommonAPIImporter REQUIRED COMPONENTS Core SomeIP gen MODULE)
# ...
target_link_libraries(my-app PUBLIC CommonAPI::Combined)

• A CMake Macro for running the CommonAPI generators. Example:

SET_UP_GEN_FILES(
  FIDL_FILE ${PROJECT_SOURCE_DIR}/fidl/example.fidl
  FDEPL_FILE ${PROJECT_SOURCE_DIR}/fidl/example.fdepl
  OUTPUT_DIR capi-gen-output
  VAR_PREFIX "EX"
  VERSION 1
  INTERFACES test.example.Example
)
# ...
target_sources(my-app PRIVATE
  ${EX_CORE_COMMON_PKG_DIR}/Example.hpp
  ${EX_CORE_PROXY_PKG_DIR}/ExampleProxyBase.hpp
  main.cpp
)

• See CMakeLists.txt

Soong (Android AOSP) Utilities

• A Soong default module to easily apply all the required links

cc_binary {
    name: "example.defaults",
    // Applies shared_libs[vsomeip, capicxx-*], etc.
    defaults: ["capi_app"],
}

• A Soong module to run the CommonAPI generators

// Runs the CommonAPI generator, depend on this with generated_sources in a cc_library/cc_binary
capi_genrule {
    name: "example.gen",
    fidl: "fidl/example.fidl",
    fdepl: "fidl/example.fdepl",
    interfaces: ["test.example.Example"],
    versions: ["1.0"],
}

• See Android.bp

Conan Recipes

This demonstration repository is tied together with Conan (2.4) recipes. The recipes aren't yet uploaded to any public remote, but once exported you can easily build any CommonAPI application. In capicxx-imprt-tools for instance I have this conanfile.py where I can easily get my dependencies with:

requires = "capicxx-cmake-modules/[>=0.7.5]@kheaactua/stable"

Notes/Caveats

• I have not yet tried these with cmake-conan yet, I'm confident it would be pretty straight forward though
• I've only built and tested these on Linux. I was also able to easily fork the recipes to build our QNX forks of these components.