* complaints.c: New file, code moved from utils.c.
[external/binutils.git] / gdb / complaints.c
1 /* Support for complaint handling during symbol reading in GDB.
2    Copyright (C) 1990, 1991, 1992  Free Software Foundation, Inc.
3
4 This file is part of GDB.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
19
20 #include "defs.h"
21 #include "complaints.h"
22 #include "gdbcmd.h"
23 #include <varargs.h>
24
25 /* Structure to manage complaints about symbol file contents.  */
26
27 struct complaint complaint_root[1] = {
28   {
29     (char *) NULL,      /* Complaint message */
30     0,                  /* Complaint counter */
31     complaint_root      /* Next complaint. */
32   }
33 };
34
35 /* How many complaints about a particular thing should be printed before
36    we stop whining about it?  Default is no whining at all, since so many
37    systems have ill-constructed symbol files.  */
38
39 static unsigned int stop_whining = 0;
40
41 /* Should each complaint be self explanatory, or should we assume that
42    a series of complaints is being produced? 
43    case 0:  self explanatory message.
44    case 1:  First message of a series that must start off with explanation.
45    case 2:  Subsequent message, when user already knows we are reading
46             symbols and we can just state our piece.  */
47
48 static int complaint_series = 0;
49
50 /* External variables and functions referenced. */
51
52 extern int info_verbose;
53
54 \f
55 /* Functions to handle complaints during symbol reading.  */
56
57 /* Print a complaint about the input symbols, and link the complaint block
58    into a chain for later handling.  */
59
60 /* VARARGS */
61 void
62 complain (va_alist)
63      va_dcl
64 {
65   va_list args;
66   struct complaint *complaint;
67   char *val;
68
69   va_start (args);
70   complaint = va_arg (args, struct complaint *);
71   complaint -> counter++;
72   if (complaint -> next == NULL)
73     {
74       complaint -> next = complaint_root -> next;
75       complaint_root -> next = complaint;
76     }
77   if (complaint -> counter > stop_whining)
78     {
79       return;
80     }
81   wrap_here ("");
82
83   switch (complaint_series + (info_verbose << 1))
84     {
85
86       /* Isolated messages, must be self-explanatory.  */
87       case 0:
88         begin_line ();
89         puts_filtered ("During symbol reading, ");
90         wrap_here ("");
91         vprintf_filtered (complaint -> message, args);
92         puts_filtered (".\n");
93         break;
94
95       /* First of a series, without `set verbose'.  */
96       case 1:
97         begin_line ();
98         puts_filtered ("During symbol reading...");
99         vprintf_filtered (complaint -> message, args);
100         puts_filtered ("...");
101         wrap_here ("");
102         complaint_series++;
103         break;
104
105       /* Subsequent messages of a series, or messages under `set verbose'.
106          (We'll already have produced a "Reading in symbols for XXX..."
107          message and will clean up at the end with a newline.)  */
108       default:
109         vprintf_filtered (complaint -> message, args);
110         puts_filtered ("...");
111         wrap_here ("");
112     }
113   va_end (args);
114 }
115
116 /* Clear out all complaint counters that have ever been incremented.
117    If sym_reading is 1, be less verbose about successive complaints,
118    since the messages are appearing all together during a command that
119    reads symbols (rather than scattered around as psymtabs get fleshed
120    out into symtabs at random times).  If noisy is 1, we are in a
121    noisy symbol reading command, and our caller will print enough
122    context for the user to figure it out.  */
123
124 void
125 clear_complaints (sym_reading, noisy)
126      int sym_reading;
127      int noisy;
128 {
129   struct complaint *p;
130
131   for (p = complaint_root -> next; p != complaint_root; p = p -> next)
132     {
133       p -> counter = 0;
134     }
135
136   if (!sym_reading && !noisy && complaint_series > 1)
137     {
138       /* Terminate previous series, since caller won't.  */
139       puts_filtered ("\n");
140     }
141
142   complaint_series = sym_reading ? 1 + noisy : 0;
143 }
144
145 _initialize_complaints ()
146 {
147   add_show_from_set
148     (add_set_cmd ("complaints", class_support, var_zinteger,
149                   (char *) &stop_whining,
150                   "Set max number of complaints about incorrect symbols.",
151                   &setlist),
152      &showlist);
153
154 }