annotate cmake/MlkBcc.cmake @ 574:8cf895e51fb6

win: various improvements
author David Demelier <markand@malikania.fr>
date Fri, 10 Mar 2023 19:23:31 +0100
parents cb4508f45048
children cedfdbc0e9a7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 #
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 # CMakeLists.txt -- CMake build system for Molko's Engine
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 #
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 # Copyright (c) 2020-2022 David Demelier <markand@malikania.fr>
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 #
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 # Permission to use, copy, modify, and/or distribute this software for any
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 # purpose with or without fee is hereby granted, provided that the above
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 # copyright notice and this permission notice appear in all copies.
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 #
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 #
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
19 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
20 # mlk_bcc(
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
21 # OUTPUT_VAR variable
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
22 # ASSETS files...
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
23 # [OUTPUT_DIRECTORY directory]
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
24 # )
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
25 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
26 # Convert binary files to header files using mlk-bcc utility.
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
27 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
28 # This macro will generate all files under the OUTPUT_DIRECTORY variable which
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
29 # defaults to ${CMAKE_CURRENT_BINARY_DIR}/assets if unset.
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
30 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
31 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
32 # It will also keep the last parent directory name under the output directory
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
33 # because most users will arrange more files under a specific file hierarchy,
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
34 # this also avoid a file name conflict.
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
35 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
36 # Example, given the following assets files:
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
37 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
38 # - assets/sprites/foo.png
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
39 # - assets/sounds/volume-up.wav
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
40 # - assets/sounds/volume-down.wav
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
41 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
42 # The following files will be generated:
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
43 #
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
44 # - <output-directory>/assets/sprites/foo.h
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
45 # - <output-directory>/assets/sounds/volume-up.h
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
46 # - <output-directory>/assets/sounds/volume-down.h
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
47 #
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 macro(mlk_bcc)
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 set(options "")
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
50 set(oneValueArgs "OUTPUT_DIRECTORY;OUTPUTS_VAR")
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 set(multiValueArgs ASSETS)
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 cmake_parse_arguments(_bcc "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 if (NOT _bcc_OUTPUTS_VAR)
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 message(FATAL_ERROR "Missing OUTPUTS_VAR")
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 elseif (NOT _bcc_ASSETS)
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 message(FATAL_ERROR "Missing ASSETS")
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 endif ()
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
61 if (NOT _bcc_OUTPUT_DIRECTORY)
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
62 set(_bcc_base_directory ${CMAKE_CURRENT_BINARY_DIR}/assets)
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
63 else ()
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
64 set(_bcc_base_directory ${_bcc_OUTPUT_DIRECTORY})
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
65 endif ()
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
66
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 foreach (a ${_bcc_ASSETS})
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
68 # Determine output parent directory name.
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
69 get_filename_component(_bcc_dirname ${a} DIRECTORY)
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
70 get_filename_component(_bcc_dirname ${_bcc_dirname} NAME)
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
71
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
72 # Determine output file name.
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
73 cmake_path(GET a FILENAME _bcc_filename)
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
74 cmake_path(REPLACE_EXTENSION _bcc_filename .h)
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
75 set(_bcc_output_file ${_bcc_base_directory}/${_bcc_dirname}/${_bcc_filename})
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
76
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
77 # Text files are better NUL terminated.
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
78 cmake_path(GET a EXTENSION _bcc_extension)
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
79
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
80 if (_bcc_extension MATCHES "\\.sql")
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
81 set(_bcc_args "-0cs")
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 else ()
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
83 set(_bcc_args "-cs")
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 endif ()
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
85
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
86 # This is the mlk-bcc variable to generate the C identifier.
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
87 set(_bcc_var "assets_${_bcc_dirname}_${_bcc_filename}")
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
88
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 add_custom_command(
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
90 OUTPUT ${_bcc_output_file}
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 COMMAND
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
92 ${CMAKE_COMMAND} -E make_directory ${_bcc_base_directory}/${_bcc_dirname}
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 COMMAND
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
94 $<TARGET_FILE:mlk-bcc> ${_bcc_args} ${a} ${_bcc_var} > ${_bcc_output_file}
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
95 COMMENT "Generating asset ${_bcc_dirname}/${_bcc_filename}"
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 DEPENDS $<TARGET_FILE:mlk-bcc> ${a}
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 )
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
98
553
cb4508f45048 cmake: rework assets output directory
David Demelier <markand@malikania.fr>
parents: 552
diff changeset
99 list(APPEND ${_bcc_OUTPUTS_VAR} ${_bcc_output_file})
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 endforeach ()
574
8cf895e51fb6 win: various improvements
David Demelier <markand@malikania.fr>
parents: 553
diff changeset
101
8cf895e51fb6 win: various improvements
David Demelier <markand@malikania.fr>
parents: 553
diff changeset
102 source_group(
8cf895e51fb6 win: various improvements
David Demelier <markand@malikania.fr>
parents: 553
diff changeset
103 TREE ${_bcc_base_directory}
8cf895e51fb6 win: various improvements
David Demelier <markand@malikania.fr>
parents: 553
diff changeset
104 FILES ${${_bcc_OUTPUTS_VAR}}
8cf895e51fb6 win: various improvements
David Demelier <markand@malikania.fr>
parents: 553
diff changeset
105 PREFIX build/assets
8cf895e51fb6 win: various improvements
David Demelier <markand@malikania.fr>
parents: 553
diff changeset
106 )
447
e1fa1b867281 cmake: resurrection
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 endmacro()