-proc wgendoc {workBench {outDir {}} {modules {}} {createChmHelp NO} {hhcLocation ""} {doxygenPath ""} {graphvizPath ""}} {
- global env
-
- if {$workBench == "-help" || $workBench == "-he"} {
- puts "Command wgendoc allow you to generate Doxygen documentation"
- puts ""
- puts "wgendoc {workBench} {outDir} {modules} {createChmHelp} {hhcLocation} {doxygenPath} {graphvizPath}"
- puts "Parameters:"
- puts " workBench - name of your OCCT workbench"
- puts " outDir - documentation output directory"
- puts " modules - list of OCCT modules, which documentation will be generated"
- puts " createChmHelp - if \"YES\", with HTML files will be generated a CHM documentation file. Default value is \"NO\"."
- puts " hhcLocation - if createChmHelp is \"YES\", then you must say, where is HTML Help Workshop directory (which contain file hhc.exe)"
- puts " doxygenPath - you can say doxygen.exe directory (if you have latest version of Doxygen). It is optional parameter."
- puts " graphvizPath - you can say dot.exe directory (if you have latest version of GraphViz). It is optional parameter."
- return
- }
+#wgendoc
+#[-wb=<workbench name>]
+#[-m=<list of modules>]
+#[-outdir=<path>]
+#[-chm]
+#[-hhc=<path to hhc.exe>]
+#[-qthelp=<path to Qt>]
+#[-doxygen=<path to doxygen.exe>]
+#[-dot=<path to dot.exe>]
+proc wgendoc {args} {
+ global env
+ global args_names
+ global args_values
- if { "$doxygenPath" == "" } { set doxygenPath "$env(WOKHOME)/3rdparty/win32/utils" }
- if { "$graphvizPath" == "" } { set graphvizPath "$env(WOKHOME)/3rdparty/win32/utils" }
-
- wokcd $workBench
- OS -box
- OCCDoc_GenerateDoc $outDir $modules $createChmHelp $hhcLocation $doxygenPath $graphvizPath {} {}
-}
-
-# general procedure for generation Doxygen documentation
-# it launches both generation process and post process
-proc OCCDoc_GenerateDoc {outDir {modules {}} {createChmHelp NO} {hhcLocation {}} {doxygenPath {}} {graphvizPath {}} {useSearch YES} {tagFiles {}}} {
- catch {exec $doxygenPath/doxygen [OCCDoc_MakeDoxyfile $outDir $modules $createChmHelp $hhcLocation $graphvizPath]}
- OCCDoc_PostProcessor $outDir
-}
-
-# generate Doxygen configuration file for specified OCCT module of toolkit
-proc OCCDoc_MakeDoxyfile {outDir {modules {}} {createChmHelp NO} {hhcLocation {}} {graphvizPath {}} {useSearch YES} {tagFiles {}}} {
-
- # by default take all modules
- if { [llength $modules] <= 0 } {
- set modules [OS -lm]
- }
+ source $env(WOKHOME)/lib/OCCTDocumentationProcedures.tcl
+
+ if {[OCCDoc_ParseArguments $args] == 1} {
+ return
+ }
- # create target directory
- if { ! [file exists $outDir] } {
- file mkdir $outDir
- }
+ # platform dependent extension for exe files
+ global tcl_platform
+ if { $tcl_platform(platform) == "windows" } {
+ set exe ".exe"
+ } else {
+ set exe ""
+ }
- if { ! [file exists $outDir/html] } {
- file mkdir $outDir/html
- }
-
- # set context
- set one_module [expr [llength $modules] == 1]
- if { $one_module } {
- set title "OCCT [$modules:name]"
- set name $modules
+ set modules {}
+ set useSearch YES
+ set outDir "[lindex [wokinfo -R] 0]/documentation"
+ set createChmHelp NO
+ set hhcPath ""
+ set gthelpPath ""
+ set createQhpHelp NO
+ set doxygenPath "$env(WOKHOME)/3rdparty/win32/utils/doxygen$exe"
+ set graphvizPath "$env(WOKHOME)/3rdparty/win32/utils/dot$exe"
+
+ foreach arg_n $args_names {
+ if {$arg_n == "h"} {
+ puts "usage : wgendoc \[-wb=<workbench name>\] \[-m=<list of modules>\] \[-outdir=<path>\] \[-chm\]
+ \[-hhc=<path to hhc.exe>\] \[-qthelp=<path to Qt>\] \[-doxygen=<path to doxygen.exe>\] \[-dot=<path to dot.exe>\]"
+ puts ""
+ puts " Options are : "
+ puts " -wb=<workbench name> : Name of OCCT workbench (current one by default)"
+ puts " -m=<list of modules> : Documentation will contain this list of modules"
+ puts " -outdir=<path> : Documentation output directory"
+ puts " -chm : Generate CHM file"
+ puts " -hhc=<path> : Path to HTML Help Compiler (hhc.exe) or equivalent"
+ puts " -qthelp=<path> : Generate Qt Help file, specify path to qthelpgenerator executable"
+ puts " -doxygen=<path> : Path to Doxygen executable"
+ puts " -dot=<path> : Path to GraphViz dot executable"
+ return
+ } elseif {$arg_n == "wb"} {
+ if {$args_values(wb) != "NULL"} {
+ wokcd $args_values(wb)
+ } else {
+ puts "Error in argument wb"
+ return
+ }
+ } elseif {$arg_n == "m"} {
+ if {$args_values(m) != "NULL"} {
+ set modules $args_values(m)
+ } else {
+ puts "Error in argument m"
+ return
+ }
+ } elseif {$arg_n == "outdir"} {
+ if {$args_values(outdir) != "NULL"} {
+ set outDir $args_values(outdir)
+ } else {
+ puts "Error in argument outdir"
+ return
+ }
+ } elseif {$arg_n == "chm"} {
+ set createChmHelp YES
+ set useSearch NO
+ # use standard location of Html Help Workshop
+ if {"$tcl_platform(platform)" == "windows" && [lsearch $args_names hhc] == -1} {
+ if { [info exist env(ProgramFiles\(x86\))] } {
+ set hhcPath "$env(ProgramFiles\(x86\))/HTML Help Workshop/hhc.exe"
+ } elseif { [info exist env(ProgramFiles)] } {
+ set hhcPath "$env(ProgramFiles)/HTML Help Workshop/hhc.exe"
+ }
+ if { ! [file exists $hhcPath] } {
+ puts "Error: HTML Help Compiler is not found in standard location [file dirname $hhcPath]; use option -hhc"
+ return
+ }
+ }
+ } elseif {$arg_n == "hhc"} {
+ if {$args_values(hhc) != "NULL"} {
+ set hhcPath $args_values(hhc)
+ if { [file isdirectory $hhcPath] } {
+ set hhcPath [file join ${hhcPath} hhc$exe]
+ }
+ if { ! [file exists $hhcPath] } {
+ puts "Error: HTML Help Compiler is not found in $hhcPath"
+ return
+ }
+ } else {
+ puts "Error in argument hhc"
+ return
+ }
+ } elseif {$arg_n == "qthelp"} {
+ set createQhpHelp YES
+ set useSearch NO
+ if {$args_values(qthelp) != "NULL"} {
+ set gthelpPath $args_values(qthelp)
+ if { [file isdirectory $gthelpPath] } {
+ set gthelpPath [file join ${gthelpPath} qhelpgenerator$exe]
+ }
+ if { ! [file exists "$gthelpPath"] } {
+ puts "Error: Qt Help Generator is not found in $gthelpPath"
+ return
+ }
+ } else {
+ puts "Error in argument qthelp: please specify path to qthelpgenerator executable"
+ return
+ }
+ } elseif {$arg_n == "doxygen"} {
+ if {$args_values(doxygen) != "NULL"} {
+ set doxygenPath $args_values(doxygen)
+ if { [file isdirectory $doxygenPath] } {
+ set doxygenPath [file join ${doxygenPath} doxygen$exe]
+ }
+ if {[file exists "$doxygenPath"] == 0} {
+ puts "Error: Doxygen is not found in $doxygenPath"
+ return
+ }
+ } else {
+ puts "Error in argument doxygen: please specify path to doxygen executable"
+ return
+ }
+ } elseif {$arg_n == "dot"} {
+ if {$args_values(dot) != "NULL"} {
+ set graphvizPath $args_values(dot)
+ if { [file isfile $graphvizPath] } {
+ set graphvizPath [file dirname ${graphvizPath}]
+ }
+ if {[file exists [file join $graphvizPath dot$exe]] == 0} {
+ puts "Error: File dot$exe is not found in $graphvizPath"
+ return
+ }
+ } else {
+ puts "Error in argument dot: please specify path to dot executable"
+ return
+ }
} else {
- set title "Open CASCADE Technology"
- set name OCCT
+ puts "Unknown argument $arg_n"
+ return
}
+ }
- # get list of header files in the specified modules
- set filelist {}
- foreach module $modules {
- if {[lsearch [OS -lm] $module] == -1 } {
- puts "Error: no module $module is known in current workbench"
- continue
- }
- foreach tk [$module:toolkits] {
- foreach pk [osutils:tk:units [woklocate -u $tk]] {
- lappend filelist [uinfo -p -T pubinclude $pk]
- }
- }
- }
-
- # filter out files Handle_*.hxx and *.lxx
- set hdrlist {}
- foreach fileset $filelist {
- set hdrset {}
- foreach hdr $fileset {
- if { ! [regexp {Handle_.*[.]hxx} $hdr] && ! [regexp {.*[.]lxx} $hdr] } {
- lappend hdrset $hdr
- }
- }
- lappend hdrlist $hdrset
- }
- set filelist $hdrlist
+# puts "modules=$modules"
+# puts "outDir=$outDir"
+# puts "createChmHelp=$createChmHelp"
+# puts "createQhpHelp=$createQhpHelp"
+# puts "hhcPath=$hhcPath"
+# puts "gthelpPath=$gthelpPath"
+# puts "doxygenPath=$doxygenPath"
+# puts "graphvizPath=$graphvizPath"
+# puts "useSearch=$useSearch"
+# return
- # get OCCT version number
- set occt_version [OCCTGetVersion]
-
- set filename "$outDir/$name.Doxyfile"
- msgprint -i -c "WOKStep_DocGenerate:Execute" "Generating Doxygen file for $title in $filename"
- set fileid [open $filename "w"]
-
- set path_prefix "$outDir/"
+ OS -box
+ OCCDoc_GenerateDoc $outDir $modules $createChmHelp $createQhpHelp $hhcPath $gthelpPath $doxygenPath $graphvizPath $useSearch {}
+}
- puts $fileid "PROJECT_NAME = \"$title\""
- puts $fileid "PROJECT_NUMBER = $occt_version "
- puts $fileid "OUTPUT_DIRECTORY = ${path_prefix}."
- puts $fileid "CREATE_SUBDIRS = NO"
- puts $fileid "OUTPUT_LANGUAGE = English"
- puts $fileid "MULTILINE_CPP_IS_BRIEF = YES"
- puts $fileid "INHERIT_DOCS = YES"
- puts $fileid "REPEAT_BRIEF = NO"
- puts $fileid "ALWAYS_DETAILED_SEC = NO"
- puts $fileid "INLINE_INHERITED_MEMB = NO"
- puts $fileid "FULL_PATH_NAMES = NO"
- puts $fileid "OPTIMIZE_OUTPUT_FOR_C = YES"
- puts $fileid "SUBGROUPING = YES"
- puts $fileid "DISTRIBUTE_GROUP_DOC = YES"
- puts $fileid "EXTRACT_ALL = YES"
- puts $fileid "EXTRACT_PRIVATE = NO"
- puts $fileid "EXTRACT_LOCAL_CLASSES = NO"
- puts $fileid "EXTRACT_LOCAL_METHODS = NO"
- puts $fileid "HIDE_FRIEND_COMPOUNDS = YES"
- puts $fileid "HIDE_UNDOC_MEMBERS = NO"
- puts $fileid "INLINE_INFO = YES"
- puts $fileid "VERBATIM_HEADERS = NO"
- puts $fileid "QUIET = YES"
- puts $fileid "WARNINGS = NO"
- puts $fileid "ENABLE_PREPROCESSING = YES"
- puts $fileid "MACRO_EXPANSION = YES"
- puts $fileid "EXPAND_ONLY_PREDEF = YES"
- puts $fileid "PREDEFINED = Standard_EXPORT __Standard_API __Draw_API Handle(a):=Handle<a>"
- puts $fileid "GENERATE_HTML = YES"
- puts $fileid "GENERATE_LATEX = NO"
- puts $fileid "SEARCH_INCLUDES = YES"
- puts $fileid "GENERATE_TAGFILE = ${path_prefix}${name}.tag"
- puts $fileid "ALLEXTERNALS = NO"
- puts $fileid "EXTERNAL_GROUPS = NO"
-
- #chm help file
- if { $createChmHelp } {
- append hhcLocation "/hhc.exe"
- if { [file exists $hhcLocation] } {
- puts $fileid "GENERATE_HTMLHELP = YES"
- puts $fileid "CHM_FILE = ../${name}HTMLHelp.CHM"
- puts $fileid "HHC_LOCATION = \"$hhcLocation\""
- } else {
- puts "Can't find $hhcLocation/hhc.exe"
- }
- }
+# general procedure for generation Doxygen documentation
+# it launches both generation process and post process
+proc OCCDoc_GenerateDoc {outDir {modules} {createChmHelp} {createQhpHelp} {hhcLocation} {gthelpPath} {doxygenPath} {graphvizPath} {useSearch} {tagFiles {}}} {
+ set doxygen_project_filename [OCCDoc_MakeDoxyfile $outDir $modules $createChmHelp $createQhpHelp $hhcLocation $gthelpPath $graphvizPath]
+
+ puts "[clock format [clock seconds] -format {%Y.%m.%d %H:%M}] Running Doxygen ..."
+ set dox_return [catch {exec $doxygenPath $doxygen_project_filename > $outDir/doxygen_out.log} dox_err]
+
+ if {$dox_return != 0} {
+ if {[llength [split $dox_err "\n"]] > 1} {
+ puts "See Doxygen messages in $outDir/doxygen_warnings_and_errors.log"
+ set dox_err_file [open "$outDir/doxygen_warnings_and_errors.log" "w"]
+ puts $dox_err_file $dox_err
+ close $dox_err_file
+ } else {
+ puts $dox_err
+ }
+ }
- # add tag files for OCCT modules (except current one and depending);
- # this is based on file Modules.tcl in unit "OS" which defines list of modules
- # in the order of their dependency
- if { [llength $tagFiles] > 0 } {
- set tagdef {}
- foreach tagfile $tagFiles {
- if [file exists ${path_prefix}$tagname.tag] {
- set tagdef "$tagdef \\\n ${path_prefix}${tagname}.tag=../../${tagname}/html"
- }
- }
- puts $fileid "TAGFILES = $tagdef"
+ if {[OCCDoc_PostProcessor $outDir] == 0} {
+ puts "[clock format [clock seconds] -format {%Y.%m.%d %H:%M}] Done"
+ puts "Doxygen log file: $outDir/doxygen_out.log"
+ puts "Start $outDir/html/Index.html to open generated HTML documentation"
+ if {$createChmHelp == YES} {
+ puts "Find generated CHM file in $outDir"
}
-
- if { $useSearch } {
- puts $fileid "SEARCHENGINE = $useSearch"
-# puts $fileid "SERVER_BASED_SEARCH = NO"
+ if {$createQhpHelp == YES} {
+ puts "Find generated QCH file in $outDir"
}
- if { "$graphvizPath" == "" && [info exists env(GRAPHVIZ_HOME)] } {
- set graphvizPath $env(GRAPHVIZ_HOME)
+ }
+}
+
+# generate Doxygen configuration file for specified OCCT module of toolkit
+proc OCCDoc_MakeDoxyfile {outDir {modules {}} {createChmHelp NO} {createQhpHelp NO} {hhcLocation {}} {gthelpPath {}} {graphvizPath {}} {useSearch YES} {tagFiles {}}} {
+
+ puts "[clock format [clock seconds] -format {%Y.%m.%d %H:%M}] Creating Doxygen Project File ..."
+
+
+ # by default take all modules
+ if { [llength $modules] <= 0 } {
+ set modules [OS -lm]
+ }
+
+ # create target directory
+ file mkdir $outDir
+ file mkdir $outDir/html
+
+ # set context
+ set one_module [expr [llength $modules] == 1]
+ if { $one_module } {
+ set title "OCCT [$modules:name]"
+ set name $modules
+ } else {
+ set title "Open CASCADE Technology"
+ set name OCCT
+ }
+
+ # get list of header files in the specified modules
+ set filelist {}
+ foreach module $modules {
+ if {[lsearch [OS -lm] $module] == -1 } {
+ puts "Error: no module $module is known in current workbench"
+ continue
}
- if { "$graphvizPath" != "" } {
- puts $fileid "HAVE_DOT = YES"
- puts $fileid "DOT_PATH = $graphvizPath"
- #puts $fileid "CLASS_DIAGRAMS = YES"
- #puts $fileid "HIDE_UNDOC_RELATIONS = YES"
- #puts $fileid "TEMPLATE_RELATIONS = NO"
- #puts $fileid "GRAPHICAL_HIERARCHY = YES"
- #puts $fileid "DIRECTORY_GRAPH = YES"
- puts $fileid "DOT_GRAPH_MAX_NODES = 100"
- puts $fileid "INCLUDE_GRAPH = NO"
- puts $fileid "INCLUDED_BY_GRAPH = NO"
- puts $fileid "DOT_MULTI_TARGETS = YES"
- puts $fileid "DOT_IMAGE_FORMAT = png"
- puts $fileid "GENERATE_LEGEND = YES"
- puts $fileid "DOTFILE_DIRS = $outDir/html"
- puts $fileid "DOT_CLEANUP = YES"
- } else {
- puts "Warning: DOT is not found; use environment variable GRAPHVIZ_HOME or command argument to specify its location"
- puts $fileid "HAVE_DOT = NO"
- puts $fileid "DOT_PATH = "
+ foreach tk [$module:toolkits] {
+ foreach pk [osutils:tk:units [woklocate -u $tk]] {
+ lappend filelist [uinfo -p -T pubinclude $pk]
+ }
}
-
- puts $fileid "COLLABORATION_GRAPH = NO"
- puts $fileid "ENABLE_PREPROCESSING = YES"
- puts $fileid "INCLUDE_FILE_PATTERNS = *.hxx *.pxx"
- puts $fileid "EXCLUDE_PATTERNS = */Handle_*.hxx"
- puts $fileid "SKIP_FUNCTION_MACROS = YES"
- puts $fileid "INLINE_SOURCES = NO"
-
- # include dirs
- set incdirs ""
- foreach wb [w_info -A] {
- set incdirs "$incdirs [wokparam -v %${wb}_Home]/inc"
+ }
+
+ # filter out files Handle_*.hxx and *.lxx
+ set hdrlist {}
+ foreach fileset $filelist {
+ set hdrset {}
+ foreach hdr $fileset {
+ if { ! [regexp {Handle_.*[.]hxx} $hdr] && ! [regexp {.*[.]lxx} $hdr] } {
+ lappend hdrset $hdr
+ }
}
- puts $fileid "INCLUDE_PATH = $incdirs"
-
- # list of files to generate
- set mainpage [OCCDoc_MakeMainPage $outDir $outDir/$name.dox $modules]
- puts $fileid "INPUT = $mainpage \\"
- foreach header $filelist {
- puts $fileid " $header \\"
+ lappend hdrlist $hdrset
+ }
+ set filelist $hdrlist
+
+ # get OCCT version number
+ set occt_version [OCCTGetVersion]
+
+ set filename "$outDir/$name.Doxyfile"
+ #msgprint -i -c "WOKStep_DocGenerate:Execute" "Generating Doxygen file for $title in $filename"
+ set fileid [open $filename "w"]
+
+ set path_prefix "$outDir/"
+
+ puts $fileid "PROJECT_NAME = \"$title\""
+ puts $fileid "PROJECT_NUMBER = $occt_version "
+ puts $fileid "OUTPUT_DIRECTORY = ${path_prefix}."
+ puts $fileid "CREATE_SUBDIRS = NO"
+ puts $fileid "OUTPUT_LANGUAGE = English"
+ puts $fileid "MULTILINE_CPP_IS_BRIEF = YES"
+ puts $fileid "INHERIT_DOCS = YES"
+ puts $fileid "REPEAT_BRIEF = NO"
+ puts $fileid "ALWAYS_DETAILED_SEC = NO"
+ puts $fileid "INLINE_INHERITED_MEMB = NO"
+ puts $fileid "FULL_PATH_NAMES = NO"
+ puts $fileid "OPTIMIZE_OUTPUT_FOR_C = YES"
+ puts $fileid "SUBGROUPING = YES"
+ puts $fileid "DISTRIBUTE_GROUP_DOC = YES"
+ puts $fileid "EXTRACT_ALL = YES"
+ puts $fileid "EXTRACT_PRIVATE = NO"
+ puts $fileid "EXTRACT_LOCAL_CLASSES = NO"
+ puts $fileid "EXTRACT_LOCAL_METHODS = NO"
+ puts $fileid "HIDE_FRIEND_COMPOUNDS = YES"
+ puts $fileid "HIDE_UNDOC_MEMBERS = NO"
+ puts $fileid "INLINE_INFO = YES"
+ puts $fileid "VERBATIM_HEADERS = NO"
+ puts $fileid "QUIET = YES"
+ puts $fileid "WARNINGS = NO"
+ puts $fileid "ENABLE_PREPROCESSING = YES"
+ puts $fileid "MACRO_EXPANSION = YES"
+ puts $fileid "EXPAND_ONLY_PREDEF = YES"
+ puts $fileid "PREDEFINED = Standard_EXPORT __Standard_API __Draw_API Handle(a):=Handle<a> DEFINE_STANDARD_ALLOC DEFINE_NCOLLECTION_ALLOC"
+ puts $fileid "GENERATE_HTML = YES"
+ puts $fileid "GENERATE_LATEX = NO"
+ puts $fileid "SEARCH_INCLUDES = YES"
+ puts $fileid "GENERATE_TAGFILE = ${path_prefix}${name}.tag"
+ puts $fileid "ALLEXTERNALS = NO"
+ puts $fileid "EXTERNAL_GROUPS = NO"
+
+ #chm help file
+ if { $createChmHelp == YES} {
+ puts $fileid "GENERATE_HTMLHELP = YES"
+ puts $fileid "CHM_FILE = ../${name}HTMLHelp.CHM"
+ puts $fileid "HHC_LOCATION = \"$hhcLocation\""
+ }
+
+ #qhp help file
+ if { $createQhpHelp == YES} {
+ puts $fileid "GENERATE_QHP = YES"
+ puts $fileid "QHP_NAMESPACE = \"occt.doxygen.documentation\""
+ #puts $fileid "QHP_VIRTUAL_FOLDER = \"${name}_QHP_VF\""
+ puts $fileid "QCH_FILE = ../${name}QHPHelp.QCH"
+ puts $fileid "QHG_LOCATION = \"$gthelpPath\""
+ }
+
+ # add tag files for OCCT modules (except current one and depending);
+ # this is based on file Modules.tcl in unit "OS" which defines list of modules
+ # in the order of their dependency
+ if { [llength $tagFiles] > 0 } {
+ set tagdef {}
+ foreach tagfile $tagFiles {
+ if [file exists ${path_prefix}$tagname.tag] {
+ set tagdef "$tagdef \\\n ${path_prefix}${tagname}.tag=../../${tagname}/html"
+ }
}
- puts $fileid ""
-
- close $fileid
+ puts $fileid "TAGFILES = $tagdef"
+ }
- return $filename
+ if { $useSearch } {
+ puts $fileid "SEARCHENGINE = $useSearch"
+ }
+
+ if { "$graphvizPath" == "" && [info exists env(GRAPHVIZ_HOME)] } {
+ set graphvizPath $env(GRAPHVIZ_HOME)
+ }
+
+ if { "$graphvizPath" != "" } {
+ puts $fileid "HAVE_DOT = YES"
+ puts $fileid "DOT_PATH = $graphvizPath"
+ puts $fileid "DOT_GRAPH_MAX_NODES = 100"
+ puts $fileid "INCLUDE_GRAPH = NO"
+ puts $fileid "INCLUDED_BY_GRAPH = NO"
+ puts $fileid "DOT_MULTI_TARGETS = YES"
+ puts $fileid "DOT_IMAGE_FORMAT = png"
+ puts $fileid "GENERATE_LEGEND = YES"
+ puts $fileid "DOTFILE_DIRS = $outDir/html"
+ puts $fileid "DOT_CLEANUP = YES"
+ # avoid generation of huge (and unusable) graphical hierarchy of all classes
+ puts $fileid "GRAPHICAL_HIERARCHY = NO"
+ }
+
+ puts $fileid "COLLABORATION_GRAPH = NO"
+ puts $fileid "ENABLE_PREPROCESSING = YES"
+ puts $fileid "INCLUDE_FILE_PATTERNS = *.hxx *.pxx"
+ puts $fileid "EXCLUDE_PATTERNS = */Handle_*.hxx"
+ puts $fileid "SKIP_FUNCTION_MACROS = YES"
+ puts $fileid "INLINE_SOURCES = NO"
+
+ # include dirs
+ set incdirs ""
+ foreach wb [w_info -A] {
+ set incdirs "$incdirs [wokparam -v %${wb}_Home]/inc"
+ }
+ puts $fileid "INCLUDE_PATH = $incdirs"
+
+ # list of files to generate
+ set mainpage [OCCDoc_MakeMainPage $outDir $outDir/$name.dox $modules]
+ puts $fileid "INPUT = $mainpage \\"
+ foreach header $filelist {
+ puts $fileid " $header \\"
+ }
+ puts $fileid ""
+
+ close $fileid
+
+ return $filename
}
# generate main page file describing module structure
proc OCCDoc_MakeMainPage {outDir outFile modules} {
-
- global env
- source $env(WOKHOME)/lib/OCCTDocumentationProcedures.tcl
-
- set one_module [expr [llength $modules] == 1]
- set fd [open $outFile "w"]
+ global env
- set module_prefix "module_"
- set toolkit_prefix "toolkit_"
- set package_prefix "package_"
-
- OCCDoc_LoadData
-
- # main page: list of modules
- if { ! $one_module } {
- puts $fd "/**"
- puts $fd "\\mainpage Open CASCADE Technology"
- foreach mod $modules {
- puts $fd "\\li \\subpage [string tolower $module_prefix$mod]"
- }
- # insert modules relationship diagramm
- puts $fd "\\dotfile [OCCDoc_CreateModulesDependencyGraph $outDir/html schema_all_modules $modules $module_prefix]"
- puts $fd "**/\n"
+ set one_module [expr [llength $modules] == 1]
+ set fd [open $outFile "w"]
+
+ set module_prefix "module_"
+ set toolkit_prefix "toolkit_"
+ set package_prefix "package_"
+
+ OCCDoc_LoadData
+
+ # main page: list of modules
+ if { ! $one_module } {
+ puts $fd "/**"
+ puts $fd "\\mainpage Open CASCADE Technology"
+ foreach mod $modules {
+ puts $fd "\\li \\subpage [string tolower $module_prefix$mod]"
}
+ # insert modules relationship diagramm
+ puts $fd "\\dotfile [OCCDoc_CreateModulesDependencyGraph $outDir/html schema_all_modules $modules $module_prefix]"
+ puts $fd "**/\n"
+ }
# one page per module: list of toolkits
- set toolkits {}
- foreach mod $modules {
- puts $fd "/**"
- if { $one_module } {
- puts $fd "\\mainpage OCCT Module [$mod:name]"
- } else {
- puts $fd "\\page [string tolower module_$mod] Module [$mod:name]"
- }
- foreach tk [lsort [$mod:toolkits]] {
- lappend toolkits $tk
- puts $fd "\\li \\subpage [string tolower toolkit_$tk]"
- }
- puts $fd "\\dotfile [OCCDoc_CreateModuleToolkitsDependencyGraph $outDir/html schema_$mod $mod $toolkit_prefix]"
- puts $fd "**/\n"
+ set toolkits {}
+ foreach mod $modules {
+ puts $fd "/**"
+ if { $one_module } {
+ puts $fd "\\mainpage OCCT Module [$mod:name]"
+ } else {
+ puts $fd "\\page [string tolower module_$mod] Module [$mod:name]"
+ }
+ foreach tk [lsort [$mod:toolkits]] {
+ lappend toolkits $tk
+ puts $fd "\\li \\subpage [string tolower toolkit_$tk]"
}
-
+ puts $fd "\\dotfile [OCCDoc_CreateModuleToolkitsDependencyGraph $outDir/html schema_$mod $mod $toolkit_prefix]"
+ puts $fd "**/\n"
+ }
+
# one page per toolkit: list of packages
- set packages {}
- foreach tk $toolkits {
- puts $fd "/**"
- puts $fd "\\dotfile [OCCDoc_CreateToolkitDependencyGraph $outDir/html schema_$tk $tk $toolkit_prefix]"
- puts $fd "\\page [string tolower toolkit_$tk] Toolkit $tk"
- foreach pk [lsort [osutils:tk:units [woklocate -u $tk]]] {
- lappend packages $pk
- set u [wokinfo -n $pk]
- puts $fd "\\li \\subpage [string tolower package_$u]"
- }
- puts $fd "**/\n"
+ set packages {}
+ foreach tk $toolkits {
+ puts $fd "/**"
+ puts $fd "\\page [string tolower toolkit_$tk] Toolkit $tk"
+ foreach pk [lsort [osutils:tk:units [woklocate -u $tk]]] {
+ lappend packages $pk
+ set u [wokinfo -n $pk]
+ puts $fd "\\li \\subpage [string tolower package_$u]"
}
+ puts $fd "\\dotfile [OCCDoc_CreateToolkitDependencyGraph $outDir/html schema_$tk $tk $toolkit_prefix]"
+ puts $fd "**/\n"
+ }
- # one page per package: list of classes
- foreach pk $packages {
- set u [wokinfo -n $pk]
- puts $fd "/**"
- puts $fd "\\page [string tolower package_$u] Package $u"
- foreach hdr [lsort [uinfo -f -T pubinclude $pk]] {
- if { ! [regexp {^Handle_} $hdr] && [regexp {(.*)[.]hxx} $hdr str obj] } {
- puts $fd "\\li \\subpage $obj"
- }
- }
- puts $fd "**/\n"
+ # one page per package: list of classes
+ foreach pk $packages {
+ set u [wokinfo -n $pk]
+ puts $fd "/**"
+ puts $fd "\\page [string tolower package_$u] Package $u"
+ foreach hdr [lsort [uinfo -f -T pubinclude $pk]] {
+ if { ! [regexp {^Handle_} $hdr] && [regexp {(.*)[.]hxx} $hdr str obj] } {
+ puts $fd "\\li \\subpage $obj"
+ }
}
+ puts $fd "**/\n"
+ }
- # one page per class: set reference to package
-# foreach pk $packages {
-# set u [wokinfo -n $pk]
-# foreach hdr [uinfo -f -T pubinclude $pk] {
-# if { ! [regexp {^Handle_} $hdr] && [regexp {(.*)[.]hxx} $hdr str obj] } {
-# puts $fd "/**"
-# puts $fd "\\class $obj"
-# puts $fd "Contained in \\ref [string tolower package_$u]"
-# puts $fd "\\addtogroup package_$u"
-# puts $fd "**/\n"
-# }
-# }
+# one page per class: set reference to package
+# foreach pk $packages {
+# set u [wokinfo -n $pk]
+# foreach hdr [uinfo -f -T pubinclude $pk] {
+# if { ! [regexp {^Handle_} $hdr] && [regexp {(.*)[.]hxx} $hdr str obj] } {
+# puts $fd "/**"
+# puts $fd "\\class $obj"
+# puts $fd "Contained in \\ref [string tolower package_$u]"
+# puts $fd "\\addtogroup package_$u"
+# puts $fd "**/\n"
+# }
# }
+# }
- close $fd
+ close $fd
- return $outFile
+ return $outFile
}
# parse generated files to add a navigation path
proc OCCDoc_PostProcessor {outDir} {
- puts "Post-process is started..."
- append outDir "/html"
- set files [glob -nocomplain -type f $outDir/package_*]
- if { $files != {} } {
- foreach f [lsort $files] {
- set packageFilePnt [open $f r]
- set packageFile [read $packageFilePnt]
- set navPath [OCCDoc_GetNodeContents "div" " id=\"nav-path\" class=\"navpath\"" $packageFile]
- set packageName [OCCDoc_GetNodeContents "div" " class=\"title\"" $packageFile]
- regsub -all {<[^<>]*>} $packageName "" packageName
-
- # add package link to nav path
- set first [expr 1 + [string last "/" $f]]
- set last [expr [string length $f] - 1]
- set packageFileName [string range $f $first $last]
- set end [string first "</ul>" $navPath]
- set end [expr $end - 1]
- set navPath [string range $navPath 0 $end]
- append navPath " <li class=\"navelem\"><a class=\"el\" href=\"$packageFileName\">$packageName</a> </li>\n </ul>"
-
- # get list of files to update
- set listContents [OCCDoc_GetNodeContents "div" " class=\"textblock\"" $packageFile]
- set listContents [OCCDoc_GetNodeContents "ul" "" $listContents]
- set lines [split $listContents "\n"]
- foreach line $lines {
- #puts "mLine: $line"
- if {[regexp {href=\"([^\"]*)\"} $line tmpLine classFileName]} {
- # check if anchor is there
- set anchorPos [string first "#" $classFileName]
- if {$anchorPos != -1} {
- set classFileName [string range $classFileName 0 [expr $anchorPos - 1]]
- }
- # read class file
- set classFilePnt [open $outDir/$classFileName r+]
- set classFile [read $classFilePnt]
- # find position of content block
- set contentPos [string first "<div class=\"header\">" $classFile]
- set navPart [string range $classFile 0 [expr $contentPos - 1]]
- # position where to insert nav path
- set posToInsert [string last "</div>" $navPart]
- set prePart [string range $classFile 0 [expr $posToInsert - 1]]
- set postPart [string range $classFile $posToInsert [string length $classFile]]
- set newClassFile ""
- append newClassFile $prePart " <div id=\"nav-path\" class=\"navpath\">" $navPath \n " </div>" \n $postPart
- # write updated content
- seek $classFilePnt 0
- puts $classFilePnt $newClassFile
- close $classFilePnt
- }
-
- }
-
-
- close $packageFilePnt
- }
- puts "Done"
- } else {
- puts "no files found"
+ puts "[clock format [clock seconds] -format {%Y.%m.%d %H:%M}] Post-process is started ..."
+ append outDir "/html"
+ set files [glob -nocomplain -type f $outDir/package_*]
+ if { $files != {} } {
+ foreach f [lsort $files] {
+ set packageFilePnt [open $f r]
+ set packageFile [read $packageFilePnt]
+ set navPath [OCCDoc_GetNodeContents "div" " id=\"nav-path\" class=\"navpath\"" $packageFile]
+ set packageName [OCCDoc_GetNodeContents "div" " class=\"title\"" $packageFile]
+ regsub -all {<[^<>]*>} $packageName "" packageName
+
+ # add package link to nav path
+ set first [expr 1 + [string last "/" $f]]
+ set last [expr [string length $f] - 1]
+ set packageFileName [string range $f $first $last]
+ set end [string first "</ul>" $navPath]
+ set end [expr $end - 1]
+ set navPath [string range $navPath 0 $end]
+ append navPath " <li class=\"navelem\"><a class=\"el\" href=\"$packageFileName\">$packageName</a> </li>\n </ul>"
+
+ # get list of files to update
+ set listContents [OCCDoc_GetNodeContents "div" " class=\"textblock\"" $packageFile]
+ set listContents [OCCDoc_GetNodeContents "ul" "" $listContents]
+ set lines [split $listContents "\n"]
+ foreach line $lines {
+ #puts "mLine: $line"
+ if {[regexp {href=\"([^\"]*)\"} $line tmpLine classFileName]} {
+ # check if anchor is there
+ set anchorPos [string first "#" $classFileName]
+ if {$anchorPos != -1} {
+ set classFileName [string range $classFileName 0 [expr $anchorPos - 1]]
+ }
+ # read class file
+ set classFilePnt [open $outDir/$classFileName r+]
+ set classFile [read $classFilePnt]
+ # find position of content block
+ set contentPos [string first "<div class=\"header\">" $classFile]
+ set navPart [string range $classFile 0 [expr $contentPos - 1]]
+ # position where to insert nav path
+ set posToInsert [string last "</div>" $navPart]
+ set prePart [string range $classFile 0 [expr $posToInsert - 1]]
+ set postPart [string range $classFile $posToInsert [string length $classFile]]
+ set newClassFile ""
+ append newClassFile $prePart " <div id=\"nav-path\" class=\"navpath\">" $navPath \n " </div>" \n $postPart
+ # write updated content
+ seek $classFilePnt 0
+ puts $classFilePnt $newClassFile
+ close $classFilePnt
+ }
+ }
+ close $packageFilePnt
}
+ return 0
+ } else {
+ puts "no files found"
+ return 1
+ }
}
# get contents of the given html node
proc OCCDoc_GetNodeContents {node props html} {
- set openTag "<$node$props>"
- set closingTag "</$node>"
- set start [string first $openTag $html]
-
- if {$start == -1} {
- return ""
- }
- set start [expr $start + [string length $openTag]]
- set end [string length $html]
- set html [string range $html $start $end]
-
- set start [string first $closingTag $html]
- set end [string length $html]
- if {$start == -1} {
- return ""
- }
- set start [expr $start - 1]
- return [string range $html 0 $start]
+ set openTag "<$node$props>"
+ set closingTag "</$node>"
+ set start [string first $openTag $html]
+ if {$start == -1} {
+ return ""
+ }
+ set start [expr $start + [string length $openTag]]
+ set end [string length $html]
+ set html [string range $html $start $end]
+ set start [string first $closingTag $html]
+ set end [string length $html]
+ if {$start == -1} {
+ return ""
+ }
+ set start [expr $start - 1]
+ return [string range $html 0 $start]
}
projects / occt-wok.git / commitdiff