--- /dev/null
+#!/bin/bash
+
+#**********************************************************************
+# Copyright (C) 2021 - The Geeqie Team
+#
+# Author: Colin Clark
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#**********************************************************************
+#
+# This script will create the Lua API html document, which is part of
+# the Geeqie Help file.
+#
+# It is run during the generation of the help files.
+#
+# The generated Lua html files are placed in doc/html/lua-api
+#
+# The doxygen.conf file is modified to extract only those comments
+# that are useful as part of an API description.
+#
+#**********************************************************************
+
+export PROJECT="Geeqie"
+export VERSION=$(git tag --list v[1-9]* | tail -1)
+export SRCDIR="$PWD/.."
+export DOCDIR="$PWD/html/lua-api"
+
+TMPFILE=$(mktemp) || exit 1
+
+# Modify the Geeqie doxygen.conf file to produce
+# only the data needed for the lua API document
+awk '
+BEGIN {
+ FILE_PATTERNS_found = "FALSE"
+}
+{
+ if (FILE_PATTERNS_found == "TRUE")
+ {
+ if ($0 ~ /\\/)
+ {
+ next
+ }
+ else
+ {
+ FILE_PATTERNS_found = "FALSE"
+ }
+ }
+ if ($1 == SHOW_INCLUDE_FILES)
+ {
+ {print "SHOW_INCLUDE_FILES = NO"}
+ }
+ else if ($1 == "FILE_PATTERNS")
+ {
+ print "FILE_PATTERNS = lua.c"
+ FILE_PATTERNS_found = "TRUE"
+ next
+ }
+ else if ($1 == "EXCLUDE_SYMBOLS")
+ {
+ print "EXCLUDE_SYMBOLS = L \\"
+ print "lua_callvalue \\"
+ print "lua_check_exif \\"
+ print "lua_check_image \\"
+ print "lua_init \\"
+ print "_XOPEN_SOURCE \\"
+ print "LUA_register_global \\"
+ print "LUA_register_meta"
+ }
+ else if ($1 == "SOURCE_BROWSER")
+ {
+ print "SOURCE_BROWSER = NO"
+ }
+ else if ($1 == "HAVE_DOT")
+ {
+ {print "HAVE_DOT = NO"}
+ }
+ else
+ {
+ {print}
+ }
+}
+' ../doxygen.conf > $TMPFILE
+
+doxygen $TMPFILE
+
+rm $TMPFILE
+
#include "ui_fileops.h"
#include "exif.h"
+/**
+ * @file
+ * User API consists of the following namespaces:
+ *
+ * @link image_methods Image:@endlink basic image information
+ *
+ * <b>Collection</b>: not implemented
+ *
+ * @link exif_methods <exif-structure>:get_datum() @endlink get single exif parameter
+ *
+ */
+
static lua_State *L; /** The LUA object needed for all operations (NOTE: That is
* a upper-case variable to match the documentation!) */
return *fd;
}
+/**
+ * @brief Get exif structure of selected image
+ * @param L
+ * @returns An @ref ExifData data structure containing the entire exif data
+ *
+ * To be used in conjunction with @link lua_exif_get_datum <exif-structure>:get_datum() @endlink
+ */
static int lua_image_get_exif(lua_State *L)
{
FileData *fd;
return 1;
}
+/**
+ * @brief Get full path of selected image
+ * @param L
+ * @returns char The full path of the file, including filename and extension
+ *
+ *
+ */
static int lua_image_get_path(lua_State *L)
{
FileData *fd;
return 1;
}
+/**
+ * @brief Get full filename of selected image
+ * @param L
+ * @returns char The full filename including extension
+ *
+ *
+ */
static int lua_image_get_name(lua_State *L)
{
FileData *fd;
return 1;
}
+/**
+ * @brief Get file extension of selected image
+ * @param L
+ * @returns char The file extension including preceding dot
+ *
+ *
+ */
static int lua_image_get_extension(lua_State *L)
{
FileData *fd;
return 1;
}
+/**
+ * @brief Get file date of selected image
+ * @param L
+ * @returns time_t The file date in Unix timestamp format.
+ *
+ * time_t - signed integer which represents the number of seconds since
+ * the start of the Unix epoch: midnight UTC of January 1, 1970
+ */
static int lua_image_get_date(lua_State *L)
{
FileData *fd;
return 1;
}
+/**
+ * @brief Get file size of selected image
+ * @param L
+ * @returns integer The file size in bytes
+ *
+ *
+ */
static int lua_image_get_size(lua_State *L)
{
FileData *fd;
return 1;
}
+/**
+ * @brief Get marks of selected image
+ * @param L
+ * @returns unsigned integer Bit map of marks set
+ *
+ * Bit 0 == Mark 1 etc.
+ *
+ *
+ */
static int lua_image_get_marks(lua_State *L)
{
FileData *fd;
return *exif;
}
-/* Interface for EXIF data */
+/**
+ * @brief Interface for EXIF data
+ * @param L
+ * @returns <i>return</i> A single exif tag extracted from a structure output by the @link lua_image_get_exif Image:get_exif() @endlink command
+ *
+ * e.g. \n
+ * exif_structure = Image:get_exif(); \n
+ * DateTimeDigitized = exif_structure:get_datum("Exif.Photo.DateTimeDigitized");
+ *
+ * Where <i>return</i> is: \n
+ * Exif.Photo.DateTimeOriginal = signed integer time_t \n
+ * Exif.Photo.DateTimeDigitized = signed integer time_t \n
+ * otherwise char
+ *
+ */
static int lua_exif_get_datum(lua_State *L)
{
const gchar *key;
return 1;
}
+/**
+ * @brief <b>Image:</b> metatable and methods \n
+ * Call by e.g. \n
+ * path_name = @link lua_image_get_path Image:getpath() @endlink \n
+ * where the keyword <b>Image</b> represents the currently selected image
+ */
+static const luaL_Reg image_methods[] = {
+ {"get_path", lua_image_get_path},
+ {"get_name", lua_image_get_name},
+ {"get_extension", lua_image_get_extension},
+ {"get_date", lua_image_get_date},
+ {"get_size", lua_image_get_size},
+ {"get_exif", lua_image_get_exif},
+ {"get_marks", lua_image_get_marks},
+ {NULL, NULL}
+};
+
+/**
+ * @brief <b>exif:</b> table and methods \n
+ * Call by e.g. \n
+ * @link lua_exif_get_datum <exif-structure>:get_datum() @endlink \n
+ * where <exif-structure> is the output of @link lua_image_get_exif Image:get_exif() @endlink
+ *
+ * exif_structure = Image:get_exif(); \n
+ * DateTimeDigitized = exif_structure:get_datum("Exif.Photo.DateTimeDigitized");
+ */
+static const luaL_Reg exif_methods[] = {
+ {"get_datum", lua_exif_get_datum},
+ {NULL, NULL}
+};
+
/**
* @brief Initialize the lua interpreter.
*/
{NULL, NULL}
};
- /* The Image metatable and methodes */
- static const luaL_Reg image_methods[] = {
- {"get_path", lua_image_get_path},
- {"get_name", lua_image_get_name},
- {"get_extension", lua_image_get_extension},
- {"get_date", lua_image_get_date},
- {"get_size", lua_image_get_size},
- {"get_exif", lua_image_get_exif},
- {"get_marks", lua_image_get_marks},
- {NULL, NULL}
- };
LUA_register_global(L, "Image", image_methods);
luaL_newmetatable(L, "Image");
LUA_register_meta(L, meta_methods);
lua_pop(L, 1);
lua_pop(L, 1);
- /* The Exif table and methodes */
- static const luaL_Reg exif_methods[] = {
- {"get_datum", lua_exif_get_datum},
- {NULL, NULL}
- };
LUA_register_global(L, "Exif", exif_methods);
luaL_newmetatable(L, "Exif");
LUA_register_meta(L, meta_methods);
projects / geeqie.git / commitdiff