gcc/read-md.h

   1 /* MD reader definitions.
   2    Copyright (C) 1987-2015 Free Software Foundation, Inc.
   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_READ_MD_H
  21 #define GCC_READ_MD_H
  22
  23 #include "obstack.h"
  24
  25 /* Holds one symbol or number in the .md file.  */
  26 struct md_name {
  27   /* The name as it appeared in the .md file.  Names are syntactically
  28      limited to the length of this buffer.  */
  29   char buffer[256];
  30
  31   /* The name that should actually be used by the generator programs.
  32      This is an expansion of NAME, after things like constant substitution.  */
  33   char *string;
  34 };
  35
  36 /* This structure represents a constant defined by define_constant,
  37    define_enum, or such-like.  */
  38 struct md_constant {
  39   /* The name of the constant.  */
  40   char *name;
  41
  42   /* The string to which the constants expands.  */
  43   char *value;
  44
  45   /* If the constant is associated with a enumeration, this field
  46      points to that enumeration, otherwise it is null.  */
  47   struct enum_type *parent_enum;
  48 };
  49
  50 /* This structure represents one value in an enum_type.  */
  51 struct enum_value {
  52   /* The next value in the enum, or null if this is the last.  */
  53   struct enum_value *next;
  54
  55   /* The name of the value as it appears in the .md file.  */
  56   char *name;
  57
  58   /* The definition of the related C value.  */
  59   struct md_constant *def;
  60 };
  61
  62 /* This structure represents an enum defined by define_enum or the like.  */
  63 struct enum_type {
  64   /* The C name of the enumeration.  */
  65   char *name;
  66
  67   /* True if this is an md-style enum (DEFINE_ENUM) rather than
  68      a C-style enum (DEFINE_C_ENUM).  */
  69   bool md_p;
  70
  71   /* The values of the enumeration.  There is always at least one.  */
  72   struct enum_value *values;
  73
  74   /* A pointer to the null terminator in VALUES.  */
  75   struct enum_value **tail_ptr;
  76
  77   /* The number of enumeration values.  */
  78   unsigned int num_values;
  79 };
  80
  81 /* A callback that handles a single .md-file directive, up to but not
  82    including the closing ')'.  It takes two arguments: the line number on
  83    which the directive started, and the name of the directive.  The next
  84    unread character is the optional space after the directive name.  */
  85 typedef void (*directive_handler_t) (int, const char *);
  86
  87 extern const char *in_fname;
  88 extern FILE *read_md_file;
  89 extern int read_md_lineno;
  90 extern const char *read_md_filename;
  91 extern struct obstack string_obstack;
  92 extern void (*include_callback) (const char *);
  93
  94 /* Read the next character from the MD file.  */
  95
  96 static inline int
  97 read_char (void)
  98 {
  99   int ch;
 100
 101   ch = getc (read_md_file);
 102   if (ch == '\n')
 103     read_md_lineno++;
 104   return ch;
 105 }
 106
 107 /* Put back CH, which was the last character read from the MD file.  */
 108
 109 static inline void
 110 unread_char (int ch)
 111 {
 112   if (ch == '\n')
 113     read_md_lineno--;
 114   ungetc (ch, read_md_file);
 115 }
 116
 117 extern hashval_t leading_string_hash (const void *);
 118 extern int leading_string_eq_p (const void *, const void *);
 119 extern void copy_md_ptr_loc (const void *, const void *);
 120 extern void print_md_ptr_loc (const void *);
 121 extern void fprint_md_ptr_loc (FILE *, const void *);
 122 extern const char *join_c_conditions (const char *, const char *);
 123 extern void print_c_condition (const char *);
 124 extern void fprint_c_condition (FILE *, const char *);
 125 extern void message_with_line (int, const char *, ...) ATTRIBUTE_PRINTF_2;
 126 extern void error_with_line (int, const char *, ...) ATTRIBUTE_PRINTF_2;
 127 extern void fatal_with_file_and_line (const char *, ...)
 128   ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN;
 129 extern void fatal_expected_char (int, int) ATTRIBUTE_NORETURN;
 130 extern int read_skip_spaces (void);
 131 extern void read_name (struct md_name *);
 132 extern char *read_quoted_string (void);
 133 extern char *read_string (int);
 134 extern void read_skip_construct (int, int);
 135 extern int n_comma_elts (const char *);
 136 extern const char *scan_comma_elt (const char **);
 137 extern void upcase_string (char *);
 138 extern void traverse_md_constants (htab_trav, void *);
 139 extern void traverse_enum_types (htab_trav, void *);
 140 extern struct enum_type *lookup_enum_type (const char *);
 141 extern bool read_md_files (int, char **, bool (*) (const char *),
 142                            directive_handler_t);
 143
 144 #endif /* GCC_READ_MD_H */