1 #### Generate the html documentation for the user guide.
3 file(GLOB_RECURSE source_doxygen
4 "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
5 "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
6 "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
11 set(DOCSSOURCES "${source_doxygen}\n${USER_GUIDE_SOURCES}")
12 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
16 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
17 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
18 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
19 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
20 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
21 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
22 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
23 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png
24 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png
27 configure_file(${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/UserGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/UserGuideDoxyfile @ONLY)
29 ADD_CUSTOM_TARGET(user_guide
30 COMMENT "Generating the SimGrid user guide..."
31 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
32 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html
33 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html
34 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen
37 ADD_CUSTOM_COMMAND(TARGET user_guide
38 DEPENDS ${source_doxygen}
39 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
40 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/logcategories.doc
41 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
44 foreach(file ${DOC_FIGS})
45 string(REPLACE ".fig" ".png" tmp_file ${file})
46 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/" tmp_file ${tmp_file})
47 ADD_CUSTOM_COMMAND(TARGET user_guide
48 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
50 endforeach(file ${DOC_FIGS})
52 foreach(file ${DOC_PNGS})
53 ADD_CUSTOM_COMMAND(TARGET user_guide
54 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
56 endforeach(file ${DOC_PNGS})
58 ADD_CUSTOM_COMMAND(TARGET user_guide
59 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
60 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
61 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
62 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
63 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
64 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
67 ADD_CUSTOM_COMMAND(TARGET user_guide
68 COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/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/user_guide/doxygen/simgrid_modules.map
69 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
70 COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile
71 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgriduserguide.tag index-API.doc
73 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
74 COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile
76 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/dir*
78 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen
83 ADD_CUSTOM_TARGET(user_guide
84 COMMENT "Generating the SimGrid user guide..."
87 ADD_CUSTOM_COMMAND(TARGET user_guide
88 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
89 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
90 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
91 COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
98 ##############################################################################"
100 message(STATUS "Check individual TOCs")
102 doc/user_guide/doxygen/gtut-tour-00-install.doc
103 doc/user_guide/doxygen/gtut-tour-01-bones.doc
104 doc/user_guide/doxygen/gtut-tour-02-simple.doc
105 doc/user_guide/doxygen/gtut-tour-03-args.doc
106 doc/user_guide/doxygen/gtut-tour-04-callback.doc
107 doc/user_guide/doxygen/gtut-tour-05-globals.doc
108 doc/user_guide/doxygen/gtut-tour-06-logs.doc
109 doc/user_guide/doxygen/gtut-tour-07-timers.doc
110 doc/user_guide/doxygen/gtut-tour-08-exceptions.doc
111 doc/user_guide/doxygen/gtut-tour-09-simpledata.doc
112 doc/user_guide/doxygen/gtut-tour-10-rpc.doc
113 doc/user_guide/doxygen/gtut-tour-11-explicitwait.doc
114 doc/user_guide/doxygen/gtut-tour-recap-messages.doc
115 doc/user_guide/doxygen/gtut-tour-12-staticstruct.doc
116 doc/user_guide/doxygen/gtut-tour-13-pointers.doc
117 doc/user_guide/doxygen/gtut-tour-14-dynar.doc
118 doc/user_guide/doxygen/gtut-tour-15-manualdatadef.doc
119 doc/user_guide/doxygen/gtut-tour-16-exchangecb.doc
122 foreach(file_name ${LISTE_GTUT})
123 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc)
124 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc)
126 file(READ "${file_name}" file_content)
127 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
128 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
129 string(REPLACE "\n" ";" file_content "${file_content}")
131 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc "\n") # make sure it exists
132 foreach(line ${file_content})
133 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
134 string(REGEX MATCH ".*_toc.*" line3 "${line}")
135 if(line2 AND NOT line3)
136 string(REPLACE "\\section " "" line2 ${line2})
137 string(REPLACE "\\subsection " "subsection" line2 ${line2})
138 string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
139 string(REGEX REPLACE " .*" "" line2 ${line2})
140 set(line2 " - \\ref ${line2}")
141 string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
142 string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
143 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc "${line2}\n")
144 endif(line2 AND NOT line3)
145 endforeach(line ${file_content})
147 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc "\n") # make sure it exists
148 foreach(line ${valeur_line})
149 string(REGEX MATCH ".*ref.*" line_ok ${line})
151 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc "${line_ok}\n")
153 endforeach(line ${valeur_line})
155 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc" OUTPUT_VARIABLE compare_files)
157 message(STATUS "Wrong toc for ${file_name}. Should be:")
158 file(READ "${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc" file_content)
159 message("${file_content}")
160 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc")
162 endforeach(file_name ${LISTE_GTUT})
164 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc)
165 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc)
167 message(STATUS "Check main TOC")
169 foreach(file_name ${LISTE_GTUT})
170 file(READ "${file_name}" file_content)
171 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
172 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
173 string(REPLACE "\n" ";" file_content "${file_content}")
175 foreach(line ${file_content})
176 string(REGEX MATCH ".*@page.*" line2 "${line}")
178 string(REPLACE "@page " "" line2 "${line2}")
179 string(REGEX REPLACE " .*" "" line2 "${line2}")
180 set(line2 " - \\ref ${line2}")
181 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc "${line2}\n")
183 endforeach(line ${file_content})
185 foreach(line ${valeur_line})
186 string(REGEX MATCH ".*toc.*" line1 "${line}")
187 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
188 string(REGEX MATCH "^[ ]*$" line3 "${line}")
189 string(REGEX MATCH "Table of Contents" line4 "${line}")
190 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
191 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc " ${line}\n")
192 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
193 endforeach(line ${valeur_line})
194 endforeach(file_name ${LISTE_GTUT})
196 file(READ "${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/gtut-tour.doc" file_content)
197 string(REPLACE "\n" ";" file_content "${file_content}")
198 foreach(line ${file_content})
199 string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
201 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc "${line}\n")
203 endforeach(line ${file_content})
205 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc" OUTPUT_VARIABLE compare_files)
207 message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
208 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc")
210 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc)
213 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc)
215 ADD_CUSTOM_TARGET(user_guide_pdf
216 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_user_guide.pdf"
218 COMMAND make pdf || true
219 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_user_guide.pdf"
220 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
221 COMMAND make pdf || true
222 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
223 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
225 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
227 add_dependencies(user_guide_pdf user_guide)