libstdc++-v3/scripts/run_doxygen

   1 #!/bin/bash
   2
   3 # Runs doxygen and massages the output files.
   4 # Copyright (C) 2001, 2002, 2003, 2004, 2008, 2009, 2010
   5 # Free Software Foundation, Inc.
   6 #
   7 # Synopsis:  run_doxygen --mode=[html|latex|man|xml] --host_alias=<alias> \
   8 #                        v3srcdir \
   9 #                        v3builddir \
  10 #                        shortname
  11 #
  12 # Originally hacked together by Phil Edwards <pme@gcc.gnu.org>
  13
  14
  15 # We can check now that the version of doxygen is >= this variable.
  16 DOXYVER=1.6.1
  17
  18 find_doxygen() {
  19     local -r v_required=`echo $DOXYVER |  \
  20                 awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
  21     local testing_version doxygen maybedoxy v_found
  22     # thank you goat book
  23     set `IFS=:; X="$PATH:/usr/local/bin:/bin:/usr/bin"; echo $X`
  24     for dir
  25     do
  26       # AC_EXEEXT could come in useful here
  27       maybedoxy="$dir/doxygen"
  28       test -f "$maybedoxy" && testing_version=`$maybedoxy --version`
  29       if test -n "$testing_version"; then
  30        v_found=`echo $testing_version |  \
  31                 awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
  32        if test $v_found -ge $v_required; then
  33          doxygen="$maybedoxy"
  34          break
  35        fi
  36       fi
  37     done
  38     if test -z "$doxygen"; then
  39         echo run_doxygen error:  Could not find Doxygen $DOXYVER in path. 1>&2
  40         print_usage
  41     fi
  42     # We need to use other tools from the same package/version.
  43     echo :: Using Doxygen tools from ${dir}.
  44     PATH=$dir:$PATH
  45     hash -r
  46 }
  47
  48 print_usage() {
  49     cat 1>&2 <<EOF
  50 Usage:  run_doxygen --mode=MODE --host_alias=BUILD_ALIAS [<options>]
  51                     <v3-src-dir> <v3-build-dir> <shortnamesp>
  52       MODE is one of:
  53           html           Generate user-level HTML library documentation.
  54           man            Generate user-level man pages.
  55           xml            Generate user-level XML pages.
  56           latex          Generate user-level LaTeX pages.
  57
  58       BUILD_ALIAS is the GCC build alias set at configure time.
  59
  60 Note:  Requires Doxygen ${DOXYVER} or later; get it at
  61        ftp://ftp.stack.nl/pub/users/dimitri/doxygen-${DOXYVER}.src.tar.gz
  62
  63 EOF
  64     exit 1
  65 }
  66
  67 parse_options() {
  68   for o
  69   do
  70     # Blatantly ripped from autoconf, er, I mean, "gratefully standing
  71     # on the shoulders of those giants who have gone before us."
  72     case "$o" in
  73       -*=*) arg=`echo "$o" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
  74       *) arg= ;;
  75     esac
  76
  77     case "$o" in
  78       --mode=*)
  79         mode=$arg ;;
  80       --host_alias=*)
  81         host_alias=$arg ;;
  82       --mode | --host_alias | --help | -h)
  83         print_usage ;;
  84       *)
  85         # this turned out to be a mess, maybe change to --srcdir=, etc
  86         if test $srcdir = unset; then
  87           srcdir=$o
  88         elif test $outdir = unset; then
  89           builddir=${o}
  90           outdir=${o}/doc/doxygen
  91         elif test $shortname = unset; then
  92           shortname=$o
  93         else
  94           echo run_doxygen error:  Too many arguments 1>&2
  95           exit 1
  96         fi
  97         ;;
  98       esac
  99   done
 100 }
 101
 102
 103 # script begins here
 104 mode=unset
 105 host_alias=unset
 106 srcdir=unset
 107 outdir=unset
 108 shortname=unset
 109 do_html=false
 110 do_man=false
 111 do_xml=false
 112 do_latex=false
 113 enabled_sections=
 114 generate_tagfile=
 115 DATEtext=`date '+%Y-%m-%d'`
 116
 117 # Show how this script is called.
 118 echo run_doxygen $*
 119
 120 parse_options $*
 121 find_doxygen
 122
 123 if test $srcdir = unset || test $outdir = unset || test $mode = unset || test $shortname = unset || test $host_alias = unset; then
 124     # this could be better
 125     echo run_doxygen error:  You have not given enough information...! 1>&2
 126     print_usage
 127 fi
 128
 129 case x"$mode" in
 130     xhtml)
 131       do_html=true
 132       enabled_sections=maint
 133       generate_tagfile="$outdir/html/libstdc++.tag"
 134       ;;
 135     xlatex)
 136       do_latex=true
 137       enabled_sections=maint
 138       ;;
 139     xman)
 140       do_man=true
 141       ;;
 142     xxml)
 143       do_xml=true
 144       enabled_sections=maint
 145       ;;
 146     *)
 147       echo run_doxygen error:  $mode is an invalid mode 1>&2
 148       exit 1 ;;
 149 esac
 150
 151 case x"$shortname" in
 152     xYES)
 153       ;;
 154     xNO)
 155       ;;
 156     *)
 157       echo run_doxygen error:  $shortname is invalid 1>&2
 158       exit 1 ;;
 159 esac
 160
 161
 162 mkdir -p $outdir
 163 chmod u+w $outdir
 164
 165 if $do_xml; then
 166     mkdir -p $outdir/xml
 167 fi
 168
 169 (
 170   set -e
 171   cd $builddir
 172   sed -e "s=@outdir@=${outdir}=g" \
 173       -e "s=@srcdir@=${srcdir}=g" \
 174       -e "s=@shortname@=${shortname}=g" \
 175       -e "s=@builddir@=${builddir}=g" \
 176       -e "s=@host_alias@=${host_alias}=g" \
 177       -e "s=@enabled_sections@=${enabled_sections}=" \
 178       -e "s=@do_html@=${do_html}=" \
 179       -e "s=@do_latex@=${do_latex}=" \
 180       -e "s=@do_man@=${do_man}=" \
 181      -e "s=@do_xml@=${do_xml}=" \
 182       -e "s=@generate_tagfile@=${generate_tagfile}=" \
 183       ${srcdir}/doc/doxygen/user.cfg.in > ${outdir}/${mode}.cfg
 184   echo :: NOTE that this may take some time...
 185   echo doxygen ${outdir}/${mode}.cfg
 186   doxygen ${outdir}/${mode}.cfg
 187   echo :: Finished, exit code was $?
 188 )
 189 ret=$?
 190 test $ret -ne 0 && exit $ret
 191
 192 if $do_latex; then
 193     mkdir -p $outdir/latex
 194 fi
 195
 196 (
 197   set -e
 198   cd $builddir
 199   sed -e "s=@outdir@=${outdir}=g" \
 200       -e "s=@srcdir@=${srcdir}=g" \
 201       -e "s=@shortname@=${shortname}=g" \
 202       -e "s=@builddir@=${builddir}=g" \
 203       -e "s=@host_alias@=${host_alias}=g" \
 204       -e "s=@enabled_sections@=${enabled_sections}=" \
 205       -e "s=@do_html@=${do_html}=" \
 206       -e "s=@do_latex@=${do_latex}=" \
 207       -e "s=@do_man@=${do_man}=" \
 208      -e "s=@do_xml@=${do_xml}=" \
 209       -e "s=@generate_tagfile@=${generate_tagfile}=" \
 210       ${srcdir}/doc/doxygen/user.cfg.in > ${outdir}/${mode}.cfg
 211   echo :: NOTE that this may take some time...
 212   echo doxygen ${outdir}/${mode}.cfg
 213   doxygen ${outdir}/${mode}.cfg
 214
 215   # Also drop in the header file and style sheet
 216   cd ${outdir}/${mode}
 217   doxygen -w latex header.tex doxygen.sty
 218   echo :: Finished, exit code was $?
 219   echo ::
 220   echo :: LaTeX pages begin with
 221   echo :: ${outdir}/latex/refman.tex
 222 )
 223 ret=$?
 224 test $ret -ne 0 && exit $ret
 225
 226 if $do_html; then
 227   cd ${outdir}/html
 228
 229   #doxytag -t libstdc++.tag . > /dev/null 2>&1
 230   sed -e '/<path>/d' libstdc++.tag > TEMP
 231   mv TEMP libstdc++.tag
 232
 233   sed -e "s=@DATE@=${DATEtext}=" \
 234       ${srcdir}/doc/doxygen/mainpage.html > index.html
 235
 236   # The following bit of line noise changes annoying
 237   #   std::foo < typename _Ugly1, typename _Ugly2, .... _DefaultUgly17 >
 238   # to user-friendly
 239   #   std::foo
 240   # in the major "Compound List" page.
 241   sed -e 's=\(::[[:alnum:]_]*\)&lt; .* &gt;=\1=' annotated.html > annstrip.html
 242   mv annstrip.html annotated.html
 243
 244   cp ${srcdir}/doc/doxygen/tables.html tables.html
 245   echo ::
 246   echo :: HTML pages begin with
 247   echo :: ${outdir}/html/index.html
 248 fi
 249
 250 # Mess with the man pages.  We don't need documentation of the internal
 251 # headers, since the man pages for those contain nothing useful anyhow.  The
 252 # man pages for doxygen modules need to be renamed (or deleted).  And the
 253 # generated #include lines need to be changed from the internal names to the
 254 # standard ones (e.g., "#include <stl_tempbuf.h>" -> "#include <memory>").
 255 if $do_man; then
 256 echo ::
 257 echo :: Fixing up the man pages...
 258 cd $outdir/man/man3
 259
 260 # File names with embedded spaces (EVIL!) need to be....?  renamed or removed?
 261 find . -name "* *" -print0 | xargs -0r rm        # requires GNU tools
 262
 263 # man pages are for functions/types/other entities, not source files
 264 # directly.  who the heck would type "man foo.h" anyhow?
 265 find . -name "[a-z]*" -a ! -name "std_*" -print | xargs rm
 266 rm -f *.h.3 *.hpp.3 *config* *.cc.3 *.tcc.3 *_t.3
 267 #rm ext_*.3 tr1_*.3 debug_*.3
 268
 269 # this is used to examine what we would have deleted, for debugging
 270 #mkdir trash
 271 #find . -name "[a-z]*" -a ! -name "std_*" -print | xargs -i mv {} trash
 272 #mv *.h.3 *config* *.cc.3 *.tcc.3 *_t.3  trash
 273
 274 # Standardize the displayed header names.  If anyone who knows perl cares
 275 # enough to rewrite all this, feel free.  This only gets run once a century,
 276 # and I'm off getting coffee then anyhow, so I didn't care enough to make
 277 # this super-fast.
 278 g++ ${srcdir}/doc/doxygen/stdheader.cc -o ./stdheader
 279 problematic=`egrep -l '#include <.*_.*>' [a-z]*.3`
 280 for f in $problematic; do
 281     # this is also slow, but safe and easy to debug
 282     oldh=`sed -n '/fC#include </s/.*<\(.*\)>.*/\1/p' $f`
 283     newh=`echo $oldh | ./stdheader`
 284     sed "s=${oldh}=${newh}=" $f > TEMP
 285     mv TEMP $f
 286 done
 287 rm stdheader
 288
 289 # Some of the pages for generated modules have text that confuses certain
 290 # implementations of man(1), e.g., Linux's.  We need to have another top-level
 291 # *roff tag to /stop/ the .SH NAME entry.
 292 problematic=`egrep --files-without-match '^\.SH SYNOPSIS' [A-Z]*.3`
 293 #problematic='Containers.3 Sequences.3 Assoc_containers.3 Iterator_types.3'
 294
 295 for f in $problematic; do
 296     sed '/^\.SH NAME/{
 297 n
 298 a\
 299 \
 300 .SH SYNOPSIS
 301     }' $f > TEMP
 302     mv TEMP $f
 303 done
 304
 305 # Also, break this (generated) line up.  It's ugly as sin.
 306 problematic=`grep -l '[^^]Definition at line' *.3`
 307 for f in $problematic; do
 308     sed 's/Definition at line/\
 309 .PP\
 310 &/'  $f > TEMP
 311     mv TEMP $f
 312 done
 313
 314 cp ${srcdir}/doc/doxygen/Intro.3 C++Intro.3
 315
 316 # Why didn't I do this at the start?  Were rabid weasels eating my brain?
 317 # Who the fsck would "man std_vector" when the class isn't named that?
 318
 319 # First, deal with nested namespaces.
 320 for f in *chrono_*; do
 321     newname=`echo $f | sed 's/chrono_/chrono::/'`
 322     mv $f $newname
 323 done
 324 for f in *__debug_*; do
 325     newname=`echo $f | sed 's/__debug_/__debug::/'`
 326     mv $f $newname
 327 done
 328 for f in *decimal_*; do
 329     newname=`echo $f | sed 's/decimal_/decimal::/'`
 330     mv $f $newname
 331 done
 332 for f in *__detail_*; do
 333     newname=`echo $f | sed 's/__detail_/__detail::/'`
 334     mv $f $newname
 335 done
 336 for f in *__parallel_*; do
 337     newname=`echo $f | sed 's/__parallel_/__parallel::/'`
 338     mv $f $newname
 339 done
 340 for f in *__profile_*; do
 341     newname=`echo $f | sed 's/__profile_/__profile::/'`
 342     mv $f $newname
 343 done
 344 for f in *__atomic0_*; do
 345     newname=`echo $f | sed 's/__atomic0_/__atomic0::/'`
 346     mv $f $newname
 347 done
 348 for f in *__atomic2_*; do
 349     newname=`echo $f | sed 's/__atomic2_/__atomic2::/'`
 350     mv $f $newname
 351 done
 352
 353 # Then, clean up other top-level namespaces.
 354 for f in std_tr1_*; do
 355     newname=`echo $f | sed 's/^std_tr1_/std::tr1::/'`
 356     mv $f $newname
 357 done
 358 for f in std_*; do
 359     newname=`echo $f | sed 's/^std_/std::/'`
 360     mv $f $newname
 361 done
 362 for f in __gnu_cxx_*; do
 363     newname=`echo $f | sed 's/^__gnu_cxx_/__gnu_cxx::/'`
 364     mv $f $newname
 365 done
 366 for f in __gnu_debug_*; do
 367     newname=`echo $f | sed 's/^__gnu_debug_/__gnu_debug::/'`
 368     mv $f $newname
 369 done
 370 for f in __gnu_parallel_*; do
 371     newname=`echo $f | sed 's/^__gnu_parallel_/__gnu_parallel::/'`
 372     mv $f $newname
 373 done
 374 for f in __gnu_profile_*; do
 375     newname=`echo $f | sed 's/^__gnu_profile_/__gnu_profile::/'`
 376     mv $f $newname
 377 done
 378 for f in __gnu_pbds_*; do
 379     newname=`echo $f | sed 's/^__gnu_pbds_/__gnu_pbds::/'`
 380     mv $f $newname
 381 done
 382 for f in __cxxabiv1_*; do
 383     newname=`echo $f | sed 's/^__cxxabiv1_/abi::/'`
 384     mv $f $newname
 385 done
 386
 387 # Then piecemeal nested classes
 388 for f in *__future_base_*; do
 389     newname=`echo $f | sed 's/__future_base_/__future_base::/'`
 390     mv $f $newname
 391 done
 392
 393
 394
 395 # Generic removal bits, where there are things in the generated man
 396 # pages that need to be killed.
 397 for f in *_libstdc__-v3_*; do
 398     rm $f
 399 done
 400
 401 for f in *_src_*; do
 402     rm $f
 403 done
 404
 405
 406 # Also, for some reason, typedefs don't get their own man pages.  Sigh.
 407 for f in ios streambuf istream ostream iostream stringbuf \
 408          istringstream ostringstream stringstream filebuf ifstream \
 409          ofstream fstream string;
 410 do
 411     echo ".so man3/std::basic_${f}.3" > std::${f}.3
 412     echo ".so man3/std::basic_${f}.3" > std::w${f}.3
 413 done
 414
 415 echo ::
 416 echo :: Man pages in ${outdir}/man
 417 fi
 418
 419 # all done
 420 echo ::
 421
 422 exit 0