fix build error when Boost CONFIG_MACRO is the last of the CMAKE_ARGS #1220

ibasurto · 2017-11-20T21:47:40Z

No description provided.

Build error happen when CONFIG_MACRO is in the last position of CMAKE_ARGS

ruslo · 2017-11-20T22:51:27Z

scripts/append-boost-config-macros.cmake


-foreach(i RANGE ${CMAKE_ARGC})
+foreach(i RANGE ${ARGC_COUNT})


Actually it's:

argv[0] = cmake

argv[1] = -P

argv[2] = append-boost-config-macros.cmake

So the range should be foreach(i RANGE 3 ${ARGC_COUNT}).

Please add it as a comment.

Actually it's:

argv[0] = cmake

argv[1] = -P

argv[2] = append-boost-config-macros.cmake

I'd already noted that but I had doubts that cmake behavior will keep consistent between differente versions or invocation modes. I know that args will be filtered out because there are not prefixed with CONFIG_MACRO.

I checked with a simple cmake scripts and it seems that cmake is very permissive with arguments parsing. For example, non cmake command line arguments before of the -P are ignored and passed to the scripts:

$ cat script.cmake math(EXPR argc ${CMAKE_ARGC}-1) foreach(i RANGE ${argc}) message("ARG${i}: '${CMAKE_ARGV${i}}'") endforeach() $ cmake pre1 pre2 -P script.cmake post1 post2 ARG0: 'cmake' ARG1: 'pre1' ARG2: 'pre2' ARG3: '-P' ARG4: 'cmake-scripts-args.cmake' ARG5: 'post1' ARG6: 'post2'

So the range should be foreach(i RANGE 3 ${ARGC_COUNT}).

Please add it as a comment.

Currently this is true when the scripts is called by url_sha_boost* but I prefer a more general comment like:

# args without prefix CONFIG_MACRO are filtered out # (including 'cmake' '-P' 'append-boost-config-macros.cmake')

Are you ok with that?

For example, non cmake command line arguments before of the -P are ignored

Actually it's quite a question how it should work because from documentation synopsis is:

cmake [(-D <var>=<value>)...] -P <cmake-script-file>

Is it designed to pass arguments without -D?

I see we are using -C by the way:

hunter/cmake/projects/OpenSSL/schemes/url_sha1_openssl.cmake.in

Lines 155 to 160 in b818355

"@CMAKE_COMMAND@"

"-C@HUNTER_ARGS_FILE@" # for 'HUNTER_INSTALL_LICENSE_FILES'

"-Dsrcdir=@HUNTER_PACKAGE_SOURCE_DIR@"

"-Ddstdir=@HUNTER_PACKAGE_LICENSE_DIR@"

-P

"@HUNTER_SELF@/scripts/try-copy-license.cmake"

Also I've filed the bug once:: https://gitlab.kitware.com/cmake/cmake/issues/16431 😄

args without prefix CONFIG_MACRO are filtered out

I don't think we should rely on that. Such tricks lead to non-trivial bugs.

As a summary I think it's better to refactor this into cmake -D<var>=<value> -P <cmake-script-file> and don't use CMAKE_ARGC.

Please use foreach(i RANGE 3 ${ARGC_COUNT}) here.

ruslo · 2017-11-20T22:58:18Z

examples/Boost-custom-args/config.cmake

@@ -2,6 +2,6 @@ hunter_config(
    Boost
    VERSION ${HUNTER_Boost_VERSION}
    CMAKE_ARGS
-    CONFIG_MACRO=BOOST_REGEX_MATCH_EXTRA;BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS


Keep the original example, it's still valid. Please add unit test for the script instead.

I guess the closest example will be this test with CMAKE_ARGS -> "etalon" comparing:

https://github.com/ruslo/hunter/blob/b818355f23a8d90541a3843eb867019810235484/tests/hunter_create_args_file/CMakeLists.txt

You can run it similar to regular example with PROJECT_DIR=tests/<name-of-the-test>.

This reverts commit 162cb26.

ruslo · 2017-11-21T12:51:53Z

scripts/append-boost-config-macros.cmake


-foreach(i RANGE ${CMAKE_ARGC})
+foreach(i RANGE ${ARGC_COUNT})


Please use foreach(i RANGE 3 ${ARGC_COUNT}) here.

ibasurto · 2017-11-21T13:29:54Z

As suggested, I am trying to refactor the script to no use CMAKE_ARGS but I think it is material for another pull request

ruslo

Tests looks good, please update PACKAGE_INTERNAL_DEPS_ID:

https://docs.hunter.sh/en/latest/reference/user-modules/hunter_download.html

ruslo · 2017-11-21T13:45:37Z

As suggested, I am trying to refactor the script to no use CMAKE_ARGS but I think it is material for another pull request

Usually I totally agree with as little updates as possible but Boost update involves a lot of testing so if you want to change append-boost-config-macros.cmake let's do it here. Just use separate commits.

…sha1_boost* schemes

ruslo · 2017-11-21T14:32:38Z

if you want to change append-boost-config-macros.cmake let's do it here

Please confirm that I should wait for updates.

Use a -DBOOST_CONFIG_MACROS instead. Parsing of custom args is move to a new helper function hunter_parse_boost_config_macros()

ruslo · 2017-11-21T14:45:25Z

cmake/modules/hunter_parse_boost_config_macros.cmake

@@ -0,0 +1,24 @@
+cmake_minimum_required(VERSION 3.0)


Not needed, we will inherit policies from parent.

ruslo · 2017-11-21T14:58:36Z

cmake/modules/hunter_parse_boost_config_macros.cmake

+    endif()
+  endforeach()
+  set(${outvar} ${boost_config_macros_list} PARENT_SCOPE)
+endfunction(hunter_parse_boost_config_macros)


Use endfunction().

ruslo · 2017-11-21T16:10:15Z

cmake/projects/Boost/schemes/url_sha1_boost.cmake.in

-    "@HUNTER_GLOBAL_SCRIPT_DIR@/append-boost-config-macros.cmake"
-    "@HUNTER_Boost_CMAKE_ARGS@"
+    "@CMAKE_COMMAND@"
+    "-DBOOST_CONFIG_MACROS=${boost_config_macros_list}"


examples/Boost-custom-args is not working.

This line converted to -DBOOST_CONFIG_MACROS=BOOST_1 BOOST_2 BOOST_3=5 (3 arguments, 2 ignored) instead of -DBOOST_CONFIG_MACROS=BOOST_1;BOOST_2;BOOST_3=5 (1 argument). It's better to use configure_file to create script.

…onfig_macros()

…ros.cmake Rename ‘append-boost-config-macros.cmake’ to ‘append-boost-config-macros.cmake.in’

ruslo

Thanks, looks good. Will run the tests soon, want to combine testing with another change.

ruslo · 2017-11-23T19:20:30Z

Testing:

ruslo · 2017-11-24T00:51:01Z

want to combine testing with another change

There was an error in this change, fixed.

Retesting:

ruslo · 2017-11-24T07:46:45Z

Uploading:

ibasurto · 2017-11-24T07:52:31Z

Thanks!

ruslo · 2017-11-24T13:16:25Z

Released: https://github.com/ruslo/hunter/releases/tag/v0.19.170

…ruslo#1220)

ibasurto added 2 commits November 20, 2017 22:40

change Boost-custom-args example to test build error

162cb26

Build error happen when CONFIG_MACRO is in the last position of CMAKE_ARGS

fix build error when Boost CONFIG_MACRO is the last of CMAKE_ARGS

9843117

ruslo suggested changes Nov 20, 2017

View reviewed changes

ibasurto added 2 commits November 21, 2017 12:34

add test for append-boost-config-macros.cmake script

b2d4dba

Revert "change Boost-custom-args example to test build error"

ed1e2fd

This reverts commit 162cb26.

ruslo suggested changes Nov 21, 2017

View reviewed changes

skip the first three args in append-boost-config-macros.cmake script

6eb4ed8

ruslo suggested changes Nov 21, 2017

View reviewed changes

ibasurto added 2 commits November 21, 2017 15:12

increase PACKAGE_INTERNAL_DEPS_ID after change in script used by url_…

e5f2559

…sha1_boost* schemes

add test for append-boost-config-macros.cmake script with quotes& spaces

aaf96ee

don’t use CMAKE_ARGS for the append-boost-config-macros.cmake script

e4ab64b

Use a -DBOOST_CONFIG_MACROS instead. Parsing of custom args is move to a new helper function hunter_parse_boost_config_macros()

ruslo suggested changes Nov 21, 2017

View reviewed changes

ibasurto added 2 commits November 21, 2017 16:34

remove cmake_minimum_required() in hunter_parse_boost_config_macros

cbc9e7b

use simple endfunction() in hunter_parse_boost_config_macros

46bbfaa

ruslo suggested changes Nov 21, 2017

View reviewed changes

ibasurto added 2 commits November 21, 2017 20:54

remove ‘in’ added by mistake in the foreach() in hunter_parse_boost_c…

b2a1546

…onfig_macros()

use configure_file() to pass config macros to append-boost-config-mac…

8205615

…ros.cmake Rename ‘append-boost-config-macros.cmake’ to ‘append-boost-config-macros.cmake.in’

ruslo approved these changes Nov 23, 2017

View reviewed changes

ruslo merged commit 9e53ad8 into ruslo:master Nov 24, 2017

caseymcc pushed a commit to caseymcc/hunter that referenced this pull request Mar 9, 2018

Fix build error when Boost CONFIG_MACRO is the last of the CMAKE_ARGS (…

0a4fc16

…ruslo#1220)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix build error when Boost CONFIG_MACRO is the last of the CMAKE_ARGS #1220

fix build error when Boost CONFIG_MACRO is the last of the CMAKE_ARGS #1220

ibasurto commented Nov 20, 2017

ruslo Nov 20, 2017

ibasurto Nov 21, 2017

ruslo Nov 21, 2017

ruslo Nov 21, 2017

ruslo Nov 20, 2017

ruslo Nov 21, 2017

ibasurto commented Nov 21, 2017

ruslo left a comment

ruslo commented Nov 21, 2017

ruslo commented Nov 21, 2017

ruslo Nov 21, 2017

ruslo Nov 21, 2017

ruslo Nov 21, 2017

ruslo left a comment

ruslo commented Nov 23, 2017

ruslo commented Nov 24, 2017

ruslo commented Nov 24, 2017

ibasurto commented Nov 24, 2017 via email

ruslo commented Nov 24, 2017


		foreach(i RANGE ${CMAKE_ARGC})
		foreach(i RANGE ${ARGC_COUNT})

	"@CMAKE_COMMAND@"
	"-C@HUNTER_ARGS_FILE@" # for 'HUNTER_INSTALL_LICENSE_FILES'
	"-Dsrcdir=@HUNTER_PACKAGE_SOURCE_DIR@"
	"-Ddstdir=@HUNTER_PACKAGE_LICENSE_DIR@"
	-P
	"@HUNTER_SELF@/scripts/try-copy-license.cmake"

fix build error when Boost CONFIG_MACRO is the last of the CMAKE_ARGS #1220

fix build error when Boost CONFIG_MACRO is the last of the CMAKE_ARGS #1220

Conversation

ibasurto commented Nov 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ibasurto commented Nov 21, 2017

ruslo left a comment

Choose a reason for hiding this comment

ruslo commented Nov 21, 2017

ruslo commented Nov 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ruslo left a comment

Choose a reason for hiding this comment

ruslo commented Nov 23, 2017

ruslo commented Nov 24, 2017

ruslo commented Nov 24, 2017

ibasurto commented Nov 24, 2017 via email

ruslo commented Nov 24, 2017