From 6d80ae38e4bfa82323398ceba27f25f94072bf5f Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kde-common@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- admin/doxygen.sh | 883 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 883 insertions(+) create mode 100644 admin/doxygen.sh (limited to 'admin/doxygen.sh') diff --git a/admin/doxygen.sh b/admin/doxygen.sh new file mode 100644 index 0000000..3e233d7 --- /dev/null +++ b/admin/doxygen.sh @@ -0,0 +1,883 @@ +#! /bin/sh +# +# doxygen.sh Copyright (C) 2005 by Adriaan de Groot +# Based on some code from Doxyfile.am, among other things. +# License: GPL version 2. +# See file COPYING in kdelibs for details. + +echo "*** doxygen.sh" + +# Recurse handling is a little complicated, since normally +# subdir (given on the command-line) processing doesn't recurse +# but you can force it to do so. +recurse=1 +recurse_given=NO +use_modulename=1 +cleanup=YES + +while test -n "$1" ; do +case "x$1" in +"x--no-cleanup" ) + cleanup=NO + ;; +"x--no-recurse" ) + recurse=0 + recurse_given=YES + ;; +"x--recurse" ) + recurse=1 + recurse_given=YES + ;; +"x--no-modulename" ) + use_modulename=0 + ;; +"x--modulename" ) + use_modulename=1 + ;; +"x--help" ) + echo "doxygen.sh usage:" + echo "doxygen.sh [--no-recurse] [--no-modulename] []" + exit 2 + ;; +x--doxdatadir=* ) + DOXDATA=`echo $1 | sed -e 's+--doxdatadir=++'` + ;; +x--installdir=*) + PREFIX=`echo $1 | sed -e 's+--installdir=++'` + ;; +x--* ) + echo "Unknown option: $1" + exit 1 + ;; +* ) + top_srcdir="$1" + break + ;; +esac +shift +done + + +### Sanity check the mandatory "top srcdir" argument. +if test -z "$top_srcdir" ; then + echo "Usage: doxygen.sh " + exit 1 +fi +if test ! -d "$top_srcdir" ; then + echo "top_srcdir ($top_srcdir) is not a directory." + exit 1 +fi + +### Normalize top_srcdir so it is an absolute path. +if expr "x$top_srcdir" : "x/" > /dev/null ; then + # top_srcdir is absolute already + : +else + top_srcdir=`cd "$top_srcdir" 2> /dev/null && pwd` + if test ! -d "$top_srcdir" ; then + echo "top_srcdir ($top_srcdir) is not a directory." + exit 1 + fi +fi + + + +### Sanity check and guess QTDOCDIR. +if test -z "$QTDOCDIR" ; then + if test -z "$QTDIR" ; then + for i in /usr/X11R6/share/doc/qt/html + do + QTDOCDIR="$i" + test -d "$QTDOCDIR" && break + done + else + for i in share/doc/qt/html doc/html + do + QTDOCDIR="$QTDIR/$i" + test -d "$QTDOCDIR" && break + done + fi +fi +if test -z "$QTDOCDIR" || test ! -d "$QTDOCDIR" ; then + if test -z "$QTDOCDIR" ; then + echo "* QTDOCDIR could not be guessed." + else + echo "* QTDOCDIR does not name a directory." + fi + if test -z "$QTDOCTAG" ; then + echo "* QTDOCDIR set to \"\"" + QTDOCDIR="" + else + echo "* But I'll use $QTDOCDIR anyway because of QTDOCTAG." + fi +fi + +### Get the "top srcdir", also its name, and handle the case that subdir "." +### is given (which would be top_srcdir then, so it's equal to none-given +### but no recursion either). +### +# top_srcdir="$1" # Already set by options processing +module_name=`basename "$top_srcdir"` +subdir="$2" +if test "x." = "x$subdir" ; then + subdir="" + if test "x$recurse_given" = "xNO" ; then + recurse=0 + fi +fi +if test "x" != "x$subdir" ; then + # If no recurse option given explicitly, default to + # no recurse when processing subdirs given on the command-line. + if test "x$recurse_given" = "xNO" ; then + recurse=0 + fi +fi + +if test -z "$DOXDATA" || test ! -d "$DOXDATA" ; then + if test -n "$DOXDATA" ; then + echo "* \$DOXDATA is '$DOXDATA' which does not name a directory" + fi + DOXDATA="$top_srcdir/doc/common" +fi + +if test ! -d "$DOXDATA" ; then + echo "* \$DOXDATA does not name a directory ( or is unset ), tried \"$DOXDATA\"" + exit 1 +fi + +if test -n "$PREFIX" && test ! -d "$PREFIX" ; then + echo "* \$PREFIX does not name a directory, tried \"$PREFIX\"" + echo "* \$PREFIX is disabled." + PREFIX="" +fi + +### We need some values from top-level files, which +### are not preserved between invocations of this +### script, so factor it out for easy use. +create_doxyfile_in() +{ + eval `grep 'VERSION="' "$top_srcdir/admin/cvs.sh"` + echo "PROJECT_NUMBER = $VERSION" > Doxyfile.in + grep '^KDE_INIT_DOXYGEN' "$top_srcdir/configure.in.in" | \ + sed -e 's+[^[]*\[\([^]]*\)+PROJECT_NAME = "\1"+' \ + -e 's+].*++' >> Doxyfile.in +} + +apidoxdir="$module_name"-apidocs +test "x$use_modulename" = "x0" && apidoxdir="apidocs" + +### If we're making the top subdir, create the structure +### for the apidox and initialize it. Otherwise, just use the +### structure assumed to be there. +if test -z "$subdir" ; then + if test ! -d "$apidoxdir" ; then + mkdir "$apidoxdir" > /dev/null 2>&1 + fi + cd "$apidoxdir" > /dev/null 2>&1 || { + echo "Cannot create and cd into $apidoxdir" + exit 1 + } + + test -f "Doxyfile.in" || create_doxyfile_in + + # Copy in logos and the like + for i in "favicon.ico" "kde_gear_64.png" + do + cp "$DOXDATA/$i" . > /dev/null 2> /dev/null + done + for i in "$top_srcdir/doc/api/Dox-"*.png + do + T=`basename "$i" | sed -e 's+Dox-++'` + test -f "$i" && cp "$i" "./$T" > /dev/null 2> /dev/null + done + + top_builddir="." + srcdir="$1" + subdir="." +else + cd "$apidoxdir" > /dev/null 2>&1 || { + echo "Cannot cd into $apidoxdir -- maybe you need to" + echo "build the top-level dox first." + exit 1 + } + + if test "x1" = "x$recurse" ; then + # OK, so --recurse was requested + if test ! -f "subdirs.top" ; then + echo "* No subdirs.top available in the $apidoxdir." + echo "* The --recurse option will be ignored." + recurse=0 + fi + fi +fi + +### Read a single line (TODO: support \ continuations) from the Makefile.am. +### Used to extract variable assignments from it. +extract_line() +{ + file="$2" ; test -z "$file" && file="$srcdir/Makefile.am" + pattern=`echo "$1" | tr + .` + grep "^$1" "$file" | \ + sed -e "s+$pattern.*=\s*++" +} + +### Handle the COMPILE_{FIRST,LAST,BEFORE,AFTER} part of Makefile.am +### in the toplevel. Copied from admin/cvs.sh. Licence presumed LGPL). +create_subdirs() +{ +echo "* Sorting top-level subdirs" +dirs= +idirs= +if test -f "$top_srcdir/inst-apps"; then + idirs=`cat "$top_srcdir/"inst-apps` +else + idirs=`cd "$top_srcdir" && ls -1 | sort` +fi + +compilefirst="" +compilelast="" +if test -f "$top_srcdir/"Makefile.am.in ; then + compilefirst=`sed -ne 's#^COMPILE_FIRST[ ]*=[ ]*##p' "$top_srcdir/"Makefile.am.in | head -n 1` + compilelast=`sed -ne 's#^COMPILE_LAST[ ]*=[ ]*##p' "$top_srcdir/"Makefile.am.in | head -n 1` +fi +for i in $idirs; do + if test -f "$top_srcdir/$i"/Makefile.am; then + case " $compilefirst $compilelast " in + *" $i "*) ;; + *) dirs="$dirs $i" + esac + fi +done + +: > ./_SUBDIRS + +for d in $compilefirst; do + echo $d >> ./_SUBDIRS +done + +(for d in $dirs; do + list="" + if test -f "$top_srcdir/"Makefile.am.in ; then + list=`sed -ne "s#^COMPILE_BEFORE_$d""[ ]*=[ ]*##p" "$top_srcdir/"Makefile.am.in | head -n 1` + fi + for s in $list; do + echo $s $d + done + list="" + if test -f "$top_srcdir/"Makefile.am.in ; then + list=`sed -ne "s#^COMPILE_AFTER_$d""[ ]*=[ ]*##p" "$top_srcdir/"Makefile.am.in | head -n 1` + fi + for s in $list; do + echo $d $s + done + echo $d $d +done ) | tsort >> ./_SUBDIRS + +for d in $compilelast; do + echo $d >> ./_SUBDIRS +done + +test -r _SUBDIRS && mv _SUBDIRS subdirs.top || true +} + + +### Add HTML header, footer, CSS tags to Doxyfile. +### Assumes $subdir is set. Argument is a string +### to stick in front of the file if needed. +apidox_htmlfiles() +{ + dox_header="$top_srcdir/doc/api/$1header.html" + dox_footer="$top_srcdir/doc/api/$1footer.html" + dox_css="$top_srcdir/doc/api/doxygen.css" + test -f "$dox_header" || dox_header="$DOXDATA/$1header.html" + test -f "$dox_footer" || dox_footer="$DOXDATA/$1footer.html" + test -f "$dox_css" || dox_css="$DOXDATA/doxygen.css" + + echo "HTML_HEADER = $dox_header" >> "$subdir/Doxyfile" ; \ + echo "HTML_FOOTER = $dox_footer" >> "$subdir/Doxyfile" ; \ + echo "HTML_STYLESHEET = $dox_css" >> "$subdir/Doxyfile" +} + +apidox_specials() +{ + line=`extract_line DOXYGEN_PROJECTNAME "$1"` + test -n "$line" && echo "PROJECT_NAME = \"$line\"" >> "$2" +} + +apidox_local() +{ + for i in "$top_srcdir/doc/api/Doxyfile.local" + do + if test -f "$i" ; then + cat "$i" >> "$subdir/Doxyfile" + break + fi + done +} + +### Post-process HTML files by substituting in the menu files +# +# In non-top directories, both and +# are calculated and replaced. Top directories get an empty +# if any. +doxyndex() +{ + # Special case top-level to have an empty MENU. + if test "x$subdir" = "x." ; then + MENU="" + htmldir="." + htmltop="$top_builddir" # Just ., presumably + echo "* Post-processing top-level files" + else + MENU="
    " + htmldir="$subdir/html" + htmltop="$top_builddir.." # top_builddir ends with / + echo "* Post-processing files in $htmldir" + + # Build a little PHP file that maps class names to file + # names, for the quick-class-picker functionality. + # (The quick-class-picker is disabled due to styling + # problems in IE & FF). + ( + echo ",g" -e "s+_00+,+g" -e "s+_3+<+g" | tr "[A-Z]" "[a-z]"` + echo " \"$classname\" => \"$htmlfile\"," + done | sort ; \ + echo ") ?>" + ) > "$subdir/classmap.inc" + + # This is a list of pairs, with / separators so we can use + # basename and dirname (a crude shell hack) to split them + # into parts. For each, if the file part exists (as a html + # file) tack it onto the MENU variable as a
  • with link. + for i in "Main Page/index" \ + "Modules/modules" \ + "Namespace List/namespaces" \ + "Class Hierarchy/hierarchy" \ + "Alphabetical List/classes" \ + "Class List/annotated" \ + "File List/files" \ + "Directories/dirs" \ + "Namespace Members/namespacemembers" \ + "Class Members/functions" \ + "Related Pages/pages" + do + NAME=`dirname "$i"` + FILE=`basename "$i"` + test -f "$htmldir/$FILE.html" && MENU="$MENU
  • $NAME
  • " + done + + MENU="$MENU
" + fi + + + # Get the list of global Menu entries. + GMENU=`cat subdirs | tr -d '\n'` + + PMENU=`grep '++' | awk '{ c=split($0,a,"/"); for (j=1; j<=c; j++) { printf " / %s\n" , a[j]; } }' | tr -d '\n'` + + # Map the PHP file into HTML options so that + # it can be substituted in for the quick-class-picker. + CMENU="" + # For now, leave the CMENU disabled + CMENUBEGIN="" + + if test "x$subdir" = "x." ; then + # Disable CMENU on toplevel anyway + CMENUBEGIN="" + else + test -f "$subdir/classmap.inc" && \ + CMENU=`grep '=>' "$subdir/classmap.inc" | sed -e 's+"\([^"]*\)" => "'"$subdir/html/"'\([^"]*\)"+