From f4f50db44155a4e050c58a74849ba8859e5daf51 Mon Sep 17 00:00:00 2001 From: Charles Brunet Date: Wed, 17 May 2023 16:29:39 -0400 Subject: qt: add preserve_paths keyword to functions This allow to generate ui and moc under subdirectories, as this is allowed with generic generators. --- docs/markdown/Qt6-module.md | 17 ++++++++++++++++- docs/markdown/_include_qt_base.md | 15 +++++++++++++++ docs/markdown/snippets/qt_preserve_path_from.md | 10 ++++++++++ 3 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docs/markdown/snippets/qt_preserve_path_from.md (limited to 'docs/markdown') diff --git a/docs/markdown/Qt6-module.md b/docs/markdown/Qt6-module.md index 8e8ec71e0..0a453dd41 100644 --- a/docs/markdown/Qt6-module.md +++ b/docs/markdown/Qt6-module.md @@ -39,6 +39,11 @@ It takes no positional arguments, and the following keyword arguments: *New in 0.60.0*: support for custom_target, custom_target_index, and generator_output. - `extra_args` string[]: Extra arguments to pass directly to `qt-uic` - `method` string: The method to use to detect Qt, see [[dependency]] + - `preserve_paths` bool: *New in 1.4.0*. If `true`, specifies that the output + files need to maintain their directory structure inside the target temporary + directory. For instance, when a file called `subdir/one.input` is processed + it generates a file `{target private directory}/subdir/one.out` when `true`, + and `{target private directory}/one.out` when `false` (default). ## compile_moc @@ -59,6 +64,11 @@ It takes no positional arguments, and the following keyword arguments: - `dependencies`: dependency objects whose include directories are used by moc. - `include_directories` (string | IncludeDirectory)[]: A list of `include_directory()` objects used when transpiling the .moc files + - `preserve_paths` bool: *New in 1.4.0*. If `true`, specifies that the output + files need to maintain their directory structure inside the target temporary + directory. For instance, when a file called `subdir/one.input` is processed + it generates a file `{target private directory}/subdir/one.out` when `true`, + and `{target private directory}/one.out` when `false` (default). ## preprocess @@ -96,7 +106,12 @@ This method takes the following keyword arguments: - `dependencies` Dependency[]: dependency objects needed by moc. - *Deprecated in 0.59.0.*: `sources`: a list of extra sources, which are added to the output unchanged. - + - `preserve_paths` bool: *Since 1.4.0*. If `true`, specifies that the output + files need to maintain their directory structure inside the target temporary + directory. For instance, when a file called `subdir/one.input` is processed + it generates a file `{target private directory}/subdir/one.out` when `true`, + and `{target private directory}/one.out` when `false` (default). + It returns an array of targets and sources to pass to a compilation target. ## compile_translations diff --git a/docs/markdown/_include_qt_base.md b/docs/markdown/_include_qt_base.md index adc6f7c6f..00d1f8344 100644 --- a/docs/markdown/_include_qt_base.md +++ b/docs/markdown/_include_qt_base.md @@ -28,6 +28,11 @@ It takes no positional arguments, and the following keyword arguments: - `extra_args` string[]: Extra arguments to pass directly to `qt-uic` - `method` string: The method to use to detect Qt, see `dependency()` for more information. + - `preserve_paths` bool: *Since 1.4.0*. If `true`, specifies that the output + files need to maintain their directory structure inside the target temporary + directory. For instance, when a file called `subdir/one.input` is processed + it generates a file `{target private directory}/subdir/one.out` when `true`, + and `{target private directory}/one.out` when `false` (default). ## compile_moc @@ -49,6 +54,11 @@ It takes no positional arguments, and the following keyword arguments: - `dependencies`: dependency objects whose include directories are used by moc. - `include_directories` (string | IncludeDirectory)[]: A list of `include_directory()` objects used when transpiling the .moc files + - `preserve_paths` bool: *New in 1.4.0*. If `true`, specifies that the output + files need to maintain their directory structure inside the target temporary + directory. For instance, when a file called `subdir/one.input` is processed + it generates a file `{target private directory}/subdir/one.out` when `true`, + and `{target private directory}/one.out` when `false` (default). ## preprocess @@ -78,6 +88,11 @@ This method takes the following keyword arguments: - `rcc_extra_arguments` string[]: any additional arguments to `rcc`. Since v0.49.0. - `dependencies` Dependency[]: dependency objects needed by moc. Available since v0.48.0. - `sources`: a list of extra sources, which are added to the output unchanged. Deprecated in 0.59.0. + - `preserve_paths` bool: *New in 1.4.0*. If `true`, specifies that the output + files need to maintain their directory structure inside the target temporary + directory. For instance, when a file called `subdir/one.input` is processed + it generates a file `{target private directory}/subdir/one.out` when `true`, + and `{target private directory}/one.out` when `false` (default). It returns an array of targets and sources to pass to a compilation target. diff --git a/docs/markdown/snippets/qt_preserve_path_from.md b/docs/markdown/snippets/qt_preserve_path_from.md new file mode 100644 index 000000000..1a0923a72 --- /dev/null +++ b/docs/markdown/snippets/qt_preserve_path_from.md @@ -0,0 +1,10 @@ +## Added `preserve_paths` keyword argument to qt module functions. + +In `qt4`, `qt5`, and `qt6` modules, `compile_ui`, `compile_moc`, and +`preprocess` functions now have a `preserve_paths` keyword argument. + +If `'true`, it specifies that the output files need to maintain their directory +structure inside the target temporary directory. For instance, when a file +called `subdir/one.input` is processed it generates a file +`{target private directory}/subdir/one.out` when `true`, +and `{target private directory}/one.out` when `false` (default). -- cgit v1.2.3