@matheusbsbs / matheus-bagliano / commits / 18568ee8f8

usage.c: add a die_message() routine

We have code in various places that would like to call die(), but wants to defer the exit(128) it would invoke, e.g. to print an additional message, or adjust the exit code. Add a die_message() helper routine to bridge this gap in the API. Functionally this behaves just like the error() routine, except it'll print a "fatal: " prefix, and it will return with 128 instead of -1, this is so that caller can pass the return value to "exit()", instead of having to hardcode "exit(128)". Note that as with the other routines the "die_message_builtin" needs to return "void" and otherwise conform to the "report_fn" signature. As we'll see in a subsequent commit callers will want to replace e.g. their default "die_routine" with a "die_message_routine". For now we're just adding the routine and making die_builtin() in usage.c itself use it. In order to do that we need to add a get_die_message_routine() function, which works like the other get_*_routine() functions in usage.c. There is no set_die_message_rotine(), as it hasn't been needed yet. We can add it if we ever need it. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Dec 7, 2021 at 19:26 UTC 18568ee8f8836db5fc1848f2b34e313ac0a86980

2 files changed +27 -3

git-compat-util.h

@@ -479,6 +479,7 @@ NORETURN void usage(const char *err);

479 NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));

480 NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));

481 NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));

482 +int die_message(const char *err, ...) __attribute__((format (printf, 1, 2)));

483 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));

484 int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));

485 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));

@@ -513,6 +514,7 @@ static inline int const_error(void)

514 typedef void (*report_fn)(const char *, va_list params);

515

516 void set_die_routine(NORETURN_PTR report_fn routine);

517 +report_fn get_die_message_routine(void);

518 void set_error_routine(report_fn routine);

519 report_fn get_error_routine(void);

520 void set_warn_routine(report_fn routine);

usage.c

+25 -3

@@ -55,6 +55,12 @@ static NORETURN void usage_builtin(const char *err, va_list params)

55 exit(129);

56 }

58 +static void die_message_builtin(const char *err, va_list params)

59 +{

60 + trace2_cmd_error_va(err, params);

61 + vreportf("fatal: ", err, params);

62 +}

63 +

64 /*

65 * We call trace2_cmd_error_va() in the below functions first and

66 * expect it to va_copy 'params' before using it (because an 'ap' can

@@ -62,10 +68,9 @@ static NORETURN void usage_builtin(const char *err, va_list params)

68 */

69 static NORETURN void die_builtin(const char *err, va_list params)

70 {

65 - trace2_cmd_error_va(err, params);

66 -

67 - vreportf("fatal: ", err, params);

71 + report_fn die_message_fn = get_die_message_routine();

73 + die_message_fn(err, params);

74 exit(128);

75 }

@@ -109,6 +114,7 @@ static int die_is_recursing_builtin(void)

114 * (ugh), so keep things static. */

115 static NORETURN_PTR report_fn usage_routine = usage_builtin;

116 static NORETURN_PTR report_fn die_routine = die_builtin;

117 +static report_fn die_message_routine = die_message_builtin;

118 static report_fn error_routine = error_builtin;

119 static report_fn warn_routine = warn_builtin;

120 static int (*die_is_recursing)(void) = die_is_recursing_builtin;

@@ -118,6 +124,11 @@ void set_die_routine(NORETURN_PTR report_fn routine)

124 die_routine = routine;

125 }

126

127 +report_fn get_die_message_routine(void)

128 +{

129 + return die_message_routine;

130 +}

131 +

132 void set_error_routine(report_fn routine)

133 {

134 error_routine = routine;

@@ -211,6 +222,17 @@ void NORETURN die_errno(const char *fmt, ...)

222 va_end(params);

223 }

224

225 +#undef die_message

226 +int die_message(const char *err, ...)

227 +{

228 + va_list params;

229 +

230 + va_start(params, err);

231 + die_message_routine(err, params);

232 + va_end(params);

233 + return 128;

234 +}

235 +

236 #undef error_errno

237 int error_errno(const char *fmt, ...)

238 {