3 # Runs doxygen and massages the output files.
4 # Copyright (C) 2001-2024 Free Software Foundation, Inc.
6 # Synopsis: run_doxygen --mode=[html|latex|man|xml] --host_alias=<alias> \
11 # Originally hacked together by Phil Edwards <pme@gcc.gnu.org>
14 # We can check now that the version of doxygen is >= this variable.
18 local -r v_required
=`echo $DOXYVER | \
19 awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
20 local testing_version doxygen maybedoxy v_found
22 set `IFS=:; X="$PATH:/usr/local/bin:/bin:/usr/bin"; echo $X`
25 # AC_EXEEXT could come in useful here
26 maybedoxy
="$dir/doxygen"
27 test -f "$maybedoxy" && testing_version
=`$maybedoxy --version`
28 if test -n "$testing_version"; then
29 v_found
=`echo $testing_version | \
30 awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
31 if test $v_found -ge $v_required; then
37 if test -z "$doxygen"; then
38 fail
"Could not find Doxygen $DOXYVER in path."
40 # We need to use other tools from the same package/version.
41 echo :: Using Doxygen tools from
${dir}.
48 Usage: run_doxygen --mode=MODE --host_alias=HOST_ALIAS [<options>]
49 <v3-src-dir> <v3-build-dir> <shortnamesp>
51 html Generate user-level HTML library documentation.
52 man Generate user-level man pages.
53 xml Generate user-level XML pages.
54 latex Generate user-level LaTeX pages.
56 HOST_ALIAS is the GCC host alias triplet set at configure time.
58 shortnamesp is one of YES or NO and is used as the SHORT_NAMES value
59 in the Doxygen config file.
63 --help | -h Print this message and exit.
64 --latex_cmd=CMD Set LATEX_CMD_NAME=CMD in the Doxygen config file.
66 Note: Requires Doxygen ${DOXYVER} or later; get it at
67 ftp://ftp.stack.nl/pub/users/dimitri/doxygen-${DOXYVER}.src.tar.gz
72 # Print an error message followed by usage to stderr, then exit.
74 echo "$0: error: $*" 1>&2
83 # Blatantly ripped from autoconf, er, I mean, "gratefully standing
84 # on the shoulders of those giants who have gone before us."
86 -*=*) arg
=`echo "$1" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
97 --mode |
--host_alias)
98 fail
"missing argument: $1" ;;
102 fail
"invalid option: $1" ;;
111 fail
"wrong number of arguments"
115 outdir
="$2/doc/doxygen"
133 DATEtext
=`date '+%Y-%m-%d'`
135 # Show how this script is called.
141 if test $srcdir = unset ||
test $outdir = unset ||
test $mode = unset ||
test $shortname = unset ||
test $host_alias = unset; then
142 # this could be better
143 fail
"You have not given enough information...! $srcdir - "
149 enabled_sections
=maint
150 generate_tagfile
="$outdir/html/libstdc++.tag"
154 enabled_sections
=maint
161 enabled_sections
=maint
164 echo run_doxygen error
: $mode is an invalid mode
1>&2
168 case x
"$shortname" in
174 echo run_doxygen error
: $shortname is invalid
1>&2
186 sed -e "s=@outdir@=${outdir}=g" \
187 -e "s=@srcdir@=${srcdir}=g" \
188 -e "s=@shortname@=${shortname}=g" \
189 -e "s=@builddir@=${builddir}=g" \
190 -e "s=@host_alias@=${host_alias}=g" \
191 -e "s=@enabled_sections@=${enabled_sections}=" \
192 -e "s=@do_html@=${do_html}=" \
193 -e "s=@do_latex@=${do_latex}=" \
194 -e "s=@latex_cmd@=${latex_cmd}=" \
195 -e "s=@do_man@=${do_man}=" \
196 -e "s=@do_xml@=${do_xml}=" \
197 -e "s=@generate_tagfile@=${generate_tagfile}=" \
198 ${srcdir}/doc/doxygen/user.cfg.in > ${outdir}/${mode}.cfg
199 echo :: NOTE that this may take some
time...
200 echo doxygen
${outdir}/${mode}.cfg
201 doxygen
${outdir}/${mode}.cfg
204 test $ret -ne 0 && exit $ret
208 echo :: XML pages begin with
209 echo :: ${outdir}/xml
/index.xml
215 # Grrr, Doxygen 1.8.x changed the -w latex options.
216 need_footer
=`doxygen -h | sed -n -e '/-w latex/s=.*footer.*=true=p'`
218 # Also drop in the header file (maybe footer file) and style sheet
219 if $need_footer; then
220 doxygen
-w latex header.tex footer.tex doxygen.sty
222 doxygen
-w latex header.tex doxygen.sty
226 echo :: LaTeX pages begin with
227 echo :: ${outdir}/latex
/refman.tex
233 #doxytag -t libstdc++.tag . > /dev/null 2>&1
235 # Strip pathnames from tag file.
236 sed -e '/<path>/d' libstdc
++.tag
> TEMP
237 mv TEMP libstdc
++.tag
239 sed -e "s=@DATE@=${DATEtext}=" \
240 ${srcdir}/doc
/doxygen
/mainpage.html
> index.html
242 # The following bit of line noise changes annoying
243 # std::foo < typename _Ugly1, typename _Ugly2, .... _DefaultUgly17 >
246 # in the major "Compound List" page.
247 sed -e 's=\(::[[:alnum:]_]*\)< .* >=\1=' annotated.html
> annstrip.html
248 mv annstrip.html annotated.html
250 cp ${srcdir}/doc
/doxygen
/tables.html tables.html
253 echo :: HTML pages begin with
254 echo :: ${outdir}/html
/index.html
257 # Mess with the man pages. We don't need documentation of the internal
258 # headers, since the man pages for those contain nothing useful anyhow. The
259 # man pages for doxygen modules need to be renamed (or deleted). And the
260 # generated #include lines need to be changed from the internal names to the
261 # standard ones (e.g., "#include <stl_tempbuf.h>" -> "#include <memory>").
264 echo :: Fixing up the man pages...
267 # File names with embedded spaces (EVIL!) need to be....? renamed or removed?
268 find .
-name "* *" -print0 |
xargs -0r rm # requires GNU tools
270 # man pages are for functions/types/other entities, not source files
271 # directly. who the heck would type "man foo.h" anyhow?
272 # FIXME: This also removes std.3 which is the only place that a lot of
273 # functions are documented. Should we keep it?
274 find .
-name "[a-z]*" -a ! -name "std_*" -print |
xargs rm
275 rm -f *.h
.3 *.hpp
.3 *config
* *.cc
.3 *.tcc
.3 *_t
.3
276 #rm ext_*.3 tr1_*.3 debug_*.3
278 # this is used to examine what we would have deleted, for debugging
280 #find . -name "[a-z]*" -a ! -name "std_*" -print | xargs -i mv {} trash
281 #mv *.h.3 *config* *.cc.3 *.tcc.3 *_t.3 trash
283 gxx
=$
($builddir/scripts
/testsuite_flags
--build-cxx)
284 cppflags
=$
($builddir/scripts
/testsuite_flags
--build-includes)
285 cxxflags
="-Og -g -std=gnu++23"
287 # Standardize the displayed header names. If anyone who knows perl cares
288 # enough to rewrite all this, feel free. This only gets run once a century,
289 # and I'm off getting coffee then anyhow, so I didn't care enough to make
291 $gxx $cppflags $cxxflags ${srcdir}/doc
/doxygen
/stdheader.cc
-o .
/stdheader ||
exit 1
292 # Doxygen outputs something like "\fC#include <unique_lock\&.h>\fP" and
293 # we want that internal header to be replaced with something like <mutex>.
294 problematic
=`grep -E -l '#include <.*h>' [a-z]*.3`
295 for f
in $problematic; do
296 # this is also slow, but safe and easy to debug
297 oldh
=`sed -n '/f[CR]#include </s/.*<\(.*\)>.*/\1/p' $f`
298 if [ "$oldh" == "" ]; then
299 echo "ERROR: Doxygen man page formatting changed" 2>&1
302 newh
=`echo $oldh | sed 's/\\\\&\\././g' | ./stdheader`
303 sed "s=${oldh/\\/.}=${newh}=" $f > TEMP
&& mv TEMP
$f
307 # Some of the pages for generated modules have text that confuses certain
308 # implementations of man(1), e.g. on GNU/Linux. We need to have another
309 # top-level *roff tag to /stop/ the .SH NAME entry.
310 problematic
=`grep -E --files-without-match '^\.SH SYNOPSIS' [A-Z]*.3`
311 #problematic='Containers.3 Sequences.3 Assoc_containers.3 Iterator_types.3'
313 for f
in $problematic; do
323 # Also, break this (generated) line up. It's ugly as sin.
324 problematic
=`grep -l '[^^]Definition at line' *.3`
325 for f
in $problematic; do
326 sed 's/Definition at line/\
332 cp ${srcdir}/doc
/doxygen
/Intro
.3 C
++Intro
.3
334 # Why didn't I do this at the start? Were rabid weasels eating my brain?
335 # Who the fsck would "man std_vector" when the class isn't named that?
337 # If no files match a glob, skip the for-loop:
339 # First, deal with nested namespaces.
340 for ns
in chrono filesystem ranges views literals
; do
341 for f
in std_
${ns}_
*; do
342 newname
=`echo $f | sed "s/std_${ns}_/std::${ns}::/"`
346 for f
in *__debug_
*; do
347 newname
=`echo $f | sed 's/__debug_/__debug::/'`
350 for f
in *decimal_
*; do
351 newname
=`echo $f | sed 's/decimal_/decimal::/'`
354 for f
in *__detail_
*; do
355 newname
=`echo $f | sed 's/__detail_/__detail::/'`
358 for f
in *__gnu_pbds_detail_
*; do
359 newname
=`echo $f | sed 's/detail_/detail::/'`
362 for f
in *__parallel_
*; do
363 newname
=`echo $f | sed 's/__parallel_/__parallel::/'`
367 # Remove inline namespaces used for versioning.
369 newname
=`echo $f | sed 's/_V2_/::/'`
370 sed 's/::_V2::/::/g' $f > $newname
373 for f
in *_experimental_filesystem_v?_
*; do
374 newname
=`echo $f | sed 's/_filesystem_v._/::filesystem::/'`
375 sed 's/::filesystem::v.::/::filesystem::/g' $f > $newname
378 for f
in *experimental_fundamentals_v?_
*; do
379 newname
=`echo $f | sed 's/experimental_.*_v[[:digit:]]_/experimental::/'`
380 sed 's/::experimental::fundamentals_v[[:digit:]]::/::experimental::/g' $f > $newname
384 # Then, clean up other top-level namespaces.
385 for f
in std_tr1_
*; do
386 newname
=`echo $f | sed 's/^std_tr1_/std::tr1::/'`
389 for f
in std_tr2_
*; do
390 newname
=`echo $f | sed 's/^std_tr2_/std::tr2::/'`
394 newname
=`echo $f | sed 's/^std_/std::/'`
397 for f
in __gnu_cxx_
*; do
398 newname
=`echo $f | sed 's/^__gnu_cxx_/__gnu_cxx::/'`
401 for f
in __gnu_debug_
*; do
402 newname
=`echo $f | sed 's/^__gnu_debug_/__gnu_debug::/'`
405 for f
in __gnu_parallel_
*; do
406 newname
=`echo $f | sed 's/^__gnu_parallel_/__gnu_parallel::/'`
409 for f
in __gnu_pbds_
*; do
410 newname
=`echo $f | sed 's/^__gnu_pbds_/__gnu_pbds::/'`
413 for f
in __cxxabiv1_
*; do
414 newname
=`echo $f | sed 's/^__cxxabiv1_/abi::/'`
418 mv std
::__unspecified___exception_ptr
.3 std
::exception_ptr
.3
420 # Then piecemeal nested classes
422 for f
in std
*distribution_param_type
.3; do
423 newname
=`echo $f | sed 's/distribution_param_type/distribution::param_type/'`
427 for f
in std
*filesystem
::path_iterator
.3; do
428 newname
=`echo $f | sed 's/path_iterator/path::iterator/'`
432 mv std
::chrono
::tzdb_list_const_iterator
.3 std
::chrono
::tzdb_list
::const_iterator
.3
434 # Generic removal bits, where there are things in the generated man
435 # pages that need to be killed.
436 for f
in *_libstdc__-v3_
*; do
444 # Remove all internal implementation details?
445 # rm std::_[A-Z]*.3 std::__detail*.3
450 # Also, for some reason, typedefs don't get their own man pages. Sigh.
451 for f
in ios streambuf istream ostream iostream stringbuf \
452 istringstream ostringstream stringstream filebuf ifstream \
453 ofstream fstream string
455 echo ".so man3/std::basic_${f}.3" > std
::${f}.3
456 echo ".so man3/std::basic_${f}.3" > std
::w
${f}.3
460 echo :: Man pages
in ${outdir}/man