DebugTrace.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk 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.0 of the License, or
//  any later version.
//
//  The GNSSTk 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 Lesser General Public
//  License along with GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
 
#ifndef GNSSTK_DEBUGTRACE_HPP
#define GNSSTK_DEBUGTRACE_HPP
 
#include <atomic>
#include <sstream>
#include <iomanip>
#include "gnsstk_export.h"
 
namespace gnsstk
{
   class DebugTrace
   {
   public:
      DebugTrace(const std::string funcName);
      ~DebugTrace();
      static void trace(const std::string& s);
      GNSSTK_EXPORT static std::atomic<bool> enabled;
   private:
      std::string functionName;
      static std::atomic<unsigned> indent;
   };
}
 
// for windows, which doesn't define __PRETTY_FUNCTION__
#ifdef WIN32
#define __PRETTY_FUNCTION__ __FUNCSIG__
#endif
 
#ifdef DEBUG_NO_TRACE
#define DEBUGTRACE_ENABLE()
#define DEBUGTRACE_DISABLE()
#define DEBUGTRACE_FUNCTION()
#define DEBUGTRACE(EXPR)
#else
#define DEBUGTRACE_ENABLE()                                             \
   {                                                                    \
      gnsstk::DebugTrace::enabled = true;                               \
      std::cerr << "WARNING: Tracing is enabled, expect slow performance" \
                << std::endl;                                           \
   }
#define DEBUGTRACE_DISABLE()                     \
   {                                             \
      gnsstk::DebugTrace::enabled = false;       \
   }
#define DEBUGTRACE_FUNCTION()                                   \
   gnsstk::DebugTrace gnsstkTraceObject(__PRETTY_FUNCTION__)
#define DEBUGTRACE(EXPR)                                 \
   {                                                     \
      std::ostringstream os;                             \
      os << "* " << std::fixed << std::setprecision(15)  \
         << EXPR << std::endl;                           \
      gnsstk::DebugTrace::trace(os.str());               \
   }
#endif
 
#endif // GNSSTK_DEBUGTRACE_HPP