1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
#!/bin/bash
#
#
# This bash script regenerates the HTML doxygen version of the
# wxWidgets manual and adjusts the doxygen log to make it more
# readable.
#
# Usage:
# ./regen.sh [html|chm|xml|latex|all]
#
# Pass "x" to regen only the X output format and "all" to regen them all.
# If no arguments are passed all formats are regenerated
# (just like passing "all").
#
# remember current folder and then cd to the docs/doxygen one
me=$(basename $0)
path=${0%%/$me} # path from which the script has been launched
current=$(pwd)
cd $path
if [[ -z "$WXWIDGETS" ]]; then
# Notice the use of -P to ensure we get the canonical path even if there
# are symlinks in the current path. This is important because Doxygen
# strips this string from the paths in the generated files textually and it
# wouldn't work if it contained symlinks.
WXWIDGETS=`cd ../.. && pwd -P`
if [ "$OSTYPE" = "cygwin" ]; then
WXWIDGETS=`cygpath -w $WXWIDGETS`
fi
export WXWIDGETS
fi
if [ "$DOXYGEN" = "" ]; then
DOXYGEN=doxygen
fi
# Check that doxygen has the correct version as different versions of it are
# unfortunately not always (in fact, practically never) compatible.
#
# Still allow using incompatible version if explicitly requested.
if [[ -z $WX_SKIP_DOXYGEN_VERSION_CHECK ]]; then
doxygen_version=`$DOXYGEN --version`
doxygen_version_required=1.8.8
if [[ $doxygen_version != $doxygen_version_required ]]; then
echo "Doxygen version $doxygen_version is not supported."
echo "Please use Doxygen $doxygen_version_required or export WX_SKIP_DOXYGEN_VERSION_CHECK."
exit 1
fi
fi
# prepare folders for the cp commands below
mkdir -p out/html # we need to copy files in this folder below
mkdir -p out/html/generic
# These are not automatically copied by Doxygen because they're not
# used in doxygen documentation, only in our html footer and by our
# custom aliases
cp images/generic/*png out/html/generic
# Defaults for settings controlled by this script
export GENERATE_DOCSET="NO";
export GENERATE_HTML="NO";
export GENERATE_HTMLHELP="NO";
export GENERATE_LATEX="NO";
export GENERATE_QHP="NO";
export GENERATE_XML="NO";
export SEARCHENGINE="NO";
export SERVER_BASED_SEARCH="NO";
# Which format should we generate during this run?
case "$1" in
all) # All *main* formats, not all formats, here for backwards compat.
export GENERATE_HTML="YES";
export GENERATE_HTMLHELP="YES";
export GENERATE_XML="YES";
;;
chm)
export GENERATE_HTML="YES";
export GENERATE_HTMLHELP="YES";
;;
docset)
export GENERATE_DOCSET="YES";
export GENERATE_HTML="YES";
;;
latex)
export GENERATE_LATEX="YES";
;;
php) # HTML, but with PHP Search Engine
export GENERATE_HTML="YES";
export SEARCHENGINE="YES";
export SERVER_BASED_SEARCH="YES";
;;
qch)
export GENERATE_HTML="YES";
export GENERATE_QHP="YES";
;;
xml)
export GENERATE_XML="YES";
;;
*) # Default to HTML only
export GENERATE_HTML="YES";
export SEARCHENGINE="YES";
;;
esac
#
# 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!
#
$DOXYGEN Doxyfile
if [[ "$1" = "qch" ]]; then
# we need to add missing files to the .qhp
cd out/html
qhelpfile="index.qhp"
# remove all <file> and <files> tags
cat $qhelpfile | grep -v "<file" >temp
# remove last 4 lines (so we have nothing after the last <keyword> tag)
lines=$(wc -l < temp)
wanted=`expr $lines - 4`
head -n $wanted temp >$qhelpfile
# 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
# add a <file> tag for _any_ file in out/html folder except the .qhp itself
for f in * */*png; do
if [[ $f != $qhelpfile ]]; then
echo " <file>$f</file>" >>$qhelpfile
fi
done
# add ending tags to the qhp file
echo " </files>
</filterSection>
</QtHelpProject>" >>$qhelpfile
# 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
# last, run qhelpgenerator:
cd ../..
qhelpgenerator out/html/index.qhp -o out/wx.qch
fi
if [[ "$1" = "docset" ]]; then
BASENAME="wxWidgets-3.0" # was org.wxwidgets.doxygen.docset.wx30
DOCSETNAME="$BASENAME.docset"
ATOM="$BASENAME.atom"
ATOMDIR="http://docs.wxwidgets.org/docsets"
XAR="$BASENAME.xar"
XARDIR="http://docs.wxwidgets.org/docsets"
XCODE_INSTALL=`xcode-select -print-path`
cd out/html
DESTINATIONDIR=`pwd`/../docset
mkdir -p $DESTINATIONDIR
rm -rf $DESTINATIONDIR/$DOCSETNAME
rm -f $DESTINATIONDIR/$XAR
make DOCSET_NAME=$DESTINATIONDIR/$DOCSETNAME
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 3.0"
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 3.0"
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info NSHumanReadableCopyright "Copyright 1992-2017 wxWidgets team, Portions 1996 Artificial Intelligence Applications Institute"
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info isJavaScriptEnabled true
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info dashIndexFilePath index.html
defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetPlatformFamily wx
$XCODE_INSTALL/usr/bin/docsetutil package -atom $DESTINATIONDIR/$ATOM -download-url $XARDIR/$XAR -output $DESTINATIONDIR/$XAR $DESTINATIONDIR/$DOCSETNAME
cd ../..
fi
# 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`/
interfacepath=`cd ../../interface && pwd`/
cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" > temp
cat temp > doxygen.log
rm temp
# return to the original folder from which this script was launched
cd $current
|
