xref: /netbsd-src/external/gpl3/gdb/dist/sim/igen/table.h (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /* The IGEN simulator generator for GDB, the GNU Debugger.
2 
3    Copyright 2002-2014 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 
23 /* Read a table, line by line, from a file.
24 
25    A table line has several forms:
26 
27    Field line:
28 
29        <text> { ":" <text> }
30        type == table_colon_entry
31 
32        Fields points to a NULL terminated list of pointers.
33 
34    Tab indented block:
35 
36      <tab> <text> <nl> { <tab> <text> <nl> }
37      type == table_code_entry
38 
39      The leading tab at the start of each line is discarded.
40      fields[i] is the i'th line with the <nl> discarded.
41 
42 
43    Code block:
44 
45      "{" <ignore-text> <nl> { <text> <nl> } "}" <ignore-text> <nl>
46      type == table_code_entry
47 
48      The leading/trailing {/} lines are discarded.
49      Lines containing two leading spaces have those spaces striped.
50      fields[i] is the i'th line with the <nl> discarded.
51 
52    In addition, the table parser reconises and handles internally the
53    following (when not in a code block):
54 
55      "#" <line-nr> '"' <file> '"'
56 
57      As per CPP/CC, treat following lines as if they were taken from
58      <file> starting at <line-nr>
59 
60    No support for CPP's "#if/#else/#endif" style conditions are
61    planned. */
62 
63 typedef struct _table table;
64 
65 typedef enum
66 {
67   table_colon_entry,
68   table_code_entry,
69 }
70 table_entry_type;
71 
72 
73 typedef struct _table_entry table_entry;
74 struct _table_entry
75 {
76   table *file;
77   line_ref *line;
78   table_entry_type type;
79   int nr_fields;
80   char **field;
81 };
82 
83 /* List of directories to search when opening a pushed file.  Current
84    directory is always searched first */
85 typedef struct _table_include table_include;
86 struct _table_include
87 {
88   char *dir;
89   table_include *next;
90 };
91 
92 
93 /* Open/read a table file.  Since the file is read once during open
94    (and then closed immediatly) there is no close method. */
95 
96 extern table *table_open (const char *file_name);
97 
98 extern table_entry *table_read (table *file);
99 
100 
101 /* Push the the state of the current file and open FILE_NAME.  When
102    the end of FILE_NAME is reached, return to the pushed file */
103 
104 extern void table_push
105   (table *file, line_ref *line, table_include *search, const char *file_name);
106 
107 
108 /* Expand the specified field_nr using the internal expansion table.
109    A field is only expanded when explicitly specified.  */
110 
111 extern void table_expand_field (table_entry *entry, int field_nr);
112 
113 
114 /* Given a code entry, write the code to FILE.  Since any
115    leading/trailing braces were striped as part of the read, they are
116    not written. */
117 
118 extern void table_print_code (lf *file, table_entry *entry);
119 
120 
121 /* Debugging */
122 
123 extern void dump_line_ref
124   (lf *file, char *prefix, const line_ref *line, char *suffix);
125 
126 extern void dump_table_entry
127   (lf *file, char *prefix, const table_entry *entry, char *suffix);
128 
129 
130 
131 /* Utilities for skipping around text */
132 
133 extern char *skip_digits (char *chp);
134 
135 extern char *skip_spaces (char *chp);
136 
137 extern char *skip_to_separator (char *chp, char *separators);
138 
139 extern char *back_spaces (char *start, char *chp);
140