Logo AND Algorithmique Numérique Distribuée

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