gcc/diagnostic-format.h

/* Declarations for managing different output formats for diagnostics.
   Copyright (C) 2023-2025 Free Software Foundation, Inc.
   Contributed by David Malcolm <dmalcolm@redhat.com>.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  */

#ifndef GCC_DIAGNOSTIC_FORMAT_H
#define GCC_DIAGNOSTIC_FORMAT_H

#include "diagnostic.h"

class diagnostic_per_format_buffer;

/* Abstract base class for a particular output format for diagnostics;
   each value of -fdiagnostics-output-format= will have its own
   implementation.  */

class diagnostic_output_format
{
public:
  virtual ~diagnostic_output_format () {}

  virtual void dump (FILE *out, int indent) const;

  /* Vfunc for making an appropriate diagnostic_per_format_buffer
     subclass for this format.  */
  virtual std::unique_ptr<diagnostic_per_format_buffer>
  make_per_format_buffer () = 0;

  /* Vfunc to be called when call a diagnostic_buffer is set on
     a diagnostic_context, to update this format.  The per_format_buffer
     will be one created by make_per_format_buffer above and thus be
     of the correct subclass.  */
  virtual void set_buffer (diagnostic_per_format_buffer *) = 0;

  virtual void on_begin_group () = 0;
  virtual void on_end_group () = 0;

  /* Vfunc with responsibility for phase 3 of formatting the message
     and "printing" the result.  */
  virtual void on_report_diagnostic (const diagnostic_info &,
				     diagnostic_t orig_diag_kind) = 0;

  virtual void on_report_verbatim (text_info &);

  virtual void on_diagram (const diagnostic_diagram &diagram) = 0;
  virtual void after_diagnostic (const diagnostic_info &) = 0;
  virtual bool machine_readable_stderr_p () const = 0;
  virtual bool follows_reference_printer_p () const = 0;

  /* Vfunc called when the diagnostic_context changes its
     reference printer (either to a new subclass of pretty_printer
     or when color/url options change).
     Subclasses should update their m_printer accordingly.  */
  virtual void update_printer () = 0;

  diagnostic_context &get_context () const { return m_context; }
  pretty_printer *get_printer () const { return m_printer.get (); }

  text_art::theme *get_diagram_theme () const
  {
    return m_context.get_diagram_theme ();
  }

  void DEBUG_FUNCTION dump () const { dump (stderr, 0); }

protected:
  diagnostic_output_format (diagnostic_context &context)
  : m_context (context),
    m_printer (context.clone_printer ())
  {}

protected:
  diagnostic_context &m_context;
  std::unique_ptr<pretty_printer> m_printer;
};

extern void
diagnostic_output_format_init (diagnostic_context &,
			       const char *main_input_filename_,
			       const char *base_file_name,
			       enum diagnostics_output_format,
			       bool json_formatting);
extern void
diagnostic_output_format_init_json_stderr (diagnostic_context &context,
					   bool formatted);
extern void
diagnostic_output_format_init_json_file (diagnostic_context &context,
					 bool formatted,
					 const char *base_file_name);

#endif /* ! GCC_DIAGNOSTIC_FORMAT_H */