tracelogger.h 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. // -*- C++ -*-
  2. // Module: Log4CPLUS
  3. // File: tracelogger.h
  4. // Created: 1/2009
  5. // Author: Vaclav Haisman
  6. //
  7. //
  8. // Copyright 2009-2015 Tad E. Smith
  9. //
  10. // Licensed under the Apache License, Version 2.0 (the "License");
  11. // you may not use this file except in compliance with the License.
  12. // You may obtain a copy of the License at
  13. //
  14. // http://www.apache.org/licenses/LICENSE-2.0
  15. //
  16. // Unless required by applicable law or agreed to in writing, software
  17. // distributed under the License is distributed on an "AS IS" BASIS,
  18. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19. // See the License for the specific language governing permissions and
  20. // limitations under the License.
  21. /** @file */
  22. #ifndef LOG4CPLUS_TRACELOGGER_H
  23. #define LOG4CPLUS_TRACELOGGER_H
  24. #include <log4cplus/config.hxx>
  25. #if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
  26. #pragma once
  27. #endif
  28. #include <log4cplus/logger.h>
  29. namespace log4cplus
  30. {
  31. /**
  32. * This class is used to produce "Trace" logging. When an instance of
  33. * this class is created, it will log a <code>"ENTER: " + msg</code>
  34. * log message if TRACE_LOG_LEVEL is enabled for <code>logger</code>.
  35. * When an instance of this class is destroyed, it will log a
  36. * <code>"ENTER: " + msg</code> log message if TRACE_LOG_LEVEL is enabled
  37. * for <code>logger</code>.
  38. * <p>
  39. * @see LOG4CPLUS_TRACE
  40. */
  41. class TraceLogger
  42. {
  43. public:
  44. TraceLogger(const Logger& l, const log4cplus::tstring& _msg,
  45. const char* _file = LOG4CPLUS_CALLER_FILE (),
  46. int _line = LOG4CPLUS_CALLER_LINE (),
  47. char const * _function = LOG4CPLUS_CALLER_FUNCTION ())
  48. : logger(l), msg(_msg), file(_file), function(_function), line(_line)
  49. {
  50. if(logger.isEnabledFor(TRACE_LOG_LEVEL))
  51. logger.forcedLog(TRACE_LOG_LEVEL, LOG4CPLUS_TEXT("ENTER: ") + msg,
  52. file, line, function);
  53. }
  54. ~TraceLogger()
  55. {
  56. if(logger.isEnabledFor(TRACE_LOG_LEVEL))
  57. logger.forcedLog(TRACE_LOG_LEVEL, LOG4CPLUS_TEXT("EXIT: ") + msg,
  58. file, line, function);
  59. }
  60. private:
  61. TraceLogger (TraceLogger const &);
  62. TraceLogger & operator = (TraceLogger const &);
  63. Logger logger;
  64. log4cplus::tstring msg;
  65. const char* file;
  66. const char* function;
  67. int line;
  68. };
  69. } // log4cplus
  70. #endif // LOG4CPLUS_TRACELOGGER_H