docs/doxygen/regen.sh

   1 #!/bin/bash
   2 #
   3 # $Id$
   4 #
   5 # This bash script regenerates the HTML doxygen version of the
   6 # wxWidgets manual and adjusts the doxygen log to make it more
   7 # readable.
   8 #
   9 # Usage:
  10 #    ./regen.sh [html|chm|xml|latex|all]
  11 #
  12 # Pass "x" to regen only the X output format and "all" to regen them all.
  13 # If no arguments are passed all formats are regenerated
  14 # (just like passing "all").
  15 #
  16
  17
  18 # remember current folder and then cd to the docs/doxygen one
  19 me=$(basename $0)
  20 path=${0%%/$me}        # path from which the script has been launched
  21 current=$(pwd)
  22 cd $path
  23 export WXWIDGETS=`cd ../.. && pwd`
  24
  25 # prepare folders for the cp commands below
  26 mkdir -p out/html       # we need to copy files in this folder below
  27 mkdir -p out/html/wxmsw out/html/wxgtk out/html/wxmac
  28
  29 # These are not automatically copied by Doxygen because they're not
  30 # used in doxygen documentation, only in our html footer and by our
  31 # custom aliases
  32 cp images/powered-by-wxwidgets.png out/html
  33 cp images/logo_*.png out/html
  34 cp images/tab_*.gif out/html
  35 cp images/wxmsw/*png out/html/wxmsw
  36 cp images/wxmac/*png out/html/wxmac
  37 cp images/wxgtk/*png out/html/wxgtk
  38 cp wxwidgets.js out/html
  39
  40 # these CSS are not automatically copied by Doxygen because they're
  41 # included by our custom html header...
  42 cp wxwidgets.css out/html
  43 cp wxtabs.css out/html
  44
  45 # which configuration should we use?
  46 if [[ -z "$1" ]]; then
  47     cfgfile="Doxyfile_all"
  48 else
  49     cfgfile="Doxyfile_$1"
  50 fi
  51
  52 #
  53 # NOW RUN DOXYGEN
  54 #
  55 # NB: we do this _after_ copying the required files to the output folders
  56 #     otherwise when generating the CHM file with Doxygen, those files are
  57 #     not included!
  58 #
  59 doxygen $cfgfile
  60
  61 if [[ "$1" = "qch" ]]; then
  62     # we need to add missing files to the .qhp
  63     cd out/html
  64     qhelpfile="index.qhp"
  65
  66     # remove all <file> and <files> tags
  67     cat $qhelpfile | grep -v "<file" >temp
  68
  69     # remove last 4 lines (so we have nothing after the last <keyword> tag)
  70     lines=$(wc -l < temp)
  71     wanted=`expr $lines - 4`
  72     head -n $wanted temp >$qhelpfile
  73
  74     # generate a list of new <keyword> tags to add to the index file; without
  75     # this step in the 'index' tab of Qt assistant the "wxWindow" class is not
  76     # present; just "wxWindow::wxWindow" ctor is listed.
  77     # NOTE: this operation is not indispensable but produces a QCH easier to use IMO.
  78     sed -e 's/<keyword name="wx[a-zA-Z~]*" id="wx\([a-zA-Z]*\)::[a-zA-Z~]*" ref="\([a-z_]*.html\)#.*"/<keyword name="wx\1" id="wx\1" ref="\2"/g' < $qhelpfile | grep "<keyword name=\"wx" | uniq >temp
  79     cat temp >>$qhelpfile
  80     echo "    </keywords>" >>$qhelpfile
  81     echo "    <files>" >>$qhelpfile
  82
  83     # remove useless files to make the qch slim
  84     rm temp *map *md5
  85
  86     # add a <file> tag for _any_ file in out/html folder except the .qhp itself
  87     for f in * */*png; do
  88         if [[ $f != $qhelpfile ]]; then
  89             echo "      <file>$f</file>" >>$qhelpfile
  90         fi
  91     done
  92
  93     # add ending tags to the qhp file
  94     echo "    </files>
  95   </filterSection>
  96 </QtHelpProject>" >>$qhelpfile
  97
  98     # replace keyword names so that they appear fully-qualified in the
  99     # "index" tab of the Qt Assistant; e.g. Fit => wxWindow::Fit
 100     # NOTE: this operation is not indispendable but produces a QCH easier to use IMO.
 101     sed -e 's/<keyword name="[a-zA-Z:~]*" id="\([a-zA-Z]*::[a-zA-Z~]*\)"/<keyword name="\1" id="\1"/g' <$qhelpfile >temp
 102     mv temp $qhelpfile
 103
 104     # last, run qhelpgenerator:
 105     cd ../..
 106     qhelpgenerator out/html/index.qhp -o out/wx.qch
 107 fi
 108
 109 # Doxygen has the annoying habit to put the full path of the
 110 # affected files in the log file; remove it to make the log
 111 # more readable
 112 currpath=`pwd`/
 113 interfacepath=`cd ../../interface && pwd`/
 114 cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" >temp
 115
 116 # Doxygen warnings are not completely sorted for filename; enforce correct sorting:
 117 cat temp | sort >doxygen.log
 118 rm temp
 119
 120 # return to the original folder from which this script was launched
 121 cd $current