vcpkg/scripts/cmake/vcpkg_execute_required_process_repeat.cmake

#[===[.md:
# vcpkg_execute_required_process_repeat

Execute a process until the command succeeds, or until the COUNT is reached.

## Usage
```cmake
vcpkg_execute_required_process_repeat(
    COUNT <num>
    COMMAND <cmd> [<arguments>]
    WORKING_DIRECTORY <directory>
    LOGNAME <name>
)
```
#]===]

function(vcpkg_execute_required_process_repeat)
    # parse parameters such that semicolons in options arguments to COMMAND don't get erased
    cmake_parse_arguments(PARSE_ARGV 0 vcpkg_execute_required_process_repeat "ALLOW_IN_DOWNLOAD_MODE" "COUNT;WORKING_DIRECTORY;LOGNAME" "COMMAND")
    #debug_message("vcpkg_execute_required_process_repeat(${vcpkg_execute_required_process_repeat_COMMAND})")
    if (DEFINED VCPKG_DOWNLOAD_MODE AND NOT vcpkg_execute_required_process_repeat_ALLOW_IN_DOWNLOAD_MODE)
        message(FATAL_ERROR
[[
This command cannot be executed in Download Mode.
Halting portfile execution.
]])
    endif()
    set(SUCCESSFUL_EXECUTION FALSE)
    foreach(loop_count RANGE ${vcpkg_execute_required_process_repeat_COUNT})
        vcpkg_execute_in_download_mode(
            COMMAND ${vcpkg_execute_required_process_repeat_COMMAND}
            OUTPUT_FILE ${CURRENT_BUILDTREES_DIR}/${vcpkg_execute_required_process_repeat_LOGNAME}-out-${loop_count}.log
            ERROR_FILE ${CURRENT_BUILDTREES_DIR}/${vcpkg_execute_required_process_repeat_LOGNAME}-err-${loop_count}.log
            RESULT_VARIABLE error_code
            WORKING_DIRECTORY ${vcpkg_execute_required_process_repeat_WORKING_DIRECTORY})
        #debug_message("error_code=${error_code}")
        file(TO_NATIVE_PATH "${CURRENT_BUILDTREES_DIR}" NATIVE_BUILDTREES_DIR)
        if(NOT error_code)
            set(SUCCESSFUL_EXECUTION TRUE)
            break()
        endif()
    endforeach(loop_count)
    if (NOT SUCCESSFUL_EXECUTION)
        z_vcpkg_prettify_command_line(vcpkg_execute_required_process_repeat_COMMAND_PRETTY ${vcpkg_execute_required_process_repeat_COMMAND})
        message(FATAL_ERROR
            "  Command failed: ${vcpkg_execute_required_process_repeat_COMMAND_PRETTY}\n"
            "  Working Directory: ${vcpkg_execute_required_process_repeat_WORKING_DIRECTORY}\n"
            "  See logs for more information:\n"
            "    ${NATIVE_BUILDTREES_DIR}\\${vcpkg_execute_required_process_repeat_LOGNAME}-out.log\n"
            "    ${NATIVE_BUILDTREES_DIR}\\${vcpkg_execute_required_process_repeat_LOGNAME}-err.log\n"
        )
    endif()
endfunction()
[vcpkg docs] Check for documentation generation in CI (#14614) * [vcpkg docs] Change how documenting port functions works Instead of using `##`, use comment blocks for documentation. Also, add some minor docs and change RST -> MD so we actually get docs generated. * add CI stuff * regenerate docs * fix vcpkg_find_acquire_program to not use _execute_process 2020-12-02 05:37:26 +08:00			`#[===[.md:`
			`# vcpkg_execute_required_process_repeat`

			`Execute a process until the command succeeds, or until the COUNT is reached.`

			`## Usage`
			```cmake
			`vcpkg_execute_required_process_repeat(`
			`COUNT <num>`
			`COMMAND <cmd> [<arguments>]`
			`WORKING_DIRECTORY <directory>`
			`LOGNAME <name>`
			`)`
			```
			`#]===]`

need a function to repeatedly build up to a number of failures, since qt builds are so flaky 2016-10-25 17:56:02 +08:00			`function(vcpkg_execute_required_process_repeat)`
[vcpkg] Fix more cases of semicolon mishandling in "scripts" - follow-up to PR #12926 (#13968) 2020-10-27 10:30:27 +08:00			`# parse parameters such that semicolons in options arguments to COMMAND don't get erased`
			`cmake_parse_arguments(PARSE_ARGV 0 vcpkg_execute_required_process_repeat "ALLOW_IN_DOWNLOAD_MODE" "COUNT;WORKING_DIRECTORY;LOGNAME" "COMMAND")`
need a function to repeatedly build up to a number of failures, since qt builds are so flaky 2016-10-25 17:56:02 +08:00			`#debug_message("vcpkg_execute_required_process_repeat(${vcpkg_execute_required_process_repeat_COMMAND})")`
[vcpkg] Fix more cases of semicolon mishandling in "scripts" - follow-up to PR #12926 (#13968) 2020-10-27 10:30:27 +08:00			`if (DEFINED VCPKG_DOWNLOAD_MODE AND NOT vcpkg_execute_required_process_repeat_ALLOW_IN_DOWNLOAD_MODE)`
[(z_)vcpkg_prettify_command(_line)] Scripts Tree Audit (#16130) * [vcpkg_prettify_command] Audit * rename file * rename out-var in docs * fix file path * add internal use message to docs * escapin' in z_vcpkg_prettify_command_line * regenerate docs 2021-02-10 07:53:36 +08:00			`message(FATAL_ERROR`
[vcpkg] Fix more cases of semicolon mishandling in "scripts" - follow-up to PR #12926 (#13968) 2020-10-27 10:30:27 +08:00			`[[`
			`This command cannot be executed in Download Mode.`
			`Halting portfile execution.`
			`]])`
			`endif()`
[vcpkg-qmake] Tidy qmake-based builds. Search for qmake.exe inside tools. 2017-03-21 07:10:45 +08:00			`set(SUCCESSFUL_EXECUTION FALSE)`
need a function to repeatedly build up to a number of failures, since qt builds are so flaky 2016-10-25 17:56:02 +08:00			`foreach(loop_count RANGE ${vcpkg_execute_required_process_repeat_COUNT})`
[vcpkg] Fix more cases of semicolon mishandling in "scripts" - follow-up to PR #12926 (#13968) 2020-10-27 10:30:27 +08:00			`vcpkg_execute_in_download_mode(`
need a function to repeatedly build up to a number of failures, since qt builds are so flaky 2016-10-25 17:56:02 +08:00			`COMMAND ${vcpkg_execute_required_process_repeat_COMMAND}`
[vcpkg-qmake] Tidy qmake-based builds. Search for qmake.exe inside tools. 2017-03-21 07:10:45 +08:00			`OUTPUT_FILE ${CURRENT_BUILDTREES_DIR}/${vcpkg_execute_required_process_repeat_LOGNAME}-out-${loop_count}.log`
			`ERROR_FILE ${CURRENT_BUILDTREES_DIR}/${vcpkg_execute_required_process_repeat_LOGNAME}-err-${loop_count}.log`
need a function to repeatedly build up to a number of failures, since qt builds are so flaky 2016-10-25 17:56:02 +08:00			`RESULT_VARIABLE error_code`
			`WORKING_DIRECTORY ${vcpkg_execute_required_process_repeat_WORKING_DIRECTORY})`
			`#debug_message("error_code=${error_code}")`
			`file(TO_NATIVE_PATH "${CURRENT_BUILDTREES_DIR}" NATIVE_BUILDTREES_DIR)`
			`if(NOT error_code)`
			`set(SUCCESSFUL_EXECUTION TRUE)`
			`break()`
			`endif()`
			`endforeach(loop_count)`
[vcpkg-qmake] Tidy qmake-based builds. Search for qmake.exe inside tools. 2017-03-21 07:10:45 +08:00			`if (NOT SUCCESSFUL_EXECUTION)`
[(z_)vcpkg_prettify_command(_line)] Scripts Tree Audit (#16130) * [vcpkg_prettify_command] Audit * rename file * rename out-var in docs * fix file path * add internal use message to docs * escapin' in z_vcpkg_prettify_command_line * regenerate docs 2021-02-10 07:53:36 +08:00			`z_vcpkg_prettify_command_line(vcpkg_execute_required_process_repeat_COMMAND_PRETTY ${vcpkg_execute_required_process_repeat_COMMAND})`
need a function to repeatedly build up to a number of failures, since qt builds are so flaky 2016-10-25 17:56:02 +08:00			`message(FATAL_ERROR`
[vcpkg] Use spaces instead of semicolons in the output (#7080) * Use spaces instead of semicolons in the output * Add prettify_command macro * Move pretty_command macro to a separate file 2019-07-02 04:30:24 +08:00			`" Command failed: ${vcpkg_execute_required_process_repeat_COMMAND_PRETTY}\n"`
need a function to repeatedly build up to a number of failures, since qt builds are so flaky 2016-10-25 17:56:02 +08:00			`" Working Directory: ${vcpkg_execute_required_process_repeat_WORKING_DIRECTORY}\n"`
			`" See logs for more information:\n"`
			`" ${NATIVE_BUILDTREES_DIR}\\${vcpkg_execute_required_process_repeat_LOGNAME}-out.log\n"`
			`" ${NATIVE_BUILDTREES_DIR}\\${vcpkg_execute_required_process_repeat_LOGNAME}-err.log\n"`
			`)`
			`endif()`
			`endfunction()`