doc/create-doxygen-lua-api.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 # This script will create the Lua API html document, which is part of
  24 # the Geeqie Help file.
  25 #
  26 # It is run during the generation of the help files.
  27 #
  28 # The generated Lua html files are placed in doc/html/lua-api
  29 #
  30 # The doxygen.conf file is modified to extract only those comments
  31 # that are useful as part of an API description.
  32 #
  33 #**********************************************************************
  34
  35 export PROJECT="Geeqie"
  36 export VERSION=$(git tag --list v[1-9]* | tail -1)
  37 export SRCDIR="$PWD/.."
  38 export DOCDIR="$PWD/html/lua-api"
  39
  40 TMPFILE=$(mktemp) || exit 1
  41
  42 # Modify the Geeqie doxygen.conf file to produce
  43 # only the data needed for the lua API document
  44 awk '
  45 BEGIN {
  46         FILE_PATTERNS_found = "FALSE"
  47 }
  48 {
  49         if (FILE_PATTERNS_found == "TRUE")
  50                 {
  51                 if ($0 ~ /\\/)
  52                         {
  53                         next
  54                         }
  55                 else
  56                         {
  57                         FILE_PATTERNS_found = "FALSE"
  58                         }
  59                 }
  60         if ($1 == SHOW_INCLUDE_FILES)
  61                 {
  62                 {print "SHOW_INCLUDE_FILES = NO"}
  63                 }
  64         else if ($1 == "FILE_PATTERNS")
  65                 {
  66                 print "FILE_PATTERNS = lua.c"
  67                 FILE_PATTERNS_found = "TRUE"
  68                 next
  69                 }
  70         else if ($1 == "EXCLUDE_SYMBOLS")
  71                 {
  72                 print "EXCLUDE_SYMBOLS = L \\"
  73                 print "lua_callvalue \\"
  74                 print "lua_check_exif \\"
  75                 print "lua_check_image \\"
  76                 print "lua_init \\"
  77                 print "_XOPEN_SOURCE \\"
  78                 print "LUA_register_global \\"
  79                 print "LUA_register_meta"
  80                 }
  81         else if ($1 == "SOURCE_BROWSER")
  82                 {
  83                 print "SOURCE_BROWSER = NO"
  84                 }
  85         else if ($1 == "HAVE_DOT")
  86                 {
  87                 {print "HAVE_DOT = NO"}
  88                 }
  89         else
  90                 {
  91                 {print}
  92                 }
  93 }
  94 ' ../doxygen.conf > $TMPFILE
  95
  96 doxygen $TMPFILE
  97
  98 rm $TMPFILE
  99