libstdc++-v3/docs/doxygen/run_doxygen

   1 #!/bin/bash
   2
   3 # Runs doxygen and massages the output files.
   4 # Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
   5 #
   6 # Synopsis:  run_doxygen --mode=[user|maint|man] --host_alias=<alias> \
   7 #                        v3srcdir  v3builddir
   8 #
   9 # Originally hacked together by Phil Edwards <pme@gcc.gnu.org>
  10
  11
  12 # We can check now that the version of doxygen is >= this variable.
  13 DOXYVER=1.3.9
  14
  15 find_doxygen() {
  16     local -r v_required=`echo $DOXYVER |  \
  17                 awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
  18     local testing_version doxygen maybedoxy v_found
  19     # thank you goat book
  20     set `IFS=:; X="$PATH:/usr/local/bin:/bin:/usr/bin"; echo $X`
  21     for dir
  22     do
  23       # AC_EXEEXT could come in useful here
  24       maybedoxy="$dir/doxygen"
  25       test -f "$maybedoxy" && testing_version=`$maybedoxy --version`
  26       if test -n "$testing_version"; then
  27        v_found=`echo $testing_version |  \
  28                 awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
  29        if test $v_found -ge $v_required; then
  30          doxygen="$maybedoxy"
  31          break
  32        fi
  33       fi
  34     done
  35     if test -z "$doxygen"; then
  36         echo run_doxygen error:  Could not find Doxygen $DOXYVER in path. 1>&2
  37         print_usage
  38     fi
  39     # We need to use other tools from the same package/version.
  40     echo :: Using Doxygen tools from ${dir}.
  41     PATH=$dir:$PATH
  42     hash -r
  43 }
  44
  45 print_usage() {
  46     cat 1>&2 <<EOF
  47 Usage:  run_doxygen --mode=MODE --host_alias=BUILD_ALIAS [<options>]
  48                     <v3-src-dir> <v3-build-dir>
  49       MODE is one of:
  50           user           Generate user-level HTML library documentation.
  51           maint          Generate maintainers' HTML documentation (lots more;
  52                              exposes non-public members, etc).
  53           man            Generate user-level man pages.
  54
  55       BUILD_ALIAS is the GCC build alias set at configure time.
  56
  57       more options when i think of them
  58
  59 Note:  Requires Doxygen ${DOXYVER} or later; get it at
  60        ftp://ftp.stack.nl/pub/users/dimitri/doxygen-${DOXYVER}.src.tar.gz
  61
  62 EOF
  63     exit 1
  64 }
  65
  66 parse_options() {
  67   for o
  68   do
  69     # Blatantly ripped from autoconf, er, I mean, "gratefully standing
  70     # on the shoulders of those giants who have gone before us."
  71     case "$o" in
  72       -*=*) arg=`echo "$o" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
  73       *) arg= ;;
  74     esac
  75
  76     case "$o" in
  77       --mode=*)
  78         mode=$arg ;;
  79       --host_alias=*)
  80         host_alias=$arg ;;
  81       --mode | --host_alias | --help | -h)
  82         print_usage ;;
  83       *)
  84         # this turned out to be a mess, maybe change to --srcdir=, etc
  85         if test $srcdir = unset; then
  86           srcdir=$o
  87         elif test $outdir = unset; then
  88           builddir=${o}
  89           outdir=${o}/docs/doxygen
  90         else
  91           echo run_doxygen error:  Too many arguments 1>&2
  92           exit 1
  93         fi
  94         ;;
  95       esac
  96   done
  97 }
  98
  99
 100 # script begins here
 101 mode=unset
 102 host_alias=unset
 103 srcdir=unset
 104 outdir=unset
 105 do_html=false
 106 do_man=false
 107 enabled_sections=
 108 generate_tagfile=
 109 DATEtext=`date '+%Y-%m-%d'`
 110
 111 # Show how this script is called.
 112 echo run_doxygen $*
 113
 114 parse_options $*
 115 find_doxygen
 116
 117 if test $srcdir = unset || test $outdir = unset || test $mode = unset || test $host_alias = unset; then
 118     # this could be better
 119     echo run_doxygen error:  You have not given enough information...! 1>&2
 120     print_usage
 121 fi
 122
 123 case x"$mode" in
 124     xuser)
 125       do_html=true
 126       LEVELtext='User'
 127       generate_tagfile="$outdir/html_$mode/libstdc++.tag"
 128       ;;
 129     xmaint)
 130       do_html=true
 131       enabled_sections=maint
 132       LEVELtext='Maintainer'
 133       generate_tagfile="$outdir/html_$mode/libstdc++.tag"
 134       ;;
 135     xman)
 136       do_man=true
 137       ;;
 138     *)
 139       echo run_doxygen error:  $mode is an invalid mode 1>&2
 140       exit 1 ;;
 141 esac
 142
 143 #rm -rf $outdir
 144 mkdir -p $outdir
 145 chmod u+w $outdir
 146
 147 # work around a stupid doxygen bug
 148 if $do_man; then
 149     mkdir -p $outdir/man/man3/ext
 150     chmod -R u+w $outdir/man/man3/ext
 151 fi
 152
 153 (
 154   set -e
 155   cd $builddir
 156   sed -e "s=@outdir@=${outdir}=g" \
 157       -e "s=@srcdir@=${srcdir}=g" \
 158       -e "s=@builddir@=${builddir}=g" \
 159       -e "s=@host_alias@=${host_alias}=g" \
 160       -e "s=@html_output_dir@=html_${mode}=" \
 161       -e "s=@enabled_sections@=${enabled_sections}=" \
 162       -e "s=@do_html@=${do_html}=" \
 163       -e "s=@do_man@=${do_man}=" \
 164       -e "s=@generate_tagfile@=${generate_tagfile}=" \
 165       ${srcdir}/docs/doxygen/user.cfg.in > ${outdir}/${mode}.cfg
 166   echo :: NOTE that this may take some time...
 167   echo doxygen ${outdir}/${mode}.cfg
 168   doxygen ${outdir}/${mode}.cfg
 169   echo :: Finished, exit code was $?
 170 )
 171 ret=$?
 172 test $ret -ne 0 && exit $ret
 173
 174 if $do_html; then
 175   cd ${outdir}/html_${mode}
 176
 177   #doxytag -t libstdc++.tag . > /dev/null 2>&1
 178   sed -e '/<path>/d' libstdc++.tag > TEMP
 179   mv TEMP libstdc++.tag
 180
 181   sed -e "s=@LEVEL@=${LEVELtext}=" \
 182       -e "s=@DATE@=${DATEtext}=" \
 183       ${srcdir}/docs/doxygen/mainpage.html > index.html
 184
 185   # The following bit of line noise changes annoying
 186   #   std::foo < typename _Ugly1, typename _Ugly2, .... _DefaultUgly17 >
 187   # to user-friendly
 188   #   std::foo
 189   # in the major "Compound List" page.
 190   sed -e 's=\(::[[:alnum:]_]*\)&lt; .* &gt;=\1=' annotated.html > annstrip.html
 191   mv annstrip.html annotated.html
 192
 193   # Work around a bug in doxygen 1.3.
 194   for f in class*html struct*html; do
 195       sed '1,10s!^<title> Template!<title>Template !' $f > TEMP
 196       mv TEMP $f
 197   done
 198
 199   cp ${srcdir}/docs/doxygen/tables.html tables.html
 200   echo ::
 201   echo :: HTML pages begin with
 202   echo :: ${outdir}/html_${mode}/index.html
 203 fi
 204
 205 # Mess with the man pages.  We don't need documentation of the internal
 206 # headers, since the man pages for those contain nothing useful anyhow.  The
 207 # man pages for doxygen modules need to be renamed (or deleted).  And the
 208 # generated #include lines need to be changed from the internal names to the
 209 # standard ones (e.g., "#include <stl_tempbuf.h>" -> "#include <memory>").
 210 if $do_man; then
 211 echo ::
 212 echo :: Fixing up the man pages...
 213 cd $outdir/man/man3
 214
 215 # here's the other end of the "stupid doxygen bug" mentioned above
 216 rm -rf ext
 217
 218 # File names with embedded spaces (EVIL!) need to be....?  renamed or removed?
 219 find . -name "* *" -print0 | xargs -0r rm        # requires GNU tools
 220
 221 # can leave SGIextensions.3 alone, it's an okay name
 222 mv s20_3_1_base.3           Intro_functors.3
 223 mv s20_3_2_arithmetic.3     Arithmetic_functors.3
 224 mv s20_3_3_comparisons.3    Comparison_functors.3
 225 mv s20_3_4_logical.3        Logical_functors.3
 226 mv s20_3_5_negators.3       Negation_functors.3
 227 mv s20_3_6_binder.3         Binder_functors.3
 228 mv s20_3_7_adaptors.3       Func_ptr_functors.3
 229 mv s20_3_8_memadaptors.3    Member_ptr_functors.3
 230 mv iterator_tags.3          Iterator_types.3
 231 mv std.3                    Namespace_std.3
 232 mv __gnu_cxx.3              Namespace___gnu_cxx.3
 233
 234 # man pages are for functions/types/other entities, not source files
 235 # directly.  who the heck would type "man foo.h" anyhow?
 236 find . -name "[a-z]*" -a ! -name "std_*" -print | xargs rm
 237 rm -f *.h.3 *config* *.cc.3 *.tcc.3 *_t.3
 238 # this is used to examine what we would have deleted, for debugging
 239 #mkdir trash
 240 #find . -name "[a-z]*" -a ! -name "std_*" -print | xargs -i mv {} trash
 241 #mv *.h.3 *config* *.cc.3 *.tcc.3 *_t.3  trash
 242
 243 # Standardize the displayed header names.  If anyone who knows perl cares
 244 # enough to rewrite all this, feel free.  This only gets run once a century,
 245 # and I'm off getting coffee then anyhow, so I didn't care enough to make
 246 # this super-fast.
 247 g++ ${srcdir}/docs/doxygen/stdheader.cc -o ./stdheader
 248 problematic=`egrep -l '#include <.*_.*>' [a-z]*.3`
 249 for f in $problematic; do
 250     # this is also slow, but safe and easy to debug
 251     oldh=`sed -n '/fC#include </s/.*<\(.*\)>.*/\1/p' $f`
 252     newh=`echo $oldh | ./stdheader`
 253     sed "s=${oldh}=${newh}=" $f > TEMP
 254     mv TEMP $f
 255 done
 256 rm stdheader
 257
 258 # Some of the pages for generated modules have text that confuses certain
 259 # implementations of man(1), e.g., Linux's.  We need to have another top-level
 260 # *roff tag to /stop/ the .SH NAME entry.
 261 #problematic=`egrep --files-without-match '^\.SH SYNOPSIS' [A-Z]*.3`
 262 problematic='Containers.3 Sequences.3 Assoc_containers.3 Iterator_types.3'
 263 for f in $problematic; do
 264     sed '/^\.SH NAME/{
 265 n
 266 a\
 267 \
 268 .SH SYNOPSIS
 269     }' $f > TEMP
 270     mv TEMP $f
 271 done
 272
 273 # Also, break this (generated) line up.  It's ugly as sin.
 274 problematic=`grep -l '[^^]Definition at line' *.3`
 275 for f in $problematic; do
 276     sed 's/Definition at line/\
 277 .PP\
 278 &/'  $f > TEMP
 279     mv TEMP $f
 280 done
 281
 282 cp ${srcdir}/docs/doxygen/Intro.3 C++Intro.3
 283
 284 # Why didn't I do this at the start?  Were rabid weasels eating my brain?
 285 # Who the fsck would "man std_vector" when the class isn't named that?
 286 for f in std_tr1_*; do
 287     newname=`echo $f | sed 's/^std_tr1_/std::tr1::/'`
 288     mv $f $newname
 289 done
 290 for f in std_*; do
 291     newname=`echo $f | sed 's/^std_/std::/'`
 292     mv $f $newname
 293 done
 294 for f in __gnu_cxx_*; do
 295     newname=`echo $f | sed 's/^__gnu_cxx_/__gnu_cxx::/'`
 296     mv $f $newname
 297 done
 298
 299 # Generic reoval bits, where there are things in the generated man
 300 # pages that need to be killed.
 301 for f in *_libstdc__-v3_*; do
 302     rm $f
 303 done
 304
 305 for f in *_src_*; do
 306     rm $f
 307 done
 308
 309
 310 # Also, for some reason, typedefs don't get their own man pages.  Sigh.
 311 for f in ios streambuf istream ostream iostream stringbuf \
 312          istringstream ostringstream stringstream filebuf ifstream \
 313          ofstream fstream string;
 314 do
 315     echo ".so man3/std::basic_${f}.3" > std::${f}.3
 316     echo ".so man3/std::basic_${f}.3" > std::w${f}.3
 317 done
 318
 319 echo ::
 320 echo :: Man pages in ${outdir}/man
 321 fi
 322
 323 # all done
 324 echo ::
 325
 326 exit 0
 327
 328 # vim:ts=4:et: