Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Added the new logo to the unstable doc, so that Lucas and Fred can show a webpage...
[simgrid.git] / buildtools / Cmake / GenerateDoc.cmake
1 #### Generate the html documentation
2
3 if(BIBTEX2HTML)
4         set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
5 else(BIBTEX2HTML)
6         find_path(BIBTEX2HTML_PATH      NAMES bibtex2html       PATHS NO_DEFAULT_PATHS)
7 endif(BIBTEX2HTML)
8
9 find_path(FIG2DEV_PATH  NAMES fig2dev   PATHS NO_DEFAULT_PATHS)
10 find_path(DOXYGEN_PATH  NAMES doxygen   PATHS NO_DEFAULT_PATHS)
11
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})
15
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]"
20 )
21
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})
27
28 if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
29
30         string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}")
31
32         #DOC_SOURCE=doc/*.doc, defined in DefinePackage
33         set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
34         string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
35
36
37         set(DOC_PNGS 
38                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png
39                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
40                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
41                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
42                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
43                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
44                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
45                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
46         )
47         
48         configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
49         configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)                
50         
51         ADD_CUSTOM_TARGET(simgrid_documentation
52                 COMMENT "Generating the SimGrid documentation..."
53                 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
54                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
55             COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
56                 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
57                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
58         )
59                 
60         ADD_CUSTOM_COMMAND(
61                 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
62                 DEPENDS ${source_doxygen}
63                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
64                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
65                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
66         )
67
68         foreach(file ${DOC_FIGS})
69                 string(REPLACE ".fig" ".png" tmp_file ${file})
70                 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
71                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
72                         COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
73                 )
74         endforeach(file ${DOC_FIGS})
75         
76         foreach(file ${DOC_PNGS})
77                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
78                         COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
79                 )
80         endforeach(file ${DOC_PNGS})
81
82         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
83                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
84                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg     ${CMAKE_HOME_DIRECTORY}/doc/html/
85                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
86                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
87                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css                          ${CMAKE_HOME_DIRECTORY}/doc/html/
88         )
89         
90         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
91             COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
92                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
93                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
94                 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                 
96                 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
97                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
98                 
99                 COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
100                 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
101                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
102                 
103                 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
104                 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
105                 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                 
107                 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
108                 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         
110                 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
111                 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         
113                 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
114                 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
115                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
116         )
117         
118 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
119
120         ADD_CUSTOM_TARGET(simgrid_documentation
121                         COMMENT "Generating the SimGrid documentation..."
122                         )
123
124         if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
125                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
126                         COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
127                         COMMAND ${CMAKE_COMMAND} -E echo  "You can download it from:"
128                         COMMAND ${CMAKE_COMMAND} -E echo  "  ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
129                         COMMAND ${CMAKE_COMMAND} -E echo  "There is also an unofficial Debian/Ubuntu package, see:"
130                         COMMAND ${CMAKE_COMMAND} -E echo  "  http://www.loria.fr/~lnussbau/bibtex2html/README"
131                         )
132         endif(NOT GOOD_BIBTEX2HTML_VERSION)
133
134         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
135                         COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH          = ${DOXYGEN_PATH}"
136                         COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH          = ${FIG2DEV_PATH}"
137                         COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH      = ${BIBTEX2HTML_PATH}"
138                         COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
139                         COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
140                         COMMAND false
141                         )
142
143                 
144 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
145
146 ##############################################################################"
147
148 message(STATUS "Check individual TOCs")
149 set(LISTE_GTUT
150         doc/gtut-tour-00-install.doc
151         doc/gtut-tour-01-bones.doc
152         doc/gtut-tour-02-simple.doc
153         doc/gtut-tour-03-args.doc
154         doc/gtut-tour-04-callback.doc
155         doc/gtut-tour-05-globals.doc
156         doc/gtut-tour-06-logs.doc
157         doc/gtut-tour-07-timers.doc
158         doc/gtut-tour-08-exceptions.doc
159         doc/gtut-tour-09-simpledata.doc
160         doc/gtut-tour-10-rpc.doc
161         doc/gtut-tour-11-explicitwait.doc
162         doc/gtut-tour-recap-messages.doc
163         doc/gtut-tour-12-staticstruct.doc
164         doc/gtut-tour-13-pointers.doc
165         doc/gtut-tour-14-dynar.doc
166         doc/gtut-tour-15-manualdatadef.doc
167         doc/gtut-tour-16-exchangecb.doc
168 )
169
170 foreach(file_name ${LISTE_GTUT})
171         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
172         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
173         
174         file(READ "${file_name}" file_content)
175         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
176         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
177         string(REPLACE "\n" ";" file_content "${file_content}")
178                
179         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists
180         foreach(line ${file_content})
181                 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
182                 string(REGEX MATCH ".*_toc.*" line3 "${line}")
183                 if(line2 AND NOT line3)
184                         string(REPLACE "\\section " "" line2 ${line2})
185                         string(REPLACE "\\subsection " "subsection" line2 ${line2})
186                         string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
187                         string(REGEX REPLACE " .*" "" line2 ${line2})
188                         set(line2                               " - \\ref ${line2}")
189                         string(REPLACE " - \\ref subsection"    "   - \\ref " line2 ${line2})
190                         string(REPLACE " - \\ref subsubsection" "     - \\ref " line2 ${line2})
191                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
192                 endif(line2 AND NOT line3)
193         endforeach(line ${file_content})
194         
195         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists
196         foreach(line ${valeur_line})
197                 string(REGEX MATCH ".*ref.*" line_ok ${line})
198                 if(line_ok)
199                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
200                 endif(line_ok)
201         endforeach(line ${valeur_line})
202         
203         exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
204         if(compare_files)
205                 message(STATUS "Wrong toc for ${file_name}. Should be:")
206                 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
207                 message("${file_content}")
208                 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
209         endif(compare_files)
210 endforeach(file_name ${LISTE_GTUT})
211
212 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
213 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
214
215 message(STATUS "Check main TOC")
216
217 foreach(file_name ${LISTE_GTUT})
218         file(READ "${file_name}" file_content)  
219         string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
220         string(REPLACE "\n" ";" valeur_line "${valeur_line}")
221         string(REPLACE "\n" ";" file_content "${file_content}")
222         
223         foreach(line ${file_content})
224                 string(REGEX MATCH ".*@page.*" line2 "${line}")
225                 if(line2)
226                         string(REPLACE "@page " "" line2 "${line2}")
227                         string(REGEX REPLACE " .*" "" line2 "${line2}")
228                         set(line2 " - \\ref ${line2}")
229                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
230                 endif(line2)
231         endforeach(line ${file_content})
232         
233         foreach(line ${valeur_line})
234                 string(REGEX MATCH ".*toc.*" line1 "${line}")
235                 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
236                 string(REGEX MATCH "^[ ]*$" line3 "${line}")
237                 string(REGEX MATCH "Table of Contents" line4 "${line}")
238                 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
239                         file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "   ${line}\n")
240                 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
241         endforeach(line ${valeur_line})
242 endforeach(file_name ${LISTE_GTUT})     
243
244 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
245 string(REPLACE "\n" ";" file_content "${file_content}")
246 foreach(line ${file_content})
247         string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
248         if(line1)
249                 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
250         endif(line1)
251 endforeach(line ${file_content})
252         
253 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
254 if(compare_files)
255         message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
256         exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
257 else(compare_files)
258         file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
259 endif(compare_files)    
260   
261 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
262
263 ADD_CUSTOM_TARGET(pdf
264     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
265     COMMAND make clean
266     COMMAND make pdf || true
267     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
268     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
269     COMMAND make pdf || true
270     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
271     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
272   
273     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
274 )
275 add_dependencies(pdf simgrid_documentation)