buildtools/Cmake/GenerateUserGuide.cmake

   1 #### Generate the html documentation for the user guide.
   2
   3 find_path(FIG2DEV_PATH  NAMES fig2dev   PATHS NO_DEFAULT_PATHS)
   4 find_path(DOXYGEN_PATH  NAMES doxygen   PATHS NO_DEFAULT_PATHS)
   5
   6
   7 file(GLOB_RECURSE source_doxygen
   8         "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
   9         "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
  10 )
  11
  12
  13 if(DOXYGEN_PATH AND FIG2DEV_PATH)
  14
  15         set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
  16         string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
  17
  18
  19         set(DOC_PNGS
  20                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
  21                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
  22                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
  23                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
  24                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
  25                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
  26                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
  27                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png
  28                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png
  29         )
  30
  31         configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  32         configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
  33
  34         ADD_CUSTOM_TARGET(user_guide
  35                 COMMENT "Generating the SimGrid user guide..."
  36                 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  37                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/userguide/html
  38             COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/userguide/html
  39                 COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' > ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
  40                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  41         )
  42
  43         ADD_CUSTOM_COMMAND(
  44                 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  45                 DEPENDS ${source_doxygen}
  46                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  47                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  48                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
  49         )
  50
  51         foreach(file ${DOC_FIGS})
  52                 string(REPLACE ".fig" ".png" tmp_file ${file})
  53                 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  54                 ADD_CUSTOM_COMMAND(TARGET user_guide
  55                         COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
  56                 )
  57         endforeach(file ${DOC_FIGS})
  58
  59         foreach(file ${DOC_PNGS})
  60                 ADD_CUSTOM_COMMAND(TARGET user_guide
  61                         COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  62                 )
  63         endforeach(file ${DOC_PNGS})
  64
  65         ADD_CUSTOM_COMMAND(TARGET user_guide
  66                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
  67                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg     ${CMAKE_HOME_DIRECTORY}/doc/html/
  68                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  69                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  70                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  71                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css                          ${CMAKE_HOME_DIRECTORY}/doc/html/
  72         )
  73
  74         ADD_CUSTOM_COMMAND(TARGET user_guide
  75             COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
  76                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  77                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
  78
  79                 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
  80                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  81
  82                 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
  83
  84                 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
  85                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
  86                 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>Grid Reality And Simulation.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
  87
  88                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
  89                 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>Advanced Metacomputing Overlay Kit.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
  90
  91                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
  92                 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>Meta SimGrid.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
  93
  94                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
  95                 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>DAG Simulator.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
  96                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
  97         )
  98
  99 else(DOXYGEN_PATH AND FIG2DEV_PATH)
 100
 101         ADD_CUSTOM_TARGET(user_guide
 102                         COMMENT "Generating the SimGrid user guide..."
 103                         )
 104
 105         ADD_CUSTOM_COMMAND(TARGET user_guide
 106                         COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH          = ${DOXYGEN_PATH}"
 107                         COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH          = ${FIG2DEV_PATH}"
 108                         COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
 109                         COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
 110                         COMMAND false
 111                         )
 112
 113
 114 endif(DOXYGEN_PATH AND FIG2DEV_PATH)
 115
 116 ##############################################################################"
 117
 118 message(STATUS "Check individual TOCs")
 119 set(LISTE_GTUT
 120         doc/gtut-tour-00-install.doc
 121         doc/gtut-tour-01-bones.doc
 122         doc/gtut-tour-02-simple.doc
 123         doc/gtut-tour-03-args.doc
 124         doc/gtut-tour-04-callback.doc
 125         doc/gtut-tour-05-globals.doc
 126         doc/gtut-tour-06-logs.doc
 127         doc/gtut-tour-07-timers.doc
 128         doc/gtut-tour-08-exceptions.doc
 129         doc/gtut-tour-09-simpledata.doc
 130         doc/gtut-tour-10-rpc.doc
 131         doc/gtut-tour-11-explicitwait.doc
 132         doc/gtut-tour-recap-messages.doc
 133         doc/gtut-tour-12-staticstruct.doc
 134         doc/gtut-tour-13-pointers.doc
 135         doc/gtut-tour-14-dynar.doc
 136         doc/gtut-tour-15-manualdatadef.doc
 137         doc/gtut-tour-16-exchangecb.doc
 138 )
 139
 140 foreach(file_name ${LISTE_GTUT})
 141         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
 142         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
 143
 144         file(READ "${file_name}" file_content)
 145         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 146         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 147         string(REPLACE "\n" ";" file_content "${file_content}")
 148
 149         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists
 150         foreach(line ${file_content})
 151                 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
 152                 string(REGEX MATCH ".*_toc.*" line3 "${line}")
 153                 if(line2 AND NOT line3)
 154                         string(REPLACE "\\section " "" line2 ${line2})
 155                         string(REPLACE "\\subsection " "subsection" line2 ${line2})
 156                         string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
 157                         string(REGEX REPLACE " .*" "" line2 ${line2})
 158                         set(line2                               " - \\ref ${line2}")
 159                         string(REPLACE " - \\ref subsection"    "   - \\ref " line2 ${line2})
 160                         string(REPLACE " - \\ref subsubsection" "     - \\ref " line2 ${line2})
 161                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
 162                 endif(line2 AND NOT line3)
 163         endforeach(line ${file_content})
 164
 165         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists
 166         foreach(line ${valeur_line})
 167                 string(REGEX MATCH ".*ref.*" line_ok ${line})
 168                 if(line_ok)
 169                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
 170                 endif(line_ok)
 171         endforeach(line ${valeur_line})
 172
 173         exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 174         if(compare_files)
 175                 message(STATUS "Wrong toc for ${file_name}. Should be:")
 176                 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
 177                 message("${file_content}")
 178                 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
 179         endif(compare_files)
 180 endforeach(file_name ${LISTE_GTUT})
 181
 182 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
 183 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
 184
 185 message(STATUS "Check main TOC")
 186
 187 foreach(file_name ${LISTE_GTUT})
 188         file(READ "${file_name}" file_content)
 189         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 190         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 191         string(REPLACE "\n" ";" file_content "${file_content}")
 192
 193         foreach(line ${file_content})
 194                 string(REGEX MATCH ".*@page.*" line2 "${line}")
 195                 if(line2)
 196                         string(REPLACE "@page " "" line2 "${line2}")
 197                         string(REGEX REPLACE " .*" "" line2 "${line2}")
 198                         set(line2 " - \\ref ${line2}")
 199                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
 200                 endif(line2)
 201         endforeach(line ${file_content})
 202
 203         foreach(line ${valeur_line})
 204                 string(REGEX MATCH ".*toc.*" line1 "${line}")
 205                 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
 206                 string(REGEX MATCH "^[ ]*$" line3 "${line}")
 207                 string(REGEX MATCH "Table of Contents" line4 "${line}")
 208                 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 209                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "   ${line}\n")
 210                 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 211         endforeach(line ${valeur_line})
 212 endforeach(file_name ${LISTE_GTUT})
 213
 214 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
 215 string(REPLACE "\n" ";" file_content "${file_content}")
 216 foreach(line ${file_content})
 217         string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
 218         if(line1)
 219                 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
 220         endif(line1)
 221 endforeach(line ${file_content})
 222
 223 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 224 if(compare_files)
 225         message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
 226         exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
 227 else(compare_files)
 228         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
 229 endif(compare_files)
 230
 231 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
 232
 233 ADD_CUSTOM_TARGET(pdf
 234     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
 235     COMMAND make clean
 236     COMMAND make pdf || true
 237     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
 238     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
 239     COMMAND make pdf || true
 240     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
 241     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
 242
 243     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
 244 )
 245 add_dependencies(pdf user_guide)