gcc/diagnostic-url.h

   1 /* Copyright (C) 2019-2022 Free Software Foundation, Inc.
   2    Contributed by David Malcolm <dmalcolm@redhat.com>.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_DIAGNOSTIC_URL_H
  21 #define GCC_DIAGNOSTIC_URL_H
  22
  23 /* Whether to add URLs to diagnostics:
  24    - DIAGNOSTICS_URL_NO: never
  25    - DIAGNOSTICS_URL_YES: always
  26    - DIAGNOSTICS_URL_AUTO: depending on the output stream.  */
  27 typedef enum
  28 {
  29   DIAGNOSTICS_URL_NO       = 0,
  30   DIAGNOSTICS_URL_YES      = 1,
  31   DIAGNOSTICS_URL_AUTO     = 2
  32 } diagnostic_url_rule_t;
  33
  34 /* Tells whether URLs should be emitted, and, if so, how to
  35    terminate strings within the escape sequence.   */
  36 enum diagnostic_url_format
  37 {
  38   /* No URLs shall be emitted.  */
  39   URL_FORMAT_NONE,
  40
  41   /* Use ST string termination.  */
  42   URL_FORMAT_ST,
  43
  44   /* Use BEL string termination.  */
  45   URL_FORMAT_BEL
  46 };
  47
  48 const diagnostic_url_format URL_FORMAT_DEFAULT = URL_FORMAT_BEL;
  49
  50 extern diagnostic_url_format determine_url_format (diagnostic_url_rule_t);
  51
  52 #endif /* ! GCC_DIAGNOSTIC_URL_H */