For the sake of consistency, use glib basic types everywhere.
[geeqie.git] / src / editors.c
1 /*
2  * Geeqie
3  * (C) 2006 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 #include "main.h"
15 #include "editors.h"
16
17 #include "filedata.h"
18 #include "filefilter.h"
19 #include "utilops.h"
20 #include "ui_fileops.h"
21 #include "ui_spinner.h"
22 #include "ui_utildlg.h"
23
24 #include <errno.h>
25
26
27 #define EDITOR_WINDOW_WIDTH 500
28 #define EDITOR_WINDOW_HEIGHT 300
29
30
31
32 typedef struct _EditorVerboseData EditorVerboseData;
33 struct _EditorVerboseData {
34         GenericDialog *gd;
35         GtkWidget *button_close;
36         GtkWidget *button_stop;
37         GtkWidget *text;
38         GtkWidget *progress;
39         GtkWidget *spinner;
40 };
41
42 typedef struct _EditorData EditorData;
43 struct _EditorData {
44         gint flags;
45         GPid pid;
46         gchar *command_template;
47         GList *list;
48         gint count;
49         gint total;
50         gboolean stopping;
51         EditorVerboseData *vd;
52         EditorCallback callback;
53         gpointer data;
54 };
55
56
57 static Editor editor_slot_defaults[GQ_EDITOR_SLOTS] = {
58         { N_("The Gimp"), "gimp-remote %{.cr2;.crw;.nef;.raw;*}f" },
59         { N_("XV"), "xv %f" },
60         { N_("Xpaint"), "xpaint %f" },
61         { N_("UFraw"), "ufraw %{.cr2;.crw;.nef;.raw}p" },
62         { N_("Add XMP sidecar"), "%vFILE=%{.cr2;.crw;.nef;.raw}p;XMP=`echo \"$FILE\"|sed -e 's|\\.[^.]*$|.xmp|'`; exiftool -tagsfromfile \"$FILE\" \"$XMP\"" },
63         { N_("Symlink"), "ln -s %p %d"},
64         { NULL, NULL },
65         { NULL, NULL },
66         { N_("Rotate jpeg clockwise"), "%vif jpegtran -rotate 90 -copy all -outfile %{.jpg;.jpeg}p_tmp %{.jpg;.jpeg}p; then mv %{.jpg;.jpeg}p_tmp %{.jpg;.jpeg}p;else rm %{.jpg;.jpeg}p_tmp;fi" },
67         { N_("Rotate jpeg counterclockwise"), "%vif jpegtran -rotate 270 -copy all -outfile %{.jpg;.jpeg}p_tmp %{.jpg;.jpeg}p; then mv %{.jpg;.jpeg}p_tmp %{.jpg;.jpeg}p;else rm %{.jpg;.jpeg}p_tmp;fi" },
68         /* special slots */
69 #if 1
70         /* for testing */
71         { N_("External Copy command"), "%vset -x;cp %p %d" },
72         { N_("External Move command"), "%vset -x;mv %p %d" },
73         { N_("External Rename command"), "%vset -x;mv %p %d" },
74         { N_("External Delete command"), NULL },
75         { N_("External New Folder command"), NULL },
76 #else
77         { N_("External Copy command"), NULL },
78         { N_("External Move command"), NULL },
79         { N_("External Rename command"), NULL },
80         { N_("External Delete command"), NULL },
81         { N_("External New Folder command"), NULL },
82 #endif
83 };
84
85 static void editor_verbose_window_progress(EditorData *ed, const gchar *text);
86 static gint editor_command_next_start(EditorData *ed);
87 static gint editor_command_next_finish(EditorData *ed, gint status);
88 static gint editor_command_done(EditorData *ed);
89
90 /*
91  *-----------------------------------------------------------------------------
92  * external editor routines
93  *-----------------------------------------------------------------------------
94  */
95
96 void editor_set_name(gint n, gchar *name)
97 {
98         if (n < 0 || n >= GQ_EDITOR_SLOTS) return;
99
100         g_free(options->editor[n].name);
101         
102         options->editor[n].name = name ? utf8_validate_or_convert(name) : NULL;
103 }
104
105 void editor_set_command(gint n, gchar *command)
106 {
107         if (n < 0 || n >= GQ_EDITOR_SLOTS) return;
108
109         g_free(options->editor[n].command);
110         options->editor[n].command = command ? utf8_validate_or_convert(command) : NULL;
111 }
112
113 void editor_reset_defaults(void)
114 {
115         gint i;
116
117         for (i = 0; i < GQ_EDITOR_SLOTS; i++)
118                 {
119                 editor_set_name(i, _(editor_slot_defaults[i].name));
120                 editor_set_command(i, _(editor_slot_defaults[i].command));
121                 }
122 }
123
124 static void editor_verbose_data_free(EditorData *ed)
125 {
126         if (!ed->vd) return;
127         g_free(ed->vd);
128         ed->vd = NULL;
129 }
130
131 static void editor_data_free(EditorData *ed)
132 {
133         editor_verbose_data_free(ed);
134         g_free(ed->command_template);
135         g_free(ed);
136 }
137
138 static void editor_verbose_window_close(GenericDialog *gd, gpointer data)
139 {
140         EditorData *ed = data;
141
142         generic_dialog_close(gd);
143         editor_verbose_data_free(ed);
144         if (ed->pid == -1) editor_data_free(ed); /* the process has already terminated */
145 }
146
147 static void editor_verbose_window_stop(GenericDialog *gd, gpointer data)
148 {
149         EditorData *ed = data;
150         ed->stopping = TRUE;
151         ed->count = 0;
152         editor_verbose_window_progress(ed, _("stopping..."));
153 }
154
155 static void editor_verbose_window_enable_close(EditorVerboseData *vd)
156 {
157         vd->gd->cancel_cb = editor_verbose_window_close;
158
159         spinner_set_interval(vd->spinner, -1);
160         gtk_widget_set_sensitive(vd->button_stop, FALSE);
161         gtk_widget_set_sensitive(vd->button_close, TRUE);
162 }
163
164 static EditorVerboseData *editor_verbose_window(EditorData *ed, const gchar *text)
165 {
166         EditorVerboseData *vd;
167         GtkWidget *scrolled;
168         GtkWidget *hbox;
169         gchar *buf;
170
171         vd = g_new0(EditorVerboseData, 1);
172
173         vd->gd = file_util_gen_dlg(_("Edit command results"), GQ_WMCLASS, "editor_results",
174                                    NULL, FALSE,
175                                    NULL, ed);
176         buf = g_strdup_printf(_("Output of %s"), text);
177         generic_dialog_add_message(vd->gd, NULL, buf, NULL);
178         g_free(buf);
179         vd->button_stop = generic_dialog_add_button(vd->gd, GTK_STOCK_STOP, NULL,
180                                                    editor_verbose_window_stop, FALSE);
181         gtk_widget_set_sensitive(vd->button_stop, FALSE);
182         vd->button_close = generic_dialog_add_button(vd->gd, GTK_STOCK_CLOSE, NULL,
183                                                     editor_verbose_window_close, TRUE);
184         gtk_widget_set_sensitive(vd->button_close, FALSE);
185
186         scrolled = gtk_scrolled_window_new(NULL, NULL);
187         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
188         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
189                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
190         gtk_box_pack_start(GTK_BOX(vd->gd->vbox), scrolled, TRUE, TRUE, 5);
191         gtk_widget_show(scrolled);
192
193         vd->text = gtk_text_view_new();
194         gtk_text_view_set_editable(GTK_TEXT_VIEW(vd->text), FALSE);
195         gtk_widget_set_size_request(vd->text, EDITOR_WINDOW_WIDTH, EDITOR_WINDOW_HEIGHT);
196         gtk_container_add(GTK_CONTAINER(scrolled), vd->text);
197         gtk_widget_show(vd->text);
198
199         hbox = gtk_hbox_new(FALSE, 0);
200         gtk_box_pack_start(GTK_BOX(vd->gd->vbox), hbox, FALSE, FALSE, 0);
201         gtk_widget_show(hbox);
202
203         vd->progress = gtk_progress_bar_new();
204         gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(vd->progress), 0.0);
205         gtk_box_pack_start(GTK_BOX(hbox), vd->progress, TRUE, TRUE, 0);
206         gtk_widget_show(vd->progress);
207
208         vd->spinner = spinner_new(NULL, SPINNER_SPEED);
209         gtk_box_pack_start(GTK_BOX(hbox), vd->spinner, FALSE, FALSE, 0);
210         gtk_widget_show(vd->spinner);
211
212         gtk_widget_show(vd->gd->dialog);
213
214         ed->vd = vd;
215         return vd;
216 }
217
218 static void editor_verbose_window_fill(EditorVerboseData *vd, gchar *text, gint len)
219 {
220         GtkTextBuffer *buffer;
221         GtkTextIter iter;
222
223         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(vd->text));
224         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
225         gtk_text_buffer_insert(buffer, &iter, text, len);
226 }
227
228 static void editor_verbose_window_progress(EditorData *ed, const gchar *text)
229 {
230         if (!ed->vd) return;
231
232         if (ed->total)
233                 {
234                 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(ed->vd->progress), (gdouble)ed->count / ed->total);
235                 }
236
237         gtk_progress_bar_set_text(GTK_PROGRESS_BAR(ed->vd->progress), (text) ? text : "");
238 }
239
240 static gboolean editor_verbose_io_cb(GIOChannel *source, GIOCondition condition, gpointer data)
241 {
242         EditorData *ed = data;
243         gchar buf[512];
244         gsize count;
245
246         if (condition & G_IO_IN)
247                 {
248                 while (g_io_channel_read_chars(source, buf, sizeof(buf), &count, NULL) == G_IO_STATUS_NORMAL)
249                         {
250                         if (!g_utf8_validate(buf, count, NULL))
251                                 {
252                                 gchar *utf8;
253
254                                 utf8 = g_locale_to_utf8(buf, count, NULL, NULL, NULL);
255                                 if (utf8)
256                                         {
257                                         editor_verbose_window_fill(ed->vd, utf8, -1);
258                                         g_free(utf8);
259                                         }
260                                 else
261                                         {
262                                         editor_verbose_window_fill(ed->vd, "Error converting text to valid utf8\n", -1);
263                                         }
264                                 }
265                         else
266                                 {
267                                 editor_verbose_window_fill(ed->vd, buf, count);
268                                 }
269                         }
270                 }
271
272         if (condition & (G_IO_ERR | G_IO_HUP))
273                 {
274                 g_io_channel_shutdown(source, TRUE, NULL);
275                 return FALSE;
276                 }
277
278         return TRUE;
279 }
280
281 typedef enum {
282         PATH_FILE,
283         PATH_DEST
284 } PathType;
285
286
287 static gchar *editor_command_path_parse(const FileData *fd, PathType type, const gchar *extensions)
288 {
289         GString *string;
290         gchar *pathl;
291         const gchar *p = NULL;
292
293         string = g_string_new("");
294
295         if (type == PATH_FILE)
296                 {
297                 GList *ext_list = filter_to_list(extensions);
298                 GList *work = ext_list;
299
300                 if (!work)
301                         p = fd->path;
302                 else
303                         {
304                         while (work)
305                                 {
306                                 GList *work2;
307                                 gchar *ext = work->data;
308                                 work = work->next;
309
310                                 if (strcmp(ext, "*") == 0 ||
311                                     strcasecmp(ext, fd->extension) == 0)
312                                         {
313                                         p = fd->path;
314                                         break;
315                                         }
316
317                                 work2 = fd->sidecar_files;
318                                 while (work2)
319                                         {
320                                         FileData *sfd = work2->data;
321                                         work2 = work2->next;
322
323                                         if (strcasecmp(ext, sfd->extension) == 0)
324                                                 {
325                                                 p = sfd->path;
326                                                 break;
327                                                 }
328                                         }
329                                 if (p) break;
330                                 }
331                         string_list_free(ext_list);
332                         if (!p) return NULL;
333                         }
334                 }
335         else if (type == PATH_DEST)
336                 {
337                 if (fd->change && fd->change->dest)
338                         p = fd->change->dest;
339                 else
340                         p = "";
341                 }
342
343         while (*p != '\0')
344                 {
345                 /* must escape \, ", `, and $ to avoid problems,
346                  * we assume system shell supports bash-like escaping
347                  */
348                 if (strchr("\\\"`$", *p) != NULL)
349                         {
350                         string = g_string_append_c(string, '\\');
351                         }
352                 string = g_string_append_c(string, *p);
353                 p++;
354                 }
355
356         pathl = path_from_utf8(string->str);
357         g_string_free(string, TRUE);
358
359         return pathl;
360 }
361
362
363 /*
364  * The supported macros for editor commands:
365  *
366  *   %f   first occurence replaced by quoted sequence of filenames, command is run once.
367  *        only one occurence of this macro is supported.
368  *        ([ls %f] results in [ls "file1" "file2" ... "lastfile"])
369  *   %p   command is run for each filename in turn, each instance replaced with single filename.
370  *        multiple occurences of this macro is supported for complex shell commands.
371  *        This macro will BLOCK THE APPLICATION until it completes, since command is run once
372  *        for every file in syncronous order. To avoid blocking add the %v macro, below.
373  *        ([ls %p] results in [ls "file1"], [ls "file2"] ... [ls "lastfile"])
374  *   none if no macro is supplied, the result is equivalent to "command %f"
375  *        ([ls] results in [ls "file1" "file2" ... "lastfile"])
376  *
377  *  Only one of the macros %f or %p may be used in a given commmand.
378  *
379  *   %v   must be the first two characters[1] in a command, causes a window to display
380  *        showing the output of the command(s).
381  *   %V   same as %v except in the case of %p only displays a window for multiple files,
382  *        operating on a single file is suppresses the output dialog.
383  *
384  *   %w   must be first two characters in a command, presence will disable full screen
385  *        from exiting upon invocation.
386  *
387  *
388  * [1] Note: %v,%V may also be preceded by "%w".
389  */
390
391
392 gint editor_command_parse(const gchar *template, GList *list, gchar **output)
393 {
394         gint flags = 0;
395         const gchar *p = template;
396         GString *result = NULL;
397         gchar *extensions = NULL;
398
399         if (output)
400                 result = g_string_new("");
401
402         if (!template || template[0] == '\0')
403                 {
404                 flags |= EDITOR_ERROR_EMPTY;
405                 goto err;
406                 }
407         
408         /* skip leading whitespaces if any */
409         while (g_ascii_isspace(*p)) p++;
410
411         /* global flags */
412         while (*p == '%')
413                 {
414                 switch (*++p)
415                         {
416                         case 'w':
417                                 flags |= EDITOR_KEEP_FS;
418                                 p++;
419                                 break;
420                         case 'v':
421                                 flags |= EDITOR_VERBOSE;
422                                 p++;
423                                 break;
424                         case 'V':
425                                 flags |= EDITOR_VERBOSE_MULTI;
426                                 p++;
427                                 break;
428                         default:
429                                 flags |= EDITOR_ERROR_SYNTAX;
430                                 goto err;
431                         }
432                 }
433
434         /* skip whitespaces if any */
435         while (g_ascii_isspace(*p)) p++;
436
437         /* command */
438
439         while (*p)
440                 {
441                 if (*p != '%')
442                         {
443                         if (output) result = g_string_append_c(result, *p);
444                         }
445                 else /* *p == '%' */
446                         {
447                         extensions = NULL;
448                         gchar *pathl = NULL;
449
450                         p++;
451
452                         /* for example "%f" or "%{.crw;.raw;.cr2}f" */
453                         if (*p == '{')
454                                 {
455                                 gchar *end;
456                                 
457                                 p++;
458                                 end = strchr(p, '}');
459                                 if (!end)
460                                         {
461                                         flags |= EDITOR_ERROR_SYNTAX;
462                                         goto err;
463                                         }
464
465                                 extensions = g_strndup(p, end - p);
466                                 p = end + 1;
467                                 }
468
469                         switch (*p)
470                                 {
471                                 case 'd':
472                                         flags |= EDITOR_DEST;
473                                         /* fall through */
474                                 case 'p':
475                                         flags |= EDITOR_FOR_EACH;
476                                         if (flags & EDITOR_SINGLE_COMMAND)
477                                                 {
478                                                 flags |= EDITOR_ERROR_INCOMPATIBLE;
479                                                 goto err;
480                                                 }
481                                         if (output)
482                                                 {
483                                                 /* use the first file from the list */
484                                                 if (!list || !list->data)
485                                                         {
486                                                         flags |= EDITOR_ERROR_NO_FILE;
487                                                         goto err;
488                                                         }
489                                                 pathl = editor_command_path_parse((FileData *)list->data,
490                                                                                   (flags & EDITOR_DEST) ? PATH_DEST : PATH_FILE,
491                                                                                   extensions);
492                                                 if (!pathl)
493                                                         {
494                                                         flags |= EDITOR_ERROR_NO_FILE;
495                                                         goto err;
496                                                         }
497                                                 result = g_string_append_c(result, '"');
498                                                 result = g_string_append(result, pathl);
499                                                 g_free(pathl);
500                                                 result = g_string_append_c(result, '"');
501                                                 }
502                                         break;
503
504                                 case 'f':
505                                         flags |= EDITOR_SINGLE_COMMAND;
506                                         if (flags & (EDITOR_FOR_EACH | EDITOR_DEST))
507                                                 {
508                                                 flags |= EDITOR_ERROR_INCOMPATIBLE;
509                                                 goto err;
510                                                 }
511
512                                         if (output)
513                                                 {
514                                                 /* use whole list */
515                                                 GList *work = list;
516                                                 gboolean ok = FALSE;
517
518                                                 while (work)
519                                                         {
520                                                         FileData *fd = work->data;
521                                                         pathl = editor_command_path_parse(fd, PATH_FILE, extensions);
522
523                                                         if (pathl)
524                                                                 {
525                                                                 ok = TRUE;
526                                                                 if (work != list) g_string_append_c(result, ' ');
527                                                                 result = g_string_append_c(result, '"');
528                                                                 result = g_string_append(result, pathl);
529                                                                 g_free(pathl);
530                                                                 result = g_string_append_c(result, '"');
531                                                                 }
532                                                         work = work->next;
533                                                         }
534                                                 if (!ok)
535                                                         {
536                                                         flags |= EDITOR_ERROR_NO_FILE;
537                                                         goto err;
538                                                         }
539                                                 }
540                                         break;
541                                 case '%':
542                                         /* %% = % escaping */
543                                         if (output) result = g_string_append_c(result, *p);
544                                         break;
545                                 default:
546                                         flags |= EDITOR_ERROR_SYNTAX;
547                                         goto err;
548                                 }
549                         if (extensions) g_free(extensions);
550                         extensions = NULL;
551                         }
552                 p++;
553                 }
554
555         if (output) *output = g_string_free(result, FALSE);
556         return flags;
557
558
559 err:
560         if (output)
561                 {
562                 g_string_free(result, TRUE);
563                 *output = NULL;
564                 }
565         if (extensions) g_free(extensions);
566         return flags;
567 }
568
569 static void editor_child_exit_cb (GPid pid, gint status, gpointer data)
570 {
571         EditorData *ed = data;
572         g_spawn_close_pid(pid);
573         ed->pid = -1;
574
575         editor_command_next_finish(ed, status);
576 }
577
578
579 static gint editor_command_one(const gchar *template, GList *list, EditorData *ed)
580 {
581         gchar *command;
582         FileData *fd = list->data;
583         GPid pid;
584         gint standard_output;
585         gint standard_error;
586         gboolean ok;
587
588         ed->pid = -1;
589         ed->flags = editor_command_parse(template, list, &command);
590
591         ok = !(ed->flags & EDITOR_ERROR_MASK);
592
593         if (ok)
594                 {
595                 ok = (options->shell.path && *options->shell.path);
596                 if (!ok) log_printf("ERROR: empty shell command\n");
597                         
598                 if (ok)
599                         {
600                         ok = (access(options->shell.path, X_OK) == 0);
601                         if (!ok) log_printf("ERROR: cannot execute shell command '%s'\n", options->shell.path);
602                         }
603
604                 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
605                 }
606
607         if (ok)
608                 {
609                 gchar *working_directory;
610                 gchar *args[4];
611                 guint n = 0;
612
613                 working_directory = remove_level_from_path(fd->path);
614                 args[n++] = options->shell.path;
615                 if (options->shell.options && *options->shell.options)
616                         args[n++] = options->shell.options;
617                 args[n++] = command;
618                 args[n] = NULL;
619
620                 ok = g_spawn_async_with_pipes(working_directory, args, NULL,
621                                       G_SPAWN_DO_NOT_REAP_CHILD, /* GSpawnFlags */
622                                       NULL, NULL,
623                                       &pid,
624                                       NULL,
625                                       ed->vd ? &standard_output : NULL,
626                                       ed->vd ? &standard_error : NULL,
627                                       NULL);
628                 
629                 g_free(working_directory);
630
631                 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
632                 }
633
634         if (ok)
635                 {
636                 g_child_watch_add(pid, editor_child_exit_cb, ed);
637                 ed->pid = pid;
638                 }
639
640         if (ed->vd)
641                 {
642                 if (!ok)
643                         {
644                         gchar *buf;
645
646                         buf = g_strdup_printf(_("Failed to run command:\n%s\n"), template);
647                         editor_verbose_window_fill(ed->vd, buf, strlen(buf));
648                         g_free(buf);
649
650                         }
651                 else
652                         {
653                         GIOChannel *channel_output;
654                         GIOChannel *channel_error;
655
656                         channel_output = g_io_channel_unix_new(standard_output);
657                         g_io_channel_set_flags(channel_output, G_IO_FLAG_NONBLOCK, NULL);
658                         g_io_channel_set_encoding(channel_output, NULL, NULL);
659
660                         g_io_add_watch_full(channel_output, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
661                                             editor_verbose_io_cb, ed, NULL);
662                         g_io_channel_unref(channel_output);
663
664                         channel_error = g_io_channel_unix_new(standard_error);
665                         g_io_channel_set_flags(channel_error, G_IO_FLAG_NONBLOCK, NULL);
666                         g_io_channel_set_encoding(channel_error, NULL, NULL);
667
668                         g_io_add_watch_full(channel_error, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
669                                             editor_verbose_io_cb, ed, NULL);
670                         g_io_channel_unref(channel_error);
671                         }
672                 }
673
674         g_free(command);
675
676         return ed->flags & EDITOR_ERROR_MASK;
677 }
678
679 static gint editor_command_next_start(EditorData *ed)
680 {
681         if (ed->vd) editor_verbose_window_fill(ed->vd, "\n", 1);
682
683         if (ed->list && ed->count < ed->total)
684                 {
685                 FileData *fd;
686                 gint error;
687
688                 fd = ed->list->data;
689
690                 if (ed->vd)
691                         {
692                         editor_verbose_window_progress(ed, (ed->flags & EDITOR_FOR_EACH) ? fd->path : _("running..."));
693                         }
694                 ed->count++;
695
696                 error = editor_command_one(ed->command_template, ed->list, ed);
697                 if (!error && ed->vd)
698                         {
699                         gtk_widget_set_sensitive(ed->vd->button_stop, (ed->list != NULL) );
700                         if (ed->flags & EDITOR_FOR_EACH)
701                                 {
702                                 editor_verbose_window_fill(ed->vd, fd->path, strlen(fd->path));
703                                 editor_verbose_window_fill(ed->vd, "\n", 1);
704                                 }
705                         }
706
707                 if (!error)
708                         return 0;
709                 else
710                         /* command was not started, call the finish immediately */
711                         return editor_command_next_finish(ed, 0);
712                 }
713
714         /* everything is done */
715         return editor_command_done(ed);
716 }
717
718 static gint editor_command_next_finish(EditorData *ed, gint status)
719 {
720         gint cont = ed->stopping ? EDITOR_CB_SKIP : EDITOR_CB_CONTINUE;
721
722         if (status)
723                 ed->flags |= EDITOR_ERROR_STATUS;
724
725         if (ed->flags & EDITOR_FOR_EACH)
726                 {
727                 /* handle the first element from the list */
728                 GList *fd_element = ed->list;
729
730                 ed->list = g_list_remove_link(ed->list, fd_element);
731                 if (ed->callback)
732                         {
733                         cont = ed->callback(ed->list ? ed : NULL, ed->flags, fd_element, ed->data);
734                         if (ed->stopping && cont == EDITOR_CB_CONTINUE) cont = EDITOR_CB_SKIP;
735                         }
736                 filelist_free(fd_element);
737                 }
738         else
739                 {
740                 /* handle whole list */
741                 if (ed->callback)
742                         cont = ed->callback(NULL, ed->flags, ed->list, ed->data);
743                 filelist_free(ed->list);
744                 ed->list = NULL;
745                 }
746
747         if (cont == EDITOR_CB_SUSPEND)
748                 return ed->flags & EDITOR_ERROR_MASK;
749         else if (cont == EDITOR_CB_SKIP)
750                 return editor_command_done(ed);
751         else
752                 return editor_command_next_start(ed);
753 }
754
755 static gint editor_command_done(EditorData *ed)
756 {
757         gint flags;
758
759         if (ed->vd)
760                 {
761                 const gchar *text;
762
763                 if (ed->count == ed->total)
764                         {
765                         text = _("done");
766                         }
767                 else
768                         {
769                         text = _("stopped by user");
770                         }
771                 editor_verbose_window_progress(ed, text);
772                 editor_verbose_window_enable_close(ed->vd);
773                 }
774
775         /* free the not-handled items */
776         if (ed->list)
777                 {
778                 ed->flags |= EDITOR_ERROR_SKIPPED;
779                 if (ed->callback) ed->callback(NULL, ed->flags, ed->list, ed->data);
780                 filelist_free(ed->list);
781                 ed->list = NULL;
782                 }
783
784         ed->count = 0;
785
786         flags = ed->flags & EDITOR_ERROR_MASK;
787
788         if (!ed->vd) editor_data_free(ed);
789
790         return flags;
791 }
792
793 void editor_resume(gpointer ed)
794 {
795         editor_command_next_start(ed);
796 }
797
798 void editor_skip(gpointer ed)
799 {
800         editor_command_done(ed);
801 }
802
803 static gint editor_command_start(const gchar *template, const gchar *text, GList *list, EditorCallback cb, gpointer data)
804 {
805         EditorData *ed;
806         gint flags = editor_command_parse(template, NULL, NULL);
807
808         if (flags & EDITOR_ERROR_MASK) return flags & EDITOR_ERROR_MASK;
809
810         ed = g_new0(EditorData, 1);
811         ed->list = filelist_copy(list);
812         ed->flags = flags;
813         ed->command_template = g_strdup(template);
814         ed->total = (flags & EDITOR_SINGLE_COMMAND) ? 1 : g_list_length(list);
815         ed->count = 0;
816         ed->stopping = FALSE;
817         ed->callback = cb;
818         ed->data =  data;
819
820         if ((flags & EDITOR_VERBOSE_MULTI) && list && list->next)
821                 flags |= EDITOR_VERBOSE;
822
823         if (flags & EDITOR_VERBOSE)
824                 editor_verbose_window(ed, text);
825
826         editor_command_next_start(ed);
827         /* errors from editor_command_next_start will be handled via callback */
828         return flags & EDITOR_ERROR_MASK;
829 }
830
831 gboolean is_valid_editor_command(gint n)
832 {
833         return (n >= 0 && n < GQ_EDITOR_SLOTS
834                 && options->editor[n].command
835                 && strlen(options->editor[n].command) > 0);
836 }
837
838 gint start_editor_from_filelist_full(gint n, GList *list, EditorCallback cb, gpointer data)
839 {
840         gchar *command;
841         gint error;
842
843         if (!list) return FALSE;
844         if (!is_valid_editor_command(n)) return FALSE;
845
846         command = g_locale_from_utf8(options->editor[n].command, -1, NULL, NULL, NULL);
847         error = editor_command_start(command, options->editor[n].name, list, cb, data);
848         g_free(command);
849
850         if (n < GQ_EDITOR_GENERIC_SLOTS && (error & EDITOR_ERROR_MASK))
851                 {
852                 gchar *text = g_strdup_printf(_("%s\n#%d \"%s\":\n%s"), editor_get_error_str(error), n+1,
853                                               options->editor[n].name, options->editor[n].command);
854                 
855                 file_util_warning_dialog(_("Invalid editor command"), text, GTK_STOCK_DIALOG_ERROR, NULL);
856                 g_free(text);
857                 }
858
859         return error;
860 }
861
862 gint start_editor_from_filelist(gint n, GList *list)
863 {
864         return start_editor_from_filelist_full(n, list,  NULL, NULL);
865 }
866
867 gint start_editor_from_file_full(gint n, FileData *fd, EditorCallback cb, gpointer data)
868 {
869         GList *list;
870         gint error;
871
872         if (!fd) return FALSE;
873
874         list = g_list_append(NULL, fd);
875         error = start_editor_from_filelist_full(n, list, cb, data);
876         g_list_free(list);
877         return error;
878 }
879
880 gint start_editor_from_file(gint n, FileData *fd)
881 {
882         return start_editor_from_file_full(n, fd, NULL, NULL);
883 }
884
885 gint editor_window_flag_set(gint n)
886 {
887         if (!is_valid_editor_command(n)) return TRUE;
888
889         return (editor_command_parse(options->editor[n].command, NULL, NULL) & EDITOR_KEEP_FS);
890 }
891
892 gint editor_is_filter(gint n)
893 {
894         if (!is_valid_editor_command(n)) return FALSE;
895
896         return (editor_command_parse(options->editor[n].command, NULL, NULL) & EDITOR_DEST);
897 }
898
899 const gchar *editor_get_error_str(gint flags)
900 {
901         if (flags & EDITOR_ERROR_EMPTY) return _("Editor template is empty.");
902         if (flags & EDITOR_ERROR_SYNTAX) return _("Editor template has incorrect syntax.");
903         if (flags & EDITOR_ERROR_INCOMPATIBLE) return _("Editor template uses incompatible macros.");
904         if (flags & EDITOR_ERROR_NO_FILE) return _("Can't find matching file type.");
905         if (flags & EDITOR_ERROR_CANT_EXEC) return _("Can't execute external editor.");
906         if (flags & EDITOR_ERROR_STATUS) return _("External editor returned error status.");
907         if (flags & EDITOR_ERROR_SKIPPED) return _("File was skipped.");
908         return _("Unknown error.");
909 }
910
911 const gchar *editor_get_name(gint n)
912 {
913         if (!is_valid_editor_command(n)) return NULL;
914
915         if (options->editor[n].name && strlen(options->editor[n].name) > 0)
916                 return options->editor[n].name;
917         
918         return _("(unknown)");
919 }