buildtools/Cmake/src/CMakeDocs.txt

   1 SET(MAKE_DOC false)
   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 if(BIBTEX2HTML_PATH)
  10         exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE SORTIE_BIBTEX2HTML_VERSION)
  11         STRING(REPLACE "[-bibtex]" "" SORTIE_BIBTEX2HTML_VERSION_2 ${SORTIE_BIBTEX2HTML_VERSION})
  12         if(${SORTIE_BIBTEX2HTML_VERSION_2} STREQUAL ${SORTIE_BIBTEX2HTML_VERSION}) # mauvaise version
  13                 message("\nERROR --> NEED to set bibtex2html path with \"ccmake ./\" or with \"cmake -DBIBTEX2HTML=<path_to> ./\"")
  14                 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)")
  15                 message("\n")
  16         else(${SORTIE_BIBTEX2HTML_VERSION_2} STREQUAL ${SORTIE_BIBTEX2HTML_VERSION})# bonne version
  17                 SET(MAKE_DOC true)
  18                 find_path(FIG2DEV_PATH  NAMES fig2dev   PATHS NO_DEFAULT_PATHS)
  19                 find_path(DOXYGEN_PATH  NAMES doxygen   PATHS NO_DEFAULT_PATHS)
  20                 find_path(BIBTOOL_PATH  NAMES bibtool   PATHS NO_DEFAULT_PATHS)
  21                 find_path(ICONV_PATH    NAMES iconv     PATHS NO_DEFAULT_PATHS)
  22
  23                 if(FIG2DEV_PATH AND DOXYGEN_PATH AND BIBTOOL_PATH AND ICONV_PATH)
  24
  25                 elseif(FIG2DEV_PATH AND DOXYGEN_PATH AND BIBTOOL_PATH AND ICONV_PATH)
  26                         message("ERROR MAKING DOC")
  27                         message("\tFIG2DEV_PATH : ${FIG2DEV_PATH}")
  28                         message("\tDOXYGEN_PATH : ${DOXYGEN_PATH}")
  29                         message("\tBIBTOOL_PATH : ${BIBTOOL_PATH}")
  30                         message("\tICONV_PATH   : ${ICONV_PATH}")
  31                 endif(FIG2DEV_PATH AND DOXYGEN_PATH AND BIBTOOL_PATH AND ICONV_PATH)
  32
  33         endif(${SORTIE_BIBTEX2HTML_VERSION_2} STREQUAL ${SORTIE_BIBTEX2HTML_VERSION})
  34 else(BIBTEX2HTML_PATH)
  35         SET(MAKE_DOC false)
  36 endif(BIBTEX2HTML_PATH)
  37
  38 if(MAKE_DOC)
  39
  40         exec_program("rm -rf ${PROJECT_DIRECTORY}/doc/html"  "${PROJECT_DIRECTORY}/doc/")
  41         exec_program("mkdir -p ${PROJECT_DIRECTORY}/doc/html"  "${PROJECT_DIRECTORY}/doc/")
  42         exec_program("find ${PROJECT_DIRECTORY}/tools/gras  ${PROJECT_DIRECTORY}/src ${PROJECT_DIRECTORY}/include -name \"*.[chl]\"" OUTPUT_VARIABLE LISTE_UNE)
  43         exec_program("find ${PROJECT_DIRECTORY} -name \"*.doc\" |grep -v logcategories.doc"  "${PROJECT_DIRECTORY}/doc/" OUTPUT_VARIABLE LISTE_DEUX)
  44
  45
  46         set(DOCSSOURCES "${LISTE_UNE}\n${LISTE_DEUX}")
  47         string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
  48
  49         set(FIGS
  50         ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules.fig
  51         ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules2.fig
  52         ${PROJECT_DIRECTORY}/doc/fig/amok_bw_test.fig
  53         ${PROJECT_DIRECTORY}/doc/fig/amok_bw_sat.fig
  54         ${PROJECT_DIRECTORY}/doc/fig/gras_comm.fig
  55         )
  56
  57         string(REPLACE ".fig" ".png\n" LISTE_TROIS ${FIGS})
  58
  59         set(PNGS
  60         ${PROJECT_DIRECTORY}/doc/webcruft/simgrid_logo.png
  61         ${PROJECT_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
  62         ${PROJECT_DIRECTORY}/doc/webcruft/poster_thumbnail.png
  63         )
  64
  65         SET(PRINT false)
  66
  67         if(PRINT)
  68
  69         message("${DOXYGEN_PATH}/doxygen")
  70         message("${FIG2DEV_PATH}/fig2dev")
  71         message("${BIBTOOL_PATH}/bibtool")
  72         message("${BIBTEX2HTML_PATH}/bibtex2html")
  73         message("${ICONV_PATH}/iconv")
  74         message("\n")
  75
  76         endif(PRINT)
  77
  78         if(DOXYGEN_PATH AND FIG2DEV_PATH)
  79
  80                 exec_program("${FIG2DEV_PATH}/fig2dev -Lmap ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules.fig | grep -e IMG -e MAP -e AREA | sed 's/imagemap/simgrid_modules/g' | sed 's/\\.gif/.png/' | sed 's/<IMG /<IMG style=\"border:0px \"/g' | sed 's/\\.gif/.png/' > ${PROJECT_DIRECTORY}/doc/simgrid_modules.map"  "${PROJECT_DIRECTORY}/doc/")
  81
  82                 foreach(file ${FIGS})
  83                         string(REPLACE ".fig" ".png" tmp_file ${file})
  84                         string(REPLACE "${PROJECT_DIRECTORY}/doc/fig/" "${PROJECT_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  85                         exec_program("${FIG2DEV_PATH}/fig2dev -Lpng ${file} > ${tmp_file}"  "${PROJECT_DIRECTORY}/doc/")
  86                 endforeach(file ${FIGS})
  87
  88
  89                 exec_program("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/")
  90                 exec_program("test -e ${PROJECT_DIRECTORY}/doc/html || mkdir ${PROJECT_DIRECTORY}/doc/html"  "${PROJECT_DIRECTORY}/doc/")
  91
  92                 foreach(file ${PNGS})
  93                         exec_program("cp ${file} ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  94                 endforeach(file ${PNGS})
  95
  96                 exec_program("cp ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  97                 exec_program("cp ${PROJECT_DIRECTORY}/doc/triva-time_interval.png ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  98                 exec_program("cp ${PROJECT_DIRECTORY}/doc/simgrid.css ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  99
 100                 set(top_srcdir "..")
 101                 set(WARNING "This file is generated, do not edit")
 102                 set(srcdir ".")
 103                 configure_file(${PROJECT_DIRECTORY}/doc/Doxyfile.in ${PROJECT_DIRECTORY}/doc/Doxyfile @ONLY)
 104         # First pass
 105                 exec_program("${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile" "${PROJECT_DIRECTORY}/doc/")
 106
 107                 exec_program("${PROJECT_DIRECTORY}/tools/doxygen/index_create.pl" "${PROJECT_DIRECTORY}/doc/"
 108                 ARGS simgrid.tag index-API.doc)
 109                 exec_program("${PROJECT_DIRECTORY}/tools/doxygen/toc_create.pl" "${PROJECT_DIRECTORY}/doc/"
 110                 ARGS FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc)
 111         # Second pass
 112                 exec_program("${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile" "${PROJECT_DIRECTORY}/doc/")
 113         # Post-processing
 114                 exec_program("rm -f ${PROJECT_DIRECTORY}/doc/html/dir*"  "${PROJECT_DIRECTORY}/doc/")
 115                 exec_program("${PROJECT_DIRECTORY}/tools/doxygen/index_php.pl""${PROJECT_DIRECTORY}/doc/"
 116                 ARGS index.php.in html/index.html index.php)
 117                 exec_program("${PROJECT_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl"  "${PROJECT_DIRECTORY}/doc/")
 118
 119         #html/gras.html:
 120                 exec_program("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/")
 121                 exec_program("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/")
 122         #html/amok.html:
 123                 exec_program("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/")
 124                 exec_program("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/")
 125         #html/msg.html:
 126                 exec_program("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/")
 127                 exec_program("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/")
 128         #html/simdag.html:
 129                 exec_program("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/")
 130                 exec_program("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/")
 131
 132         if(BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
 133
 134         #publis_count.html: all.bib
 135                 exec_program("${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${PROJECT_DIRECTORY}/doc/all.bib > ${PROJECT_DIRECTORY}/doc/publis_count.html"  "${PROJECT_DIRECTORY}/doc/")
 136
 137         #publis_core.bib: all.bib
 138                 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/")
 139
 140         #publis_extern.bib: all.bib
 141                 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/")
 142
 143         #publis_intra.bib: all.bib
 144                 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/")
 145
 146         #%_bib.latin1.html: %.bib
 147                 exec_program("find ${PROJECT_DIRECTORY}/doc/ -name \"*.bib\""  "${PROJECT_DIRECTORY}/doc/" OUTPUT_VARIABLE LISTE_QUATRE)
 148                 string(REPLACE "\n" ";" LISTE_QUATRE ${LISTE_QUATRE})
 149                 foreach(file ${LISTE_QUATRE})
 150                         string(REPLACE ".bib" "_bib.latin1.html" file_tmp "${file}")
 151                         string(REPLACE ".html" ".html.tmp" file_tmp2 "${file_tmp}")
 152                         exec_program("${BIBTEX2HTML_PATH}/bibtex2html -single-output -nv -force -sort year -copy-icons ${file} -output ${file_tmp2} 2>&1 | grep -v 'WARNING: unknown field type'"  "${PROJECT_DIRECTORY}/doc/")
 153                         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_postprocessor.pl < ${file_tmp2} > ${file_tmp}"  "${PROJECT_DIRECTORY}/doc/")
 154                         #message("file ${file}\nfile_tmp ${file_tmp}")
 155                 endforeach(file ${LISTE_QUATRE})
 156
 157
 158         #%_bib.html: %_bib.latin1.html
 159                 exec_program("find ${PROJECT_DIRECTORY}/doc/ -name \"*_bib.latin1.html\""  "${PROJECT_DIRECTORY}/doc/" OUTPUT_VARIABLE LISTE_CINQ)
 160                 string(REPLACE "\n" ";" LISTE_CINQ ${LISTE_CINQ})
 161                 foreach(file ${LISTE_CINQ})
 162                         string(REPLACE "_bib.latin1.html" "_bib.html" file_tmp "${file}")
 163                         exec_program("${ICONV_PATH}/iconv --from-code latin1 --to-code utf8 ${file} --output ${file_tmp}"  "${PROJECT_DIRECTORY}/doc/")
 164                         #message("file ${file}\nfile_tmp ${file_tmp}")
 165                 endforeach(file ${LISTE_CINQ})
 166         endif(BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
 167
 168         endif(DOXYGEN_PATH AND FIG2DEV_PATH)
 169
 170         file(WRITE ${PROJECT_DIRECTORY}/doc/logcategories.sh    "\#! /bin/sh")
 171         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\npwd=`pwd`")
 172         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\nrm -f $pwd/logcategories.doc")
 173         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\nset -e")
 174         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\necho \"/* Generated file, do not edit */\"     > $pwd/logcategories.doc")
 175         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\necho \"/** \\addtogroup XBT_log_cats\"          >> $pwd/logcategories.doc")
 176         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\necho \"    @{\"                                >> $pwd/logcategories.doc")
 177         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\ncd ${PROJECT_DIRECTORY}/src")
 178         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\n${PROJECT_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl      >> $pwd/logcategories.doc")
 179         file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\necho \"@}*/\"                                 >> $pwd/logcategories.doc")
 180
 181         exec_program("chmod a=rwx ${PROJECT_DIRECTORY}/doc/logcategories.sh"  "${PROJECT_DIRECTORY}/doc/")
 182         exec_program("${PROJECT_DIRECTORY}/doc/logcategories.sh" "${PROJECT_DIRECTORY}/doc/"
 183         ARGS ${DOCSSOURCES})
 184
 185
 186         file(WRITE ${PROJECT_DIRECTORY}/doc/realtoc.sh  "\#! /bin/sh")
 187         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n\necho \"Check individual TOCs\"")
 188         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nfor n in gtut-tour-*.doc ; do")
 189         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  sed -n '/Table of Contents/,/hr/p' $n|grep ref > tmp.curtoc;")
 190         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  grep -E '\\\\s?u?b?section' $n | grep -v _toc | sed -e 's/\\\\section //' -e 's/\\\\subsection /subsection/' -e 's/ .*//' | sed -e 's/^/ - \\\\ref /' -e 's/- \\\\ref subsection/   - \\\\ref /' > tmp.realtoc;")
 191         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  if ! diff -q tmp.curtoc tmp.realtoc >/dev/null; then")
 192         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n    echo \"Wrong toc for $n. Should be ;\"")
 193         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n    cat tmp.realtoc;")
 194         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  fi ;")
 195         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\ndone")
 196         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n\nrm tmp.realtoc tmp.curtoc")
 197         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\necho \"Check main TOC\"")
 198         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nfor n in gtut-tour-*doc; do")
 199         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  grep @page $n | sed -e 's/@page //' -e 's/ .*//' -e 's/^/ - \\\\ref /' >>tmp.realtoc;")
 200         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  sed -n -e '/Table of Contents/,/hr/p' $n|sed -e 's/^/   /'| grep -v toc|grep -v '<hr>'|grep [^[:blank:]] >>tmp.realtoc;")
 201         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\ndone")
 202         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\ngrep ' *- \\\\ref' gtut-tour.doc > tmp.curtoc")
 203         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nif ! diff -b -u tmp.curtoc tmp.realtoc ; then")
 204         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  echo \"Wrong toc for gtut-tour.doc Right one is in tmp.realtoc\";")
 205         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nelse")
 206         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  rm tmp.realtoc;")
 207         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nfi ;")
 208         file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nrm tmp.curtoc")
 209
 210         exec_program("chmod a=rwx ${PROJECT_DIRECTORY}/doc/realtoc.sh"  "${PROJECT_DIRECTORY}/doc/")
 211         exec_program("${PROJECT_DIRECTORY}/doc/realtoc.sh" "${PROJECT_DIRECTORY}/doc/")
 212 endif(MAKE_DOC)