blocxx

ScopeLogger.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2005, Quest Software, Inc. All rights reserved.
00003 * Copyright (C) 2006, Novell, Inc. All rights reserved.
00004 * 
00005 * Redistribution and use in source and binary forms, with or without
00006 * modification, are permitted provided that the following conditions are met:
00007 * 
00008 *     * Redistributions of source code must retain the above copyright notice,
00009 *       this list of conditions and the following disclaimer.
00010 *     * Redistributions in binary form must reproduce the above copyright
00011 *       notice, this list of conditions and the following disclaimer in the
00012 *       documentation and/or other materials provided with the distribution.
00013 *     * Neither the name of 
00014 *       Quest Software, Inc., 
00015 *       nor Novell, Inc., 
00016 *       nor the names of its contributors or employees may be used to 
00017 *       endorse or promote products derived from this software without 
00018 *       specific prior written permission.
00019 * 
00020 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00021 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00022 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00023 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00024 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00025 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00026 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00029 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030 * POSSIBILITY OF SUCH DAMAGE.
00031 *******************************************************************************/
00032 
00033 
00043 #ifndef BLOCXX_SCOPE_LOGGER_HPP
00044 #define BLOCXX_SCOPE_LOGGER_HPP
00045 #include "blocxx/BLOCXX_config.h"
00046 #include <iosfwd>
00047 #include "blocxx/String.hpp"
00048 #include "blocxx/LogAppender.hpp"
00049 #include "blocxx/Logger.hpp"
00050 #include "blocxx/DelayedFormat.hpp"
00051 #include "blocxx/Reference.hpp"
00052 
00053 namespace BLOCXX_NAMESPACE
00054 {
00055 
00061    class BLOCXX_COMMON_API ScopeLogger
00062    {
00063    public:
00069       ScopeLogger(const String& entrance, const String& exit, const Logger& lgr);
00076       ScopeLogger(const String& entrance, const String& exit, const String& component = Logger::STR_DEFAULT_COMPONENT, const LogAppenderRef& appender = LogAppenderRef());
00077 
00085       ScopeLogger(const String& entrance, const String& exit, const Reference<DelayedFormat>& format, const Logger& lgr);
00094       ScopeLogger(const String& entrance, const String& exit, const Reference<DelayedFormat>& format, const String& component = Logger::STR_DEFAULT_COMPONENT, const LogAppenderRef& appender = LogAppenderRef());
00095 
00096       virtual ~ScopeLogger();
00097 
00098    private:
00099       // Not implemented because there is no reason to copy this class.  It is
00100       // intended for a single scope only.
00101       ScopeLogger(const ScopeLogger&);
00102       ScopeLogger& operator=(const ScopeLogger&);
00103 
00104       String enterMessage;
00105       String exitMessage;
00106       Logger logger;
00107 
00108       Reference<DelayedFormat> formatter;
00109    };
00110 
00111 } // end namespace BLOCXX_NAMESPACE
00112 
00113 #endif // BLOCXX_SCOPE_LOGGER_HPP