src/editors.h

   1 /*
   2  * Geeqie
   3  * (C) 2004 John Ellis
   4  * Copyright (C) 2008 - 2009 The Geeqie Team
   5  *
   6  * Author: John Ellis
   7  *
   8  * This software is released under the GNU General Public License (GNU GPL).
   9  * Please read the included file COPYING for more information.
  10  * This software comes with no warranty of any kind, use at your own risk!
  11  */
  12
  13
  14 #ifndef EDITORS_H
  15 #define EDITORS_H
  16
  17
  18 typedef enum {
  19         EDITOR_KEEP_FS            = 0x00000001,
  20         EDITOR_VERBOSE            = 0x00000002,
  21         EDITOR_VERBOSE_MULTI      = 0x00000004,
  22         EDITOR_TERMINAL           = 0x00000008,
  23
  24         EDITOR_DEST               = 0x00000100,
  25         EDITOR_FOR_EACH           = 0x00000200,
  26         EDITOR_SINGLE_COMMAND     = 0x00000400,
  27         /* below are errors */
  28         EDITOR_ERROR_EMPTY        = 0x00020000,
  29         EDITOR_ERROR_SYNTAX       = 0x00040000,
  30         EDITOR_ERROR_INCOMPATIBLE = 0x00080000,
  31         EDITOR_ERROR_NO_FILE      = 0x00100000,
  32         EDITOR_ERROR_CANT_EXEC    = 0x00200000,
  33         EDITOR_ERROR_STATUS       = 0x00400000,
  34         EDITOR_ERROR_SKIPPED      = 0x00800000,
  35         /* mask to match errors only */
  36         EDITOR_ERROR_MASK         = 0xffff0000,
  37 } EditorFlags;
  38
  39 struct _EditorDescription {
  40         gchar *key;             /* desktop file name, not including path, including extension */
  41         gchar *name;            /* Name, localized name presented to user */
  42         gchar *icon;            /* Icon */
  43         gchar *exec;            /* Exec */
  44         gchar *menu_path;
  45         gchar *hotkey;
  46         GList *ext_list;
  47         gchar *file;
  48         gchar *comment;         /* .desktop Comment key, used to show a tooltip */
  49         EditorFlags flags;
  50         gboolean hidden;
  51 };
  52
  53 #define EDITOR_ERRORS(flags) ((flags) & EDITOR_ERROR_MASK)
  54 #define EDITOR_ERRORS_BUT_SKIPPED(flags) (!!(((flags) & EDITOR_ERROR_MASK) && !((flags) & EDITOR_ERROR_SKIPPED)))
  55
  56
  57 /* return values from callback function */
  58 enum {
  59         EDITOR_CB_CONTINUE = 0, /* continue multiple editor execution on remaining files*/
  60         EDITOR_CB_SKIP,         /* skip the remaining files */
  61         EDITOR_CB_SUSPEND       /* suspend execution, one of editor_resume or editor_skip
  62                                    must be called later */
  63 };
  64
  65 extern GHashTable *editors;
  66
  67 void editor_load_descriptions(void);
  68 GList *editor_list_get(void);
  69
  70
  71 /*
  72 Callback is called even on skipped files, with the EDITOR_ERROR_SKIPPED flag set.
  73 It is a good place to call file_data_change_info_free().
  74
  75 ed - pointer that can be used for editor_resume/editor_skip or NULL if all files were already processed
  76 flags - flags above
  77 list - list of procesed FileData structures, typically single file or whole list passed to start_editor_*
  78 data - generic pointer
  79 */
  80 typedef gint (*EditorCallback) (gpointer ed, EditorFlags flags, GList *list, gpointer data);
  81
  82
  83 void editor_resume(gpointer ed);
  84 void editor_skip(gpointer ed);
  85
  86
  87
  88 EditorFlags start_editor_from_file(const gchar *key, FileData *fd);
  89 EditorFlags start_editor_from_filelist(const gchar *key, GList *list);
  90 EditorFlags start_editor_from_file_full(const gchar *key, FileData *fd, EditorCallback cb, gpointer data);
  91 EditorFlags start_editor_from_filelist_full(const gchar *key, GList *list, EditorCallback cb, gpointer data);
  92 gboolean editor_window_flag_set(const gchar *key);
  93 gboolean editor_is_filter(const gchar *key);
  94 const gchar *editor_get_error_str(EditorFlags flags);
  95
  96 const gchar *editor_get_name(const gchar *key);
  97
  98 gboolean is_valid_editor_command(const gchar *key);
  99 EditorFlags editor_command_parse(const EditorDescription *editor, GList *list, gchar **output);
 100
 101 #endif
 102 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */