src/editors.h

   1 /*
   2  * Geeqie
   3  * (C) 2004 John Ellis
   4  * Copyright (C) 2008 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 #define EDITOR_KEEP_FS            0x00000001
  19 #define EDITOR_VERBOSE            0x00000002
  20 #define EDITOR_VERBOSE_MULTI      0x00000004
  21
  22 #define EDITOR_DEST               0x00000100
  23 #define EDITOR_FOR_EACH           0x00000200
  24 #define EDITOR_SINGLE_COMMAND     0x00000400
  25
  26 #define EDITOR_ERROR_EMPTY        0x00020000
  27 #define EDITOR_ERROR_SYNTAX       0x00040000
  28 #define EDITOR_ERROR_INCOMPATIBLE 0x00080000
  29 #define EDITOR_ERROR_NO_FILE      0x00100000
  30 #define EDITOR_ERROR_CANT_EXEC    0x00200000
  31 #define EDITOR_ERROR_STATUS       0x00400000
  32 #define EDITOR_ERROR_SKIPPED      0x00800000
  33
  34 #define EDITOR_ERROR_MASK         0xffff0000
  35
  36
  37 /* return values from callback function */
  38 enum {
  39         EDITOR_CB_CONTINUE = 0, /* continue multiple editor execution on remaining files*/
  40         EDITOR_CB_SKIP,         /* skip the remaining files */
  41         EDITOR_CB_SUSPEND       /* suspend execution, one of editor_resume or editor_skip
  42                                    must be called later */
  43 };
  44
  45
  46 /*
  47 Callback is called even on skipped files, with the EDITOR_ERROR_SKIPPED flag set.
  48 It is a good place to call file_data_change_info_free().
  49
  50 ed - pointer that can be used for editor_resume/editor_skip or NULL if all files were already processed
  51 flags - flags above
  52 list - list of procesed FileData structures, typically single file or whole list passed to start_editor_*
  53 data - generic pointer
  54 */
  55 typedef gint (*EditorCallback) (gpointer ed, gint flags, GList *list, gpointer data);
  56
  57 void editor_set_name(gint n, gchar *name);
  58 void editor_set_command(gint n, gchar *command);
  59
  60
  61 void editor_resume(gpointer ed);
  62 void editor_skip(gpointer ed);
  63
  64
  65 gint editor_command_parse(const gchar *template, GList *list, gchar **output);
  66
  67 void editor_reset_defaults(void);
  68 gint start_editor_from_file(gint n, FileData *fd);
  69 gint start_editor_from_filelist(gint n, GList *list);
  70 gint start_editor_from_file_full(gint n, FileData *fd, EditorCallback cb, gpointer data);
  71 gint start_editor_from_filelist_full(gint n, GList *list, EditorCallback cb, gpointer data);
  72 gint editor_window_flag_set(gint n);
  73 gint editor_is_filter(gint n);
  74 const gchar *editor_get_error_str(gint flags);
  75
  76 const gchar *editor_get_name(gint n);
  77
  78 gboolean is_valid_editor_command(gint n);
  79
  80 #endif
  81 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */