t3404: todo list with commented-out commands only aborts
[gitweb.git] / editor.c
index 7519edecdc297a0c0fdbbb2f3c68cb55abf2e8b2..c985eee1f9d1c7307b7f533cb2d38de5a42ccb23 100644 (file)
--- a/editor.c
+++ b/editor.c
@@ -1,4 +1,5 @@
 #include "cache.h"
+#include "config.h"
 #include "strbuf.h"
 #include "run-command.h"
 #include "sigchain.h"
@@ -7,11 +8,16 @@
 #define DEFAULT_EDITOR "vi"
 #endif
 
+int is_terminal_dumb(void)
+{
+       const char *terminal = getenv("TERM");
+       return !terminal || !strcmp(terminal, "dumb");
+}
+
 const char *git_editor(void)
 {
        const char *editor = getenv("GIT_EDITOR");
-       const char *terminal = getenv("TERM");
-       int terminal_is_dumb = !terminal || !strcmp(terminal, "dumb");
+       int terminal_is_dumb = is_terminal_dumb();
 
        if (!editor && editor_program)
                editor = editor_program;
@@ -29,10 +35,21 @@ const char *git_editor(void)
        return editor;
 }
 
-int launch_editor(const char *path, struct strbuf *buffer, const char *const *env)
+const char *git_sequence_editor(void)
 {
-       const char *editor = git_editor();
+       const char *editor = getenv("GIT_SEQUENCE_EDITOR");
 
+       if (!editor)
+               git_config_get_string_const("sequence.editor", &editor);
+       if (!editor)
+               editor = git_editor();
+
+       return editor;
+}
+
+static int launch_specified_editor(const char *editor, const char *path,
+                                  struct strbuf *buffer, const char *const *env)
+{
        if (!editor)
                return error("Terminal is dumb, but EDITOR unset");
 
@@ -40,6 +57,23 @@ int launch_editor(const char *path, struct strbuf *buffer, const char *const *en
                const char *args[] = { editor, real_path(path), NULL };
                struct child_process p = CHILD_PROCESS_INIT;
                int ret, sig;
+               int print_waiting_for_editor = advice_waiting_for_editor && isatty(2);
+
+               if (print_waiting_for_editor) {
+                       /*
+                        * A dumb terminal cannot erase the line later on. Add a
+                        * newline to separate the hint from subsequent output.
+                        *
+                        * Make sure that our message is separated with a whitespace
+                        * from further cruft that may be written by the editor.
+                        */
+                       const char term = is_terminal_dumb() ? '\n' : ' ';
+
+                       fprintf(stderr,
+                               _("hint: Waiting for your editor to close the file...%c"),
+                               term);
+                       fflush(stderr);
+               }
 
                p.argv = args;
                p.env = env;
@@ -58,6 +92,13 @@ int launch_editor(const char *path, struct strbuf *buffer, const char *const *en
                if (ret)
                        return error("There was a problem with the editor '%s'.",
                                        editor);
+
+               if (print_waiting_for_editor && !is_terminal_dumb())
+                       /*
+                        * Go back to the beginning and erase the entire line to
+                        * avoid wasting the vertical space.
+                        */
+                       fputs("\r\033[K", stderr);
        }
 
        if (!buffer)
@@ -66,3 +107,14 @@ int launch_editor(const char *path, struct strbuf *buffer, const char *const *en
                return error_errno("could not read file '%s'", path);
        return 0;
 }
+
+int launch_editor(const char *path, struct strbuf *buffer, const char *const *env)
+{
+       return launch_specified_editor(git_editor(), path, buffer, env);
+}
+
+int launch_sequence_editor(const char *path, struct strbuf *buffer,
+                          const char *const *env)
+{
+       return launch_specified_editor(git_sequence_editor(), path, buffer, env);
+}