X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1c990af7381be73a56c9bab672d425fde1861590..f43c766932553c0f32c9e681ea5b7032003c29a7:/buildtools/Cmake/GenerateUserGuide.cmake diff --git a/buildtools/Cmake/GenerateUserGuide.cmake b/buildtools/Cmake/GenerateUserGuide.cmake index 805e8b7970..3f72487934 100644 --- a/buildtools/Cmake/GenerateUserGuide.cmake +++ b/buildtools/Cmake/GenerateUserGuide.cmake @@ -1,245 +1,96 @@ #### Generate the html documentation for the user guide. -find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS) -find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) - - file(GLOB_RECURSE source_doxygen - "${CMAKE_HOME_DIRECTORY}/src/*.[chl]" - "${CMAKE_HOME_DIRECTORY}/include/*.[chl]" -) - - -if(DOXYGEN_PATH AND FIG2DEV_PATH) - - set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}") - string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES}) - - - set(DOC_PNGS - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png - ) - - configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) - configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY) - - ADD_CUSTOM_TARGET(user_guide - COMMENT "Generating the SimGrid user guide..." - DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} - COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/userguide/html - COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/userguide/html - COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc - ) - - ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc - DEPENDS ${source_doxygen} - COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY} - ) - - foreach(file ${DOC_FIGS}) - string(REPLACE ".fig" ".png" tmp_file ${file}) - string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file}) - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} - ) - endforeach(file ${DOC_FIGS}) - - foreach(file ${DOC_PNGS}) - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ - ) - endforeach(file ${DOC_PNGS}) - - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/ - ) - - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc - - COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile - - COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir* - - COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages" - COMMAND ${CMAKE_COMMAND} -E echo \"\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html - COMMAND ${CMAKE_COMMAND} -E echo \"


Grid Reality And Simulation.

\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html - - COMMAND ${CMAKE_COMMAND} -E echo \"\" > ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html - COMMAND ${CMAKE_COMMAND} -E echo \"


Advanced Metacomputing Overlay Kit.

\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html - - COMMAND ${CMAKE_COMMAND} -E echo \"\" > ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html - COMMAND ${CMAKE_COMMAND} -E echo \"


Meta SimGrid.

\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html - - COMMAND ${CMAKE_COMMAND} -E echo \"\" > ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html - COMMAND ${CMAKE_COMMAND} -E echo \"


DAG Simulator.

\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ - ) - -else(DOXYGEN_PATH AND FIG2DEV_PATH) - - ADD_CUSTOM_TARGET(user_guide - COMMENT "Generating the SimGrid user guide..." - ) - - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}" - COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}" - COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!" - COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..." - COMMAND false - ) - - -endif(DOXYGEN_PATH AND FIG2DEV_PATH) - -##############################################################################" - -message(STATUS "Check individual TOCs") -set(LISTE_GTUT - doc/gtut-tour-00-install.doc - doc/gtut-tour-01-bones.doc - doc/gtut-tour-02-simple.doc - doc/gtut-tour-03-args.doc - doc/gtut-tour-04-callback.doc - doc/gtut-tour-05-globals.doc - doc/gtut-tour-06-logs.doc - doc/gtut-tour-07-timers.doc - doc/gtut-tour-08-exceptions.doc - doc/gtut-tour-09-simpledata.doc - doc/gtut-tour-10-rpc.doc - doc/gtut-tour-11-explicitwait.doc - doc/gtut-tour-recap-messages.doc - doc/gtut-tour-12-staticstruct.doc - doc/gtut-tour-13-pointers.doc - doc/gtut-tour-14-dynar.doc - doc/gtut-tour-15-manualdatadef.doc - doc/gtut-tour-16-exchangecb.doc -) - -foreach(file_name ${LISTE_GTUT}) - file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc) - file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc) - - file(READ "${file_name}" file_content) - string(REGEX MATCH "Table of Contents.*
" valeur_line "${file_content}") - string(REPLACE "\n" ";" valeur_line "${valeur_line}") - string(REPLACE "\n" ";" file_content "${file_content}") - - file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists - foreach(line ${file_content}) - string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}") - string(REGEX MATCH ".*_toc.*" line3 "${line}") - if(line2 AND NOT line3) - string(REPLACE "\\section " "" line2 ${line2}) - string(REPLACE "\\subsection " "subsection" line2 ${line2}) - string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2}) - string(REGEX REPLACE " .*" "" line2 ${line2}) - set(line2 " - \\ref ${line2}") - string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2}) - string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2}) - file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n") - endif(line2 AND NOT line3) - endforeach(line ${file_content}) - - file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists - foreach(line ${valeur_line}) - string(REGEX MATCH ".*ref.*" line_ok ${line}) - if(line_ok) - file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n") - endif(line_ok) - endforeach(line ${valeur_line}) - - exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files) - if(compare_files) - message(STATUS "Wrong toc for ${file_name}. Should be:") - file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content) - message("${file_content}") - exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc") - endif(compare_files) -endforeach(file_name ${LISTE_GTUT}) - -file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc) -file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc) - -message(STATUS "Check main TOC") - -foreach(file_name ${LISTE_GTUT}) - file(READ "${file_name}" file_content) - string(REGEX MATCH "Table of Contents.*
" valeur_line "${file_content}") - string(REPLACE "\n" ";" valeur_line "${valeur_line}") - string(REPLACE "\n" ";" file_content "${file_content}") - - foreach(line ${file_content}) - string(REGEX MATCH ".*@page.*" line2 "${line}") - if(line2) - string(REPLACE "@page " "" line2 "${line2}") - string(REGEX REPLACE " .*" "" line2 "${line2}") - set(line2 " - \\ref ${line2}") - file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n") - endif(line2) - endforeach(line ${file_content}) - - foreach(line ${valeur_line}) - string(REGEX MATCH ".*toc.*" line1 "${line}") - string(REGEX MATCH ".*
.*" line2 "${line}") - string(REGEX MATCH "^[ ]*$" line3 "${line}") - string(REGEX MATCH "Table of Contents" line4 "${line}") - if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4) - file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc " ${line}\n") - endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4) - endforeach(line ${valeur_line}) -endforeach(file_name ${LISTE_GTUT}) - -file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content) -string(REPLACE "\n" ";" file_content "${file_content}") -foreach(line ${file_content}) - string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}") - if(line1) - file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n") - endif(line1) -endforeach(line ${file_content}) - -exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files) -if(compare_files) - message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc") - exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc") -else(compare_files) - file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc) -endif(compare_files) - -file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc) - -ADD_CUSTOM_TARGET(pdf - COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf" + "${CMAKE_HOME_DIRECTORY}/src/*.[chl]" + "${CMAKE_HOME_DIRECTORY}/include/*.[chl]" + ) + +if(FIG2DEV_PATH) + set(DOC_PNGS + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png + ) + + configure_file(${CMAKE_HOME_DIRECTORY}/doc/doxygen/UserGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/doxygen/UserGuideDoxyfile @ONLY) + + ADD_CUSTOM_TARGET(user_guide + COMMENT "Generating the SimGrid user guide..." + DEPENDS ${USER_GUIDE_SOURCES} ${DOC_FIGS} ${source_doxygen} + COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html + COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/doxygen + ) + + foreach(file ${DOC_FIGS}) + string(REPLACE ".fig" ".png" tmp_file ${file}) + string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file}) + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} + ) + endforeach(file ${DOC_FIGS}) + + foreach(file ${DOC_PNGS}) + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ + ) + endforeach(file ${DOC_PNGS}) + + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-time_interval.png ${CMAKE_HOME_DIRECTORY}/doc/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/ + ) + + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/doxygen/simgrid_modules.map + COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" + COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile + + COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" + COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile + + COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir* + + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/doxygen + ) + +else() + + ADD_CUSTOM_TARGET(user_guide + COMMENT "Generating the SimGrid user guide..." + ) + + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!" + COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..." + COMMAND false + ) + +endif() + +ADD_CUSTOM_TARGET(user_guide_pdf + COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_user_guide.pdf" COMMAND make clean COMMAND make pdf || true - COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf" + COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_user_guide.pdf" COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf COMMAND make pdf || true COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf" COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf - + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/ ) -add_dependencies(pdf user_guide) +add_dependencies(user_guide_pdf user_guide)