Tracing.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper is distributed in the hope that it will be useful,           *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 6743 $                                                       *
 *   $Author: moebius $                                                      *
 *   $Date: 2009-08-05 11:03:10 +0200 (Mi, 05. Aug 2009) $                   *
 *                                                                           *
\*===========================================================================*/




//=============================================================================
//
//  CLASS Tracing
//
//=============================================================================


#ifndef ACG_TRACING_HH
#define ACG_TRACING_HH


//== INCLUDES =================================================================

#include "StopWatch.hh"
#include <iostream>
#include <string>
#include "../Config/ACGDefines.hh"


//== NAMESPACES ===============================================================

namespace ACG {


//== HELPER MACROS ============================================================


#define ACG_TRACE(_text) ACG::Tracing acg_tracer__(_text)
#define ACG_TRACE_CMD(_text, _cmd) { ACG_TRACE(_text); cmd; }

#define ACG_TIMED_TRACE(_text) ACG::TimedTracing acg_tracer__(_text)
#define ACG_TIMED_TRACE_CMD(_text, _cmd) { ACG_TIMED_TRACE(_text); _cmd; }

#define ACG_TRACE_PROGRESS acg_tracer__.progress()


//== CLASS DEFINITION =========================================================


class ACGDLLEXPORT Tracing
{
public:

  Tracing(const std::string& _text,
          std::ostream&      _os = std::cerr)
    : os_(_os)
  { os_ << _text << "  " << std::flush; }


  ~Tracing() { os_ << "finished.\n" << std::flush; }


  void progress() {
    os_ << progress_[((++idx_)&=0x3)] << "\b" << std::flush;
  }


protected:

  std::ostream&  os_;
  static char    progress_[4];
  static unsigned char idx_;
};


//== CLASS DEFINITION =========================================================



class ACGDLLEXPORT TimedTracing : public Tracing
{
public:

  TimedTracing( const std::string& _text,
                std::ostream&      _os = std::cerr )
    : Tracing(_text, _os)
  { timer_.start(); }


  ~TimedTracing()
  {
    os_ << timer_.stop()*0.001 << " secs, ";
  }

private:

  StopWatch timer_;
};



//=============================================================================
} // namespace ACG
//=============================================================================
#endif // ACG_TRACING_HH defined
//=============================================================================