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 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
41 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
42 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
43 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
44 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
47 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
48 configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
50 ADD_CUSTOM_TARGET(simgrid_documentation
51 COMMENT "Generating the SimGrid documentation..."
52 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
53 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
54 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
55 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
56 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
60 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
61 DEPENDS ${source_doxygen}
62 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
63 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
64 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
67 foreach(file ${DOC_FIGS})
68 string(REPLACE ".fig" ".png" tmp_file ${file})
69 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
70 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
71 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
73 endforeach(file ${DOC_FIGS})
75 foreach(file ${DOC_PNGS})
76 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
77 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
79 endforeach(file ${DOC_PNGS})
81 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
82 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
83 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
84 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/
85 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/
86 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
89 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
90 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
91 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
92 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
93 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl pls.doc index.doc gtut-introduction.doc installSimgrid.doc bindings.doc options.doc tracing.doc
95 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
96 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
98 COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
99 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
100 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
102 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
103 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
104 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
106 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
107 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
109 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
110 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
112 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
113 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
114 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
117 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
119 ADD_CUSTOM_TARGET(simgrid_documentation
120 COMMENT "Generating the SimGrid documentation..."
123 if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
124 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
125 COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
126 COMMAND ${CMAKE_COMMAND} -E echo "You can download it from:"
127 COMMAND ${CMAKE_COMMAND} -E echo " ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
128 COMMAND ${CMAKE_COMMAND} -E echo "There is also an unofficial Debian/Ubuntu package, see:"
129 COMMAND ${CMAKE_COMMAND} -E echo " http://www.loria.fr/~lnussbau/bibtex2html/README"
131 endif(NOT GOOD_BIBTEX2HTML_VERSION)
133 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
134 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
135 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
136 COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}"
137 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
138 COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
143 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
145 ##############################################################################"
147 message(STATUS "Check individual TOCs")
149 doc/gtut-tour-00-install.doc
150 doc/gtut-tour-01-bones.doc
151 doc/gtut-tour-02-simple.doc
152 doc/gtut-tour-03-args.doc
153 doc/gtut-tour-04-callback.doc
154 doc/gtut-tour-05-globals.doc
155 doc/gtut-tour-06-logs.doc
156 doc/gtut-tour-07-timers.doc
157 doc/gtut-tour-08-exceptions.doc
158 doc/gtut-tour-09-simpledata.doc
159 doc/gtut-tour-10-rpc.doc
160 doc/gtut-tour-11-explicitwait.doc
161 doc/gtut-tour-recap-messages.doc
162 doc/gtut-tour-12-staticstruct.doc
163 doc/gtut-tour-13-pointers.doc
164 doc/gtut-tour-14-dynar.doc
165 doc/gtut-tour-15-manualdatadef.doc
166 doc/gtut-tour-16-exchangecb.doc
169 foreach(file_name ${LISTE_GTUT})
170 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
171 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
173 file(READ "${file_name}" file_content)
174 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
175 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
176 string(REPLACE "\n" ";" file_content "${file_content}")
178 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists
179 foreach(line ${file_content})
180 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
181 string(REGEX MATCH ".*_toc.*" line3 "${line}")
182 if(line2 AND NOT line3)
183 string(REPLACE "\\section " "" line2 ${line2})
184 string(REPLACE "\\subsection " "subsection" line2 ${line2})
185 string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
186 string(REGEX REPLACE " .*" "" line2 ${line2})
187 set(line2 " - \\ref ${line2}")
188 string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
189 string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
190 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
191 endif(line2 AND NOT line3)
192 endforeach(line ${file_content})
194 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists
195 foreach(line ${valeur_line})
196 string(REGEX MATCH ".*ref.*" line_ok ${line})
198 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
200 endforeach(line ${valeur_line})
202 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
204 message(STATUS "Wrong toc for ${file_name}. Should be:")
205 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
206 message("${file_content}")
207 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
209 endforeach(file_name ${LISTE_GTUT})
211 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
212 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
214 message(STATUS "Check main TOC")
216 foreach(file_name ${LISTE_GTUT})
217 file(READ "${file_name}" file_content)
218 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
219 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
220 string(REPLACE "\n" ";" file_content "${file_content}")
222 foreach(line ${file_content})
223 string(REGEX MATCH ".*@page.*" line2 "${line}")
225 string(REPLACE "@page " "" line2 "${line2}")
226 string(REGEX REPLACE " .*" "" line2 "${line2}")
227 set(line2 " - \\ref ${line2}")
228 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
230 endforeach(line ${file_content})
232 foreach(line ${valeur_line})
233 string(REGEX MATCH ".*toc.*" line1 "${line}")
234 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
235 string(REGEX MATCH "^[ ]*$" line3 "${line}")
236 string(REGEX MATCH "Table of Contents" line4 "${line}")
237 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
238 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc " ${line}\n")
239 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
240 endforeach(line ${valeur_line})
241 endforeach(file_name ${LISTE_GTUT})
243 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
244 string(REPLACE "\n" ";" file_content "${file_content}")
245 foreach(line ${file_content})
246 string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
248 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
250 endforeach(line ${file_content})
252 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
254 message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
255 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
257 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
260 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
262 ADD_CUSTOM_TARGET(pdf
263 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
265 COMMAND make pdf || true
266 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
267 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
268 COMMAND make pdf || true
269 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
270 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
272 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
274 add_dependencies(pdf simgrid_documentation)