Merge branch 'ds/commit-graph-fsck'
[git] / editor.c
1 #include "cache.h"
2 #include "strbuf.h"
3 #include "run-command.h"
4 #include "sigchain.h"
5
6 #ifndef DEFAULT_EDITOR
7 #define DEFAULT_EDITOR "vi"
8 #endif
9
10 int is_terminal_dumb(void)
11 {
12         const char *terminal = getenv("TERM");
13         return !terminal || !strcmp(terminal, "dumb");
14 }
15
16 const char *git_editor(void)
17 {
18         const char *editor = getenv("GIT_EDITOR");
19         int terminal_is_dumb = is_terminal_dumb();
20
21         if (!editor && editor_program)
22                 editor = editor_program;
23         if (!editor && !terminal_is_dumb)
24                 editor = getenv("VISUAL");
25         if (!editor)
26                 editor = getenv("EDITOR");
27
28         if (!editor && terminal_is_dumb)
29                 return NULL;
30
31         if (!editor)
32                 editor = DEFAULT_EDITOR;
33
34         return editor;
35 }
36
37 int launch_editor(const char *path, struct strbuf *buffer, const char *const *env)
38 {
39         const char *editor = git_editor();
40
41         if (!editor)
42                 return error("Terminal is dumb, but EDITOR unset");
43
44         if (strcmp(editor, ":")) {
45                 const char *args[] = { editor, real_path(path), NULL };
46                 struct child_process p = CHILD_PROCESS_INIT;
47                 int ret, sig;
48                 int print_waiting_for_editor = advice_waiting_for_editor && isatty(2);
49
50                 if (print_waiting_for_editor) {
51                         /*
52                          * A dumb terminal cannot erase the line later on. Add a
53                          * newline to separate the hint from subsequent output.
54                          *
55                          * Make sure that our message is separated with a whitespace
56                          * from further cruft that may be written by the editor.
57                          */
58                         const char term = is_terminal_dumb() ? '\n' : ' ';
59
60                         fprintf(stderr,
61                                 _("hint: Waiting for your editor to close the file...%c"),
62                                 term);
63                         fflush(stderr);
64                 }
65
66                 p.argv = args;
67                 p.env = env;
68                 p.use_shell = 1;
69                 if (start_command(&p) < 0)
70                         return error("unable to start editor '%s'", editor);
71
72                 sigchain_push(SIGINT, SIG_IGN);
73                 sigchain_push(SIGQUIT, SIG_IGN);
74                 ret = finish_command(&p);
75                 sig = ret - 128;
76                 sigchain_pop(SIGINT);
77                 sigchain_pop(SIGQUIT);
78                 if (sig == SIGINT || sig == SIGQUIT)
79                         raise(sig);
80                 if (ret)
81                         return error("There was a problem with the editor '%s'.",
82                                         editor);
83
84                 if (print_waiting_for_editor && !is_terminal_dumb())
85                         /*
86                          * Go back to the beginning and erase the entire line to
87                          * avoid wasting the vertical space.
88                          */
89                         fputs("\r\033[K", stderr);
90         }
91
92         if (!buffer)
93                 return 0;
94         if (strbuf_read_file(buffer, path, 0) < 0)
95                 return error_errno("could not read file '%s'", path);
96         return 0;
97 }