Fix #314: Remote commands for thumbnail maintenance
[geeqie.git] / src / ui_fileops.h
index 2ba463c..8f30502 100644 (file)
@@ -1,20 +1,28 @@
 /*
- * (SLIK) SimpLIstic sKin functions
- * (C) 2004 John Ellis
- * Copyright (C) 2008 The Geeqie Team
+ * Copyright (C) 2004 John Ellis
+ * Copyright (C) 2008 - 2016 The Geeqie Team
  *
  * Author: John Ellis
  *
- * This software is released under the GNU General Public License (GNU GPL).
- * Please read the included file COPYING for more information.
- * This software comes with no warranty of any kind, use at your own risk!
+ * 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.
  */
 
-
 #ifndef UI_FILEOPS_H
 #define UI_FILEOPS_H
 
-
+#include "config.h"
 #include <sys/stat.h>
 #include <sys/time.h>
 #include <sys/types.h>
@@ -31,55 +39,75 @@ void print_term(const gchar *text_utf8);
                g_free(msg); \
        } while (0)
 
+#if GQ_DEBUG_PATH_UTF8
+#define path_to_utf8(path) path_to_utf8_debug(path, __FILE__, __LINE__)
+#define path_from_utf8(utf8) path_from_utf8_debug(utf8, __FILE__, __LINE__)
+gchar *path_to_utf8_debug(const gchar *path, const gchar *file, gint line);
+gchar *path_from_utf8_debug(const gchar *utf8, const gchar *file, gint line);
+#else
 gchar *path_to_utf8(const gchar *path);
-gchar *path_from_utf8(const gchar *path);
+gchar *path_from_utf8(const gchar *utf8);
+#endif
 
+const gchar *xdg_data_home_get(void);
+const gchar *xdg_config_home_get(void);
+const gchar *xdg_cache_home_get(void);
 const gchar *homedir(void);
 const gchar *get_rc_dir(void);
 const gchar *get_collections_dir(void);
 const gchar *get_trash_dir(void);
 
-gint stat_utf8(const gchar *s, struct stat *st);
-gint lstat_utf8(const gchar *s, struct stat *st);
-gint isname(const gchar *s);
-gint isfile(const gchar *s);
-gint isdir(const gchar *s);
-gint islink(const gchar *s);
+gboolean stat_utf8(const gchar *s, struct stat *st);
+gboolean lstat_utf8(const gchar *s, struct stat *st);
+
+gboolean isname(const gchar *s);
+gboolean isfile(const gchar *s);
+gboolean isdir(const gchar *s);
+gboolean islink(const gchar *s);
 gint64 filesize(const gchar *s);
 time_t filetime(const gchar *s);
-gint filetime_set(const gchar *s, time_t tval);
-gint access_file(const gchar *s, gint mode);
-gint unlink_file(const gchar *s);
-gint symlink_utf8(const gchar *source, const gchar *target);
-gint mkdir_utf8(const gchar *s, gint mode);
-gint rmdir_utf8(const gchar *s);
-gint copy_file_attributes(const gchar *s, const gchar *t, gint perms, gint mtime);
-gint copy_file(const gchar *s, const gchar *t);
-gint move_file(const gchar *s, const gchar *t);
-gint rename_file(const gchar *s, const gchar *t);
+gboolean filetime_set(const gchar *s, time_t tval);
+gboolean is_readable_file(const gchar *s);
+gboolean access_file(const gchar *s, gint mode);
+gboolean unlink_file(const gchar *s);
+gboolean symlink_utf8(const gchar *source, const gchar *target);
+gboolean mkdir_utf8(const gchar *s, gint mode);
+gboolean rmdir_utf8(const gchar *s);
+gboolean copy_file_attributes(const gchar *s, const gchar *t, gint perms, gint mtime);
+gboolean copy_file(const gchar *s, const gchar *t);
+gboolean move_file(const gchar *s, const gchar *t);
+gboolean rename_file(const gchar *s, const gchar *t);
 gchar *get_current_dir(void);
 
 /* return True on success, it is up to you to free
  * the lists with string_list_free()
  */
 void string_list_free(GList *list);
-GList *string_list_copy(GList *list);
+GList *string_list_copy(const GList *list);
 
-gchar *unique_filename(const gchar *path, const gchar *ext, const gchar *divider, gint pad);
+gchar *unique_filename(const gchar *path, const gchar *ext, const gchar *divider, gboolean pad);
 gchar *unique_filename_simple(const gchar *path);
 
 const gchar *filename_from_path(const gchar *path);
 gchar *remove_level_from_path(const gchar *path);
 
-const gchar *extension_from_path(const gchar *path);
 gchar *remove_extension_from_path(const gchar *path);
 
-gint file_extension_match(const gchar *path, const gchar *ext);
+gboolean file_extension_match(const gchar *path, const gchar *ext);
 
 /* warning note: this modifies path string! */
 void parse_out_relatives(gchar *path);
 
-gint file_in_path(const gchar *name);
+gboolean file_in_path(const gchar *name);
+
+gboolean recursive_mkdir_if_not_exists(const gchar *path, mode_t mode);
+
+
+/* generate md5 string from file,
+ * on failure returns newly allocated copy of error_text, error_text may be NULL
+  */
+gchar *md5_text_from_file_utf8(const gchar *path, const gchar *error_text);
+gboolean md5_get_digest_from_file_utf8(const gchar *path, guchar digest[16]);
 
 #endif
 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */