scripts/doxygen-help.sh

   1 #!/bin/sh
   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 ## @file
  23 ## @brief 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 ##
  31 ## The environment variable PROJECT must be set to the value used
  32 ## when creating the Doxygen files.
  33 ##
  34 ## Set a hot key in the code editor to call this script with
  35 ## the highlighted variable or function name as a parameter.
  36 ##
  37 ## The file $DOCDIR/$PROJECT.tag contains an index of all documented
  38 ## items and is scanned to locate the relevant html section.
  39 ##
  40 ## xdg-open is used to call the html browser to display the document.
  41 ##
  42 ##  **********************************************************************
  43 ##
  44 ## To generate the Doxygen html files run 'doxygen.sh'
  45 ##
  46
  47 if [ -z "${DOCDIR}" ]
  48 then
  49         printf '%s\n' "Environment variable DOCDIR not set"
  50         zenity --title="Geeqie" --width=200 --warning --text="Environment variable DOCDIR not set"
  51 elif [ -z "${PROJECT}" ]
  52 then
  53         printf '%s\n' "Environment variable PROJECT not set"
  54         zenity --title="Geeqie" --width=200 --warning --text="Environment variable PROJECT not set"
  55 else
  56         url_found=$(awk  -v search_param="$1" -v docdir="$DOCDIR" '
  57                 {
  58                 if ($1 == "<name>_"search_param"</name>")
  59                         {
  60                         getline
  61                         n=split($1, anchorfile, /[<>]/)
  62
  63                         getline
  64                         n=split($1, anchor, /[<>]/)
  65                         struct_result="file://"docdir"/html/" anchorfile[3] "#" anchor[3]
  66                         }
  67                 else
  68                         {
  69                         if ($1 == "<name>"search_param"</name>")
  70                                 {
  71                                 getline
  72                                 n=split($1, anchorfile, /[<>]/)
  73
  74                                 getline
  75                                 n=split($1, anchor, /[<>]/)
  76                                 function_result="file://"docdir"/html/" anchorfile[3] "#" anchor[3]
  77                                 }
  78                         }
  79                 }
  80                 END {
  81                         if (struct_result != "")
  82                                 {
  83                                 print struct_result
  84                                 }
  85                         else if (function_result != "")
  86                                 {
  87                                 print function_result
  88                                 }
  89                         }
  90                 ' "$DOCDIR"/"$PROJECT".tag)
  91
  92         if [ -z "$url_found" ]
  93         then
  94                 exit 1
  95         else
  96                 xdg-open "$url_found"
  97                 exit 0
  98         fi
  99 fi