buildtools/Cmake/src/doc/CMakeLists.txt

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