doclib/doxygen.sh

   1 #!/bin/bash -e
   2
   3 do_html_cleanup()
   4 {
   5     sed -e 's/id="current"/class="current"/' \
   6         | tidy -ascii -q --wrap 0 --show-warnings no --fix-uri no \
   7         | sed -e 's/name="\([^"]*\)"\([^>]*\) id="\1"/name="\1"\2/g' \
   8         | xsltproc --novalid --nonet --html --stringparam topdir "$reltopdir" \
   9               "$base/html-munge.xsl" -
  10 }
  11
  12 ###########################################################################
  13
  14 # Build absolute, normalized pathname
  15 abspath()
  16 {
  17     case "$1" in
  18         /*) echo "$1" ;;
  19         *) echo "`pwd`/$1" ;;
  20     esac | sed \
  21         -e 's/\/\/*/\//g' \
  22         -e:a \
  23         -e 's/\/\.\(\/\|$\)/\1/g' \
  24         -eta \
  25         -e:b \
  26         -e 's/\/[^\/]*\/..\(\/\|$\)/\1/' \
  27         -etb \
  28         -e 's/^\(\/..\)*\(\/\|$\)/\2/' \
  29         -e 's/^$/\//'
  30 }
  31
  32 # Create relative path from absolute directory $1 to absolute path $2
  33 relpath()
  34 {
  35     local src="${1#/}"
  36     local dst="${2#/}"
  37     while true; do
  38         if [ -z "$src" -a -z "$dst" ]; then
  39             echo "Internal error in relpath()" 1>&2
  40             exit 1
  41         fi
  42         srcd="${src%%/*}"
  43         dstd="${dst%%/*}"
  44         if [ "$srcd" = "$dstd" ]; then
  45             src="${src#$srcd}"; src="${src#/}"
  46             dst="${dst#$dstd}"; dst="${dst#/}"
  47         else
  48             break
  49         fi
  50     done
  51     rel="`echo "$src" | sed -e "s/[^\/]*/../g"`/$dst" # `"
  52     echo "${rel%/}"
  53 }
  54
  55 # Log executed commands
  56 cmd()
  57 {
  58     echo "+" "$@"
  59     "$@"
  60 }
  61
  62 html_cleanup()
  63 {
  64     mv "$1" "${1}.orig"
  65     do_html_cleanup <"${1}.orig" >"$1"
  66 }
  67
  68 ###########################################################################
  69
  70 name="`basename "$0"`"; #`"
  71 base="`dirname "$0"`"; base="`cd "$base"; pwd`" #`"
  72
  73 TEMP=`getopt -n $name -o '' -l html,tagfile,tagfile-name:,tagfiles:,output-dir:,html-dir:  -- "$@"`
  74 if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
  75 eval set -- "$TEMP"
  76
  77 tagxsl="$base/tag-munge.xsl"
  78
  79 html="NO"; tagfile="NO"; tagfile_name=""; tagfiles=""; output_dir="doc"; html_dir="html"
  80
  81 while true; do
  82     case "$1" in
  83         --html)
  84             html="YES" ; shift ;;
  85         --tagfile)
  86             tagfile="YES" ; shift ;;
  87         --tagfile-name)
  88             tagfile_name="$2"; shift 2 ;;
  89         --tagfiles)
  90             for f in $2; do
  91                 f="`abspath "$f"`" #`"
  92                 tagfiles="$tagfiles${tagfiles:+ }$f"
  93             done
  94             shift 2
  95             ;;
  96         --output-dir)
  97             output_dir="$2"; shift 2 ;;
  98         --html-dir)
  99             html_dir="$2"; shift 2 ;;
 100         --)
 101             shift; break ;;
 102         *)
 103             echo "Internal error: $*"; exit 1 ;;
 104     esac
 105 done
 106
 107 if [ -z "$1" ]; then
 108     cat <<EOF
 109 Usage:
 110     $name
 111         [--html]
 112         [--tagfile]
 113         [--tagfile-name=<name>]
 114         [--tagfiles=<files>]
 115         [--output-dir=<dir>]
 116         [--html-dir=<dir>]
 117             <doxyfile-or-dir>
 118 EOF
 119     exit 1
 120 fi
 121
 122 if [ "$tagfile" = "YES" -a -z "$tagfile_name" ]; then
 123     echo "--tagfile-name is required with --tagfile"
 124     exit 1
 125 fi
 126
 127 doxydir="$1"
 128
 129 if [ -f "$doxydir" ]; then
 130     doxydir="`dirname "$doxydir"`" #`"
 131 fi
 132
 133 doxydir="`abspath "$doxydir"`" #`"
 134
 135 ###########################################################################
 136
 137 ## Find $TOPDIR
 138
 139 cd "$doxydir"
 140 while [ ! -r "SConstruct" -a "`pwd`" != "/" ]; do cd ..; done
 141 if [ ! -r "SConstruct" ]; then
 142     echo "topdir not found"
 143     exit 1;
 144 fi
 145 TOPDIR="`pwd`";
 146 reltopdir="`relpath "$doxydir/$output_dir/$html_dir" "$TOPDIR"`" #`"
 147 cd "$doxydir"
 148
 149
 150 ## Remove tagfile_name from list of tagfiles
 151
 152 if [ -n "$tagfile_name" ]; then
 153     tagfile_name="`abspath "$output_dir/$tagfile_name"`" #`"
 154     x="$tagfiles"; tagfiles=""
 155     for f in $x; do
 156         if [ "$f" != "$tagfile_name" ]; then
 157             tagfiles="$tagfiles${tagfiles:+ }$f"
 158         fi
 159     done
 160 fi
 161
 162 ## Call doxygen proper
 163
 164 generate_tagfile=""
 165 if [ "$tagfile" = "YES" ]; then
 166     generate_tagfile="$tagfile_name"
 167 fi
 168 export TOPDIR html tagfile tagfile_name tagfiles output_dir html_dir generate_tagfile
 169
 170 cmd ${DOXYGEN:-doxygen}
 171
 172
 173 ## Clean up tagfile, if generated
 174
 175 if [ "$tagfile" = "YES" ]; then
 176     mv "$tagfile_name" "${tagfile_name}.orig"
 177     cmd xsltproc --novalid --nonet -o "$tagfile_name" "$tagxsl" "${tagfile_name}.orig"
 178 fi
 179
 180
 181 ## Call installdox
 182
 183 if [ -n "$tagfiles" ]; then
 184     args=""
 185     for f in $tagfiles; do
 186         n="`basename "$f"`" #`"
 187         d="`dirname "$f"`" #`"
 188         url="`relpath "$doxydir/$output_dir/$html_dir" "$d/$html_dir"`" #`"
 189         args="$args${args:+ }-l $n@$url"
 190     done
 191
 192     (
 193         cd "./$output_dir/$html_dir"
 194         cmd "./installdox" $args
 195     )
 196 fi
 197
 198
 199 ## Postprocess html files, if generated
 200
 201 if [ "$html" = "YES" ]; then
 202     for h in "$doxydir/$output_dir/$html_dir"/*.html; do
 203         cmd html_cleanup "$h"
 204     done
 205 fi