solenv/bin/mkdocs.sh

   1 #!/usr/bin/env bash
   2 #
   3 # This file is part of the LibreOffice project.
   4 #
   5 # This Source Code Form is subject to the terms of the Mozilla Public
   6 # License, v. 2.0. If a copy of the MPL was not distributed with this
   7 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8 #
   9 # Doxygen / README doc generation
  10 #
  11 # See git for contributors
  12 #
  13
  14 function header {
  15   title=$1
  16   breadcrumb=$2
  17   output=$3
  18
  19   cat - > $output <<EOF
  20 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
  21 <html>
  22 <head>
  23         <title>$title</title>
  24
  25         <style>
  26         * { margin: 0; padding: 0; }
  27         body { font-family: sans-serif; font-size: 12px; }
  28         #head { padding: 20px; background: #00A500; }
  29         #head a { color: #000; }
  30         #body { padding: 20px; }
  31         #foot { padding: 10px; font-size: 9px; border-top: 1px #18A303 solid; margin-top: 25px; }
  32         p { line-height: 1.7em; margin-bottom: 1em; }
  33         pre { margin-bottom: 0.5em; }
  34         .multi-col { -moz-column-width: 20em; -webkit-column-width: 20em; -moz-column-gap: 1em; -webkit-column-gap: 1em; }
  35         h1 { margin-bottom: 0.5em; }
  36         h2,h3,h4 { margin: 1.3em 0 0.5em 0; }
  37         ul, ol { margin: 0.5em 1.5em; }
  38         </style>
  39 </head>
  40 <body>
  41         <div id="head">
  42         <h1>$title</h1>
  43         <p>$breadcrumb</p>
  44         </div>
  45         <div id="body" style="multi-col">
  46 EOF
  47 }
  48
  49 function footer {
  50   output=$1
  51
  52   cat - >> $output <<EOF
  53
  54 </div>
  55 <div id="foot">
  56   <small>
  57     <p>Generated by Libreoffice <a href="http://cgit.freedesktop.org/libreoffice/core/plain/solenv/bin/mkdocs.sh">Module Description Tool</a></p>
  58     <p>Last updated:
  59 EOF
  60 LANG= date >> $output
  61 cat - >> $output <<EOF
  62     </p>
  63   </small>
  64 </div>
  65 </body>
  66 </html>
  67 EOF
  68
  69 }
  70
  71 function proc_text {
  72   # Local links: [[...]]
  73   # Git links: [git:...]
  74   # Other remote links: [...]
  75   # Headings: == bleh ==
  76   # Paragraphs: \n\n
  77   sed -re ' s/\[\[([-_a-zA-Z0-9]+)\]\]/<a href="\1.html">\1<\/a>/g' - \
  78   | sed -re ' s/\[git:([^]]+)\]/<a href="http:\/\/cgit.freedesktop.org\/libreoffice\/core\/tree\/\1">\1<\/a>/g' \
  79   | sed -re ' s/\[([^]]+)\]/<a href="\1">\1<\/a>/g' \
  80   | sed -re ' s/====([^=]+)====/<h4>\1<\/h4>/g' \
  81   | sed -re ' s/===([^=]+)===/<h3>\1<\/h3>/g' \
  82   | sed -re ' s/==([^=]+)==/<h2>\1<\/h2>/g' \
  83   | sed -re ':a;N;$!ba;s/\n\n/<\/p><p>/g' \
  84   | awk 'BEGIN { print "<p>" } { print } END { print "</p>" }'
  85 }
  86
  87 function setup {
  88   parm=$1
  89   if [ -z "${!parm}" ] ; then
  90     echo "grep \"${parm}=\" ./config_host.mk | sed -re \" s/${parm}=//\")"
  91     echo "$parm=$(grep \"${parm}=\" ./config_host.mk | sed -re \" s/${parm}=//\")"
  92     eval "$parm=$(grep \"${parm}=\" ./config_host.mk | sed -re \" s/${parm}=//\")"
  93   fi
  94   if [ -z "${!parm}" ] ; then
  95     echo "could not determine $parm" >&2
  96     exit 1
  97   fi
  98 }
  99
 100 # binaries that we need
 101 which doxygen > /dev/null 2>&1 || {
 102     echo "You need doxygen for doc generation" >&2
 103     exit 1
 104 }
 105 which dot > /dev/null 2>&1 || {
 106     echo "You need the graphviz tools to create the nice inheritance graphs" >&2
 107     exit 1
 108 }
 109
 110 # suck setup
 111 setup "SOLARINC"
 112 shopt -s nullglob
 113
 114 # Title of the documentation
 115 DOXYGEN_PROJECT_PREFIX="LibreOffice"
 116
 117 # get list of modules
 118 if [ -z "$INPUT_PROJECTS" ]; then
 119     INPUT_PROJECTS="`ls */Module_*.mk | sed 's#/.*##'`"
 120 fi
 121
 122
 123 # output directory for generated documentation
 124 BASE_OUTPUT="$1"
 125 mkdir -p "$BASE_OUTPUT" || {
 126     echo "Cannot create $BASE_OUTPUT"
 127     exit 1
 128 }
 129
 130 # paths for binary and configuration file
 131 BASE_PATH=`pwd`
 132 DOXYGEN_CFG="$2"
 133 if test ! -f "$DOXYGEN_CFG"; then
 134     echo "doxygen.cfg not found"
 135     exit 1
 136 fi
 137
 138 # strip -I. and bin -I prefix; exlude system headers
 139 DOXYGEN_INCLUDE_PATH=`echo $SOLARINC | sed -e 's/-I\.//g' -e 's/ -I/ /'g -e 's/ -isystem/ /g' -e 's|/usr/[^ ]*| |g'`
 140
 141 # setup version string
 142 DOXYGEN_VERSION="master"
 143
 144
 145 ###################################################
 146 #
 147 # Generate docs
 148 #
 149 ###################################################
 150
 151 # cleanup
 152 echo "cleaning up" && rm -rf $BASE_OUTPUT/*
 153
 154 # make the stuff world-readable
 155 umask 022
 156
 157 # generate docs
 158 echo "generating doxygen docs"
 159 DOXYGEN_REF_TAGFILES=""
 160 for PROJECT in $INPUT_PROJECTS;
 161 do
 162   # avoid processing of full project subdirs, only add source and inc
 163
 164   # project header files can be in $PROJECT/inc and/pr include/$PROJECT
 165   if [ -d "$PROJECT/inc" ]; then
 166       PROJECT_INCLUDE="$PROJECT/inc"
 167   else
 168       PROJECT_INCLUDE=""
 169   fi
 170
 171   if [ -d "include/$PROJECT" ]; then
 172       PROJECT_INCLUDE="$PROJECT_INCLUDE include/$PROJECT"
 173   fi
 174
 175   DOXYGEN_INPUT=`printf "%s" "$PROJECT/source $PROJECT_INCLUDE"`
 176
 177   DOXYGEN_OUTPUT="$BASE_OUTPUT/$PROJECT"
 178   DOXYGEN_OUR_TAGFILE="$DOXYGEN_OUTPUT/$PROJECT.tags"
 179   DOXYGEN_PROJECTNAME="$DOXYGEN_PROJECT_PREFIX Module $PROJECT"
 180
 181   # export variables referenced in doxygen config file
 182   export DOXYGEN_INPUT
 183   export DOXYGEN_OUTPUT
 184   export DOXYGEN_INCLUDE_PATH
 185   export DOXYGEN_VERSION
 186   export DOXYGEN_OUR_TAGFILE
 187   export DOXYGEN_REF_TAGFILES
 188   export DOXYGEN_PROJECTNAME
 189
 190   # debug
 191   echo "Calling $DOXYGEN_PATH/doxygen $DOXYGEN_CFG with"
 192   echo "Input:      $DOXYGEN_INPUT"
 193   echo "Output:     $DOXYGEN_OUTPUT"
 194   echo "Include:    $DOXYGEN_INCLUDE_PATH"
 195   echo "Version:    $DOXYGEN_VERSION"
 196   echo "Tagfile:    $DOXYGEN_OUR_TAGFILE"
 197   echo "Ref-Tags:   $DOXYGEN_REF_TAGFILES"
 198   echo "Title:      $DOXYGEN_PROJECTNAME"
 199
 200   nice -15 doxygen "$DOXYGEN_CFG" >>$BASE_OUTPUT/doxygen.log 2>&1 || exit 1
 201
 202   # setup referenced tagfiles for next round
 203   DOXYGEN_REF_TAGFILES="$DOXYGEN_REF_TAGFILES $DOXYGEN_OUR_TAGFILE=$BASE_URL/$PROJECT/html"
 204 done
 205
 206 # generate entry page
 207 echo "generating index page"
 208 header "LibreOffice Modules" " " "$BASE_OUTPUT/index.html"
 209 for module_name in *; do
 210   if [ -d $module_name ]; then
 211     cur_file=$(echo $module_name/README* $module_name/readme.txt*)
 212         if [ -f "$cur_file" ]; then
 213       # write index.html entry
 214       text="<h2><a href=\"${module_name}.html\">${module_name}</a></h2>\n"
 215           text="${text}$(head -n1 $cur_file | proc_text )"
 216           echo -e $text >> "$BASE_OUTPUT/index.html"
 217
 218       # write detailed module content
 219       header "$module_name" "<a href=\"index.html\">LibreOffice</a> &raquo; ${module_name}" "$BASE_OUTPUT/${module_name}.html"
 220       text="<p><b>View module in:</b>"
 221           text="${text} &nbsp; <a href=\"http://cgit.freedesktop.org/libreoffice/core/tree/${module_name}\">cgit</a>"
 222       if $(echo $INPUT_PROJECTS | grep -q $module_name); then
 223         text="${text} &nbsp; <a href=\"${module_name}/html/classes.html\">Doxygen</a>"
 224       fi
 225       text="${text} </p><p>&nbsp;</p>"
 226           echo -e $text >> "$BASE_OUTPUT/${module_name}.html"
 227           proc_text < $cur_file >> "$BASE_OUTPUT/${module_name}.html"
 228           footer "$BASE_OUTPUT/${module_name}.html"
 229     else
 230       empty_modules[${#empty_modules[*]}]=$module_name
 231         fi
 232   fi
 233 done
 234 if [ ${#empty_modules[*]} -gt 0 ]; then
 235   echo -e "<p>&nbsp;</p><p>READMEs were not available for these modules:</p><ul>\n" >> "$BASE_OUTPUT/index.html"
 236   for module_name in "${empty_modules[@]}"; do
 237     echo -e "<li><a href=\"http://cgit.freedesktop.org/libreoffice/core/tree/${module_name}\">${module_name}</a></li>\n" >> "$BASE_OUTPUT/index.html"
 238   done
 239   echo -e "</ul>\n" >> "$BASE_OUTPUT/index.html"
 240 fi
 241
 242 footer "$BASE_OUTPUT/index.html"
 243
 244 ## done