Verbose_ostream.h

Go to the documentation of this file.

// ======================================================================
//
// Copyright (c) 1997 The CGAL Consortium

// This software and related documentation is part of the Computational
// Geometry Algorithms Library (CGAL).
// This software and documentation is provided "as-is" and without warranty
// of any kind. In no event shall the CGAL Consortium be liable for any
// damage of any kind. 
//
// Every use of CGAL requires a license. 
//
// Academic research and teaching license
// - For academic research and teaching purposes, permission to use and copy
//   the software and its documentation is hereby granted free of charge,
//   provided that it is not a component of a commercial product, and this
//   notice appears in all copies of the software and related documentation. 
//
// Commercial licenses
// - A commercial license is available through Algorithmic Solutions, who also
//   markets LEDA (http://www.algorithmic-solutions.de). 
// - Commercial users may apply for an evaluation license by writing to
//   Algorithmic Solutions (contact@algorithmic-solutions.com). 
//
// The CGAL Consortium consists of Utrecht University (The Netherlands),
// ETH Zurich (Switzerland), Free University of Berlin (Germany),
// INRIA Sophia-Antipolis (France), Martin-Luther-University Halle-Wittenberg
// (Germany), Max-Planck-Institute Saarbrucken (Germany), RISC Linz (Austria),
// and Tel-Aviv University (Israel).
//
// ----------------------------------------------------------------------
//
// release       : CGAL-2.2
// release_date  : 2000, September 30
//
// file          : include/CGAL/IO/Verbose_ostream.h
// package       : Stream_support (2.9)
// chapter       : $CGAL_Chapter: Stream Support $
// source        : support.fw
// revision      : $Revision: 1.1.1.1 $
// revision_date : $Date: 2001/07/05 22:17:48 $
// author(s)     : Lutz Kettner
//
// coordinator   : INRIA, Sophia Antipolis
//
// A stream like output class for verbose output.
// email         : contact@cgal.org
// www           : http://www.cgal.org
//
// ======================================================================

#ifndef CGAL_IO_VERBOSE_OSTREAM_H
#define CGAL_IO_VERBOSE_OSTREAM_H 1
#ifndef CGAL_PROTECT_IOSTREAM
#include <iostream>
#define CGAL_PROTECT_IOSTREAM
#endif

CGAL_BEGIN_NAMESPACE

#define CGAL__VERB(x) if (b) *o << x; return *this

class Verbose_ostream {
    bool          b;
    std::ostream* o;
public:
    Verbose_ostream( bool active = false, std::ostream& out = std::cerr)
        : b(active), o(&out){}

    bool          verbose()           const { return b; }
    void          set_verbose( bool active) { b = active; }
    std::ostream& out()                     { return *o; }

#ifndef CGAL_CFG_NO_MEMBER_TEMPLATES
    template < class T >
    Verbose_ostream&  operator<<( const T& t)            { CGAL__VERB(t);}
#endif // CGAL_CFG_NO_MEMBER_TEMPLATES //
    // The following specialisations avoid the & for their small args.
    Verbose_ostream&  operator<<( char c)                { CGAL__VERB(c);}
    Verbose_ostream&  operator<<( const char* s)         { CGAL__VERB(s);}
    Verbose_ostream&  operator<<( int a)                 { CGAL__VERB(a);}
    Verbose_ostream&  operator<<( long l)                { CGAL__VERB(l);}
    Verbose_ostream&  operator<<( double d)              { CGAL__VERB(d);}
    Verbose_ostream&  operator<<( float f)               { CGAL__VERB(f);}
    Verbose_ostream&  operator<<( unsigned int a)        { CGAL__VERB(a);}
    Verbose_ostream&  operator<<( unsigned long l)       { CGAL__VERB(l);}
#ifdef _LONGLONG
    Verbose_ostream&  operator<<( long long l)           { CGAL__VERB(l);}
    Verbose_ostream&  operator<<( unsigned long long l)  { CGAL__VERB(l);}
#endif /* _LONGLONG */
    Verbose_ostream&  operator<<( void* p)               { CGAL__VERB(p);}
    Verbose_ostream&  operator<<( short i)               { CGAL__VERB(i);}
    Verbose_ostream&  operator<<( unsigned short i)      { CGAL__VERB(i);}

    Verbose_ostream&  operator<<( std::ostream& (*f)(std::ostream&))
                                                         { CGAL__VERB(f);}
    Verbose_ostream&  operator<<( std::ios& (*f)(std::ios&))
                                                         { CGAL__VERB(f);}
    Verbose_ostream&  flush() {
        if (b)
            o->flush();
        return *this;
    }
    Verbose_ostream&  put(char c) {
        if (b)
            o->put(c);
        return *this;
    }
    Verbose_ostream&  write(const char*  s,int n) {
        if (b)
            o->write( s, n);
        return *this;
    }
};
#undef CGAL__VERB

CGAL_END_NAMESPACE
#endif // CGAL_IO_VERBOSE_OSTREAM_H //
// EOF //