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         "${PROJECT_DIRECTORY}/tools/gras/*.[chl]"
  35         "${PROJECT_DIRECTORY}/src/*.[chl]"
  36         "${PROJECT_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                 ${PROJECT_DIRECTORY}/doc/webcruft/simgrid_logo.png
  51                 ${PROJECT_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
  52                 ${PROJECT_DIRECTORY}/doc/webcruft/poster_thumbnail.png
  53         )
  54
  55         ADD_CUSTOM_TARGET(simgrid_documentation ALL
  56                 COMMENT "Generating the SimGrid documentation..."
  57                 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  58                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${PROJECT_DIRECTORY}/doc/html
  59                 COMMAND ${CMAKE_COMMAND} -E make_directory   ${PROJECT_DIRECTORY}/doc/html
  60
  61                 COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' | ${PROJECT_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${PROJECT_DIRECTORY}/doc/simgrid_modules.map
  62
  63                 WORKING_DIRECTORY ${PROJECT_DIRECTORY}/doc
  64         )
  65
  66         ADD_CUSTOM_COMMAND(
  67                 OUTPUT ${PROJECT_DIRECTORY}/doc/logcategories.doc
  68                 DEPENDS ${source_doxygen}
  69                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${PROJECT_DIRECTORY}/doc/logcategories.doc
  70                 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${PROJECT_DIRECTORY}/doc/logcategories.doc
  71                 WORKING_DIRECTORY ${PROJECT_DIRECTORY}
  72         )
  73
  74         foreach(file ${DOC_FIGS})
  75                 string(REPLACE ".fig" ".png" tmp_file ${file})
  76                 string(REPLACE "${PROJECT_DIRECTORY}/doc/fig/" "${PROJECT_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  77                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  78                         COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
  79                 )
  80         endforeach(file ${DOC_FIGS})
  81
  82
  83         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  84                 COMMAND ${CMAKE_COMMAND} -E touch ${PROJECT_DIRECTORY}/doc/index-API.doc ${PROJECT_DIRECTORY}/doc/.FAQ.doc.toc ${PROJECT_DIRECTORY}/doc/.index.doc.toc ${PROJECT_DIRECTORY}/doc/.contrib.doc.toc ${PROJECT_DIRECTORY}/doc/.history.doc.toc
  85         )
  86
  87
  88         foreach(file ${DOC_PNGS})
  89                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  90                         COMMAND ${CMAKE_COMMAND} -E copy ${file} ${PROJECT_DIRECTORY}/doc/html/
  91                 )
  92         endforeach(file ${DOC_PNGS})
  93
  94         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  95                 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${PROJECT_DIRECTORY}/doc/html/
  96                 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg     ${PROJECT_DIRECTORY}/doc/html/
  97                 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/triva-graph_configuration.png        ${PROJECT_DIRECTORY}/doc/html/
  98                 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/triva-graph_visualization.png        ${PROJECT_DIRECTORY}/doc/html/
  99                 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/simgrid.css                          ${PROJECT_DIRECTORY}/doc/html/
 100         )
 101
 102         configure_file(${PROJECT_DIRECTORY}/doc/Doxyfile.in ${PROJECT_DIRECTORY}/doc/Doxyfile @ONLY)
 103
 104         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
 105                 WORKING_DIRECTORY ${PROJECT_DIRECTORY}/doc/
 106                 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
 107                 COMMAND ${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile
 108                 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
 109                 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc
 110
 111                 COMMAND ${CMAKE_COMMAND} -E echo XX Second Doxygen pass
 112                 COMMAND ${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile
 113
 114                 COMMAND ${CMAKE_COMMAND} -E echo XX Post-processing Doxygen result
 115                 COMMAND ${CMAKE_COMMAND} -E remove -f ${PROJECT_DIRECTORY}/doc/html/dir*
 116                 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php
 117                 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
 118
 119                 COMMAND ${CMAKE_COMMAND} -E echo XX Create shortcuts pages
 120                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>\" > ${PROJECT_DIRECTORY}/doc/html/gras.html
 121                 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>\" >> ${PROJECT_DIRECTORY}/doc/html/gras.html
 122
 123                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>\" > ${PROJECT_DIRECTORY}/doc/html/amok.html
 124                 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>\" >> ${PROJECT_DIRECTORY}/doc/html/amok.html
 125
 126                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>\" > ${PROJECT_DIRECTORY}/doc/html/msg.html
 127                 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>\" >> ${PROJECT_DIRECTORY}/doc/html/msg.html
 128
 129                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>\" > ${PROJECT_DIRECTORY}/doc/html/simdag.html
 130                 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>\" >> ${PROJECT_DIRECTORY}/doc/html/simdag.html
 131         )
 132
 133         ADD_CUSTOM_COMMAND(
 134                 OUTPUT ${PROJECT_DIRECTORY}/doc/publis_count.html
 135                 DEPENDS all.bib
 136                 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${PROJECT_DIRECTORY}/doc/all.bib > ${PROJECT_DIRECTORY}/doc/publis_count.html
 137         )
 138         add_dependencies(simgrid_documentation ${PROJECT_DIRECTORY}/doc/publis_count.html)
 139
 140         ADD_CUSTOM_COMMAND(
 141                 OUTPUT publis_core.bib publis_extern.bib publis_intra.bib
 142                 DEPENDS all.bib
 143
 144                 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "core"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${PROJECT_DIRECTORY}/doc/all.bib -o ${PROJECT_DIRECTORY}/doc/publis_core.bib
 145                 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "extern"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${PROJECT_DIRECTORY}/doc/all.bib -o ${PROJECT_DIRECTORY}/doc/publis_extern.bib
 146                 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "intra"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${PROJECT_DIRECTORY}/doc/all.bib -o ${PROJECT_DIRECTORY}/doc/publis_intra.bib
 147         )
 148
 149         foreach(file "publis_core publis_extern publis_intra")
 150                 ADD_CUSTOM_COMMAND(
 151                         OUTPUT ${PROJECT_DIRECTORY}/doc/${file}.html
 152                         DEPENDS "${file}.bib"
 153
 154                         COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl ${file}
 155                 )
 156
 157                 add_dependencies(simgrid_documentation ${PROJECT_DIRECTORY}/doc/${file}.html)
 158         endforeach(file "publis_core publis_extern publis_intra")
 159
 160 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
 161         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")
 162
 163 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
 164
 165 message("Check individual TOCs")
 166 file(GLOB_RECURSE LISTE_GTUT
 167         "${PROJECT_DIRECTORY}/doc/gtut-tour-*.doc"
 168 )
 169 foreach(file_name ${LISTE_GTUT})
 170         file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)
 171         file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
 172
 173         file(READ "${file_name}" file_content)
 174         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 175         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 176         string(REPLACE "\n" ";" file_content "${file_content}")
 177
 178         foreach(line ${file_content})
 179                 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
 180                 string(REGEX MATCH ".*_toc.*" line3 "${line}")
 181                 if(line2 AND NOT line3)
 182                         string(REPLACE "\\section " "" line2 ${line2})
 183                         string(REPLACE "\\subsection " "subsection" line2 ${line2})
 184                         string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
 185                         string(REGEX REPLACE " .*" "" line2 ${line2})
 186                         set(line2                               " - \\ref ${line2}")
 187                         string(REPLACE " - \\ref subsection"    "   - \\ref " line2 ${line2})
 188                         string(REPLACE " - \\ref subsubsection" "     - \\ref " line2 ${line2})
 189                         file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
 190                 endif(line2 AND NOT line3)
 191         endforeach(line ${file_content})
 192
 193         foreach(line ${valeur_line})
 194                 string(REGEX MATCH ".*ref.*" line_ok ${line})
 195                 if(line_ok)
 196                         file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
 197                 endif(line_ok)
 198         endforeach(line ${valeur_line})
 199
 200         exec_program("${CMAKE_COMMAND} -E compare_files ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 201         if(compare_files)
 202                 message("Wrong toc for ${file_name}. Should be:")
 203                 file(READ "${PROJECT_DIRECTORY}/doc/tmp.realtoc" file_content)
 204                 message("${file_content}")
 205                 exec_program("diff -u ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc")
 206         endif(compare_files)
 207 endforeach(file_name ${LISTE_GTUT})
 208
 209 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)
 210 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
 211
 212 message("Check main TOC")
 213
 214 foreach(file_name ${LISTE_GTUT})
 215         file(READ "${file_name}" file_content)
 216         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 217         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 218         string(REPLACE "\n" ";" file_content "${file_content}")
 219
 220         foreach(line ${file_content})
 221                 string(REGEX MATCH ".*@page.*" line2 "${line}")
 222                 if(line2)
 223                         string(REPLACE "@page " "" line2 "${line2}")
 224                         string(REGEX REPLACE " .*" "" line2 "${line2}")
 225                         set(line2 " - \\ref ${line2}")
 226                         file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
 227                 endif(line2)
 228         endforeach(line ${file_content})
 229
 230         foreach(line ${valeur_line})
 231                 string(REGEX MATCH ".*toc.*" line1 "${line}")
 232                 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
 233                 string(REGEX MATCH "^[ ]*$" line3 "${line}")
 234                 string(REGEX MATCH "Table of Contents" line4 "${line}")
 235                 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 236                         file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc "   ${line}\n")
 237                 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 238         endforeach(line ${valeur_line})
 239 endforeach(file_name ${LISTE_GTUT})
 240
 241 file(READ "${PROJECT_DIRECTORY}/doc/gtut-tour.doc" file_content)
 242 string(REPLACE "\n" ";" file_content "${file_content}")
 243 foreach(line ${file_content})
 244         string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
 245         if(line1)
 246                 file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.curtoc "${line}\n")
 247         endif(line1)
 248 endforeach(line ${file_content})
 249
 250 exec_program("${CMAKE_COMMAND} -E compare_files ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 251 if(compare_files)
 252         message("Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
 253         exec_program("diff -u ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc")
 254 else(compare_files)
 255         file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
 256 endif(compare_files)
 257
 258 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)