buildtools/Cmake/GenerateDoc.cmake

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