2 set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
4 find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS)
7 find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
8 find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS)
9 find_path(BIBTOOL_PATH NAMES bibtool PATHS NO_DEFAULT_PATHS)
10 find_path(ICONV_PATH NAMES iconv PATHS NO_DEFAULT_PATHS)
12 ### Check whether the bibtex2html that we found is the one that Arnaud requires
13 exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION)
14 STRING(REPLACE "[-bibtex]" "" OUTPUT_BIBTEX2HTML_VERSION_2 ${OUTPUT_BIBTEX2HTML_VERSION})
16 file(GLOB_RECURSE source_doxygen
17 "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
18 "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
19 "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
22 if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version
23 SET(GOOD_BIBTEX2HTML_VERSION 0)
24 else(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # good version
25 SET(GOOD_BIBTEX2HTML_VERSION 1)
26 endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION})
28 if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
30 string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}")
32 #DOC_SOURCE=doc/*.doc, defined in DefinePackage
33 set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
34 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
38 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png
39 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
40 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
43 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
45 ADD_CUSTOM_TARGET(simgrid_documentation
46 COMMENT "Generating the SimGrid documentation..."
47 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
48 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
49 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
50 COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' | ${CMAKE_HOME_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
51 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
55 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
56 DEPENDS ${source_doxygen}
57 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
58 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
59 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
62 foreach(file ${DOC_FIGS})
63 string(REPLACE ".fig" ".png" tmp_file ${file})
64 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
65 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
66 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
68 endforeach(file ${DOC_FIGS})
70 foreach(file ${DOC_PNGS})
71 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
72 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
74 endforeach(file ${DOC_PNGS})
76 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
77 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
78 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
79 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/
80 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/
81 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
84 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
85 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
86 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
87 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
88 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc
90 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
91 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
93 COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
94 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
95 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php
96 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
98 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
99 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
100 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>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
102 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
103 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>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
105 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
106 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>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
108 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
109 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>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
110 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
115 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html
117 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${CMAKE_HOME_DIRECTORY}/doc/all.bib > ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html
119 add_dependencies(simgrid_documentation ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html)
122 OUTPUT publis_core.bib publis_extern.bib publis_intra.bib
125 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "core"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_core.bib
126 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "extern"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_extern.bib
127 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "intra"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_intra.bib
130 foreach(file "publis_core publis_extern publis_intra")
132 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/${file}.html
133 DEPENDS "${file}.bib"
135 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl ${file}
138 add_dependencies(simgrid_documentation ${CMAKE_HOME_DIRECTORY}/doc/${file}.html)
139 endforeach(file "publis_core publis_extern publis_intra")
141 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
143 ADD_CUSTOM_TARGET(simgrid_documentation
144 COMMENT "Generating the SimGrid documentation..."
147 if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
148 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
149 COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
150 COMMAND ${CMAKE_COMMAND} -E echo "You can download it from : ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
152 endif(NOT GOOD_BIBTEX2HTML_VERSION)
154 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
155 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
156 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
157 COMMAND ${CMAKE_COMMAND} -E echo "BIBTOOL_PATH = ${BIBTOOL_PATH}"
158 COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}"
159 COMMAND ${CMAKE_COMMAND} -E echo "ICONV_PATH = ${ICONV_PATH}"
160 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
161 COMMAND FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ...
165 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
167 ##############################################################################"
169 message("Check individual TOCs")
170 file(GLOB_RECURSE LISTE_GTUT
171 "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc"
173 foreach(file_name ${LISTE_GTUT})
174 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
175 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
177 file(READ "${file_name}" file_content)
178 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
179 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
180 string(REPLACE "\n" ";" file_content "${file_content}")
182 foreach(line ${file_content})
183 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
184 string(REGEX MATCH ".*_toc.*" line3 "${line}")
185 if(line2 AND NOT line3)
186 string(REPLACE "\\section " "" line2 ${line2})
187 string(REPLACE "\\subsection " "subsection" line2 ${line2})
188 string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
189 string(REGEX REPLACE " .*" "" line2 ${line2})
190 set(line2 " - \\ref ${line2}")
191 string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
192 string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
193 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
194 endif(line2 AND NOT line3)
195 endforeach(line ${file_content})
197 foreach(line ${valeur_line})
198 string(REGEX MATCH ".*ref.*" line_ok ${line})
200 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
202 endforeach(line ${valeur_line})
204 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
206 message("Wrong toc for ${file_name}. Should be:")
207 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
208 message("${file_content}")
209 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
211 endforeach(file_name ${LISTE_GTUT})
213 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
214 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
216 message("Check main TOC")
218 foreach(file_name ${LISTE_GTUT})
219 file(READ "${file_name}" file_content)
220 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
221 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
222 string(REPLACE "\n" ";" file_content "${file_content}")
224 foreach(line ${file_content})
225 string(REGEX MATCH ".*@page.*" line2 "${line}")
227 string(REPLACE "@page " "" line2 "${line2}")
228 string(REGEX REPLACE " .*" "" line2 "${line2}")
229 set(line2 " - \\ref ${line2}")
230 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
232 endforeach(line ${file_content})
234 foreach(line ${valeur_line})
235 string(REGEX MATCH ".*toc.*" line1 "${line}")
236 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
237 string(REGEX MATCH "^[ ]*$" line3 "${line}")
238 string(REGEX MATCH "Table of Contents" line4 "${line}")
239 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
240 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc " ${line}\n")
241 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
242 endforeach(line ${valeur_line})
243 endforeach(file_name ${LISTE_GTUT})
245 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
246 string(REPLACE "\n" ";" file_content "${file_content}")
247 foreach(line ${file_content})
248 string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
250 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
252 endforeach(line ${file_content})
254 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
256 message("Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
257 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
259 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
262 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)