OSDN Git Service

2003-11-11 Doug Gregor <gregod@cs.rpi.edu>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / src / debug.cc
1 // Debugging mode support code -*- C++ -*-
2
3 // Copyright (C) 2003
4 // Free Software Foundation, Inc.
5 //
6 // This file is part of the GNU ISO C++ Library.  This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 2, or (at your option)
10 // any later version.
11
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 // GNU General Public License for more details.
16
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING.  If not, write to the Free
19 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
20 // USA.
21
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction.  Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License.  This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
30
31 #include <debug/debug.h>
32 #include <debug/safe_sequence.h>
33 #include <debug/safe_iterator.h>
34 #include <algorithm>
35 #include <cstdlib>
36 #include <cassert>
37 #include <cstring>
38 #include <cstdio>
39 #include <cctype>
40
41 using namespace std;
42
43 namespace __gnu_debug
44 {
45   const char* _S_debug_messages[] = 
46   {
47     "function requires a valid iterator range [%1.name;, %2.name;)",
48     "attempt to insert into container with a singular iterator",
49     "attempt to insert into container with an iterator from a different container",
50     "attempt to erase from container with a %2.state; iterator",
51     "attempt to erase from container with an iterator from a different container",
52     "attempt to subscript container with out-of-bounds index %2;, but container only holds %3; elements",
53     "attempt to access an element in an empty container",
54     "elements in iterator range [%1.name;, %2.name;) are not partitioned by the value %3;",
55     "elements in iterator range [%1.name;, %2.name;) are not partitioned by the predicate %3; and value %4;",
56     "elements in iterator range [%1.name;, %2.name;) are not sorted",
57     "elements in iterator range [%1.name;, %2.name;) are not sorted according to the predicate %3;",
58     "elements in iterator range [%1.name;, %2.name;) do not form a heap",
59     "elements in iterator range [%1.name;, %2.name;) do not form a heap with respect to the predicate %3;",
60     "attempt to write through a singular bitset reference",
61     "attempt to read from a singular bitset reference",
62     "attempt to flip a singular bitset reference",
63     "attempt to splice a list into itself",
64     "attempt to splice lists with inequal allocators",
65     "attempt to splice elements referenced by a %1.state; iterator",
66     "attempt to splice an iterator from a different container",
67     "splice destination %1.name; occurs within source range [%2.name;, %3.name;)",
68     "attempt to initialize an iterator that will immediately become singular",
69     "attempt to copy-construct an iterator from a singular iterator",
70     "attempt to construct a constant iterator from a singular mutable iterator",
71     "attempt to copy from a singular iterator",
72     "attempt to dereference a %1.state; iterator",
73     "attempt to increment a %1.state; iterator",
74     "attempt to decrement a %1.state; iterator",
75     "attempt to subscript a %1.state; iterator %2; step from its current position, which falls outside its dereferenceable range",
76     "attempt to advance a %1.state; iterator %2; steps, which falls outside its valid range",
77     "attempt to retreat a %1.state; iterator %2; steps, which falls outside its valid range",
78     "attempt to compare a %1.state; iterator to a %2.state; iterator",
79     "attempt to compare iterators from different sequences",
80     "attempt to order a %1.state; iterator to a %2.state; iterator",
81     "attempt to order iterators from different sequences",
82     "attempt to compute the difference between a %1.state; iterator to a %2.state; iterator",
83     "attempt to compute the different between two iterators from different sequences",
84     "attempt to dereference an end-of-stream istream_iterator",
85     "attempt to increment an end-of-stream istream_iterator",
86     "attempt to output via an ostream_iterator with no associated stream",
87     "attempt to dereference an end-of-stream istreambuf_iterator (this is a GNU extension)",
88     "attempt to increment an end-of-stream istreambuf_iterator"
89   };
90
91   void 
92   _Safe_sequence_base::
93   _M_detach_all()
94   {
95     for (_Safe_iterator_base* iter = _M_iterators; iter; )
96     {
97       _Safe_iterator_base* old = iter;
98       iter = iter->_M_next;
99       old->_M_attach(0, false);
100     }
101     
102     for (_Safe_iterator_base* iter = _M_const_iterators; iter; )
103     {
104       _Safe_iterator_base* old = iter;
105       iter = iter->_M_next;
106       old->_M_attach(0, true);
107     }
108   }
109
110   void 
111   _Safe_sequence_base::
112   _M_detach_singular()
113   {
114     for (_Safe_iterator_base* iter = _M_iterators; iter; )
115     {
116       _Safe_iterator_base* old = iter;
117       iter = iter->_M_next;
118       if (old->_M_singular())
119         old->_M_attach(0, false);
120     }
121
122     for (_Safe_iterator_base* iter = _M_const_iterators; iter; )
123     {
124       _Safe_iterator_base* old = iter;
125       iter = iter->_M_next;
126       if (old->_M_singular())
127         old->_M_attach(0, true);
128     }
129   }
130
131   void 
132   _Safe_sequence_base::
133   _M_revalidate_singular()
134   {
135     for (_Safe_iterator_base* iter = _M_iterators; iter;
136          iter = iter->_M_next)
137     {
138       iter->_M_version = _M_version;
139       iter = iter->_M_next;
140     }
141     
142     for (_Safe_iterator_base* iter = _M_const_iterators; iter;
143          iter = iter->_M_next)
144     {
145       iter->_M_version = _M_version;
146       iter = iter->_M_next;
147     }
148   }
149
150   void 
151   _Safe_sequence_base::
152   _M_swap(_Safe_sequence_base& __x)
153   {
154     swap(_M_iterators, __x._M_iterators);
155     swap(_M_const_iterators, __x._M_const_iterators);
156     swap(_M_version, __x._M_version);
157     for (_Safe_iterator_base* iter = _M_iterators; iter; iter = iter->_M_next)
158       iter->_M_sequence = this;
159     for (_Safe_iterator_base* iter = __x._M_iterators; iter; iter = iter->_M_next)
160       iter->_M_sequence = &__x;
161     for (_Safe_iterator_base* iter = _M_const_iterators; iter; iter = iter->_M_next)
162       iter->_M_sequence = this;
163     for (_Safe_iterator_base* iter = __x._M_const_iterators; iter; iter = iter->_M_next)
164       iter->_M_sequence = &__x;
165   }
166   
167   void 
168   _Safe_iterator_base::
169   _M_attach(_Safe_sequence_base* __seq, bool __constant)
170   {
171     _M_detach();
172     
173     // Attach to the new sequence (if there is one)
174     if (__seq)
175     {
176       _M_sequence = __seq;
177       _M_version = _M_sequence->_M_version;
178       _M_prior = 0;
179       if (__constant)
180       {
181         _M_next = _M_sequence->_M_const_iterators;
182         if (_M_next)
183           _M_next->_M_prior = this;
184         _M_sequence->_M_const_iterators = this;
185       }
186       else
187       {
188         _M_next = _M_sequence->_M_iterators;
189         if (_M_next)
190           _M_next->_M_prior = this;
191         _M_sequence->_M_iterators = this;
192       }
193     }
194   }
195
196   void 
197   _Safe_iterator_base::
198   _M_detach()
199   {
200     if (_M_sequence)
201     {
202       // Remove us from this sequence's list
203       if (_M_prior) _M_prior->_M_next = _M_next;
204       if (_M_next)  _M_next->_M_prior = _M_prior;
205       
206       if (_M_sequence->_M_const_iterators == this)
207         _M_sequence->_M_const_iterators = _M_next;
208       if (_M_sequence->_M_iterators == this)
209         _M_sequence->_M_iterators = _M_next;
210     }
211
212     _M_sequence = 0;
213     _M_version = 0;
214     _M_prior = 0;
215     _M_next = 0;
216   }
217   
218   bool
219   _Safe_iterator_base::
220   _M_singular() const
221   { return !_M_sequence || _M_version != _M_sequence->_M_version; }
222     
223   bool
224   _Safe_iterator_base::
225   _M_can_compare(const _Safe_iterator_base& __x) const
226   {
227     return (! _M_singular() && !__x._M_singular()
228             && _M_sequence == __x._M_sequence);
229   }
230
231   void
232   _Error_formatter::_Parameter::
233   _M_print_field(const _Error_formatter* __formatter,
234                  const char* __name) const
235   {
236     assert(this->_M_kind != _Parameter::__unused_param);
237     const int bufsize = 64;
238     char buf[bufsize];
239     
240     if (_M_kind == __iterator)
241     {
242       if (strcmp(__name, "name") == 0)
243       {
244         assert(_M_variant._M_iterator._M_name);
245         __formatter->_M_print_word(_M_variant._M_iterator._M_name);
246       }
247       else if (strcmp(__name, "address") == 0)
248       {
249         snprintf(buf, bufsize, "%p", _M_variant._M_iterator._M_address);
250         __formatter->_M_print_word(buf);
251       }
252       else if (strcmp(__name, "type") == 0)
253       {
254         assert(_M_variant._M_iterator._M_type);
255         // TBD: demangle!
256         __formatter->_M_print_word(_M_variant._M_iterator._M_type->name());
257       }
258       else if (strcmp(__name, "constness") == 0)
259       {
260         static const char* __constness_names[__last_constness] =
261         {
262           "<unknown>",
263           "constant",
264           "mutable"
265         };
266         __formatter->_M_print_word(__constness_names[_M_variant._M_iterator._M_constness]);
267       }
268       else if (strcmp(__name, "state") == 0)
269       {
270         static const char* __state_names[__last_state] = 
271         {
272           "<unknown>",
273           "singular",
274           "dereferenceable (start-of-sequence)",
275           "dereferenceable",
276           "past-the-end"
277         };
278         __formatter->_M_print_word(__state_names[_M_variant._M_iterator._M_state]);
279       }
280       else if (strcmp(__name, "sequence") == 0)
281       {
282         assert(_M_variant._M_iterator._M_sequence);
283         snprintf(buf, bufsize, "%p", _M_variant._M_iterator._M_sequence);
284         __formatter->_M_print_word(buf);
285       }
286       else if (strcmp(__name, "seq_type") == 0)
287       {
288         // TBD: demangle!
289         assert(_M_variant._M_iterator._M_seq_type);
290         __formatter->_M_print_word(_M_variant._M_iterator._M_seq_type->name());
291       }
292       else
293         assert(false);
294     }
295     else if (_M_kind == __sequence)
296     {
297       if (strcmp(__name, "name") == 0)
298       {
299         assert(_M_variant._M_sequence._M_name);
300         __formatter->_M_print_word(_M_variant._M_sequence._M_name);
301       }
302       else if (strcmp(__name, "address") == 0)
303       {
304         assert(_M_variant._M_sequence._M_address);
305         snprintf(buf, bufsize, "%p", _M_variant._M_sequence._M_address);
306         __formatter->_M_print_word(buf);
307       }
308       else if (strcmp(__name, "type") == 0)
309       {
310         // TBD: demangle!
311         assert(_M_variant._M_sequence._M_type);
312         __formatter->_M_print_word(_M_variant._M_sequence._M_type->name());
313       }
314       else
315         assert(false);
316     }
317     else if (_M_kind == __integer)
318     {
319       if (strcmp(__name, "name") == 0)
320       {
321         assert(_M_variant._M_integer._M_name);
322         __formatter->_M_print_word(_M_variant._M_integer._M_name);
323       }
324       else
325         assert(false);
326     }
327     else if (_M_kind == __string)
328     {
329       if (strcmp(__name, "name") == 0)
330       {
331         assert(_M_variant._M_string._M_name);
332         __formatter->_M_print_word(_M_variant._M_string._M_name);
333       }
334       else
335         assert(false);
336     }
337     else
338     {
339       assert(false);
340     }
341   }
342
343   void
344   _Error_formatter::_Parameter::
345   _M_print_description(const _Error_formatter* __formatter) const
346   {
347     const int bufsize = 128;
348     char buf[bufsize];
349     
350     if (_M_kind == __iterator)
351     {
352       __formatter->_M_print_word("iterator ");
353       if (_M_variant._M_iterator._M_name)
354       {
355         snprintf(buf, bufsize, "\"%s\" ", 
356                  _M_variant._M_iterator._M_name);
357         __formatter->_M_print_word(buf);
358       }
359       
360       snprintf(buf, bufsize, "@ 0x%p {\n", 
361                _M_variant._M_iterator._M_address);
362       __formatter->_M_print_word(buf);
363       if (_M_variant._M_iterator._M_type)
364       {
365         __formatter->_M_print_word("type = ");
366         _M_print_field(__formatter, "type");
367         
368         if (_M_variant._M_iterator._M_constness != __unknown_constness)
369         {
370           __formatter->_M_print_word(" (");
371           _M_print_field(__formatter, "constness");
372           __formatter->_M_print_word(" iterator)");
373         }
374         __formatter->_M_print_word(";\n");
375       }
376       
377       if (_M_variant._M_iterator._M_state != __unknown_state)
378       {
379         __formatter->_M_print_word("  state = ");
380         _M_print_field(__formatter, "state");
381         __formatter->_M_print_word(";\n");
382       }
383
384       if (_M_variant._M_iterator._M_sequence)
385       {
386         __formatter->_M_print_word("  references sequence ");
387         if (_M_variant._M_iterator._M_seq_type)
388         {
389           __formatter->_M_print_word("with type `");
390           _M_print_field(__formatter, "seq_type");
391           __formatter->_M_print_word("' ");
392         }
393         
394         snprintf(buf, bufsize, "@ 0x%p\n", _M_variant._M_sequence._M_address);
395         __formatter->_M_print_word(buf);
396       }
397       __formatter->_M_print_word("}\n");
398     }
399     else if (_M_kind == __sequence)
400     {
401       __formatter->_M_print_word("sequence ");
402       if (_M_variant._M_sequence._M_name)
403       {
404         snprintf(buf, bufsize, "\"%s\" ", 
405                  _M_variant._M_sequence._M_name);
406         __formatter->_M_print_word(buf);
407       }
408       
409       snprintf(buf, bufsize, "@ 0x%p {\n", 
410                _M_variant._M_sequence._M_address);
411       __formatter->_M_print_word(buf);
412       
413       if (_M_variant._M_sequence._M_type)
414       {
415         __formatter->_M_print_word("  type = ");
416         _M_print_field(__formatter, "type");
417         __formatter->_M_print_word(";\n");
418       }   
419       __formatter->_M_print_word("}\n");
420     }
421   }
422
423   const _Error_formatter&
424   _Error_formatter::_M_message(_Debug_msg_id __id) const
425   { return this->_M_message(_S_debug_messages[__id]); }
426   
427   void
428   _Error_formatter::_M_error() const
429   {
430     const int bufsize = 128;
431     char buf[bufsize];
432     
433     // Emit file & line number information
434     _M_column = 1;
435     _M_wordwrap = false;
436     if (_M_file)
437     {
438       snprintf(buf, bufsize, "%s:", _M_file);
439       _M_print_word(buf);
440       _M_column += strlen(buf);
441     }
442     
443     if (_M_line > 0)
444     {
445       snprintf(buf, bufsize, "%u:", _M_line);
446       _M_print_word(buf);
447       _M_column += strlen(buf);
448     }
449     
450     _M_wordwrap = true;
451     _M_print_word("error: ");
452     
453     // Print the error message
454     assert(_M_text);
455     _M_print_string(_M_text);
456     _M_print_word(".\n");
457     
458     // Emit descriptions of the objects involved in the operation
459     _M_wordwrap = false;
460     bool has_noninteger_parameters = false;
461     for (unsigned int i = 0; i < _M_num_parameters; ++i)
462     {
463       if (_M_parameters[i]._M_kind == _Parameter::__iterator
464           || _M_parameters[i]._M_kind == _Parameter::__sequence)
465       {
466         if (!has_noninteger_parameters)
467         {
468           _M_first_line = true;
469           _M_print_word("\nObjects involved in the operation:\n");
470           has_noninteger_parameters = true;
471         }
472         _M_parameters[i]._M_print_description(this);
473       }
474     }
475     
476     abort();
477   }
478
479   void 
480   _Error_formatter::_M_print_word(const char* __word) const
481   {
482     if (!_M_wordwrap) 
483     {
484       fprintf(stderr, "%s", __word);
485       return;
486     }
487     
488     size_t __length = strlen(__word);
489     if (__length == 0)
490       return;
491     
492     if ((_M_column + __length < _M_max_length)
493         || (__length >= _M_max_length && _M_column == 1)) 
494     {
495       // If this isn't the first line, indent
496       if (_M_column == 1 && !_M_first_line)
497       {
498         char spacing[_M_indent + 1];
499         for (int i = 0; i < _M_indent; ++i)
500           spacing[i] = ' ';
501         spacing[_M_indent] = '\0';
502         fprintf(stderr, "%s", spacing);
503         _M_column += _M_indent;
504       }
505       
506       fprintf(stderr, "%s", __word);
507       _M_column += __length;
508       
509       if (__word[__length - 1] == '\n') 
510       {
511         _M_first_line = false;
512         _M_column = 1;
513       }
514     }
515     else
516     {
517       _M_column = 1;
518       _M_print_word("\n");
519       _M_print_word(__word);
520     }
521   }
522   
523   void
524   _Error_formatter::
525   _M_print_string(const char* __string) const
526   {
527     const char* __start = __string;
528     const char* __end = __start;
529     const int bufsize = 128;
530     char buf[bufsize];
531
532     while (*__start)
533     {
534       if (*__start != '%')
535       {
536         // [__start, __end) denotes the next word
537         __end = __start;
538         while (isalnum(*__end)) ++__end;
539         if (__start == __end) ++__end;
540         if (isspace(*__end)) ++__end;
541         
542         assert(__end - __start + 1< bufsize);
543         snprintf(buf, __end - __start + 1, "%s", __start);
544         _M_print_word(buf);
545         __start = __end;
546         
547         // Skip extra whitespace
548         while (*__start == ' ') ++__start;
549         
550         continue;
551       } 
552         
553       ++__start;
554       assert(*__start);
555       if (*__start == '%')
556       {
557         _M_print_word("%");
558         ++__start;
559         continue;
560       }
561       
562       // Get the parameter number
563       assert(*__start >= '1' && *__start <= '9');
564       size_t param = *__start - '0';
565       --param;
566       assert(param < _M_num_parameters);
567       
568       // '.' separates the parameter number from the field
569       // name, if there is one.
570       ++__start;
571       if (*__start != '.')
572       {
573         assert(*__start == ';');
574         ++__start;
575         buf[0] = '\0';
576         if (_M_parameters[param]._M_kind == _Parameter::__integer)
577         {
578           snprintf(buf, bufsize, "%ld", 
579                    _M_parameters[param]._M_variant._M_integer._M_value);
580           _M_print_word(buf);
581         }
582         else if (_M_parameters[param]._M_kind == _Parameter::__string)
583           _M_print_string(_M_parameters[param]._M_variant._M_string._M_value);
584         continue;
585       }
586       
587       // Extract the field name we want
588       enum { max_field_len = 16 };
589       char field[max_field_len];
590       int field_idx = 0;
591       ++__start;
592       while (*__start != ';')
593       {
594         assert(*__start);
595         assert(field_idx < max_field_len-1);
596         field[field_idx++] = *__start++;
597       }
598       ++__start;
599       field[field_idx] = 0;
600       
601       _M_parameters[param]._M_print_field(this, field);           
602     }
603   }
604 } // namespace __gnu_debug