fdiagnostics-format=
Common Joined RejectNegative Enum(diagnostics_output_format)
--fdiagnostics-format=[text|json] Select output format.
+-fdiagnostics-format=[text|json|json-stderr|json-file] Select output format.
fdiagnostics-escape-format=
Common Joined RejectNegative Enum(diagnostics_escape_format)
Enum(diagnostics_output_format) String(text) Value(DIAGNOSTICS_OUTPUT_FORMAT_TEXT)
EnumValue
-Enum(diagnostics_output_format) String(json) Value(DIAGNOSTICS_OUTPUT_FORMAT_JSON)
+Enum(diagnostics_output_format) String(json) Value(DIAGNOSTICS_OUTPUT_FORMAT_JSON_STDERR)
+
+EnumValue
+Enum(diagnostics_output_format) String(json-stderr) Value(DIAGNOSTICS_OUTPUT_FORMAT_JSON_STDERR)
+
+EnumValue
+Enum(diagnostics_output_format) String(json-file) Value(DIAGNOSTICS_OUTPUT_FORMAT_JSON_FILE)
fdiagnostics-parseable-fixits
Common Var(flag_diagnostics_parseable_fixits)
cur_children_array = NULL;
}
-/* Callback for final cleanup for JSON output. */
+/* Flush the top-level array to OUTF. */
static void
-json_final_cb (diagnostic_context *)
+json_flush_to_file (FILE *outf)
{
- /* Flush the top-level array. */
- toplevel_array->dump (stderr);
- fprintf (stderr, "\n");
+ toplevel_array->dump (outf);
+ fprintf (outf, "\n");
delete toplevel_array;
toplevel_array = NULL;
}
-/* Set the output format for CONTEXT to FORMAT. */
+/* Callback for final cleanup for JSON output to stderr. */
-void
-diagnostic_output_format_init (diagnostic_context *context,
- enum diagnostics_output_format format)
+static void
+json_stderr_final_cb (diagnostic_context *)
+{
+ json_flush_to_file (stderr);
+}
+
+static char *json_output_base_file_name;
+
+/* Callback for final cleanup for JSON output to a file. */
+
+static void
+json_file_final_cb (diagnostic_context *)
{
- switch (format)
+ char *filename = concat (json_output_base_file_name, ".gcc.json", NULL);
+ FILE *outf = fopen (filename, "w");
+ if (!outf)
{
- default:
- gcc_unreachable ();
- case DIAGNOSTICS_OUTPUT_FORMAT_TEXT:
- /* The default; do nothing. */
- break;
-
- case DIAGNOSTICS_OUTPUT_FORMAT_JSON:
- {
- /* Set up top-level JSON array. */
- if (toplevel_array == NULL)
- toplevel_array = new json::array ();
-
- /* Override callbacks. */
- context->begin_diagnostic = json_begin_diagnostic;
- context->end_diagnostic = json_end_diagnostic;
- context->begin_group_cb = json_begin_group;
- context->end_group_cb = json_end_group;
- context->final_cb = json_final_cb;
- context->print_path = NULL; /* handled in json_end_diagnostic. */
-
- /* The metadata is handled in JSON format, rather than as text. */
- context->show_cwe = false;
-
- /* The option is handled in JSON format, rather than as text. */
- context->show_option_requested = false;
-
- /* Don't colorize the text. */
- pp_show_color (context->printer) = false;
- }
- break;
+ const char *errstr = xstrerror (errno);
+ fnotice (stderr, "error: unable to open '%s' for writing: %s\n",
+ filename, errstr);
+ free (filename);
+ return;
}
+ json_flush_to_file (outf);
+ fclose (outf);
+ free (filename);
+}
+
+/* Populate CONTEXT in preparation for JSON output (either to stderr, or
+ to a file). */
+
+static void
+diagnostic_output_format_init_json (diagnostic_context *context)
+{
+ /* Set up top-level JSON array. */
+ if (toplevel_array == NULL)
+ toplevel_array = new json::array ();
+
+ /* Override callbacks. */
+ context->begin_diagnostic = json_begin_diagnostic;
+ context->end_diagnostic = json_end_diagnostic;
+ context->begin_group_cb = json_begin_group;
+ context->end_group_cb = json_end_group;
+ context->print_path = NULL; /* handled in json_end_diagnostic. */
+
+ /* The metadata is handled in JSON format, rather than as text. */
+ context->show_cwe = false;
+
+ /* The option is handled in JSON format, rather than as text. */
+ context->show_option_requested = false;
+
+ /* Don't colorize the text. */
+ pp_show_color (context->printer) = false;
+}
+
+/* Populate CONTEXT in preparation for JSON output to stderr. */
+
+void
+diagnostic_output_format_init_json_stderr (diagnostic_context *context)
+{
+ diagnostic_output_format_init_json (context);
+ context->final_cb = json_stderr_final_cb;
+}
+
+/* Populate CONTEXT in preparation for JSON output to a file named
+ BASE_FILE_NAME.gcc.json. */
+
+void
+diagnostic_output_format_init_json_file (diagnostic_context *context,
+ const char *base_file_name)
+{
+ diagnostic_output_format_init_json (context);
+ context->final_cb = json_file_final_cb;
+ json_output_base_file_name = xstrdup (base_file_name);
}
#if CHECKING_P
}
}
+/* Set the output format for CONTEXT to FORMAT, using BASE_FILE_NAME for
+ file-based output formats. */
+
+void
+diagnostic_output_format_init (diagnostic_context *context,
+ const char *base_file_name,
+ enum diagnostics_output_format format)
+{
+ switch (format)
+ {
+ default:
+ gcc_unreachable ();
+ case DIAGNOSTICS_OUTPUT_FORMAT_TEXT:
+ /* The default; do nothing. */
+ break;
+
+ case DIAGNOSTICS_OUTPUT_FORMAT_JSON_STDERR:
+ diagnostic_output_format_init_json_stderr (context);
+ break;
+
+ case DIAGNOSTICS_OUTPUT_FORMAT_JSON_FILE:
+ diagnostic_output_format_init_json_file (context, base_file_name);
+ break;
+ }
+}
+
/* Implementation of diagnostic_path::num_events vfunc for
simple_diagnostic_path: simply get the number of events in the vec. */
/* The default: textual output. */
DIAGNOSTICS_OUTPUT_FORMAT_TEXT,
- /* JSON-based output. */
- DIAGNOSTICS_OUTPUT_FORMAT_JSON
+ /* JSON-based output, to stderr. */
+ DIAGNOSTICS_OUTPUT_FORMAT_JSON_STDERR,
+
+ /* JSON-based output, to a file. */
+ DIAGNOSTICS_OUTPUT_FORMAT_JSON_FILE
};
/* An enum for controlling how diagnostic_paths should be printed. */
extern char *build_message_string (const char *, ...) ATTRIBUTE_PRINTF_1;
extern void diagnostic_output_format_init (diagnostic_context *,
+ const char *base_file_name,
enum diagnostics_output_format);
+extern void diagnostic_output_format_init_json_stderr (diagnostic_context *context);
+extern void diagnostic_output_format_init_json_file (diagnostic_context *context,
+ const char *base_file_name);
/* Compute the number of digits in the decimal representation of an integer. */
extern int num_digits (int);
-fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} @gol
-fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]} @gol
-fdiagnostics-urls=@r{[}auto@r{|}never@r{|}always@r{]} @gol
--fdiagnostics-format=@r{[}text@r{|}json@r{]} @gol
+-fdiagnostics-format=@r{[}text@r{|}json@r{|}json-stderr@r{|}json-file@r{]} @gol
-fno-diagnostics-show-option -fno-diagnostics-show-caret @gol
-fno-diagnostics-show-labels -fno-diagnostics-show-line-numbers @gol
-fno-diagnostics-show-cwe @gol
@item -fdiagnostics-format=@var{FORMAT}
@opindex fdiagnostics-format
Select a different format for printing diagnostics.
-@var{FORMAT} is @samp{text} or @samp{json}.
+@var{FORMAT} is @samp{text}, @samp{json}, @samp{json-stderr},
+or @samp{json-file}.
+
The default is @samp{text}.
-The @samp{json} format consists of a top-level JSON array containing JSON
-objects representing the diagnostics.
+The @samp{json} format is a synonym for @samp{json-stderr}.
+The @samp{json-stderr} and @samp{json-file} formats are identical, apart from
+where the JSON is emitted to - with the former, the JSON is emitted to stderr,
+whereas with @samp{json-file} it is written to @file{@var{source}.gcc.json}.
-The JSON is emitted as one line, without formatting; the examples below
-have been formatted for clarity.
+The emitted JSON consists of a top-level JSON array containing JSON objects
+representing the diagnostics. The JSON is emitted as one line, without
+formatting; the examples below have been formatted for clarity.
Diagnostics can have child diagnostics. For example, this error and note:
break;
case OPT_fdiagnostics_format_:
- diagnostic_output_format_init (dc,
+ diagnostic_output_format_init (dc, opts->x_dump_base_name,
(enum diagnostics_output_format)value);
break;
break;
case OPT_fdiagnostics_format_:
- diagnostic_output_format_init (dc,
+ diagnostic_output_format_init (dc, opts->x_dump_base_name,
(enum diagnostics_output_format)value);
break;
--- /dev/null
+/* Check that -fdiagnostics-format=json-file works. */
+/* { dg-do compile } */
+/* { dg-options "-fdiagnostics-format=json-file" } */
+
+#warning message
+
+/* Verify that some JSON was written to a file with the expected name. */
+/* { dg-final { scan-file "diagnostic-format-json-file-1.c.gcc.json" "\"message\": \"#warning message\"" } } */
--- /dev/null
+/* Check that "json" and "json-stderr" are synonymous when used as
+ arguments to "-fdiagnostics-format=". */
+/* { dg-do compile } */
+/* { dg-options "-fdiagnostics-format=json-stderr" } */
+
+#error message
+
+/* Use dg-regexp to consume the JSON output starting with
+ the innermost values, and working outwards.
+ We can't rely on any ordering of the keys. */
+
+/* { dg-regexp "\"kind\": \"error\"" } */
+/* { dg-regexp "\"column-origin\": 1" } */
+/* { dg-regexp "\"escape-source\": false" } */
+/* { dg-regexp "\"message\": \"#error message\"" } */
+
+/* { dg-regexp "\"caret\": \{" } */
+/* { dg-regexp "\"file\": \"\[^\n\r\"\]*diagnostic-format-json-stderr-1.c\"" } */
+/* { dg-regexp "\"line\": 6" } */
+/* { dg-regexp "\"column\": 2" } */
+/* { dg-regexp "\"display-column\": 2" } */
+/* { dg-regexp "\"byte-column\": 2" } */
+
+/* { dg-regexp "\"finish\": \{" } */
+/* { dg-regexp "\"file\": \"\[^\n\r\"\]*diagnostic-format-json-stderr-1.c\"" } */
+/* { dg-regexp "\"line\": 6" } */
+/* { dg-regexp "\"column\": 6" } */
+/* { dg-regexp "\"display-column\": 6" } */
+/* { dg-regexp "\"byte-column\": 6" } */
+
+/* { dg-regexp "\"locations\": \[\[\{\}, \]*\]" } */
+/* { dg-regexp "\"children\": \[\[\]\[\]\]" } */
+/* { dg-regexp "\[\[\{\}, \]*\]" } */
projects / thirdparty / gcc.git / commitdiff
