libstdc++-v3/docs/doxygen/run_doxygen

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