added members to turn on and off the debug streams
[dyninst.git] / common / h / debugOstream.h
1 /*
2  * Copyright (c) 1996 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 // debugOstream.h
43
44 #ifndef _DEBUG_OSTREAM_H_
45 #define _DEBUG_OSTREAM_H_
46
47 #include <iostream.h>
48 #include "common/h/Types.h"
49
50 #ifdef NEW_TIME_TYPES
51 class timeUnit;
52 class timeBase;
53 class timeLength;
54 class timeStamp;
55 class relTimeStamp;
56 #endif
57
58 class debug_ostream {
59  private:
60    ostream &actual_ostream; // probably cerr or cout
61    bool on;
62
63  public:
64    debug_ostream(ostream &iActual, bool iOn) : actual_ostream(iActual) {on=iOn;}
65   ~debug_ostream() {}
66    bool isOn() { return on; }
67    void turnOn()  { on = true;  }
68    void turnOff() { on = false; }
69    debug_ostream &operator<<(char c);
70    debug_ostream &operator<<(unsigned char c);
71    debug_ostream &operator<<(short s);
72    debug_ostream &operator<<(unsigned short s);
73    debug_ostream &operator<<(int i);
74    debug_ostream &operator<<(unsigned i);
75 #if !defined(mips_sgi_irix6_4) && !defined(alpha_dec_osf4_0)
76    // int64_t is a long which causes multiply defined functions if this
77    // is included
78    debug_ostream &operator<<(long l);
79    debug_ostream &operator<<(unsigned long l);
80 #endif
81    debug_ostream &operator<<(int64_t l);
82    debug_ostream &operator<<(uint64_t l);
83
84    debug_ostream &operator<<(const char *str);
85    debug_ostream &operator<<(const unsigned char *str);
86
87    debug_ostream &operator<<(const void *ptr);
88
89    debug_ostream &operator<<(float f);
90    debug_ostream &operator<<(double d);
91
92    debug_ostream& operator<<( ostream& (*f)(ostream&) );
93 #ifdef NEW_TIME_TYPES
94    debug_ostream& operator<<(timeUnit   &tu);
95    debug_ostream& operator<<(timeBase   tb);
96    debug_ostream& operator<<(timeLength tl);
97    debug_ostream& operator<<(timeStamp  ts);
98    debug_ostream& operator<<(relTimeStamp  ts);
99 #endif
100 };
101
102 #endif
103