scripts/doxygen-help.sh

   1 #!/bin/bash
   2
   3 #**********************************************************************
   4 # Copyright (C) 2021 - The Geeqie Team
   5 #
   6 # Author: Colin Clark
   7 #
   8 # This program is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 2 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License along
  19 # with this program; if not, write to the Free Software Foundation, Inc.,
  20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21 #**********************************************************************
  22 #
  23 # Facilitate the integration of the Doxygen html files
  24 # into a code editor.
  25 #
  26 # doxygen-help.sh <parameter to be searched for>
  27 #
  28 # The environment variable DOCDIR must be set to point to the
  29 # Doxygen html files location.
  30 # The environment variable PROJECT must be set to the value used
  31 # when creating the Doxygen files.
  32 #
  33 # Set a hot key in the code editor to call this script with
  34 # the highlighted variable or function name as a parameter.
  35 #
  36 # The file $DOCDIR/$PROJECT.tag contains an index of all documented
  37 # items and is scanned to locate the relevant html section.
  38 #
  39 # xdg-open is used to call the html browser to display the document.
  40 #
  41 #**********************************************************************
  42 #
  43 # To generate the Doxygen html files set the following
  44 # environment variables:
  45 # DOCDIR (destination folder)
  46 # SRCDIR (must point to the level above the source code)
  47 # PROJECT
  48 # VERSION
  49 #
  50 # Then run 'doxygen doxygen.conf'
  51
  52 if [[ -z "${DOCDIR}" ]]
  53 then
  54         echo "Environment variable DOCDIR not set"
  55         zenity --title="Geeqie" --width=200 --warning --text="Environment variable DOCDIR not set"
  56 elif [[ -z "${PROJECT}" ]]
  57 then
  58         echo "Environment variable PROJECT not set"
  59         zenity --title="Geeqie" --width=200 --warning --text="Environment variable PROJECT not set"
  60 else
  61         url_found=$(awk  -v search_param="$1" -v docdir="$DOCDIR" '
  62                 {
  63                 if ($1 == "<name>_"search_param"</name>")
  64                         {
  65                         getline
  66                         n=split($1, anchorfile, /[<>]/)
  67
  68                         getline
  69                         n=split($1, anchor, /[<>]/)
  70                         struct_result="file://"docdir"/html/" anchorfile[3] "#" anchor[3]
  71                         }
  72                 else
  73                         {
  74                         if ($1 == "<name>"search_param"</name>")
  75                                 {
  76                                 getline
  77                                 n=split($1, anchorfile, /[<>]/)
  78
  79                                 getline
  80                                 n=split($1, anchor, /[<>]/)
  81                                 function_result="file://"docdir"/html/" anchorfile[3] "#" anchor[3]
  82                                 }
  83                         }
  84                 }
  85                 END {
  86                         if (struct_result != "")
  87                                 {
  88                                 print struct_result
  89                                 }
  90                         else if (function_result != "")
  91                                 {
  92                                 print function_result
  93                                 }
  94                         }
  95                 ' "$DOCDIR"/"$PROJECT".tag)
  96
  97         if [[ -z $url_found ]]
  98         then
  99                 exit 1
 100         else
 101                 xdg-open "$url_found"
 102                 exit 0
 103         fi
 104 fi