src/editors.h

   1 /*
   2  * Copyright (C) 2004 John Ellis
   3  * Copyright (C) 2008 - 2016 The Geeqie Team
   4  *
   5  * Author: John Ellis
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef EDITORS_H
  23 #define EDITORS_H
  24
  25 #include <glib.h>
  26 #include <gtk/gtk.h>
  27
  28 struct FileData;
  29
  30 enum EditorFlags {
  31         EDITOR_KEEP_FS            = 0x00000001,
  32         EDITOR_VERBOSE            = 0x00000002,
  33         EDITOR_VERBOSE_MULTI      = 0x00000004,
  34         EDITOR_TERMINAL           = 0x00000008,
  35
  36         EDITOR_DEST               = 0x00000100,
  37         EDITOR_FOR_EACH           = 0x00000200,
  38         EDITOR_SINGLE_COMMAND     = 0x00000400,
  39         EDITOR_NO_PARAM           = 0x00000800,
  40         /**< below are errors */
  41         EDITOR_ERROR_EMPTY        = 0x00020000,
  42         EDITOR_ERROR_SYNTAX       = 0x00040000,
  43         EDITOR_ERROR_INCOMPATIBLE = 0x00080000,
  44         EDITOR_ERROR_NO_FILE      = 0x00100000,
  45         EDITOR_ERROR_CANT_EXEC    = 0x00200000,
  46         EDITOR_ERROR_STATUS       = 0x00400000,
  47         EDITOR_ERROR_SKIPPED      = 0x00800000,
  48         /**< mask to match errors only */
  49         EDITOR_ERROR_MASK         = ~0xffff,
  50 };
  51
  52 struct EditorDescription {
  53         gchar *key;             /**< desktop file name, not including path, including extension */
  54         gchar *name;            /**< Name, localized name presented to user */
  55         gchar *icon;            /**< Icon */
  56         gchar *exec;            /**< Exec */
  57         gchar *menu_path;
  58         gchar *hotkey;
  59         GList *ext_list;
  60         gchar *file;
  61         gchar *comment;         /**< .desktop Comment key, used to show a tooltip */
  62         EditorFlags flags;
  63         gboolean hidden;        /**< explicitly hidden, shown in configuration dialog */
  64         gboolean ignored;       /**< not interesting, do not show at all */
  65         gboolean disabled;      /**< display disabled by user */
  66 };
  67
  68 inline gint editor_errors(EditorFlags flags) { return flags & EDITOR_ERROR_MASK; }
  69 inline gboolean editor_errors_but_skipped(EditorFlags flags) { return !!(editor_errors(flags) && !(flags & EDITOR_ERROR_SKIPPED)); }
  70
  71
  72 /**
  73  * @note EDITOR_CB_*:
  74  * Return values from callback function
  75  */
  76 enum {
  77         EDITOR_CB_CONTINUE = 0, /**< continue multiple editor execution on remaining files*/
  78         EDITOR_CB_SKIP,         /**< skip the remaining files */
  79         EDITOR_CB_SUSPEND       /**< suspend execution, one of editor_resume or editor_skip
  80                                    must be called later */
  81 };
  82
  83 enum {
  84         DESKTOP_FILE_COLUMN_KEY,
  85         DESKTOP_FILE_COLUMN_DISABLED,
  86         DESKTOP_FILE_COLUMN_NAME,
  87         DESKTOP_FILE_COLUMN_HIDDEN,
  88         DESKTOP_FILE_COLUMN_WRITABLE,
  89         DESKTOP_FILE_COLUMN_PATH,
  90         DESKTOP_FILE_COLUMN_COUNT
  91 };
  92
  93 extern GtkListStore *desktop_file_list;
  94
  95
  96 extern GHashTable *editors;
  97
  98 void editor_table_finish();
  99 void editor_table_clear();
 100 GList *editor_get_desktop_files();
 101 gboolean editor_read_desktop_file(const gchar *path);
 102
 103 GList *editor_list_get();
 104
 105
 106 /**
 107  * @typedef EditorCallback
 108  *
 109  * Callback is called even on skipped files, with the #EDITOR_ERROR_SKIPPED flag set.
 110  * It is a good place to call file_data_change_info_free().
 111  *
 112  * @param ed - pointer that can be used for editor_resume/editor_skip or NULL if all files were already processed \n
 113  * @param flags - flags above \n
 114  * @param list - list of processed #FileData structures, typically single file or whole list passed to start_editor_* @n
 115  * @param data - generic pointer
 116 */
 117 using EditorCallback = gint (*)(gpointer, EditorFlags, GList *, gpointer);
 118
 119
 120 void editor_resume(gpointer ed);
 121 void editor_skip(gpointer ed);
 122
 123
 124
 125 EditorFlags start_editor(const gchar *key, const gchar *working_directory);
 126 EditorFlags start_editor_from_file(const gchar *key, FileData *fd);
 127 EditorFlags start_editor_from_filelist(const gchar *key, GList *list);
 128 EditorFlags start_editor_from_file_full(const gchar *key, FileData *fd, EditorCallback cb, gpointer data);
 129 EditorFlags start_editor_from_filelist_full(const gchar *key, GList *list, const gchar *working_directory, EditorCallback cb, gpointer data);
 130 gboolean editor_window_flag_set(const gchar *key);
 131 gboolean editor_is_filter(const gchar *key);
 132 gboolean editor_no_param(const gchar *key);
 133 const gchar *editor_get_error_str(EditorFlags flags);
 134
 135 gboolean is_valid_editor_command(const gchar *key);
 136 gboolean editor_blocks_file(const gchar *key);
 137
 138 EditorFlags editor_command_parse(const EditorDescription *editor, GList *list, gboolean consider_sidecars, gchar **output);
 139
 140 #endif
 141 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */