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