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 exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE SORTIE_BIBTEX2HTML_VERSION)
  21 STRING(REPLACE "[-bibtex]" "" SORTIE_BIBTEX2HTML_VERSION_2 ${SORTIE_BIBTEX2HTML_VERSION})
  22
  23 if(BIBTEX2HTML_PATH)
  24         if(${SORTIE_BIBTEX2HTML_VERSION_2} STREQUAL ${SORTIE_BIBTEX2HTML_VERSION}) # mauvaise version
  25                 message("\nERROR --> NEED to set bibtex2html path with \"ccmake ./\" or with \"cmake -DBIBTEX2HTML=<path_to> ./\"")
  26                 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)")
  27                 message(FATAL_ERROR "\n")
  28         endif(${SORTIE_BIBTEX2HTML_VERSION_2} STREQUAL ${SORTIE_BIBTEX2HTML_VERSION})
  29 endif(BIBTEX2HTML_PATH)
  30
  31 exec_program("${CMAKE_COMMAND} -E remove_directory ${PROJECT_DIRECTORY}/doc/html"  "${PROJECT_DIRECTORY}/doc/")
  32 exec_program("${CMAKE_COMMAND} -E make_directory ${PROJECT_DIRECTORY}/doc/html"  "${PROJECT_DIRECTORY}/doc/")
  33
  34 file(GLOB_RECURSE LISTE_UNE
  35 "${PROJECT_DIRECTORY}/tools/gras/*.[chl]"
  36 "${PROJECT_DIRECTORY}/src/*.[chl]"
  37 "${PROJECT_DIRECTORY}/include/*.[chl]"
  38 )
  39
  40 file(GLOB_RECURSE LISTE_DEUX
  41 "${PROJECT_DIRECTORY}/*.doc"
  42 )
  43 string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}")
  44
  45 set(DOCSSOURCES "${LISTE_UNE}\n${LISTE_DEUX}")
  46 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
  47
  48 set(FIGS
  49 ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules.fig
  50 ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules2.fig
  51 ${PROJECT_DIRECTORY}/doc/fig/amok_bw_test.fig
  52 ${PROJECT_DIRECTORY}/doc/fig/amok_bw_sat.fig
  53 ${PROJECT_DIRECTORY}/doc/fig/gras_comm.fig
  54 )
  55
  56 string(REPLACE ".fig" ".png\n" LISTE_TROIS ${FIGS})
  57
  58 set(PNGS
  59 ${PROJECT_DIRECTORY}/doc/webcruft/simgrid_logo.png
  60 ${PROJECT_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
  61 ${PROJECT_DIRECTORY}/doc/webcruft/poster_thumbnail.png
  62 )
  63
  64 if(DOXYGEN_PATH AND FIG2DEV_PATH)
  65
  66         exec_program("${FIG2DEV_PATH}/fig2dev -Lmap ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules.fig" OUTPUT_VARIABLE output_fig2dev)
  67         string(REPLACE "\n" ";" output_fig2dev "${output_fig2dev}")
  68
  69         file(REMOVE ${PROJECT_DIRECTORY}/doc/simgrid_modules.map)
  70
  71         foreach(line ${output_fig2dev})
  72                 string(REGEX MATCH "IMG" test_oki1 "${line}")
  73                 string(REGEX MATCH "MAP" test_oki2 "${line}")
  74                 string(REGEX MATCH "AREA" test_oki3 "${line}")
  75                 if(test_oki1 OR test_oki2 OR test_oki3)
  76                         string(REPLACE "imagemap"       "simgrid_modules" line "${line}")
  77                         string(REPLACE ".gif"   ".png" line "${line}")
  78                         string(REPLACE "<IMG"   "<IMG style=\"border:0px\""  line "${line}")
  79                 file(APPEND ${PROJECT_DIRECTORY}/doc/simgrid_modules.map "${line}\n")
  80                 endif(test_oki1 OR test_oki2 OR test_oki3)
  81         endforeach(line ${output_fig2dev})
  82
  83         foreach(file ${FIGS})
  84                 string(REPLACE ".fig" ".png" tmp_file ${file})
  85                 string(REPLACE "${PROJECT_DIRECTORY}/doc/fig/" "${PROJECT_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  86                 exec_program("${FIG2DEV_PATH}/fig2dev -Lpng ${file} > ${tmp_file}"  "${PROJECT_DIRECTORY}/doc/")
  87         endforeach(file ${FIGS})
  88
  89
  90         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
  91
  92         if(NOT EXISTS ${PROJECT_DIRECTORY}/doc/html)
  93                 file(MAKE_DIRECTORY ${PROJECT_DIRECTORY}/doc/html)
  94         endif(NOT EXISTS ${PROJECT_DIRECTORY}/doc/html)
  95
  96         foreach(file ${PNGS})
  97                 exec_program("${CMAKE_COMMAND} -E copy ${file} ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  98         endforeach(file ${PNGS})
  99
 100         exec_program("${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
 101         exec_program("${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/triva-time_interval.png ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
 102         exec_program("${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/triva-graph_configuration.png ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
 103         exec_program("${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/triva-graph_visualization.png ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
 104         exec_program("${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/simgrid.css ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
 105
 106         set(top_srcdir "..")
 107         set(WARNING "This file is generated, do not edit")
 108         set(srcdir ".")
 109         configure_file(${PROJECT_DIRECTORY}/doc/Doxyfile.in ${PROJECT_DIRECTORY}/doc/Doxyfile @ONLY)
 110 # First pass
 111         exec_program("${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile" "${PROJECT_DIRECTORY}/doc/")
 112
 113         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/index_create.pl" "${PROJECT_DIRECTORY}/doc/"
 114         ARGS simgrid.tag index-API.doc)
 115         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/toc_create.pl" "${PROJECT_DIRECTORY}/doc/"
 116         ARGS FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc)
 117 # Second pass
 118         exec_program("${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile" "${PROJECT_DIRECTORY}/doc/")
 119 # Post-processing
 120
 121         exec_program("${CMAKE_COMMAND} -E remove -f ${PROJECT_DIRECTORY}/doc/html/dir*"  "${PROJECT_DIRECTORY}/doc/")
 122
 123         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/index_php.pl""${PROJECT_DIRECTORY}/doc/"
 124         ARGS index.php.in html/index.html index.php)
 125         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl"  "${PROJECT_DIRECTORY}/doc/")
 126
 127 #html/gras.html:
 128         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 129         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 130 #html/amok.html:
 131         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 132         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 133 #html/msg.html:
 134         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 135         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 136 #html/simdag.html:
 137         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 138         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 139
 140 if(BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
 141
 142 #publis_count.html: all.bib
 143         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${PROJECT_DIRECTORY}/doc/all.bib > ${PROJECT_DIRECTORY}/doc/publis_count.html"  "${PROJECT_DIRECTORY}/doc/")
 144
 145 #publis_core.bib: all.bib
 146         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 147
 148 #publis_extern.bib: all.bib
 149         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 150
 151 #publis_intra.bib: all.bib
 152         exec_program("${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"  "${PROJECT_DIRECTORY}/doc/")
 153
 154 #%_bib.latin1.html: %.bib
 155         file(GLOB_RECURSE LISTE_QUATRE
 156         "${PROJECT_DIRECTORY}/doc/*.bib"
 157         )
 158         foreach(file ${LISTE_QUATRE})
 159                 string(REPLACE ".bib" "_bib.latin1.html" file_tmp "${file}")
 160                 string(REPLACE ".html" ".html.tmp" file_tmp2 "${file_tmp}")
 161                 exec_program("${BIBTEX2HTML_PATH}/bibtex2html -single-output -nv -force -sort year -copy-icons ${file} -output ${file_tmp2} 2>&1" "${PROJECT_DIRECTORY}/doc/")
 162                 file(READ ${file_tmp2} READ_TMP)
 163                 file(REMOVE ${file_tmp2})
 164                 string(REPLACE "\n" ";" READ_TMP ${READ_TMP})
 165
 166                 foreach(line ${READ_TMP})
 167                         string(REGEX MATCH "WARNING: unknown field type" line1 ${line})
 168                         if(NOT line1)
 169                                 file(APPEND   ${file_tmp2} "${line}\n")
 170                         endif(NOT line1)
 171                 endforeach(line ${READ_TMP})
 172                 exec_program("${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_postprocessor.pl < ${file_tmp2} > ${file_tmp}"  "${PROJECT_DIRECTORY}/doc/")
 173         endforeach(file ${LISTE_QUATRE})
 174
 175
 176 #%_bib.html: %_bib.latin1.html
 177         file(GLOB_RECURSE LISTE_CINQ
 178         "${PROJECT_DIRECTORY}/doc/*_bib.latin1.html"
 179         )
 180         foreach(file ${LISTE_CINQ})
 181                 string(REPLACE "_bib.latin1.html" "_bib.html" file_tmp "${file}")
 182                 exec_program("${ICONV_PATH}/iconv --from-code latin1 --to-code utf8 ${file} --output ${file_tmp}"  "${PROJECT_DIRECTORY}/doc/")
 183         endforeach(file ${LISTE_CINQ})
 184 endif(BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
 185
 186 endif(DOXYGEN_PATH AND FIG2DEV_PATH)
 187
 188 file(REMOVE ${PROJECT_DIRECTORY}/doc/logcategories.doc)
 189 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.doc "/* Generated file, do not edit */\n")
 190 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.doc "/** \\addtogroup XBT_log_cats\n")
 191 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.doc "        @{\n")
 192 exec_program("${PROJECT_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl" "${PROJECT_DIRECTORY}/src" OUTPUT_VARIABLE output_log_extract_hierarchy)
 193 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.doc "${output_log_extract_hierarchy}\n")
 194 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.doc  "@}*/")
 195
 196 file(WRITE ${PROJECT_DIRECTORY}/doc/realtoc.sh  "\#! /bin/sh")
 197
 198 message("Check individual TOCs")
 199 file(GLOB_RECURSE LISTE_GTUT
 200 "${PROJECT_DIRECTORY}/doc/gtut-tour-*.doc"
 201 )
 202
 203
 204
 205 foreach(file_name ${LISTE_GTUT})
 206         file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)
 207         file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
 208
 209         file(READ "${file_name}" file_content)
 210         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 211         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 212         string(REPLACE "\n" ";" file_content "${file_content}")
 213
 214         foreach(line ${file_content})
 215                 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
 216                 string(REGEX MATCH ".*_toc.*" line3 "${line}")
 217                 if(line2 AND NOT line3)
 218                         string(REPLACE "\\section " "" line2 ${line2})
 219                         string(REPLACE "\\subsection " "subsection" line2 ${line2})
 220                         string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
 221                         string(REGEX REPLACE " .*" "" line2 ${line2})
 222                         set(line2                               " - \\ref ${line2}")
 223                         string(REPLACE " - \\ref subsection"    "   - \\ref " line2 ${line2})
 224                         string(REPLACE " - \\ref subsubsection" "     - \\ref " line2 ${line2})
 225                         file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
 226                 endif(line2 AND NOT line3)
 227         endforeach(line ${file_content})
 228
 229         foreach(line ${valeur_line})
 230                 string(REGEX MATCH ".*ref.*" line_ok ${line})
 231                 if(line_ok)
 232                         file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
 233                 endif(line_ok)
 234         endforeach(line ${valeur_line})
 235
 236         exec_program("${CMAKE_COMMAND} -E compare_files ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 237         if(compare_files)
 238                 message("Wrong toc for ${file_name}. Should be:")
 239                 file(READ "${PROJECT_DIRECTORY}/doc/tmp.realtoc" file_content)
 240                 message("${file_content}")
 241                 exec_program("diff -u ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc")
 242         endif(compare_files)
 243 endforeach(file_name ${LISTE_GTUT})
 244
 245 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)
 246 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
 247
 248 message("Check main TOC")
 249
 250 foreach(file_name ${LISTE_GTUT})
 251         file(READ "${file_name}" file_content)
 252         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 253         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 254         string(REPLACE "\n" ";" file_content "${file_content}")
 255
 256         foreach(line ${file_content})
 257                 string(REGEX MATCH ".*@page.*" line2 "${line}")
 258                 if(line2)
 259                         string(REPLACE "@page " "" line2 "${line2}")
 260                         string(REGEX REPLACE " .*" "" line2 "${line2}")
 261                         set(line2 " - \\ref ${line2}")
 262                         file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
 263                 endif(line2)
 264         endforeach(line ${file_content})
 265
 266         foreach(line ${valeur_line})
 267                 string(REGEX MATCH ".*toc.*" line1 "${line}")
 268                 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
 269                 string(REGEX MATCH "^[ ]*$" line3 "${line}")
 270                 string(REGEX MATCH "Table of Contents" line4 "${line}")
 271                 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 272                         file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc "   ${line}\n")
 273                 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 274         endforeach(line ${valeur_line})
 275 endforeach(file_name ${LISTE_GTUT})
 276
 277 file(READ "${PROJECT_DIRECTORY}/doc/gtut-tour.doc" file_content)
 278 string(REPLACE "\n" ";" file_content "${file_content}")
 279 foreach(line ${file_content})
 280         string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
 281         if(line1)
 282                 file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.curtoc "${line}\n")
 283         endif(line1)
 284 endforeach(line ${file_content})
 285
 286 exec_program("${CMAKE_COMMAND} -E compare_files ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 287 if(compare_files)
 288         message("Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
 289         exec_program("diff -u ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc")
 290 else(compare_files)
 291         file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
 292 endif(compare_files)
 293
 294 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)
 295