2008-02-28 16:50:05 -05:00
|
|
|
#!/bin/bash
|
2008-03-08 10:30:12 -05:00
|
|
|
#
|
2008-02-24 09:33:49 -05:00
|
|
|
# $Id$
|
2008-03-08 10:30:12 -05:00
|
|
|
#
|
2008-02-24 09:33:49 -05:00
|
|
|
# This bash script regenerates the HTML doxygen version of the
|
|
|
|
# wxWidgets manual and adjusts the doxygen log to make it more
|
|
|
|
# readable.
|
2008-03-08 10:30:12 -05:00
|
|
|
#
|
|
|
|
# Usage:
|
2008-03-09 07:08:33 -04:00
|
|
|
# ./regen.sh [html|chm|xml|latex|all]
|
2008-03-08 10:30:12 -05:00
|
|
|
#
|
2008-03-09 07:08:33 -04:00
|
|
|
# Pass "x" to regen only the X output format and "all" to regen them all.
|
2008-03-08 10:30:12 -05:00
|
|
|
# If no arguments are passed all formats are regenerated
|
|
|
|
# (just like passing "all").
|
|
|
|
#
|
|
|
|
|
2008-02-24 09:33:49 -05:00
|
|
|
|
2008-03-09 07:08:33 -04:00
|
|
|
# remember current folder and then cd to the docs/doxygen one
|
2008-03-08 09:39:02 -05:00
|
|
|
me=$(basename $0)
|
|
|
|
path=${0%%/$me} # path from which the script has been launched
|
|
|
|
current=$(pwd)
|
|
|
|
cd $path
|
2012-02-21 00:38:53 -05:00
|
|
|
if [ "$WXWIDGETS" = "" ]; then
|
|
|
|
export WXWIDGETS=`cd ../.. && pwd`
|
|
|
|
if [ "$OSTYPE" = "cygwin" ]; then
|
|
|
|
export WXWIDGETS=`cygpath -w $WXWIDGETS`
|
|
|
|
fi
|
|
|
|
fi
|
2008-03-08 09:39:02 -05:00
|
|
|
|
2012-06-13 19:20:08 -04:00
|
|
|
if [ "$DOXYGEN" = "" ]; then
|
|
|
|
DOXYGEN=doxygen
|
|
|
|
fi
|
|
|
|
|
2008-03-08 10:30:12 -05:00
|
|
|
# prepare folders for the cp commands below
|
2008-02-28 16:50:05 -05:00
|
|
|
mkdir -p out/html # we need to copy files in this folder below
|
2011-08-27 10:56:33 -04:00
|
|
|
mkdir -p out/html/generic out/html/wxmsw out/html/wxgtk out/html/wxmac
|
2008-02-19 08:18:53 -05:00
|
|
|
|
2008-04-16 16:11:08 -04:00
|
|
|
# These are not automatically copied by Doxygen because they're not
|
|
|
|
# used in doxygen documentation, only in our html footer and by our
|
2008-03-08 10:30:12 -05:00
|
|
|
# custom aliases
|
2008-02-19 08:18:53 -05:00
|
|
|
cp images/powered-by-wxwidgets.png out/html
|
2009-02-17 17:06:45 -05:00
|
|
|
cp images/logo_*.png out/html
|
2010-07-25 07:05:43 -04:00
|
|
|
cp images/tab_*.gif out/html
|
2008-03-03 18:27:46 -05:00
|
|
|
cp images/wxmsw/*png out/html/wxmsw
|
|
|
|
cp images/wxmac/*png out/html/wxmac
|
|
|
|
cp images/wxgtk/*png out/html/wxgtk
|
2011-08-27 10:56:33 -04:00
|
|
|
cp images/generic/*png out/html/generic
|
2008-04-16 16:11:08 -04:00
|
|
|
cp wxwidgets.js out/html
|
2008-02-19 11:35:45 -05:00
|
|
|
|
2008-03-08 10:30:12 -05:00
|
|
|
# which configuration should we use?
|
|
|
|
if [[ -z "$1" ]]; then
|
2008-03-14 17:16:33 -04:00
|
|
|
cfgfile="Doxyfile_all"
|
2008-03-08 10:30:12 -05:00
|
|
|
else
|
2008-03-14 17:16:33 -04:00
|
|
|
cfgfile="Doxyfile_$1"
|
2008-03-08 10:30:12 -05:00
|
|
|
fi
|
|
|
|
|
2008-02-28 16:50:05 -05:00
|
|
|
#
|
|
|
|
# NOW RUN DOXYGEN
|
|
|
|
#
|
|
|
|
# NB: we do this _after_ copying the required files to the output folders
|
|
|
|
# otherwise when generating the CHM file with Doxygen, those files are
|
|
|
|
# not included!
|
|
|
|
#
|
2012-06-13 19:20:08 -04:00
|
|
|
$DOXYGEN $cfgfile
|
2008-02-28 16:50:05 -05:00
|
|
|
|
2008-11-28 14:28:15 -05:00
|
|
|
if [[ "$1" = "qch" ]]; then
|
|
|
|
# we need to add missing files to the .qhp
|
|
|
|
cd out/html
|
|
|
|
qhelpfile="index.qhp"
|
|
|
|
|
2008-11-30 20:13:01 -05:00
|
|
|
# remove all <file> and <files> tags
|
|
|
|
cat $qhelpfile | grep -v "<file" >temp
|
2008-11-28 14:28:15 -05:00
|
|
|
|
2008-11-30 20:13:01 -05:00
|
|
|
# remove last 4 lines (so we have nothing after the last <keyword> tag)
|
2008-11-28 14:28:15 -05:00
|
|
|
lines=$(wc -l < temp)
|
2008-11-30 20:13:01 -05:00
|
|
|
wanted=`expr $lines - 4`
|
2008-11-28 14:28:15 -05:00
|
|
|
head -n $wanted temp >$qhelpfile
|
|
|
|
|
2008-11-30 20:13:01 -05:00
|
|
|
# generate a list of new <keyword> tags to add to the index file; without
|
|
|
|
# this step in the 'index' tab of Qt assistant the "wxWindow" class is not
|
|
|
|
# present; just "wxWindow::wxWindow" ctor is listed.
|
|
|
|
# NOTE: this operation is not indispensable but produces a QCH easier to use IMO.
|
|
|
|
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
|
|
|
|
cat temp >>$qhelpfile
|
|
|
|
echo " </keywords>" >>$qhelpfile
|
|
|
|
echo " <files>" >>$qhelpfile
|
|
|
|
|
|
|
|
# remove useless files to make the qch slim
|
|
|
|
rm temp *map *md5
|
2008-11-28 14:28:15 -05:00
|
|
|
|
|
|
|
# add a <file> tag for _any_ file in out/html folder except the .qhp itself
|
2008-11-30 20:13:01 -05:00
|
|
|
for f in * */*png; do
|
2008-11-28 14:28:15 -05:00
|
|
|
if [[ $f != $qhelpfile ]]; then
|
|
|
|
echo " <file>$f</file>" >>$qhelpfile
|
|
|
|
fi
|
|
|
|
done
|
|
|
|
|
|
|
|
# add ending tags to the qhp file
|
|
|
|
echo " </files>
|
|
|
|
</filterSection>
|
|
|
|
</QtHelpProject>" >>$qhelpfile
|
|
|
|
|
2008-11-30 20:13:01 -05:00
|
|
|
# replace keyword names so that they appear fully-qualified in the
|
|
|
|
# "index" tab of the Qt Assistant; e.g. Fit => wxWindow::Fit
|
|
|
|
# NOTE: this operation is not indispendable but produces a QCH easier to use IMO.
|
|
|
|
sed -e 's/<keyword name="[a-zA-Z:~]*" id="\([a-zA-Z]*::[a-zA-Z~]*\)"/<keyword name="\1" id="\1"/g' <$qhelpfile >temp
|
|
|
|
mv temp $qhelpfile
|
|
|
|
|
2008-11-28 14:28:15 -05:00
|
|
|
# last, run qhelpgenerator:
|
|
|
|
cd ../..
|
|
|
|
qhelpgenerator out/html/index.qhp -o out/wx.qch
|
|
|
|
fi
|
|
|
|
|
2011-06-11 23:39:17 -04:00
|
|
|
if [[ "$1" = "docset" ]]; then
|
|
|
|
DOCSETNAME="org.wxwidgets.doxygen.wx29.docset"
|
|
|
|
ATOM="org.wxwidgets.doxygen.docset.wx29.atom"
|
|
|
|
ATOMDIR="http://docs.wxwidgets.org/docsets"
|
|
|
|
XAR="org.wxwidgets.doxygen.docset.wx29.xar"
|
|
|
|
XARDIR="http://docs.wxwidgets.org/docsets"
|
|
|
|
XCODE_INSTALL=`sh xcode-select -print-path`
|
|
|
|
|
|
|
|
cp wxdocsettabs.css out/html/wxtabs.css
|
|
|
|
cp wxdocsetwidgets.css out/html/wxwidgets.css
|
|
|
|
cp img_downArrow.png out/html
|
|
|
|
cp background_navigation.png out/html
|
|
|
|
|
|
|
|
cd out/html
|
|
|
|
DESTINATIONDIR=`pwd`
|
|
|
|
|
|
|
|
rm -rf $DESTINATIONDIR/$DOCSETNAME
|
|
|
|
rm -f $DESTINATIONDIR/$XAR
|
|
|
|
|
|
|
|
make
|
|
|
|
|
|
|
|
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleVersion 1.3
|
|
|
|
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleShortVersionString 1.3
|
|
|
|
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleName "wxWidgets 2.9 Library"
|
|
|
|
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetFeedURL $ATOMDIR/$ATOM
|
|
|
|
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetFallbackURL http://docs.wxwidgets.org
|
|
|
|
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetDescription "API reference and conceptual documentation for wxWidgets 2.9"
|
|
|
|
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info NSHumanReadableCopyright "Copyright 1992-2011 wxWidgets team, Portions 1996 Artificial Intelligence Applications Institute"
|
|
|
|
|
|
|
|
$XCODE_INSTALL/usr/bin/docsetutil package -atom $DESTINATIONDIR/$ATOM -download-url $XARDIR/$XAR -output $DESTINATIONDIR/$XAR $DESTINATIONDIR/$DOCSETNAME
|
|
|
|
|
|
|
|
cd ../..
|
|
|
|
fi
|
|
|
|
|
2008-02-19 11:35:45 -05:00
|
|
|
# Doxygen has the annoying habit to put the full path of the
|
|
|
|
# affected files in the log file; remove it to make the log
|
|
|
|
# more readable
|
|
|
|
currpath=`pwd`/
|
2008-02-19 12:28:40 -05:00
|
|
|
interfacepath=`cd ../../interface && pwd`/
|
2011-12-08 10:45:41 -05:00
|
|
|
cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" > temp
|
|
|
|
cat temp > doxygen.log
|
2008-03-16 13:23:00 -04:00
|
|
|
rm temp
|
2008-02-21 16:11:25 -05:00
|
|
|
|
2008-03-16 13:23:00 -04:00
|
|
|
# return to the original folder from which this script was launched
|
2008-03-08 09:39:02 -05:00
|
|
|
cd $current
|