buildtools/Cmake/src/CMakeDocs.txt

   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("rm -rf ${PROJECT_DIRECTORY}/doc/html"  "${PROJECT_DIRECTORY}/doc/")
  32 exec_program("mkdir -p ${PROJECT_DIRECTORY}/doc/html"  "${PROJECT_DIRECTORY}/doc/")
  33 exec_program("find ${PROJECT_DIRECTORY}/tools/gras  ${PROJECT_DIRECTORY}/src ${PROJECT_DIRECTORY}/include -name \"*.[chl]\"" OUTPUT_VARIABLE LISTE_UNE)
  34 exec_program("find ${PROJECT_DIRECTORY} -name \"*.doc\" |grep -v logcategories.doc"  "${PROJECT_DIRECTORY}/doc/" OUTPUT_VARIABLE LISTE_DEUX)
  35
  36 set(DOCSSOURCES "${LISTE_UNE}\n${LISTE_DEUX}")
  37 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
  38
  39 set(FIGS
  40 ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules.fig
  41 ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules2.fig
  42 ${PROJECT_DIRECTORY}/doc/fig/amok_bw_test.fig
  43 ${PROJECT_DIRECTORY}/doc/fig/amok_bw_sat.fig
  44 ${PROJECT_DIRECTORY}/doc/fig/gras_comm.fig
  45 )
  46
  47 string(REPLACE ".fig" ".png\n" LISTE_TROIS ${FIGS})
  48
  49 set(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 if(DOXYGEN_PATH AND FIG2DEV_PATH)
  56
  57         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/")
  58
  59         foreach(file ${FIGS})
  60                 string(REPLACE ".fig" ".png" tmp_file ${file})
  61                 string(REPLACE "${PROJECT_DIRECTORY}/doc/fig/" "${PROJECT_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  62                 exec_program("${FIG2DEV_PATH}/fig2dev -Lpng ${file} > ${tmp_file}"  "${PROJECT_DIRECTORY}/doc/")
  63         endforeach(file ${FIGS})
  64
  65
  66         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/")
  67         exec_program("test -e ${PROJECT_DIRECTORY}/doc/html || mkdir ${PROJECT_DIRECTORY}/doc/html"  "${PROJECT_DIRECTORY}/doc/")
  68
  69         foreach(file ${PNGS})
  70                 exec_program("cp ${file} ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  71         endforeach(file ${PNGS})
  72
  73         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/")
  74         exec_program("cp ${PROJECT_DIRECTORY}/doc/triva-time_interval.png ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  75         exec_program("cp ${PROJECT_DIRECTORY}/doc/triva-graph_configuration.png ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  76         exec_program("cp ${PROJECT_DIRECTORY}/doc/triva-graph_visualization.png ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  77         exec_program("cp ${PROJECT_DIRECTORY}/doc/simgrid.css ${PROJECT_DIRECTORY}/doc/html/"  "${PROJECT_DIRECTORY}/doc/")
  78
  79         set(top_srcdir "..")
  80         set(WARNING "This file is generated, do not edit")
  81         set(srcdir ".")
  82         configure_file(${PROJECT_DIRECTORY}/doc/Doxyfile.in ${PROJECT_DIRECTORY}/doc/Doxyfile @ONLY)
  83 # First pass
  84         exec_program("${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile" "${PROJECT_DIRECTORY}/doc/")
  85
  86         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/index_create.pl" "${PROJECT_DIRECTORY}/doc/"
  87         ARGS simgrid.tag index-API.doc)
  88         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/toc_create.pl" "${PROJECT_DIRECTORY}/doc/"
  89         ARGS FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc)
  90 # Second pass
  91         exec_program("${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile" "${PROJECT_DIRECTORY}/doc/")
  92 # Post-processing
  93         exec_program("rm -f ${PROJECT_DIRECTORY}/doc/html/dir*"  "${PROJECT_DIRECTORY}/doc/")
  94         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/index_php.pl""${PROJECT_DIRECTORY}/doc/"
  95         ARGS index.php.in html/index.html index.php)
  96         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl"  "${PROJECT_DIRECTORY}/doc/")
  97
  98 #html/gras.html:
  99         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/")
 100         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/")
 101 #html/amok.html:
 102         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/")
 103         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/")
 104 #html/msg.html:
 105         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/")
 106         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/")
 107 #html/simdag.html:
 108         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/")
 109         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/")
 110
 111 if(BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
 112
 113 #publis_count.html: all.bib
 114         exec_program("${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${PROJECT_DIRECTORY}/doc/all.bib > ${PROJECT_DIRECTORY}/doc/publis_count.html"  "${PROJECT_DIRECTORY}/doc/")
 115
 116 #publis_core.bib: all.bib
 117         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/")
 118
 119 #publis_extern.bib: all.bib
 120         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/")
 121
 122 #publis_intra.bib: all.bib
 123         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/")
 124
 125 #%_bib.latin1.html: %.bib
 126         exec_program("find ${PROJECT_DIRECTORY}/doc/ -name \"*.bib\""  "${PROJECT_DIRECTORY}/doc/" OUTPUT_VARIABLE LISTE_QUATRE)
 127         string(REPLACE "\n" ";" LISTE_QUATRE ${LISTE_QUATRE})
 128         foreach(file ${LISTE_QUATRE})
 129                 string(REPLACE ".bib" "_bib.latin1.html" file_tmp "${file}")
 130                 string(REPLACE ".html" ".html.tmp" file_tmp2 "${file_tmp}")
 131                 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/")
 132                 exec_program("${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_postprocessor.pl < ${file_tmp2} > ${file_tmp}"  "${PROJECT_DIRECTORY}/doc/")
 133                 #message("file ${file}\nfile_tmp ${file_tmp}")
 134         endforeach(file ${LISTE_QUATRE})
 135
 136
 137 #%_bib.html: %_bib.latin1.html
 138         exec_program("find ${PROJECT_DIRECTORY}/doc/ -name \"*_bib.latin1.html\""  "${PROJECT_DIRECTORY}/doc/" OUTPUT_VARIABLE LISTE_CINQ)
 139         string(REPLACE "\n" ";" LISTE_CINQ ${LISTE_CINQ})
 140         foreach(file ${LISTE_CINQ})
 141                 string(REPLACE "_bib.latin1.html" "_bib.html" file_tmp "${file}")
 142                 exec_program("${ICONV_PATH}/iconv --from-code latin1 --to-code utf8 ${file} --output ${file_tmp}"  "${PROJECT_DIRECTORY}/doc/")
 143                 #message("file ${file}\nfile_tmp ${file_tmp}")
 144         endforeach(file ${LISTE_CINQ})
 145 endif(BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
 146
 147 endif(DOXYGEN_PATH AND FIG2DEV_PATH)
 148
 149 file(WRITE ${PROJECT_DIRECTORY}/doc/logcategories.sh    "\#! /bin/sh")
 150 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\npwd=`pwd`")
 151 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\nrm -f $pwd/logcategories.doc")
 152 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\nset -e")
 153 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\necho \"/* Generated file, do not edit */\"     > $pwd/logcategories.doc")
 154 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\necho \"/** \\addtogroup XBT_log_cats\"          >> $pwd/logcategories.doc")
 155 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\necho \"    @{\"                                >> $pwd/logcategories.doc")
 156 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\ncd ${PROJECT_DIRECTORY}/src")
 157 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\n${PROJECT_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl      >> $pwd/logcategories.doc")
 158 file(APPEND ${PROJECT_DIRECTORY}/doc/logcategories.sh   "\necho \"@}*/\"                                 >> $pwd/logcategories.doc")
 159
 160 exec_program("chmod a=rwx ${PROJECT_DIRECTORY}/doc/logcategories.sh"  "${PROJECT_DIRECTORY}/doc/")
 161 exec_program("${PROJECT_DIRECTORY}/doc/logcategories.sh" "${PROJECT_DIRECTORY}/doc/"
 162 ARGS ${DOCSSOURCES})
 163
 164
 165 file(WRITE ${PROJECT_DIRECTORY}/doc/realtoc.sh  "\#! /bin/sh")
 166 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n\necho \"Check individual TOCs\"")
 167 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nfor n in gtut-tour-*.doc ; do")
 168 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  sed -n '/Table of Contents/,/hr/p' $n|grep ref > tmp.curtoc;")
 169 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;")
 170 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  if ! diff -q tmp.curtoc tmp.realtoc >/dev/null; then")
 171 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n    echo \"Wrong toc for $n. Should be ;\"")
 172 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n    cat tmp.realtoc;")
 173 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  fi ;")
 174 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\ndone")
 175 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n\nrm tmp.realtoc tmp.curtoc")
 176 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\necho \"Check main TOC\"")
 177 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nfor n in gtut-tour-*doc; do")
 178 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  grep @page $n | sed -e 's/@page //' -e 's/ .*//' -e 's/^/ - \\\\ref /' >>tmp.realtoc;")
 179 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;")
 180 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\ndone")
 181 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\ngrep ' *- \\\\ref' gtut-tour.doc > tmp.curtoc")
 182 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nif ! diff -b -u tmp.curtoc tmp.realtoc ; then")
 183 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  echo \"Wrong toc for gtut-tour.doc Right one is in tmp.realtoc\";")
 184 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nelse")
 185 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\n  rm tmp.realtoc;")
 186 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nfi ;")
 187 file(APPEND ${PROJECT_DIRECTORY}/doc/realtoc.sh "\nrm tmp.curtoc")
 188
 189 exec_program("chmod a=rwx ${PROJECT_DIRECTORY}/doc/realtoc.sh"  "${PROJECT_DIRECTORY}/doc/")
 190 exec_program("${PROJECT_DIRECTORY}/doc/realtoc.sh" "${PROJECT_DIRECTORY}/doc/")