diff options
Diffstat (limited to 'cmake/modules/FindXSLTPROC.cmake')
| -rw-r--r-- | cmake/modules/FindXSLTPROC.cmake | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/cmake/modules/FindXSLTPROC.cmake b/cmake/modules/FindXSLTPROC.cmake new file mode 100644 index 0000000..b554622 --- /dev/null +++ b/cmake/modules/FindXSLTPROC.cmake @@ -0,0 +1,152 @@ +# +# - Find XSLTPROC +# This module looks for some usual Unix commands. +# + +include(FindChocolatey) + +# Strawberry Perl ships with xsltproc but no DocBook XML files, which +# is detrimental to our interests. Search for the Chocolatey +# versions first, and un-find xsltproc if needed. +find_program(XSLTPROC_EXECUTABLE + NAMES + xsltproc + HINTS + ${CHOCOLATEY_BIN_PATH} + PATHS + /usr/local/bin + /sbin +) + +string(TOLOWER ${XSLTPROC_EXECUTABLE} _xe_lower) +if(${_xe_lower} MATCHES "strawberry") + set(_ignore_reason "Strawberry xsltproc found at ${XSLTPROC_EXECUTABLE}. Ignoring.") + message(STATUS ${_ignore_reason}) + set(XSLTPROC_EXECUTABLE XSLTPROC_EXECUTABLE-NOTFOUND CACHE FILEPATH ${_ignore_reason} FORCE) +endif() + +# Handle the QUIETLY and REQUIRED arguments and set XSLTPROC_FOUND to TRUE if +# all listed variables are TRUE +INCLUDE(FindPackageHandleStandardArgs) +FIND_PACKAGE_HANDLE_STANDARD_ARGS(XSLTPROC DEFAULT_MSG XSLTPROC_EXECUTABLE) + +MARK_AS_ADVANCED(XSLTPROC_EXECUTABLE) + +set (_common_xsltproc_args + --stringparam use.id.as.filename 1 + --stringparam admon.graphics 1 + --stringparam admon.graphics.extension .svg + --stringparam section.autolabel 1 + --stringparam section.label.includes.component.label 1 + --stringparam html.stylesheet ws.css + ) + +set(_xsltproc_path "${CMAKE_CURRENT_SOURCE_DIR}:${CMAKE_CURRENT_BINARY_DIR}:${CMAKE_CURRENT_BINARY_DIR}/wsluarm_src") + +# Workaround for parallel build issue with msbuild. +# https://gitlab.kitware.com/cmake/cmake/issues/16767 +if(CMAKE_GENERATOR MATCHES "Visual Studio") + # msbuild (as used by the Visual Studio generators) must not depend on the XML + # file (otherwise the XML file will be generated multiple times, possibly in + # parallel, breaking the build). Workaround: add one dependency to generate + # the XML file when outdated, depend on the -stamp file to ensure that the + # target is rebuilt when the XML file is regenerated. + function(get_docbook_xml_depends varname _dbk_source) + set(${varname} + "generate_${_dbk_source}" + "${CMAKE_CURRENT_BINARY_DIR}/${_dbk_source}-stamp" + PARENT_SCOPE + ) + endfunction() +else() + # Unix Makefiles, Ninja, etc: first dependency enforces that the XML file is + # rebuilt when outdated, the second dependency ensures that the target is + # rebuilt when the XML file has changed. + function(get_docbook_xml_depends varname _dbk_source) + set(${varname} + "generate_${_dbk_source}" + "${_dbk_source}" + PARENT_SCOPE + ) + endfunction() +endif() + +# Translate XML to HTML +#XML2HTML( +# wsug or wsdg +# single-page or chunked +# WSUG_FILES +# WSUG_GRAPHICS +#) +MACRO(XML2HTML _target_dep _dir_pfx _mode _dbk_source _gfx_sources) + # We depend on the docbook target to avoid parallel builds. + SET(_dbk_dep ${_target_dep}_docbook) + + # We can pass chunker.xxx parameters to customize the chunked output. + # We have to use a custom layer to customize the single-page output. + # Set the output encoding for both to UTF-8. Indent the single-page + # output because we sometimes need to copy and paste the release + # note contents. + IF(${_mode} STREQUAL "chunked") + SET(_basedir ${_dir_pfx}_html_chunked) + SET(_stylesheet "http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl") + SET(_modeparams --stringparam chunker.output.encoding UTF-8 --stringparam chunk.quietly 1) + ELSE() # single-page + SET(_basedir ${_dir_pfx}_html) + SET(_stylesheet ${CMAKE_SOURCE_DIR}/docbook/custom_layer_single_html.xsl) + SET(_modeparams --output ${_basedir}/index.html) + ENDIF() + + SET(_out_dir ${CMAKE_CURRENT_BINARY_DIR}/${_basedir}) + SET(_output ${_basedir}/index.html) + get_docbook_xml_depends(_dbk_xml_deps "${_dbk_source}") + + FOREACH(_tmpgfx ${${_gfx_sources}}) + set(_gfx_deps ${CMAKE_CURRENT_SOURCE_DIR}/${_tmpgfx}) + ENDFOREACH() + + SET(_gfx_src_dir ${_dir_pfx}_src/images) + ADD_CUSTOM_COMMAND( + OUTPUT + ${_output} + COMMAND ${CMAKE_COMMAND} + -E make_directory ${_out_dir} + COMMAND ${CMAKE_COMMAND} + -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/${_gfx_src_dir} ${_out_dir}/images + COMMAND ${CMAKE_COMMAND} + -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/ws.css ${_out_dir} + COMMAND ${XSLTPROC_EXECUTABLE} + --path "${_xsltproc_path}" + --stringparam base.dir ${_basedir}/ + ${_common_xsltproc_args} + --stringparam admon.graphics.path images/ + ${_modeparams} + --noout ${_stylesheet} + ${_dbk_source} + DEPENDS + ${_dbk_xml_deps} + ${_dbk_dep} + ${_gfx_deps} + custom_layer_single_html.xsl + ) + if(${_dir_pfx} STREQUAL wsug) + ADD_CUSTOM_COMMAND( + OUTPUT + ${_output} + COMMAND ${CMAKE_COMMAND} + -E make_directory ${_out_dir}/images/toolbar + COMMAND ${CMAKE_COMMAND} + -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/${_gfx_src_dir}/toolbar ${_out_dir}/images/toolbar + APPEND + ) + endif() + IF(NOT WIN32) + ADD_CUSTOM_COMMAND( + OUTPUT + ${_output} + COMMAND chmod + -R og+rX ${_out_dir} + APPEND + ) + ENDIF() +ENDMACRO(XML2HTML) |