1#!/usr/bin/env bash 2 3set -e 4 5# Locale can change behavior of utilities like 'sort' but we want the output 6# to be stable on all machines. Force the locale to 'C' for consistency. 7export LC_ALL=C 8 9function show_usage() { 10 cat \ 11 << EOF 12Usage: $(basename "$0") [options] <command-args>* 13 14Generate meson.build files from a directory tree containing YAML files and 15facilitate building the sdbus++ sources. 16 17Options: 18 --help - Display this message 19 --command <cmd> - Command mode to execute (default 'meson'). 20 --directory <path> - Root directory of the YAML source (default '.'). 21 --output <path> - Root directory of the output (default '.'). 22 --tool <path> - Path to the processing tool (default 'sdbus++'). 23 --version - Display this tool's version string. 24 25Commands: 26 meson - Generate a tree of meson.build files corresponding 27 to the source YAML files. 28 cpp <intf> - Generate the source files from a YAML interface. 29 markdown <intf> - Generate the markdown files from a YAML interface. 30 version - Display this tool's version string. 31 32EOF 33} 34 35## The version is somewhat arbitrary but is used to create a warning message 36## if a repository contains old copies of the generated meson.build files and 37## needs an update. We should increment the version number whenever the 38## resulting meson.build would change. 39tool_version="sdbus++-gen-meson version 5" 40function show_version() { 41 echo "${tool_version}" 42} 43 44# Set up defaults. 45sdbuspp="sdbus++" 46outputdir="." 47cmd="meson" 48rootdir="." 49 50# Parse options. 51options="$(getopt -o hc:d:o:t:v --long help,command:,directory:,output:,tool:,version -- "$@")" 52eval set -- "${options}" 53 54while true; do 55 case "$1" in 56 -h | --help) 57 show_usage 58 exit 59 ;; 60 61 -c | --command) 62 shift 63 cmd="$1" 64 shift 65 ;; 66 67 -d | --directory) 68 shift 69 rootdir="$1" 70 shift 71 ;; 72 73 -o | --output) 74 shift 75 outputdir="$1" 76 shift 77 ;; 78 79 -t | --tool) 80 shift 81 sdbuspp="$1" 82 shift 83 ;; 84 85 -v | --version) 86 show_version 87 exit 88 ;; 89 90 --) 91 shift 92 break 93 ;; 94 95 *) 96 echo "Invalid argument $1" 97 exit 1 98 ;; 99 esac 100done 101 102## Create an initially empty meson.build file. 103## $1 - path to create meson.build at. 104function meson_empty_file() { 105 mkdir -p "$1" 106 echo "# Generated file; do not modify." > "$1/meson.build" 107} 108 109## Create the root-level meson.build 110## 111## Inserts rules to run the available version of this tool to ensure the 112## version has not changed. 113function meson_create_root() { 114 meson_empty_file "${outputdir}" 115 116 cat >> "${outputdir}/meson.build" \ 117 << EOF 118sdbuspp_gen_meson_ver = run_command( 119 sdbuspp_gen_meson_prog, 120 '--version', 121 check: true, 122).stdout().strip().split('\n')[0] 123 124if sdbuspp_gen_meson_ver != '${tool_version}' 125 warning('Generated meson files from wrong version of sdbus++-gen-meson.') 126 warning( 127 'Expected "${tool_version}", got:', 128 sdbuspp_gen_meson_ver 129 ) 130endif 131 132EOF 133} 134 135## hash-tables to store: 136## meson_paths - list of subdirectory paths for which an empty meson.build 137## has already been created. 138## interfaces - list of interface paths which a YAML has been found and 139## which YAML types (interface, errors, etc.). 140declare -A meson_paths 141declare -A interfaces 142 143## Ensure the meson.build files to a path have been created. 144## $1 - The path requiring to be created. 145function meson_create_path() { 146 147 meson_path="${outputdir}" 148 prev_meson_path="" 149 150 # Split the path into segments. 151 for part in $(echo "$1" | tr '/' '\n'); do 152 prev_meson_path="${meson_path}" 153 meson_path="${meson_path}/${part}" 154 155 # Create the meson.build for this segment if it doesn't already exist. 156 if [[ "" == "${meson_paths[${meson_path}]}" ]]; then 157 meson_paths["${meson_path}"]="1" 158 meson_empty_file "${meson_path}" 159 160 # Add the 'subdir' link into the parent's meson.build. 161 # We need to skip adding the links into the 'root' meson.build 162 # because most repositories want to selectively add TLDs based 163 # on config flags. Let them figure out their own logic for that. 164 if [[ ${outputdir} != "${prev_meson_path}" ]]; then 165 echo "subdir('${part}')" >> "${prev_meson_path}/meson.build" 166 fi 167 fi 168 done 169} 170 171## Generate the meson target for the source files (.cpp/.hpp) from a YAML 172## interface. 173## 174## $1 - The interface to generate a target for. 175function meson_cpp_target() { 176 mesondir="${outputdir}/$1" 177 yamldir="$(realpath --relative-to="${mesondir}" "${rootdir}")" 178 179 # Determine the source and output files based on the YAMLs present. 180 sources="" 181 outputs="" 182 for s in ${interfaces[$1]}; do 183 sources="'${yamldir}/$1.${s}', " 184 185 case "${s}" in 186 errors.yaml) 187 outputs="${outputs}'error.cpp', 'error.hpp', " 188 ;; 189 190 interface.yaml) 191 outputs="${outputs}'server.cpp', 'server.hpp', " 192 outputs="${outputs}'client.hpp', " 193 ;; 194 195 *) 196 echo "Unknown interface type: ${s}" 197 exit 1 198 ;; 199 esac 200 done 201 202 # Create the target to generate the 'outputs'. 203 cat >> "${mesondir}/meson.build" \ 204 << EOF 205generated_sources += custom_target( 206 '$1__cpp'.underscorify(), 207 input: [ ${sources} ], 208 output: [ ${outputs} ], 209 depend_files: sdbusplusplus_depfiles, 210 command: [ 211 sdbuspp_gen_meson_prog, '--command', 'cpp', 212 '--output', meson.current_build_dir(), 213 '--tool', sdbusplusplus_prog, 214 '--directory', meson.current_source_dir() / '${yamldir}', 215 '$1', 216 ], 217) 218 219EOF 220} 221 222## Generate the meson target for the markdown files from a YAML interface. 223## $1 - The interface to generate a target for. 224function meson_md_target() { 225 mesondir="${outputdir}/$(dirname "$1")" 226 yamldir="$(realpath --relative-to="${mesondir}" "${rootdir}")" 227 228 # Determine the source files based on the YAMLs present. 229 sources="" 230 for s in ${interfaces[$1]}; do 231 sources="'${yamldir}/$1.${s}', " 232 done 233 234 # Create the target to generate the interface.md file. 235 cat >> "${mesondir}/meson.build" \ 236 << EOF 237generated_others += custom_target( 238 '$1__markdown'.underscorify(), 239 input: [ ${sources} ], 240 output: [ '$(basename "$1").md' ], 241 depend_files: sdbusplusplus_depfiles, 242 command: [ 243 sdbuspp_gen_meson_prog, '--command', 'markdown', 244 '--output', meson.current_build_dir(), 245 '--tool', sdbusplusplus_prog, 246 '--directory', meson.current_source_dir() / '${yamldir}', 247 '$1', 248 ], 249) 250 251EOF 252} 253 254## Handle command=meson by generating the tree of meson.build files. 255function cmd_meson() { 256 # Find and sort all the YAML files 257 yamls="$(find "${rootdir}" -name '*.interface.yaml' -o -name '*.errors.yaml')" 258 yamls="$(echo "${yamls}" | sort)" 259 260 # Assign the YAML files into the hash-table by interface name. 261 for y in ${yamls}; do 262 rel="$(realpath "--relative-to=${rootdir}" "${y}")" 263 dir="$(dirname "${rel}")" 264 ext="${rel#*.}" 265 base="$(basename "${rel}" ".${ext}")" 266 key="${dir}/${base}" 267 268 interfaces["${key}"]="${interfaces[${key}]} ${ext}" 269 done 270 271 # Create the meson.build files. 272 meson_create_root 273 # shellcheck disable=SC2312 274 sorted_ifaces="$(echo "${!interfaces[@]}" | tr " " "\n" | sort)" 275 for i in ${sorted_ifaces}; do 276 meson_create_path "${i}" 277 meson_cpp_target "${i}" 278 meson_md_target "${i}" 279 done 280} 281 282## Handle command=cpp by calling sdbus++ as appropriate. 283## $1 - interface to generate. 284## 285## For an interface foo/bar, the outputdir is expected to be foo/bar. 286function cmd_cpp() { 287 288 if [[ "" == "$1" ]]; then 289 show_usage 290 exit 1 291 fi 292 293 if [[ ! -e "${rootdir}/$1.interface.yaml" ]] && 294 [[ ! -e "${rootdir}/$1.errors.yaml" ]]; then 295 echo "Missing YAML for $1." 296 exit 1 297 fi 298 299 mkdir -p "${outputdir}" 300 301 sdbusppcmd="${sdbuspp} -r ${rootdir}" 302 intf="${1//\//.}" 303 304 if [[ -e "${rootdir}/$1.interface.yaml" ]]; then 305 ${sdbusppcmd} interface server-header "${intf}" > "${outputdir}/server.hpp" 306 ${sdbusppcmd} interface server-cpp "${intf}" > "${outputdir}/server.cpp" 307 ${sdbusppcmd} interface client-header "${intf}" > "${outputdir}/client.hpp" 308 fi 309 310 if [[ -e "${rootdir}/$1.errors.yaml" ]]; then 311 ${sdbusppcmd} error exception-header "${intf}" > "${outputdir}/error.hpp" 312 ${sdbusppcmd} error exception-cpp "${intf}" > "${outputdir}/error.cpp" 313 fi 314} 315 316## Handle command=markdown by calling sdbus++ as appropriate. 317## $1 - interface to generate. 318## 319## For an interface foo/bar, the outputdir is expected to be foo. 320function cmd_markdown() { 321 322 if [[ "" == "$1" ]]; then 323 show_usage 324 exit 1 325 fi 326 327 if [[ ! -e "${rootdir}/$1.interface.yaml" ]] && 328 [[ ! -e "${rootdir}/$1.errors.yaml" ]]; then 329 echo "Missing YAML for $1." 330 exit 1 331 fi 332 333 mkdir -p "${outputdir}" 334 335 sdbusppcmd="${sdbuspp} -r ${rootdir}" 336 intf="${1//\//.}" 337 base="$(basename "$1")" 338 339 echo -n > "${outputdir}/${base}.md" 340 if [[ -e "${rootdir}/$1.interface.yaml" ]]; then 341 ${sdbusppcmd} interface markdown "${intf}" >> "${outputdir}/${base}.md" 342 fi 343 344 if [[ -e "${rootdir}/$1.errors.yaml" ]]; then 345 ${sdbusppcmd} error markdown "${intf}" >> "${outputdir}/${base}.md" 346 fi 347} 348 349## Handle command=version. 350function cmd_version() { 351 show_version 352} 353 354"cmd_${cmd}" "$*" 355