build_infra/Graphviz/main.cmake

function(psc_graphviz_ps_array out_value)
    set(values)
    foreach(item IN LISTS ARGN)
        string(REPLACE "\\" "/" normalized "${item}")
        list(APPEND values "'${normalized}'")
    endforeach()
    string(REPLACE ";" "," value "${values}")
    set(value "@(${value})")
    set(${out_value} "${value}" PARENT_SCOPE)
endfunction()
function(psc_graphviz_sh_array out_value)
    set(value "")
    foreach(item IN LISTS ARGN)
        string(REPLACE "\\" "/" normalized "${item}")
        string(APPEND value "'${normalized}' ")
    endforeach()
    set(${out_value} "${value}" PARENT_SCOPE)
endfunction()
function(psc_graphviz_bool out_value value)
    if (${value})
        set(${out_value} "$true" PARENT_SCOPE)
    else ()
        set(${out_value} "$false" PARENT_SCOPE)
    endif ()
endfunction()
function(psc_generate_graphviz_render_scripts script_name)
    set(options)
    set(oneValueArgs OUTPUT_DIR FORMAT DOT_EXECUTABLE)
    set(multiValueArgs INPUT)
    cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
    if (NOT ARG_OUTPUT_DIR)
        set(ARG_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/graphviz/${script_name}")
    endif ()
    if (NOT ARG_FORMAT)
        set(ARG_FORMAT "svg")
    endif ()
    if (NOT ARG_DOT_EXECUTABLE)
        set(ARG_DOT_EXECUTABLE "C:/Program Files/Graphviz/bin/dot.exe")
    endif ()
    psc_graphviz_ps_array(PSC_INPUT_FILES ${ARG_INPUT})
    psc_graphviz_sh_array(PSC_INPUT_FILES_SH ${ARG_INPUT})
    set(PSC_OUTPUT_DIR "${ARG_OUTPUT_DIR}")
    set(PSC_FORMAT "${ARG_FORMAT}")
    set(PSC_DOT_EXECUTABLE "${ARG_DOT_EXECUTABLE}")
    set(script_dir "${CMAKE_CURRENT_BINARY_DIR}/psc_doc_scripts/${script_name}")
    file(MAKE_DIRECTORY "${script_dir}")
    set(power_shell_script "${script_dir}/${script_name}_graphviz_render.ps1")
    set(bash_script "${script_dir}/${script_name}_graphviz_render.sh")
    configure_file("${CMAKE_CURRENT_FUNCTION_LIST_DIR}/Graphviz_Render.ps1.in" "${power_shell_script}" @ONLY)
    configure_file("${CMAKE_CURRENT_FUNCTION_LIST_DIR}/Graphviz_Render.sh.in" "${bash_script}" @ONLY)
    set(${script_name}_POWERSHELL_SCRIPT "${power_shell_script}" PARENT_SCOPE)
    set(${script_name}_BASH_SCRIPT "${bash_script}" PARENT_SCOPE)
    set(${script_name}_OUTPUT_DIR "${ARG_OUTPUT_DIR}" PARENT_SCOPE)
endfunction()
function(psc_add_graphviz_render_target target_name)
    psc_generate_graphviz_render_scripts(${target_name} ${ARGN})
    if (WIN32)
        add_custom_target(${target_name}
            COMMAND pwsh -NoProfile -ExecutionPolicy Bypass -File "${${target_name}_POWERSHELL_SCRIPT}"
            VERBATIM
        )
    else ()
        add_custom_target(${target_name}
            COMMAND bash "${${target_name}_BASH_SCRIPT}"
            VERBATIM
        )
    endif ()
endfunction()
function(psc_generate_graphviz_directory_scripts script_name)
    set(options EXCLUDE_THIRD_PARTY)
    set(oneValueArgs OUTPUT_DIR FORMAT DOT_EXECUTABLE MAX_DEPTH COLLAPSE_THRESHOLD)
    set(multiValueArgs INPUT_DIRS EXCLUDE_DIRS)
    cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
    if (NOT ARG_OUTPUT_DIR)
        set(ARG_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/graphviz/${script_name}")
    endif ()
    if (NOT ARG_FORMAT)
        set(ARG_FORMAT "svg")
    endif ()
    if (NOT ARG_DOT_EXECUTABLE)
        set(ARG_DOT_EXECUTABLE "C:/Program Files/Graphviz/bin/dot.exe")
    endif ()
    if (NOT ARG_INPUT_DIRS)
        set(ARG_INPUT_DIRS "${CMAKE_SOURCE_DIR}")
    endif ()
    if (NOT ARG_MAX_DEPTH)
        set(ARG_MAX_DEPTH 4)
    endif ()
    if (NOT ARG_COLLAPSE_THRESHOLD)
        set(ARG_COLLAPSE_THRESHOLD 20)
    endif ()
    psc_graphviz_ps_array(PSC_INPUT_DIRS ${ARG_INPUT_DIRS})
    psc_graphviz_ps_array(PSC_EXCLUDE_DIRS ${ARG_EXCLUDE_DIRS})
    psc_graphviz_sh_array(PSC_INPUT_DIRS_SH ${ARG_INPUT_DIRS})
    psc_graphviz_sh_array(PSC_EXCLUDE_DIRS_SH ${ARG_EXCLUDE_DIRS})
    psc_graphviz_bool(PSC_EXCLUDE_THIRD_PARTY ${ARG_EXCLUDE_THIRD_PARTY})
    set(PSC_OUTPUT_DIR "${ARG_OUTPUT_DIR}")
    set(PSC_FORMAT "${ARG_FORMAT}")
    set(PSC_DOT_EXECUTABLE "${ARG_DOT_EXECUTABLE}")
    set(PSC_MAX_DEPTH "${ARG_MAX_DEPTH}")
    set(PSC_COLLAPSE_THRESHOLD "${ARG_COLLAPSE_THRESHOLD}")
    set(script_dir "${CMAKE_CURRENT_BINARY_DIR}/psc_doc_scripts/${script_name}")
    file(MAKE_DIRECTORY "${script_dir}")
    set(power_shell_script "${script_dir}/${script_name}_graphviz_directory.ps1")
    set(bash_script "${script_dir}/${script_name}_graphviz_directory.sh")
    configure_file("${CMAKE_CURRENT_FUNCTION_LIST_DIR}/Project_Graphs.ps1.in" "${power_shell_script}" @ONLY)
    configure_file("${CMAKE_CURRENT_FUNCTION_LIST_DIR}/Project_Graphs.sh.in" "${bash_script}" @ONLY)
    set(${script_name}_POWERSHELL_SCRIPT "${power_shell_script}" PARENT_SCOPE)
    set(${script_name}_BASH_SCRIPT "${bash_script}" PARENT_SCOPE)
    set(${script_name}_OUTPUT_DIR "${ARG_OUTPUT_DIR}" PARENT_SCOPE)
endfunction()
function(psc_add_graphviz_directory_target target_name)
    psc_generate_graphviz_directory_scripts(${target_name} ${ARGN})
    if (WIN32)
        add_custom_target(${target_name}
            COMMAND pwsh -NoProfile -ExecutionPolicy Bypass -File "${${target_name}_POWERSHELL_SCRIPT}"
            VERBATIM
        )
    else ()
        add_custom_target(${target_name}
            COMMAND bash "${${target_name}_BASH_SCRIPT}"
            VERBATIM
        )
    endif ()
endfunction()
function(psc_target_graph_add_edge out_nodes out_edges left right)
    set(nodes ${${out_nodes}})
    set(edges ${${out_edges}})
    list(APPEND nodes "${left}" "${right}")
    list(APPEND edges "${left}|${right}")
    list(REMOVE_DUPLICATES nodes)
    list(REMOVE_DUPLICATES edges)
    set(${out_nodes} ${nodes} PARENT_SCOPE)
    set(${out_edges} ${edges} PARENT_SCOPE)
endfunction()
function(psc_generate_cmake_graphviz_scripts script_name)
    set(options)
    set(oneValueArgs OUTPUT_DIR FORMAT DOT_EXECUTABLE)
    set(multiValueArgs TARGETS)
    cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
    if (NOT ARG_OUTPUT_DIR)
        set(ARG_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/graphviz/${script_name}")
    endif ()
    if (NOT ARG_FORMAT)
        set(ARG_FORMAT "svg")
    endif ()
    if (NOT ARG_DOT_EXECUTABLE)
        set(ARG_DOT_EXECUTABLE "C:/Program Files/Graphviz/bin/dot.exe")
    endif ()
    set(target_nodes)
    set(target_edges)
    foreach(target_name IN LISTS ARG_TARGETS)
        if (TARGET ${target_name})
            list(APPEND target_nodes "${target_name}")
            get_target_property(link_libs ${target_name} LINK_LIBRARIES)
            get_target_property(interface_libs ${target_name} INTERFACE_LINK_LIBRARIES)
            foreach(link_name IN LISTS link_libs interface_libs)
                if (TARGET ${link_name})
                    psc_target_graph_add_edge(target_nodes target_edges "${target_name}" "${link_name}")
                endif ()
            endforeach()
        endif ()
    endforeach()
    list(REMOVE_DUPLICATES target_nodes)
    psc_graphviz_ps_array(PSC_TARGETS ${target_nodes})
    psc_graphviz_ps_array(PSC_TARGET_EDGES ${target_edges})
    psc_graphviz_sh_array(PSC_TARGETS_SH ${target_nodes})
    psc_graphviz_sh_array(PSC_TARGET_EDGES_SH ${target_edges})
    set(PSC_OUTPUT_DIR "${ARG_OUTPUT_DIR}")
    set(PSC_FORMAT "${ARG_FORMAT}")
    set(PSC_DOT_EXECUTABLE "${ARG_DOT_EXECUTABLE}")
    set(script_dir "${CMAKE_CURRENT_BINARY_DIR}/psc_doc_scripts/${script_name}")
    file(MAKE_DIRECTORY "${script_dir}")
    set(power_shell_script "${script_dir}/${script_name}_cmake_graphviz.ps1")
    set(bash_script "${script_dir}/${script_name}_cmake_graphviz.sh")
    configure_file("${CMAKE_CURRENT_FUNCTION_LIST_DIR}/Cmake_Target_Graph.ps1.in" "${power_shell_script}" @ONLY)
    configure_file("${CMAKE_CURRENT_FUNCTION_LIST_DIR}/Cmake_Target_Graph.sh.in" "${bash_script}" @ONLY)
    set(${script_name}_POWERSHELL_SCRIPT "${power_shell_script}" PARENT_SCOPE)
    set(${script_name}_BASH_SCRIPT "${bash_script}" PARENT_SCOPE)
    set(${script_name}_OUTPUT_DIR "${ARG_OUTPUT_DIR}" PARENT_SCOPE)
endfunction()
function(psc_add_cmake_graphviz_target target_name)
    psc_generate_cmake_graphviz_scripts(${target_name} ${ARGN})
    if (WIN32)
        add_custom_target(${target_name}
            COMMAND pwsh -NoProfile -ExecutionPolicy Bypass -File "${${target_name}_POWERSHELL_SCRIPT}"
            VERBATIM
        )
    else ()
        add_custom_target(${target_name}
            COMMAND bash "${${target_name}_BASH_SCRIPT}"
            VERBATIM
        )
    endif ()
endfunction()