sim/igen/lf.h

   1 /* The IGEN simulator generator for GDB, the GNU Debugger.
   2
   3    Copyright 2002-2021 Free Software Foundation, Inc.
   4
   5    Contributed by Andrew Cagney.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #include "ansidecl.h"
  23
  24 /* LF: Line Numbered Output Stream */
  25
  26 typedef struct _lf lf;
  27
  28 typedef enum
  29 {
  30   lf_is_h,
  31   lf_is_c,
  32   lf_is_text,
  33 }
  34 lf_file_type;
  35
  36
  37 typedef enum
  38 {
  39   lf_include_references,
  40   lf_omit_references,
  41 }
  42 lf_file_references;
  43
  44
  45 /* Open the file NAME for writing ("-" for stdout).  Use REAL_NAME
  46    when refering to the opened file.  Line number information (in the
  47    output) can be suppressed with FILE_REFERENCES ==
  48    LF_OMIT_REFERENCES.  TYPE is to determine the formatting of some of
  49    the print messages below. */
  50
  51 extern lf *lf_open
  52   (char *name,
  53    char *real_name,
  54    lf_file_references file_references,
  55    lf_file_type type, const char *program);
  56
  57 extern lf_file_type lf_get_file_type (const lf *file);
  58
  59 extern void lf_close (lf *file);
  60
  61
  62 /* Basic output functions */
  63
  64 extern int lf_write (lf *file, const char *string, int len);
  65
  66 extern int lf_putchr (lf *file, const char ch);
  67
  68 extern int lf_putstr (lf *file, const char *string);
  69
  70 extern int lf_putint (lf *file, int decimal);
  71
  72 extern int lf_putbin (lf *file, int decimal, int width);
  73
  74 extern int lf_printf
  75   (lf *file, const char *fmt, ...) ATTRIBUTE_PRINTF (2, 3);
  76
  77
  78 /* Indentation control.
  79
  80    lf_indent_suppress suppresses indentation on the next line (current
  81    line if that has not yet been started) */
  82
  83 extern void lf_indent_suppress (lf *file);
  84
  85 extern void lf_indent (lf *file, int delta);
  86
  87
  88 /* Print generic text: */
  89
  90
  91 extern int lf_print__gnu_copyleft (lf *file);
  92
  93 extern int lf_print__file_start (lf *file);
  94
  95 extern int lf_print__this_file_is_empty (lf *file, const char *reason);
  96
  97 extern int lf_print__file_finish (lf *file);
  98
  99 extern int lf_print__internal_ref (lf *file);
 100
 101 extern int lf_print__external_ref
 102   (lf *file, int line_nr, const char *file_name);
 103
 104 extern int lf_print__line_ref (lf *file, line_ref *line);
 105
 106 extern int lf_print__ucase_filename (lf *file);
 107
 108 extern int lf_print__function_type
 109   (lf *file,
 110    const char *type, const char *prefix, const char *trailing_space);
 111
 112 typedef int print_function (lf *file);
 113
 114 extern int lf_print__function_type_function
 115   (lf *file,
 116    print_function * print_type,
 117    const char *prefix, const char *trailing_space);