1 message("\tBIBTEX2HTML : ${BIBTEX2HTML}")
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)
11 find_path(BIBTOOL_PATH NAMES bibtool PATHS NO_DEFAULT_PATHS)
12 find_path(ICONV_PATH NAMES iconv PATHS NO_DEFAULT_PATHS)
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}")
20 ### Check whether the bibtex2html that we found is the one that Arnaud requires
21 exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION)
22 STRING(REPLACE "[-bibtex]" "" OUTPUT_BIBTEX2HTML_VERSION_2 ${OUTPUT_BIBTEX2HTML_VERSION})
25 if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version
26 message("\nERROR --> NEED to set bibtex2html path with \"ccmake ./\" or with \"cmake -DBIBTEX2HTML=<path_to> ./\"")
27 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)")
28 message(FATAL_ERROR "\n")
29 endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION})
30 endif(BIBTEX2HTML_PATH)
33 file(GLOB_RECURSE source_doxygen
34 "${PROJECT_DIRECTORY}/tools/gras/*.[chl]"
35 "${PROJECT_DIRECTORY}/src/*.[chl]"
36 "${PROJECT_DIRECTORY}/include/*.[chl]"
40 OUTPUT ${PROJECT_DIRECTORY}/doc/html/generated
41 COMMENT "Generating the SimGrid documentation..."
42 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
44 COMMAND ${CMAKE_COMMAND} -E remove_directory ${PROJECT_DIRECTORY}/doc/html
45 COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_DIRECTORY}/doc/html
46 COMMAND ${CMAKE_COMMAND} -E touch ${PROJECT_DIRECTORY}/doc/html/generated
48 WORKING_DIRECTORY ${PROJECT_DIRECTORY}/doc/
53 string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}")
55 #DOC_SOURCE=doc/*.doc, defined in DefinePackage
56 set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
57 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
61 ${PROJECT_DIRECTORY}/doc/webcruft/simgrid_logo.png
62 ${PROJECT_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
63 ${PROJECT_DIRECTORY}/doc/webcruft/poster_thumbnail.png
66 if(DOXYGEN_PATH AND FIG2DEV_PATH)
68 ADD_CUSTOM_COMMAND(APPEND
69 OUTPUT doc/html/generated
70 COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${PROJECT_DIRECTORY}/doc/fig/simgrid_modules.fig |perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' > ${PROJECT_DIRECTORY}/doc/simgrid_modules.map
74 string(REPLACE ".fig" ".png" tmp_file ${file})
75 string(REPLACE "${PROJECT_DIRECTORY}/doc/fig/" "${PROJECT_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
76 ADD_CUSTOM_COMMAND(APPEND
77 OUTPUT doc/html/generated
78 COMMAND "${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}"
80 endforeach(file ${FIGS})
83 ADD_CUSTOM_COMMAND(APPEND
84 OUTPUT doc/html/generated
85 COMMAND ${CMAKE_COMMAND} -E 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
89 foreach(file ${DOC_PNGS})
90 ADD_CUSTOM_COMMAND(APPEND
91 OUTPUT doc/html/generated
92 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${PROJECT_DIRECTORY}/doc/html/
94 endforeach(file ${DOC_PNGS})
96 ADD_CUSTOM_COMMAND(APPEND
97 OUTPUT doc/html/generated
98 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${PROJECT_DIRECTORY}/doc/html/
99 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${PROJECT_DIRECTORY}/doc/html/
100 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/triva-graph_configuration.png ${PROJECT_DIRECTORY}/doc/html/
101 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/triva-graph_visualization.png ${PROJECT_DIRECTORY}/doc/html/
102 COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_DIRECTORY}/doc/simgrid.css ${PROJECT_DIRECTORY}/doc/html/
105 configure_file(${PROJECT_DIRECTORY}/doc/Doxyfile.in ${PROJECT_DIRECTORY}/doc/Doxyfile @ONLY)
107 ADD_CUSTOM_COMMAND(OUTPUT doc/html/generated APPEND
108 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
109 COMMAND ${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile
110 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
111 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc
113 COMMAND ${CMAKE_COMMAND} -E echo XX Second Doxygen pass
114 COMMAND ${DOXYGEN_PATH}/doxygen ${PROJECT_DIRECTORY}/doc/Doxyfile
116 COMMAND ${CMAKE_COMMAND} -E echo XX Post-processing Doxygen result
117 COMMAND ${CMAKE_COMMAND} -E remove -f ${PROJECT_DIRECTORY}/doc/html/dir*
118 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php
119 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
121 COMMAND ${CMAKE_COMMAND} -E echo XX Create shortcuts pages
122 COMMAND ${CMAKE_COMMAND} -E 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
123 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>\" >> ${PROJECT_DIRECTORY}/doc/html/gras.html
125 COMMAND ${CMAKE_COMMAND} -E 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
126 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>\" >> ${PROJECT_DIRECTORY}/doc/html/amok.html
128 COMMAND ${CMAKE_COMMAND} -E 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
129 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>\" >> ${PROJECT_DIRECTORY}/doc/html/msg.html
131 COMMAND ${CMAKE_COMMAND} -E 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
132 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>\" >> ${PROJECT_DIRECTORY}/doc/html/simdag.html
135 if(BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
137 OUTPUT ${PROJECT_DIRECTORY}/doc/publis_count.html
139 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${PROJECT_DIRECTORY}/doc/all.bib > ${PROJECT_DIRECTORY}/doc/publis_count.html
141 add_dependencies(doc/html/generated ${PROJECT_DIRECTORY}/doc/publis_count.html)
144 OUTPUT publis_core.bib publis_extern.bib publis_intra.bib
147 COMMAND ${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
148 COMMAND ${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
149 COMMAND ${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
152 foreach(file "publis_core publis_extern publis_intra")
154 OUTPUT ${PROJECT_DIRECTORY}/doc/${file}.html
155 DEPENDS "${file}.bib"
157 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl ${file}
160 add_dependencies(doc/html/generated ${PROJECT_DIRECTORY}/doc/${file}.html)
161 endforeach(file "publis_core publis_extern publis_intra")
163 endif(BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
165 endif(DOXYGEN_PATH AND FIG2DEV_PATH)
168 OUTPUT ${PROJECT_DIRECTORY}/doc/logcategories.doc
169 DEPENDS ${source_doxygen}
171 COMMAND ${PROJECT_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${PROJECT_DIRECTORY}/doc/logcategories.doc
175 message("Check individual TOCs")
176 file(GLOB_RECURSE LISTE_GTUT
177 "${PROJECT_DIRECTORY}/doc/gtut-tour-*.doc"
179 foreach(file_name ${LISTE_GTUT})
180 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)
181 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
183 file(READ "${file_name}" file_content)
184 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
185 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
186 string(REPLACE "\n" ";" file_content "${file_content}")
188 foreach(line ${file_content})
189 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
190 string(REGEX MATCH ".*_toc.*" line3 "${line}")
191 if(line2 AND NOT line3)
192 string(REPLACE "\\section " "" line2 ${line2})
193 string(REPLACE "\\subsection " "subsection" line2 ${line2})
194 string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
195 string(REGEX REPLACE " .*" "" line2 ${line2})
196 set(line2 " - \\ref ${line2}")
197 string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
198 string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
199 file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
200 endif(line2 AND NOT line3)
201 endforeach(line ${file_content})
203 foreach(line ${valeur_line})
204 string(REGEX MATCH ".*ref.*" line_ok ${line})
206 file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
208 endforeach(line ${valeur_line})
210 exec_program("${CMAKE_COMMAND} -E compare_files ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
212 message("Wrong toc for ${file_name}. Should be:")
213 file(READ "${PROJECT_DIRECTORY}/doc/tmp.realtoc" file_content)
214 message("${file_content}")
215 exec_program("diff -u ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc")
217 endforeach(file_name ${LISTE_GTUT})
219 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)
220 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
222 message("Check main TOC")
224 foreach(file_name ${LISTE_GTUT})
225 file(READ "${file_name}" file_content)
226 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
227 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
228 string(REPLACE "\n" ";" file_content "${file_content}")
230 foreach(line ${file_content})
231 string(REGEX MATCH ".*@page.*" line2 "${line}")
233 string(REPLACE "@page " "" line2 "${line2}")
234 string(REGEX REPLACE " .*" "" line2 "${line2}")
235 set(line2 " - \\ref ${line2}")
236 file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
238 endforeach(line ${file_content})
240 foreach(line ${valeur_line})
241 string(REGEX MATCH ".*toc.*" line1 "${line}")
242 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
243 string(REGEX MATCH "^[ ]*$" line3 "${line}")
244 string(REGEX MATCH "Table of Contents" line4 "${line}")
245 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
246 file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.realtoc " ${line}\n")
247 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
248 endforeach(line ${valeur_line})
249 endforeach(file_name ${LISTE_GTUT})
251 file(READ "${PROJECT_DIRECTORY}/doc/gtut-tour.doc" file_content)
252 string(REPLACE "\n" ";" file_content "${file_content}")
253 foreach(line ${file_content})
254 string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
256 file(APPEND ${PROJECT_DIRECTORY}/doc/tmp.curtoc "${line}\n")
258 endforeach(line ${file_content})
260 exec_program("${CMAKE_COMMAND} -E compare_files ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
262 message("Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
263 exec_program("diff -u ${PROJECT_DIRECTORY}/doc/tmp.curtoc ${PROJECT_DIRECTORY}/doc/tmp.realtoc")
265 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.realtoc)
268 file(REMOVE ${PROJECT_DIRECTORY}/doc/tmp.curtoc)