cmake/doc/CMakeLists.txt

   1 find_package(Doxygen)
   2
   3 if(DOXYGEN_EXECUTABLE)
   4   OPTION(DBUS_ENABLE_DOXYGEN_DOCS "build DOXYGEN documentation (requires Doxygen)" ON)
   5 endif(DOXYGEN_EXECUTABLE)
   6
   7 if (DBUS_ENABLE_DOXYGEN_DOCS)
   8     set (top_srcdir ${CMAKE_SOURCE_DIR}/..)
   9     configure_file(${CMAKE_SOURCE_DIR}/../Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile )
  10     add_custom_target(doc
  11         COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
  12         WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
  13     )
  14 endif (DBUS_ENABLE_DOXYGEN_DOCS)
  15
  16 #
  17 # find docbook generator
  18 #
  19 find_program(MEINPROC4_EXECUTABLE meinproc4)
  20
  21 find_program(XMLTO_EXECUTABLE xmlto)
  22
  23 if (MEINPROC4_EXECUTABLE OR XMLTO_EXECUTABLE)
  24   OPTION(DBUS_ENABLE_XML_DOCS "build XML  documentation (requires xmlto or meinproc4)" ON)
  25   ADD_CUSTOM_TARGET(xmldoc ALL)
  26 endif (MEINPROC4_EXECUTABLE OR XMLTO_EXECUTABLE)
  27
  28 if (XMLTO_EXECUTABLE)
  29         set (DOCBOOK_GENERATOR_NAME "xmlto" PARENT_SCOPE)
  30         set(DBUS_XML_DOCS_ENABLED 1)
  31         set(MEINPROC4_EXECUTABLE 0)
  32         MESSAGE(STATUS "xmlto docbook generator found")
  33         set(STYLESHEET_MAN "${DOCBOOKXSL_DIR}/manpages/docbook.xsl")
  34         set(STYLESHEET_HTML "${DOCBOOKXSL_DIR}/html/docbook.xsl")
  35
  36 elseif (MEINPROC4_EXECUTABLE)
  37         set(DOCBOOK_GENERATOR_NAME "meinproc4" PARENT_SCOPE)
  38         set(DBUS_XML_DOCS_ENABLED 1)
  39         if(WIN32)
  40                 get_filename_component(_a ${MEINPROC4_EXECUTABLE} PATH)
  41                 get_filename_component(_meinproc_install_path ${_a} PATH)
  42                 set(STYLESHEET_HTML "${_meinproc_install_path}/share/apps/ksgmltools2/docbook/xsl/html/docbook.xsl")
  43         else(WIN32)
  44                 set(STYLESHEET_HTML file:///usr/share/kde4/apps/ksgmltools2/customization/kde-nochunk.xsl)
  45         endif(WIN32)
  46 endif ()
  47
  48 if (DBUS_ENABLE_XML_DOCS)
  49
  50 macro (DOCBOOK _sources _format)
  51   get_filename_component(_infile ${_sources} ABSOLUTE)
  52   get_filename_component(_name ${_infile} NAME)
  53   set(_deps ${CMAKE_SOURCE_DIR}/CMakeLists.txt ${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.txt)
  54
  55   if (${_format} STREQUAL "man")
  56     string(REPLACE ".xml" "" _outname ${_name})
  57     set(STYLESHEET ${STYLESHEET_MAN})
  58   else()
  59     string(REPLACE ".xml" ".html" _outname ${_name})
  60     set(STYLESHEET ${STYLESHEET_HTML})
  61   endif ()
  62
  63   set(_outfile ${CMAKE_CURRENT_BINARY_DIR}/${_outname})
  64   if (EXISTS ${_sources})
  65           if (MEINPROC4_EXECUTABLE)
  66                     ADD_CUSTOM_COMMAND(
  67                         OUTPUT ${_outfile}
  68                         COMMAND ${MEINPROC4_EXECUTABLE} --stylesheet ${STYLESHEET} -o ${_outfile} ${_infile}
  69                         DEPENDS ${_infile} ${STYLESHEET} ${_deps}
  70                         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  71                 )
  72           endif ()
  73           if (XMLTO_EXECUTABLE)
  74                     ADD_CUSTOM_COMMAND(
  75                         OUTPUT ${_outfile}
  76                         COMMAND ${XMLTO_EXECUTABLE} -vv ${_format} ${_infile}
  77                         DEPENDS ${_infile} ${_deps}
  78                         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  79                 )
  80           endif ()
  81           if (${_format} STREQUAL "man")
  82                   install(FILES ${_outfile} DESTINATION share/man/man1)
  83           else ()
  84                   install(FILES ${_outfile} DESTINATION share/doc/dbus)
  85           endif ()
  86   else ()
  87           MESSAGE(STATUS "skipping xml doc generating for ${_infile}, file not found")
  88   endif ()
  89   ADD_CUSTOM_TARGET(${_outname} DEPENDS ${_outfile})
  90   ADD_DEPENDENCIES(xmldoc ${_outname})
  91 endmacro (DOCBOOK)
  92
  93 ### copy tests to builddir so that generated tests and static tests
  94 ### are all in one place.
  95 ### todo how to add more filetypes
  96 MACRO (COPYDIR _src _type)
  97     FOREACH(FILE_TYPE ${_type})
  98         FOREACH(DIR ${_src})
  99                 FILE(GLOB FILES "${CMAKE_SOURCE_DIR}/../${DIR}/${FILE_TYPE}" )
 100                 FILE(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/${DIR})
 101                 FOREACH(FILE ${FILES})
 102                         GET_FILENAME_COMPONENT(FILENAME ${FILE} NAME)
 103                         SET (TARGET ${CMAKE_BINARY_DIR}/${DIR}/${FILENAME})
 104                         configure_file(${FILE} ${TARGET} COPYONLY)
 105                         IF (CONFIG_VERBOSE)
 106                                 MESSAGE("FROM: ${FILE}\nTO: ${TARGET}\n")
 107                         ENDIF (CONFIG_VERBOSE)
 108                 ENDFOREACH(FILE)
 109         ENDFOREACH(DIR)
 110     ENDFOREACH(FILE_TYPE)
 111 ENDMACRO (COPYDIR)
 112
 113 COPYDIR(doc *.png)
 114 COPYDIR(doc *.svg)
 115
 116 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-test-plan.xml html-nochunks)
 117 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-tutorial.xml html-nochunks)
 118 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-specification.xml html-nochunks)
 119 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-faq.xml html-nochunks)
 120 configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-cleanup-sockets.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-cleanup-sockets.1.xml)
 121 configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-daemon.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml)
 122 configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-launch.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-launch.1.xml)
 123 configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-monitor.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-monitor.1.xml)
 124 configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-send.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-send.1.xml)
 125 configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-uuidgen.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-uuidgen.1.xml)
 126 DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-cleanup-sockets.1.xml html-nochunks)
 127 DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml html-nochunks)
 128 DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-launch.1.xml html-nochunks)
 129 DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-monitor.1.xml html-nochunks)
 130 DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-send.1.xml html-nochunks)
 131 DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-uuidgen.1.xml html-nochunks)
 132 if (UNIX)
 133   DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml man)
 134   DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-monitor.1.xml man)
 135   DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-send.1.xml man)
 136   DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-launch.1.xml man)
 137   DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-uuidgen.1.xml man)
 138   DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-cleanup-sockets.1.xml man)
 139 endif()
 140 #
 141 # handle html index file
 142 #
 143 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/index.html.cmake ${CMAKE_CURRENT_BINARY_DIR}/index.html )
 144 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/index.html DESTINATION share/doc/dbus)
 145
 146 set (EXTRA_DIST
 147         ${CMAKE_SOURCE_DIR}/../doc/busconfig.dtd
 148         ${CMAKE_SOURCE_DIR}/../doc/introspect.dtd
 149         ${CMAKE_SOURCE_DIR}/../doc/introspect.xsl
 150 )
 151
 152 install(FILES ${EXTRA_DIST} DESTINATION share/doc/dbus)
 153
 154 endif(DBUS_ENABLE_XML_DOCS)