buildtools/Cmake/GenerateDoc.cmake

   1 if(BIBTEX2HTML)
   2         set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
   3 else(BIBTEX2HTML)
   4         find_path(BIBTEX2HTML_PATH      NAMES bibtex2html       PATHS NO_DEFAULT_PATHS)
   5 endif(BIBTEX2HTML)
   6
   7 find_path(FIG2DEV_PATH  NAMES fig2dev   PATHS NO_DEFAULT_PATHS)
   8 find_path(DOXYGEN_PATH  NAMES doxygen   PATHS NO_DEFAULT_PATHS)
   9 find_path(BIBTOOL_PATH  NAMES bibtool   PATHS NO_DEFAULT_PATHS)
  10 find_path(ICONV_PATH    NAMES iconv     PATHS NO_DEFAULT_PATHS)
  11
  12 ### Check whether the bibtex2html that we found is the one that Arnaud requires
  13 exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION)
  14 STRING(REPLACE "[-bibtex]" "" OUTPUT_BIBTEX2HTML_VERSION_2 ${OUTPUT_BIBTEX2HTML_VERSION})
  15
  16 file(GLOB_RECURSE source_doxygen
  17         "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
  18         "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
  19         "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
  20 )
  21
  22 if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version
  23         SET(GOOD_BIBTEX2HTML_VERSION 0)
  24 else(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # good version
  25         SET(GOOD_BIBTEX2HTML_VERSION 1)
  26 endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION})
  27
  28 if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
  29
  30         string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}")
  31
  32         #DOC_SOURCE=doc/*.doc, defined in DefinePackage
  33         set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
  34         string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
  35
  36
  37         set(DOC_PNGS
  38                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png
  39                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
  40                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
  41         )
  42
  43         configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  44         configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
  45
  46         ADD_CUSTOM_TARGET(simgrid_documentation
  47                 COMMENT "Generating the SimGrid documentation..."
  48                 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  49                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  50                 COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  51                 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}/tools/doxygen/fig2dev_postprocessor.pl > ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
  52                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  53         )
  54
  55         ADD_CUSTOM_COMMAND(
  56                 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  57                 DEPENDS ${source_doxygen}
  58                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  59                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  60                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
  61         )
  62
  63         foreach(file ${DOC_FIGS})
  64                 string(REPLACE ".fig" ".png" tmp_file ${file})
  65                 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  66                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  67                         COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
  68                 )
  69         endforeach(file ${DOC_FIGS})
  70
  71         foreach(file ${DOC_PNGS})
  72                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  73                         COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  74                 )
  75         endforeach(file ${DOC_PNGS})
  76
  77         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  78                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
  79                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg     ${CMAKE_HOME_DIRECTORY}/doc/html/
  80                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  81                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  82                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css                          ${CMAKE_HOME_DIRECTORY}/doc/html/
  83         )
  84
  85         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  86                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  87                 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
  88                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
  89                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc
  90
  91                 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
  92                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  93
  94                 COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
  95                 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
  96                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php
  97                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
  98
  99                 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
 100                 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
 101                 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
 102
 103                 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
 104                 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
 105
 106                 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
 107                 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
 108
 109                 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
 110                 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
 111                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
 112         )
 113
 114
 115         ADD_CUSTOM_COMMAND(
 116                 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html
 117                 DEPENDS all.bib
 118                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${CMAKE_HOME_DIRECTORY}/doc/all.bib > ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html
 119         )
 120         add_dependencies(simgrid_documentation ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html)
 121
 122         ADD_CUSTOM_COMMAND(
 123                 OUTPUT publis_core.bib publis_extern.bib publis_intra.bib
 124                 DEPENDS all.bib
 125
 126                 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "core"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_core.bib
 127                 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "extern"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_extern.bib
 128                 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "intra"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_intra.bib
 129         )
 130
 131         foreach(file "publis_core publis_extern publis_intra")
 132                 ADD_CUSTOM_COMMAND(
 133                         OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/${file}.html
 134                         DEPENDS "${file}.bib"
 135
 136                         COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl ${file}
 137                 )
 138
 139                 add_dependencies(simgrid_documentation ${CMAKE_HOME_DIRECTORY}/doc/${file}.html)
 140         endforeach(file "publis_core publis_extern publis_intra")
 141
 142 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
 143
 144         ADD_CUSTOM_TARGET(simgrid_documentation
 145                         COMMENT "Generating the SimGrid documentation..."
 146                         )
 147
 148         if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
 149                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
 150                         COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
 151                         COMMAND ${CMAKE_COMMAND} -E echo  "You can download it from : ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
 152                         )
 153         endif(NOT GOOD_BIBTEX2HTML_VERSION)
 154
 155         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
 156                         COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH          = ${DOXYGEN_PATH}"
 157                         COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH          = ${FIG2DEV_PATH}"
 158                         COMMAND ${CMAKE_COMMAND} -E echo "BIBTOOL_PATH          = ${BIBTOOL_PATH}"
 159                         COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH      = ${BIBTEX2HTML_PATH}"
 160                         COMMAND ${CMAKE_COMMAND} -E echo "ICONV_PATH            = ${ICONV_PATH}"
 161                         COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
 162                         COMMAND FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ...
 163                         )
 164
 165
 166 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
 167
 168 ##############################################################################"
 169
 170 message(STATUS "Check individual TOCs")
 171 file(GLOB_RECURSE LISTE_GTUT
 172         "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc"
 173 )
 174 foreach(file_name ${LISTE_GTUT})
 175         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
 176         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
 177
 178         file(READ "${file_name}" file_content)
 179         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 180         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 181         string(REPLACE "\n" ";" file_content "${file_content}")
 182
 183         foreach(line ${file_content})
 184                 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
 185                 string(REGEX MATCH ".*_toc.*" line3 "${line}")
 186                 if(line2 AND NOT line3)
 187                         string(REPLACE "\\section " "" line2 ${line2})
 188                         string(REPLACE "\\subsection " "subsection" line2 ${line2})
 189                         string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
 190                         string(REGEX REPLACE " .*" "" line2 ${line2})
 191                         set(line2                               " - \\ref ${line2}")
 192                         string(REPLACE " - \\ref subsection"    "   - \\ref " line2 ${line2})
 193                         string(REPLACE " - \\ref subsubsection" "     - \\ref " line2 ${line2})
 194                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
 195                 endif(line2 AND NOT line3)
 196         endforeach(line ${file_content})
 197
 198         foreach(line ${valeur_line})
 199                 string(REGEX MATCH ".*ref.*" line_ok ${line})
 200                 if(line_ok)
 201                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
 202                 endif(line_ok)
 203         endforeach(line ${valeur_line})
 204
 205         exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 206         if(compare_files)
 207                 message(STATUS "Wrong toc for ${file_name}. Should be:")
 208                 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
 209                 message("${file_content}")
 210                 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
 211         endif(compare_files)
 212 endforeach(file_name ${LISTE_GTUT})
 213
 214 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
 215 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
 216
 217 message(STATUS "Check main TOC")
 218
 219 foreach(file_name ${LISTE_GTUT})
 220         file(READ "${file_name}" file_content)
 221         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 222         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 223         string(REPLACE "\n" ";" file_content "${file_content}")
 224
 225         foreach(line ${file_content})
 226                 string(REGEX MATCH ".*@page.*" line2 "${line}")
 227                 if(line2)
 228                         string(REPLACE "@page " "" line2 "${line2}")
 229                         string(REGEX REPLACE " .*" "" line2 "${line2}")
 230                         set(line2 " - \\ref ${line2}")
 231                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
 232                 endif(line2)
 233         endforeach(line ${file_content})
 234
 235         foreach(line ${valeur_line})
 236                 string(REGEX MATCH ".*toc.*" line1 "${line}")
 237                 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
 238                 string(REGEX MATCH "^[ ]*$" line3 "${line}")
 239                 string(REGEX MATCH "Table of Contents" line4 "${line}")
 240                 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 241                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "   ${line}\n")
 242                 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 243         endforeach(line ${valeur_line})
 244 endforeach(file_name ${LISTE_GTUT})
 245
 246 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
 247 string(REPLACE "\n" ";" file_content "${file_content}")
 248 foreach(line ${file_content})
 249         string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
 250         if(line1)
 251                 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
 252         endif(line1)
 253 endforeach(line ${file_content})
 254
 255 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 256 if(compare_files)
 257         message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
 258         exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
 259 else(compare_files)
 260         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
 261 endif(compare_files)
 262
 263 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)