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 struct FileData;
  26
  27 enum EditorFlags {
  28         EDITOR_KEEP_FS            = 0x00000001,
  29         EDITOR_VERBOSE            = 0x00000002,
  30         EDITOR_VERBOSE_MULTI      = 0x00000004,
  31         EDITOR_TERMINAL           = 0x00000008,
  32
  33         EDITOR_DEST               = 0x00000100,
  34         EDITOR_FOR_EACH           = 0x00000200,
  35         EDITOR_SINGLE_COMMAND     = 0x00000400,
  36         EDITOR_NO_PARAM           = 0x00000800,
  37         /**< below are errors */
  38         EDITOR_ERROR_EMPTY        = 0x00020000,
  39         EDITOR_ERROR_SYNTAX       = 0x00040000,
  40         EDITOR_ERROR_INCOMPATIBLE = 0x00080000,
  41         EDITOR_ERROR_NO_FILE      = 0x00100000,
  42         EDITOR_ERROR_CANT_EXEC    = 0x00200000,
  43         EDITOR_ERROR_STATUS       = 0x00400000,
  44         EDITOR_ERROR_SKIPPED      = 0x00800000,
  45         /**< mask to match errors only */
  46         EDITOR_ERROR_MASK         = ~0xffff,
  47 };
  48
  49 struct EditorDescription {
  50         gchar *key;             /**< desktop file name, not including path, including extension */
  51         gchar *name;            /**< Name, localized name presented to user */
  52         gchar *icon;            /**< Icon */
  53         gchar *exec;            /**< Exec */
  54         gchar *menu_path;
  55         gchar *hotkey;
  56         GList *ext_list;
  57         gchar *file;
  58         gchar *comment;         /**< .desktop Comment key, used to show a tooltip */
  59         EditorFlags flags;
  60         gboolean hidden;        /**< explicitly hidden, shown in configuration dialog */
  61         gboolean ignored;       /**< not interesting, do not show at all */
  62         gboolean disabled;      /**< display disabled by user */
  63 };
  64
  65 #define EDITOR_ERRORS(flags) ((flags) & EDITOR_ERROR_MASK)
  66 #define EDITOR_ERRORS_BUT_SKIPPED(flags) (!!(((flags) & EDITOR_ERROR_MASK) && !((flags) & EDITOR_ERROR_SKIPPED)))
  67
  68
  69 /**
  70  * @note EDITOR_CB_*:
  71  * Return values from callback function
  72  */
  73 enum {
  74         EDITOR_CB_CONTINUE = 0, /**< continue multiple editor execution on remaining files*/
  75         EDITOR_CB_SKIP,         /**< skip the remaining files */
  76         EDITOR_CB_SUSPEND       /**< suspend execution, one of editor_resume or editor_skip
  77                                    must be called later */
  78 };
  79
  80 enum {
  81         DESKTOP_FILE_COLUMN_KEY,
  82         DESKTOP_FILE_COLUMN_DISABLED,
  83         DESKTOP_FILE_COLUMN_NAME,
  84         DESKTOP_FILE_COLUMN_HIDDEN,
  85         DESKTOP_FILE_COLUMN_WRITABLE,
  86         DESKTOP_FILE_COLUMN_PATH,
  87         DESKTOP_FILE_COLUMN_COUNT
  88 };
  89
  90 extern GtkListStore *desktop_file_list;
  91
  92
  93 extern GHashTable *editors;
  94
  95 void editor_table_finish();
  96 void editor_table_clear();
  97 GList *editor_get_desktop_files();
  98 gboolean editor_read_desktop_file(const gchar *path);
  99
 100 GList *editor_list_get();
 101
 102
 103 /**
 104  * @typedef EditorCallback
 105  *
 106  * Callback is called even on skipped files, with the #EDITOR_ERROR_SKIPPED flag set.
 107  * It is a good place to call file_data_change_info_free().
 108  *
 109  * @param ed - pointer that can be used for editor_resume/editor_skip or NULL if all files were already processed \n
 110  * @param flags - flags above \n
 111  * @param list - list of processed #FileData structures, typically single file or whole list passed to start_editor_* @n
 112  * @param data - generic pointer
 113 */
 114 using EditorCallback = gint (*)(gpointer, EditorFlags, GList *, gpointer);
 115
 116
 117 void editor_resume(gpointer ed);
 118 void editor_skip(gpointer ed);
 119
 120
 121
 122 EditorFlags start_editor(const gchar *key, const gchar *working_directory);
 123 EditorFlags start_editor_from_file(const gchar *key, FileData *fd);
 124 EditorFlags start_editor_from_filelist(const gchar *key, GList *list);
 125 EditorFlags start_editor_from_file_full(const gchar *key, FileData *fd, EditorCallback cb, gpointer data);
 126 EditorFlags start_editor_from_filelist_full(const gchar *key, GList *list, const gchar *working_directory, EditorCallback cb, gpointer data);
 127 gboolean editor_window_flag_set(const gchar *key);
 128 gboolean editor_is_filter(const gchar *key);
 129 gboolean editor_no_param(const gchar *key);
 130 const gchar *editor_get_error_str(EditorFlags flags);
 131
 132 gboolean is_valid_editor_command(const gchar *key);
 133 gboolean editor_blocks_file(const gchar *key);
 134
 135 EditorFlags editor_command_parse(const EditorDescription *editor, GList *list, gboolean consider_sidecars, gchar **output);
 136
 137 #endif
 138 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */