Update copyright to LGPL on all files
[dyninst.git] / common / h / debugOstream.h
1 /*
2  * Copyright (c) 1996-2009 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  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32
33 // debugOstream.h
34
35 #ifndef _DEBUG_OSTREAM_H_
36 #define _DEBUG_OSTREAM_H_
37
38 #include "common/h/std_namesp.h"
39 #include "common/h/Types.h"
40
41 #ifdef NEW_TIME_TYPES
42 class timeUnit;
43 class timeBase;
44 class timeLength;
45 class timeStamp;
46 class relTimeStamp;
47 #endif
48
49 class COMMON_EXPORT debug_ostream {
50  private:
51    ostream &actual_ostream; // probably cerr or cout
52    bool on;
53
54  public:
55    debug_ostream(ostream &iActual, bool iOn) : actual_ostream(iActual) {on=iOn;}
56   ~debug_ostream() {}
57    bool isOn() { return on; }
58    void turnOn()  { on = true;  }
59    void turnOff() { on = false; }
60    debug_ostream &operator<<(char c);
61    debug_ostream &operator<<(unsigned char c);
62    debug_ostream &operator<<(short s);
63    debug_ostream &operator<<(unsigned short s);
64    debug_ostream &operator<<(int i);
65    debug_ostream &operator<<(unsigned i);
66 #if !defined(TYPE64BIT)
67    // int64_t is a long which causes multiply defined functions if this
68    // is included
69    debug_ostream &operator<<(long l);
70    debug_ostream &operator<<(unsigned long l);
71 #else
72    //  These are creating probs with gcc 3.2.3
73    //  (default gcc for fresh install on x86_64 systems)
74    debug_ostream &operator<<(int64_t l);
75    debug_ostream &operator<<(uint64_t l);
76 #endif
77
78    debug_ostream &operator<<(const char *str);
79    debug_ostream &operator<<(const unsigned char *str);
80
81    debug_ostream &operator<<(const void *ptr);
82
83    debug_ostream &operator<<(float f);
84    debug_ostream &operator<<(double d);
85
86    debug_ostream& operator<<( ostream& (*f)(ostream&) );
87 #ifdef NEW_TIME_TYPES
88    debug_ostream& operator<<(timeUnit   &tu);
89    debug_ostream& operator<<(timeBase   tb);
90    debug_ostream& operator<<(timeLength tl);
91    debug_ostream& operator<<(timeStamp  ts);
92    debug_ostream& operator<<(relTimeStamp  ts);
93 #endif
94 };
95 #endif
96