editor.c

   1 #include "cache.h"
   2 #include "config.h"
   3 #include "strbuf.h"
   4 #include "run-command.h"
   5 #include "sigchain.h"
   6 #include "compat/terminal.h"
   7
   8 #ifndef DEFAULT_EDITOR
   9 #define DEFAULT_EDITOR "vi"
  10 #endif
  11
  12 int is_terminal_dumb(void)
  13 {
  14         const char *terminal = getenv("TERM");
  15         return !terminal || !strcmp(terminal, "dumb");
  16 }
  17
  18 const char *git_editor(void)
  19 {
  20         const char *editor = getenv("GIT_EDITOR");
  21         int terminal_is_dumb = is_terminal_dumb();
  22
  23         if (!editor && editor_program)
  24                 editor = editor_program;
  25         if (!editor && !terminal_is_dumb)
  26                 editor = getenv("VISUAL");
  27         if (!editor)
  28                 editor = getenv("EDITOR");
  29
  30         if (!editor && terminal_is_dumb)
  31                 return NULL;
  32
  33         if (!editor)
  34                 editor = DEFAULT_EDITOR;
  35
  36         return editor;
  37 }
  38
  39 const char *git_sequence_editor(void)
  40 {
  41         const char *editor = getenv("GIT_SEQUENCE_EDITOR");
  42
  43         if (!editor)
  44                 git_config_get_string_tmp("sequence.editor", &editor);
  45         if (!editor)
  46                 editor = git_editor();
  47
  48         return editor;
  49 }
  50
  51 static int launch_specified_editor(const char *editor, const char *path,
  52                                    struct strbuf *buffer, const char *const *env)
  53 {
  54         int term_fail;
  55
  56         if (!editor)
  57                 return error("Terminal is dumb, but EDITOR unset");
  58
  59         if (strcmp(editor, ":")) {
  60                 struct strbuf realpath = STRBUF_INIT;
  61                 const char *args[] = { editor, NULL, NULL };
  62                 struct child_process p = CHILD_PROCESS_INIT;
  63                 int ret, sig;
  64                 int print_waiting_for_editor = advice_enabled(ADVICE_WAITING_FOR_EDITOR) && isatty(2);
  65
  66                 if (print_waiting_for_editor) {
  67                         /*
  68                          * A dumb terminal cannot erase the line later on. Add a
  69                          * newline to separate the hint from subsequent output.
  70                          *
  71                          * Make sure that our message is separated with a whitespace
  72                          * from further cruft that may be written by the editor.
  73                          */
  74                         const char term = is_terminal_dumb() ? '\n' : ' ';
  75
  76                         fprintf(stderr,
  77                                 _("hint: Waiting for your editor to close the file...%c"),
  78                                 term);
  79                         fflush(stderr);
  80                 }
  81
  82                 strbuf_realpath(&realpath, path, 1);
  83                 args[1] = realpath.buf;
  84
  85                 p.argv = args;
  86                 p.env = env;
  87                 p.use_shell = 1;
  88                 p.trace2_child_class = "editor";
  89                 term_fail = save_term(1);
  90                 if (start_command(&p) < 0) {
  91                         if (!term_fail)
  92                                 restore_term();
  93                         strbuf_release(&realpath);
  94                         return error("unable to start editor '%s'", editor);
  95                 }
  96
  97                 sigchain_push(SIGINT, SIG_IGN);
  98                 sigchain_push(SIGQUIT, SIG_IGN);
  99                 ret = finish_command(&p);
 100                 if (!term_fail)
 101                         restore_term();
 102                 strbuf_release(&realpath);
 103                 sig = ret - 128;
 104                 sigchain_pop(SIGINT);
 105                 sigchain_pop(SIGQUIT);
 106                 if (sig == SIGINT || sig == SIGQUIT)
 107                         raise(sig);
 108                 if (ret)
 109                         return error("There was a problem with the editor '%s'.",
 110                                         editor);
 111
 112                 if (print_waiting_for_editor && !is_terminal_dumb())
 113                         /*
 114                          * Erase the entire line to avoid wasting the
 115                          * vertical space.
 116                          */
 117                         term_clear_line();
 118         }
 119
 120         if (!buffer)
 121                 return 0;
 122         if (strbuf_read_file(buffer, path, 0) < 0)
 123                 return error_errno("could not read file '%s'", path);
 124         return 0;
 125 }
 126
 127 int launch_editor(const char *path, struct strbuf *buffer, const char *const *env)
 128 {
 129         return launch_specified_editor(git_editor(), path, buffer, env);
 130 }
 131
 132 int launch_sequence_editor(const char *path, struct strbuf *buffer,
 133                            const char *const *env)
 134 {
 135         return launch_specified_editor(git_sequence_editor(), path, buffer, env);
 136 }