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