blob: 27c0f4eac312b2aba9f230d7ff81de848dead0dc [file] [log] [blame]
Patrick Williams847a0c32020-06-24 15:18:10 -05001#!/usr/bin/env bash
2
3set -e
4
Patrick Williamsa4c9edc2020-12-17 21:02:36 -06005# 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
Patrick Williams847a0c32020-06-24 15:18:10 -05009function show_usage {
10 cat \
Patrick Williams9ede18b2022-03-12 07:55:36 -060011 << EOF
Patrick Williams847a0c32020-06-24 15:18:10 -050012Usage: $(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.
William A. Kennington III293c8a22022-09-02 14:35:54 -070039tool_version="sdbus++-gen-meson version 4"
Patrick Williams847a0c32020-06-24 15:18:10 -050040function show_version {
Patrick Williamsd77548a2022-04-29 14:43:15 -050041 echo "${tool_version}"
Patrick Williams847a0c32020-06-24 15:18:10 -050042}
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 -- "$@")"
Patrick Williamsd77548a2022-04-29 14:43:15 -050052eval set -- "${options}"
Patrick Williams847a0c32020-06-24 15:18:10 -050053
Patrick Williams9ede18b2022-03-12 07:55:36 -060054while true; do
Patrick Williams847a0c32020-06-24 15:18:10 -050055 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 ;;
Patrick Williamsd77548a2022-04-29 14:43:15 -050094
95 *)
96 echo "Invalid argument $1"
97 exit 1
98 ;;
Patrick Williams847a0c32020-06-24 15:18:10 -050099 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 {
Patrick Williamsd77548a2022-04-29 14:43:15 -0500114 meson_empty_file "${outputdir}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500115
Patrick Williamsd77548a2022-04-29 14:43:15 -0500116 cat >> "${outputdir}/meson.build" \
Patrick Williams9ede18b2022-03-12 07:55:36 -0600117 << EOF
Patrick Williams847a0c32020-06-24 15:18:10 -0500118sdbuspp_gen_meson_ver = run_command(
119 sdbuspp_gen_meson_prog,
120 '--version',
121).stdout().strip().split('\n')[0]
122
Patrick Williamsd77548a2022-04-29 14:43:15 -0500123if sdbuspp_gen_meson_ver != '${tool_version}'
Patrick Williams847a0c32020-06-24 15:18:10 -0500124 warning('Generated meson files from wrong version of sdbus++-gen-meson.')
125 warning(
Patrick Williamsd77548a2022-04-29 14:43:15 -0500126 'Expected "${tool_version}", got:',
Patrick Williams847a0c32020-06-24 15:18:10 -0500127 sdbuspp_gen_meson_ver
128 )
129endif
130
131EOF
132}
133
134## hash-tables to store:
135## meson_paths - list of subdirectory paths for which an empty meson.build
136## has already been created.
137## interfaces - list of interface paths which a YAML has been found and
138## which YAML types (interface, errors, etc.).
139declare -A meson_paths
140declare -A interfaces
141
142## Ensure the meson.build files to a path have been created.
143## $1 - The path requiring to be created.
144function meson_create_path {
145
Patrick Williamsd77548a2022-04-29 14:43:15 -0500146 meson_path="${outputdir}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500147 prev_meson_path=""
148
149 # Split the path into segments.
Patrick Williams9ede18b2022-03-12 07:55:36 -0600150 for part in $(echo "$1" | tr '/' '\n'); do
Patrick Williamsd77548a2022-04-29 14:43:15 -0500151 prev_meson_path="${meson_path}"
152 meson_path="${meson_path}/${part}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500153
154 # Create the meson.build for this segment if it doesn't already exist.
Patrick Williamsd77548a2022-04-29 14:43:15 -0500155 if [[ "" == "${meson_paths[${meson_path}]}" ]]; then
156 meson_paths["${meson_path}"]="1"
157 meson_empty_file "${meson_path}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500158
159 # Add the 'subdir' link into the parent's meson.build.
160 # We need to skip adding the links into the 'root' meson.build
161 # because most repositories want to selectively add TLDs based
162 # on config flags. Let them figure out their own logic for that.
Patrick Williamsd77548a2022-04-29 14:43:15 -0500163 if [[ ${outputdir} != "${prev_meson_path}" ]]; then
164 echo "subdir('${part}')" >> "${prev_meson_path}/meson.build"
Patrick Williams847a0c32020-06-24 15:18:10 -0500165 fi
166 fi
167 done
168}
169
170## Generate the meson target for the source files (.cpp/.hpp) from a YAML
171## interface.
172##
173## $1 - The interface to generate a target for.
174function meson_cpp_target {
Patrick Williamsd77548a2022-04-29 14:43:15 -0500175 mesondir="${outputdir}/$1"
176 yamldir="$(realpath --relative-to="${mesondir}" "${rootdir}")"
Patrick Williams847a0c32020-06-24 15:18:10 -0500177
178 # Determine the source and output files based on the YAMLs present.
179 sources=""
180 outputs=""
Patrick Williams9ede18b2022-03-12 07:55:36 -0600181 for s in ${interfaces[$1]}; do
Patrick Williamsd77548a2022-04-29 14:43:15 -0500182 sources="'${yamldir}/$1.${s}', "
Patrick Williams847a0c32020-06-24 15:18:10 -0500183
Patrick Williamsd77548a2022-04-29 14:43:15 -0500184 case "${s}" in
Patrick Williams847a0c32020-06-24 15:18:10 -0500185 errors.yaml)
186 outputs="${outputs}'error.cpp', 'error.hpp', "
187 ;;
188
189 interface.yaml)
190 outputs="${outputs}'server.cpp', 'server.hpp', "
191 outputs="${outputs}'client.hpp', "
192 ;;
Patrick Williamsd77548a2022-04-29 14:43:15 -0500193
194 *)
195 echo "Unknown interface type: ${s}"
196 exit 1
197 ;;
Patrick Williams847a0c32020-06-24 15:18:10 -0500198 esac
199 done
200
201 # Create the target to generate the 'outputs'.
Patrick Williamsd77548a2022-04-29 14:43:15 -0500202 cat >> "${mesondir}/meson.build" \
Patrick Williams9ede18b2022-03-12 07:55:36 -0600203 << EOF
Patrick Williams847a0c32020-06-24 15:18:10 -0500204generated_sources += custom_target(
205 '$1__cpp'.underscorify(),
Patrick Williamsd77548a2022-04-29 14:43:15 -0500206 input: [ ${sources} ],
207 output: [ ${outputs} ],
William A. Kennington III293c8a22022-09-02 14:35:54 -0700208 depend_files: sdbusplusplus_depfiles,
Patrick Williams847a0c32020-06-24 15:18:10 -0500209 command: [
210 sdbuspp_gen_meson_prog, '--command', 'cpp',
211 '--output', meson.current_build_dir(),
212 '--tool', sdbusplusplus_prog,
Patrick Williamsd77548a2022-04-29 14:43:15 -0500213 '--directory', meson.current_source_dir() / '${yamldir}',
Patrick Williams847a0c32020-06-24 15:18:10 -0500214 '$1',
215 ],
216)
217
218EOF
219}
220
221## Generate the meson target for the markdown files from a YAML interface.
222## $1 - The interface to generate a target for.
223function meson_md_target {
Patrick Williamsd77548a2022-04-29 14:43:15 -0500224 mesondir="${outputdir}/$(dirname "$1")"
225 yamldir="$(realpath --relative-to="${mesondir}" "${rootdir}")"
Patrick Williams847a0c32020-06-24 15:18:10 -0500226
227 # Determine the source files based on the YAMLs present.
228 sources=""
Patrick Williams9ede18b2022-03-12 07:55:36 -0600229 for s in ${interfaces[$1]}; do
Patrick Williamsd77548a2022-04-29 14:43:15 -0500230 sources="'${yamldir}/$1.${s}', "
Patrick Williams847a0c32020-06-24 15:18:10 -0500231 done
232
233 # Create the target to generate the interface.md file.
Patrick Williamsd77548a2022-04-29 14:43:15 -0500234 cat >> "${mesondir}/meson.build" \
Patrick Williams9ede18b2022-03-12 07:55:36 -0600235 << EOF
Patrick Williams847a0c32020-06-24 15:18:10 -0500236generated_others += custom_target(
237 '$1__markdown'.underscorify(),
Patrick Williamsd77548a2022-04-29 14:43:15 -0500238 input: [ ${sources} ],
Patrick Williams847a0c32020-06-24 15:18:10 -0500239 output: [ '$(basename "$1").md' ],
William A. Kennington III293c8a22022-09-02 14:35:54 -0700240 depend_files: sdbusplusplus_depfiles,
Patrick Williams847a0c32020-06-24 15:18:10 -0500241 command: [
242 sdbuspp_gen_meson_prog, '--command', 'markdown',
243 '--output', meson.current_build_dir(),
244 '--tool', sdbusplusplus_prog,
Patrick Williamsd77548a2022-04-29 14:43:15 -0500245 '--directory', meson.current_source_dir() / '${yamldir}',
Patrick Williams847a0c32020-06-24 15:18:10 -0500246 '$1',
247 ],
Patrick Williams847a0c32020-06-24 15:18:10 -0500248)
249
250EOF
251}
252
253## Handle command=meson by generating the tree of meson.build files.
254function cmd_meson {
Willam A. Kennington IIIce8d16d2022-09-07 15:46:40 -0700255 # Find and sort all the YAML files
256 yamls="$(find "${rootdir}" -name '*.interface.yaml' -o -name '*.errors.yaml')"
257 yamls="$(echo "${yamls}" | sort)"
Patrick Williams847a0c32020-06-24 15:18:10 -0500258
259 # Assign the YAML files into the hash-table by interface name.
Patrick Williamsd77548a2022-04-29 14:43:15 -0500260 for y in ${yamls}; do
261 rel="$(realpath "--relative-to=${rootdir}" "${y}")"
262 dir="$(dirname "${rel}")"
Patrick Williams847a0c32020-06-24 15:18:10 -0500263 ext="${rel#*.}"
Patrick Williamsd77548a2022-04-29 14:43:15 -0500264 base="$(basename "${rel}" ".${ext}")"
265 key="${dir}/${base}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500266
Patrick Williamsd77548a2022-04-29 14:43:15 -0500267 interfaces["${key}"]="${interfaces[${key}]} ${ext}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500268 done
269
270 # Create the meson.build files.
271 meson_create_root
Patrick Williamsd77548a2022-04-29 14:43:15 -0500272 # shellcheck disable=SC2312
Patrick Williams847a0c32020-06-24 15:18:10 -0500273 sorted_ifaces="$(echo "${!interfaces[@]}" | tr " " "\n" | sort)"
Patrick Williams9ede18b2022-03-12 07:55:36 -0600274 for i in ${sorted_ifaces}; do
Patrick Williamsd77548a2022-04-29 14:43:15 -0500275 meson_create_path "${i}"
276 meson_cpp_target "${i}"
277 meson_md_target "${i}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500278 done
279}
280
281## Handle command=cpp by calling sdbus++ as appropriate.
282## $1 - interface to generate.
283##
284## For an interface foo/bar, the outputdir is expected to be foo/bar.
285function cmd_cpp {
286
Patrick Williamsd77548a2022-04-29 14:43:15 -0500287 if [[ "" == "$1" ]]; then
Patrick Williams847a0c32020-06-24 15:18:10 -0500288 show_usage
289 exit 1
290 fi
291
Patrick Williamsd77548a2022-04-29 14:43:15 -0500292 if [[ ! -e "${rootdir}/$1.interface.yaml" ]] &&
293 [[ ! -e "${rootdir}/$1.errors.yaml" ]]; then
Patrick Williams847a0c32020-06-24 15:18:10 -0500294 echo "Missing YAML for $1."
295 exit 1
296 fi
297
Patrick Williamsd77548a2022-04-29 14:43:15 -0500298 mkdir -p "${outputdir}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500299
Patrick Williamsd77548a2022-04-29 14:43:15 -0500300 sdbusppcmd="${sdbuspp} -r ${rootdir}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500301 intf="${1//\//.}"
302
Patrick Williamsd77548a2022-04-29 14:43:15 -0500303 if [[ -e "${rootdir}/$1.interface.yaml" ]]; then
304 ${sdbusppcmd} interface server-header "${intf}" > "${outputdir}/server.hpp"
305 ${sdbusppcmd} interface server-cpp "${intf}" > "${outputdir}/server.cpp"
306 ${sdbusppcmd} interface client-header "${intf}" > "${outputdir}/client.hpp"
Patrick Williams847a0c32020-06-24 15:18:10 -0500307 fi
308
Patrick Williamsd77548a2022-04-29 14:43:15 -0500309 if [[ -e "${rootdir}/$1.errors.yaml" ]]; then
310 ${sdbusppcmd} error exception-header "${intf}" > "${outputdir}/error.hpp"
311 ${sdbusppcmd} error exception-cpp "${intf}" > "${outputdir}/error.cpp"
Patrick Williams847a0c32020-06-24 15:18:10 -0500312 fi
313}
314
315## Handle command=markdown by calling sdbus++ as appropriate.
316## $1 - interface to generate.
317##
318## For an interface foo/bar, the outputdir is expected to be foo.
319function cmd_markdown {
320
Patrick Williamsd77548a2022-04-29 14:43:15 -0500321 if [[ "" == "$1" ]]; then
Patrick Williams847a0c32020-06-24 15:18:10 -0500322 show_usage
323 exit 1
324 fi
325
Patrick Williamsd77548a2022-04-29 14:43:15 -0500326 if [[ ! -e "${rootdir}/$1.interface.yaml" ]] &&
327 [[ ! -e "${rootdir}/$1.errors.yaml" ]]; then
Patrick Williams847a0c32020-06-24 15:18:10 -0500328 echo "Missing YAML for $1."
329 exit 1
330 fi
331
Patrick Williamsd77548a2022-04-29 14:43:15 -0500332 mkdir -p "${outputdir}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500333
Patrick Williamsd77548a2022-04-29 14:43:15 -0500334 sdbusppcmd="${sdbuspp} -r ${rootdir}"
Patrick Williams847a0c32020-06-24 15:18:10 -0500335 intf="${1//\//.}"
336 base="$(basename "$1")"
337
Patrick Williamsd77548a2022-04-29 14:43:15 -0500338 echo -n > "${outputdir}/${base}.md"
339 if [[ -e "${rootdir}/$1.interface.yaml" ]]; then
340 ${sdbusppcmd} interface markdown "${intf}" >> "${outputdir}/${base}.md"
Patrick Williams847a0c32020-06-24 15:18:10 -0500341 fi
342
Patrick Williamsd77548a2022-04-29 14:43:15 -0500343 if [[ -e "${rootdir}/$1.errors.yaml" ]]; then
344 ${sdbusppcmd} error markdown "${intf}" >> "${outputdir}/${base}.md"
Patrick Williams847a0c32020-06-24 15:18:10 -0500345 fi
346}
347
348## Handle command=version.
349function cmd_version {
350 show_version
351}
352
Patrick Williamsd77548a2022-04-29 14:43:15 -0500353"cmd_${cmd}" "$*"