1 #### Generate the html documentation
4 set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
6 find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS)
9 find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
10 find_path(DOXYGEN_PATH NAMES doxygen 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 BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
30 #DOC_SOURCE=doc/*.doc, defined in DefinePackage
31 set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
32 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
36 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png
37 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
38 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
39 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
40 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
41 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
42 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
43 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
44 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png
45 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png
46 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_001.png
47 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_002.png
48 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_003.png
49 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_004.png
50 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_005.png
51 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_006.png
52 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_007.png
53 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_008.png
54 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_009.png
55 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_010.png
56 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_011.png
57 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_012.png
58 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_013.png
59 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_014.png
60 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_015.png
61 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_016.png
62 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_017.png
63 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_018.png
64 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_019.png
65 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_020.png
66 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_021.png
67 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_022.png
68 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_023.png
69 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_024.png
70 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_025.png
71 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_026.png
72 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_027.png
73 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_028.png
74 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_029.png
75 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_030.png
76 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101.pdf
79 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
80 configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
82 ADD_CUSTOM_TARGET(simgrid_documentation
83 COMMENT "Generating the SimGrid documentation..."
84 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
85 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
86 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
87 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
88 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
92 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
93 DEPENDS ${source_doxygen}
94 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
95 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
96 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
99 foreach(file ${DOC_FIGS})
100 string(REPLACE ".fig" ".png" tmp_file ${file})
101 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
102 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
103 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
105 endforeach(file ${DOC_FIGS})
107 foreach(file ${DOC_PNGS})
108 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
109 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
111 endforeach(file ${DOC_PNGS})
113 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
114 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
115 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
116 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/
117 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/
118 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/html/
119 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
122 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
123 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
124 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
125 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
126 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl pls.doc index.doc FAQ.doc gtut-introduction.doc install.doc bindings.doc options.doc tracing.doc platform.doc
128 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
129 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
131 COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
132 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
133 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
135 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
136 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
137 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
139 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
140 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
142 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
143 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
145 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
146 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
147 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
150 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
152 ADD_CUSTOM_TARGET(simgrid_documentation
153 COMMENT "Generating the SimGrid documentation..."
156 if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
157 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
158 COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
159 COMMAND ${CMAKE_COMMAND} -E echo "You can download it from:"
160 COMMAND ${CMAKE_COMMAND} -E echo " ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
161 COMMAND ${CMAKE_COMMAND} -E echo "There is also an unofficial Debian/Ubuntu package, see:"
162 COMMAND ${CMAKE_COMMAND} -E echo " http://www.loria.fr/~lnussbau/bibtex2html/README"
164 endif(NOT GOOD_BIBTEX2HTML_VERSION)
166 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
167 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
168 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
169 COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}"
170 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
171 COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
176 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
178 ##############################################################################"
180 message(STATUS "Check individual TOCs")
182 doc/gtut-tour-00-install.doc
183 doc/gtut-tour-01-bones.doc
184 doc/gtut-tour-02-simple.doc
185 doc/gtut-tour-03-args.doc
186 doc/gtut-tour-04-callback.doc
187 doc/gtut-tour-05-globals.doc
188 doc/gtut-tour-06-logs.doc
189 doc/gtut-tour-07-timers.doc
190 doc/gtut-tour-08-exceptions.doc
191 doc/gtut-tour-09-simpledata.doc
192 doc/gtut-tour-10-rpc.doc
193 doc/gtut-tour-11-explicitwait.doc
194 doc/gtut-tour-recap-messages.doc
195 doc/gtut-tour-12-staticstruct.doc
196 doc/gtut-tour-13-pointers.doc
197 doc/gtut-tour-14-dynar.doc
198 doc/gtut-tour-15-manualdatadef.doc
199 doc/gtut-tour-16-exchangecb.doc
202 foreach(file_name ${LISTE_GTUT})
203 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
204 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
206 file(READ "${file_name}" file_content)
207 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
208 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
209 string(REPLACE "\n" ";" file_content "${file_content}")
211 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists
212 foreach(line ${file_content})
213 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
214 string(REGEX MATCH ".*_toc.*" line3 "${line}")
215 if(line2 AND NOT line3)
216 string(REPLACE "\\section " "" line2 ${line2})
217 string(REPLACE "\\subsection " "subsection" line2 ${line2})
218 string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
219 string(REGEX REPLACE " .*" "" line2 ${line2})
220 set(line2 " - \\ref ${line2}")
221 string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
222 string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
223 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
224 endif(line2 AND NOT line3)
225 endforeach(line ${file_content})
227 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists
228 foreach(line ${valeur_line})
229 string(REGEX MATCH ".*ref.*" line_ok ${line})
231 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
233 endforeach(line ${valeur_line})
235 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
237 message(STATUS "Wrong toc for ${file_name}. Should be:")
238 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
239 message("${file_content}")
240 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
242 endforeach(file_name ${LISTE_GTUT})
244 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
245 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
247 message(STATUS "Check main TOC")
249 foreach(file_name ${LISTE_GTUT})
250 file(READ "${file_name}" file_content)
251 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
252 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
253 string(REPLACE "\n" ";" file_content "${file_content}")
255 foreach(line ${file_content})
256 string(REGEX MATCH ".*@page.*" line2 "${line}")
258 string(REPLACE "@page " "" line2 "${line2}")
259 string(REGEX REPLACE " .*" "" line2 "${line2}")
260 set(line2 " - \\ref ${line2}")
261 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
263 endforeach(line ${file_content})
265 foreach(line ${valeur_line})
266 string(REGEX MATCH ".*toc.*" line1 "${line}")
267 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
268 string(REGEX MATCH "^[ ]*$" line3 "${line}")
269 string(REGEX MATCH "Table of Contents" line4 "${line}")
270 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
271 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc " ${line}\n")
272 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
273 endforeach(line ${valeur_line})
274 endforeach(file_name ${LISTE_GTUT})
276 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
277 string(REPLACE "\n" ";" file_content "${file_content}")
278 foreach(line ${file_content})
279 string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
281 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
283 endforeach(line ${file_content})
285 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
287 message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
288 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
290 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
293 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
295 ADD_CUSTOM_TARGET(pdf
296 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
298 COMMAND make pdf || true
299 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
300 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
301 COMMAND make pdf || true
302 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
303 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
305 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
307 add_dependencies(pdf simgrid_documentation)