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 if [[ -z "$WXWIDGETS" ]]; then
  24     # Notice the use of -P to ensure we get the canonical path even if there
  25     # are symlinks in the current path. This is important because Doxygen
  26     # strips this string from the paths in the generated files textually and it
  27     # wouldn't work if it contained symlinks.
  28     WXWIDGETS=`cd ../.. && pwd -P`
  29     if [ "$OSTYPE" = "cygwin" ]; then
  30         WXWIDGETS=`cygpath -w $WXWIDGETS`
  31     fi
  32     export WXWIDGETS
  33 fi
  34
  35 if [ "$DOXYGEN" = "" ]; then
  36     DOXYGEN=doxygen
  37 fi
  38
  39 # Check that doxygen has the correct version as different versions of it are
  40 # unfortunately not always (in fact, practically never) compatible.
  41 #
  42 # Still allow using incompatible version for some quick local testing if really
  43 # needed and 1.8.2 can't be installed for whatever reason.
  44 if [[ -z $WX_SKIP_DOXYGEN_VERSION_CHECK ]]; then
  45     doxygen_version=`$DOXYGEN --version`
  46     doxygen_version_required=1.8.2
  47     if [[ $doxygen_version != $doxygen_version_required ]]; then
  48         echo "Doxygen version $doxygen_version is not supported."
  49         echo "Please use Doxygen $doxygen_version_required or export WX_SKIP_DOXYGEN_VERSION_CHECK."
  50         exit 1
  51     fi
  52 fi
  53
  54 # prepare folders for the cp commands below
  55 mkdir -p out/html       # we need to copy files in this folder below
  56 mkdir -p out/html/generic
  57
  58 # These are not automatically copied by Doxygen because they're not
  59 # used in doxygen documentation, only in our html footer and by our
  60 # custom aliases
  61 cp images/generic/*png out/html/generic
  62
  63 # Defaults for settings controlled by this script
  64 export GENERATE_DOCSET="NO";
  65 export GENERATE_HTML="NO";
  66 export GENERATE_HTMLHELP="NO";
  67 export GENERATE_LATEX="NO";
  68 export GENERATE_QHP="NO";
  69 export GENERATE_XML="NO";
  70 export SEARCHENGINE="NO";
  71 export SERVER_BASED_SEARCH="NO";
  72
  73 # Which format should we generate during this run?
  74 case "$1" in
  75     all) # All *main* formats, not all formats, here for backwards compat.
  76         export GENERATE_HTML="YES";
  77         export GENERATE_HTMLHELP="YES";
  78         export GENERATE_XML="YES";
  79         ;;
  80     chm)
  81         export GENERATE_HTML="YES";
  82         export GENERATE_HTMLHELP="YES";
  83         ;;
  84     docset)
  85         export GENERATE_DOCSET="YES";
  86         export GENERATE_HTML="YES";
  87         ;;
  88     latex)
  89         export GENERATE_LATEX="YES";
  90         ;;
  91     php) # HTML, but with PHP Search Engine
  92         export GENERATE_HTML="YES";
  93         export SEARCHENGINE="YES";
  94         export SERVER_BASED_SEARCH="YES";
  95         ;;
  96     qch)
  97         export GENERATE_HTML="YES";
  98         export GENERATE_QHP="YES";
  99         ;;
 100     xml)
 101         export GENERATE_XML="YES";
 102         ;;
 103     *) # Default to HTML only
 104         export GENERATE_HTML="YES";
 105         export SEARCHENGINE="YES";
 106         ;;
 107 esac
 108
 109 #
 110 # NOW RUN DOXYGEN
 111 #
 112 # NB: we do this _after_ copying the required files to the output folders
 113 #     otherwise when generating the CHM file with Doxygen, those files are
 114 #     not included!
 115 #
 116 $DOXYGEN Doxyfile
 117
 118 if [[ "$1" = "qch" ]]; then
 119     # we need to add missing files to the .qhp
 120     cd out/html
 121     qhelpfile="index.qhp"
 122
 123     # remove all <file> and <files> tags
 124     cat $qhelpfile | grep -v "<file" >temp
 125
 126     # remove last 4 lines (so we have nothing after the last <keyword> tag)
 127     lines=$(wc -l < temp)
 128     wanted=`expr $lines - 4`
 129     head -n $wanted temp >$qhelpfile
 130
 131     # generate a list of new <keyword> tags to add to the index file; without
 132     # this step in the 'index' tab of Qt assistant the "wxWindow" class is not
 133     # present; just "wxWindow::wxWindow" ctor is listed.
 134     # NOTE: this operation is not indispensable but produces a QCH easier to use IMO.
 135     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
 136     cat temp >>$qhelpfile
 137     echo "    </keywords>" >>$qhelpfile
 138     echo "    <files>" >>$qhelpfile
 139
 140     # remove useless files to make the qch slim
 141     rm temp *map *md5
 142
 143     # add a <file> tag for _any_ file in out/html folder except the .qhp itself
 144     for f in * */*png; do
 145         if [[ $f != $qhelpfile ]]; then
 146             echo "      <file>$f</file>" >>$qhelpfile
 147         fi
 148     done
 149
 150     # add ending tags to the qhp file
 151     echo "    </files>
 152   </filterSection>
 153 </QtHelpProject>" >>$qhelpfile
 154
 155     # replace keyword names so that they appear fully-qualified in the
 156     # "index" tab of the Qt Assistant; e.g. Fit => wxWindow::Fit
 157     # NOTE: this operation is not indispendable but produces a QCH easier to use IMO.
 158     sed -e 's/<keyword name="[a-zA-Z:~]*" id="\([a-zA-Z]*::[a-zA-Z~]*\)"/<keyword name="\1" id="\1"/g' <$qhelpfile >temp
 159     mv temp $qhelpfile
 160
 161     # last, run qhelpgenerator:
 162     cd ../..
 163     qhelpgenerator out/html/index.qhp -o out/wx.qch
 164 fi
 165
 166 if [[ "$1" = "docset" ]]; then
 167     DOCSETNAME="org.wxwidgets.doxygen.wx29.docset"
 168     ATOM="org.wxwidgets.doxygen.docset.wx29.atom"
 169     ATOMDIR="http://docs.wxwidgets.org/docsets"
 170     XAR="org.wxwidgets.doxygen.docset.wx29.xar"
 171     XARDIR="http://docs.wxwidgets.org/docsets"
 172     XCODE_INSTALL=`sh xcode-select -print-path`
 173
 174     cd out/html
 175     DESTINATIONDIR=`pwd`
 176
 177     rm -rf $DESTINATIONDIR/$DOCSETNAME
 178     rm -f $DESTINATIONDIR/$XAR
 179
 180     make
 181
 182     defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleVersion 1.3
 183     defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleShortVersionString 1.3
 184     defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleName "wxWidgets 2.9 Library"
 185     defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetFeedURL $ATOMDIR/$ATOM
 186     defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetFallbackURL http://docs.wxwidgets.org
 187     defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetDescription "API reference and conceptual documentation for wxWidgets 2.9"
 188     defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info NSHumanReadableCopyright "Copyright 1992-2012 wxWidgets team, Portions 1996 Artificial Intelligence Applications Institute"
 189
 190     $XCODE_INSTALL/usr/bin/docsetutil package -atom $DESTINATIONDIR/$ATOM -download-url $XARDIR/$XAR -output $DESTINATIONDIR/$XAR $DESTINATIONDIR/$DOCSETNAME
 191
 192     cd ../..
 193 fi
 194
 195 # Doxygen has the annoying habit to put the full path of the
 196 # affected files in the log file; remove it to make the log
 197 # more readable
 198 currpath=`pwd`/
 199 interfacepath=`cd ../../interface && pwd`/
 200 cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" > temp
 201 cat temp > doxygen.log
 202 rm temp
 203
 204 # return to the original folder from which this script was launched
 205 cd $current