ndc.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_NDC_H
#define _LOG4CXX_NDC_H

#include <log4cxx/log4cxx.h>
#include <log4cxx/logstring.h>
#include <stack>

#if defined(_MSC_VER)
    #pragma warning ( push )
    #pragma warning ( disable: 4231 4251 4275 4786 )
#endif

namespace log4cxx
{

class LOG4CXX_EXPORT NDC
{
    public:
        typedef std::pair<LogString, LogString> DiagnosticContext;
        typedef std::stack<DiagnosticContext> Stack;

        NDC(const std::string& message);

        ~NDC();

        static void clear();

        static Stack* cloneStack();

        static void inherit(Stack* stack);

        static bool get(LogString& dest);

        static int getDepth();


        static bool empty();

        static LogString pop();
        static bool pop(std::string& buf);

        static LogString peek();
        static bool peek(std::string& buf);

        static void push(const std::string& message);
        static void pushLS(const LogString& message);

        static void remove();

#if LOG4CXX_WCHAR_T_API

        NDC(const std::wstring& message);
        static void push(const std::wstring& message);
        static bool peek(std::wstring& dst);
        static bool pop(std::wstring& dst);
#endif
#if LOG4CXX_UNICHAR_API

        NDC(const std::basic_string<UniChar>& message);
        static void push(const std::basic_string<UniChar>& message);
        static bool peek(std::basic_string<UniChar>& dst);
        static bool pop(std::basic_string<UniChar>& dst);
#endif
#if LOG4CXX_CFSTRING_API

        NDC(const CFStringRef& message);
        static void push(const CFStringRef& message);
        static bool peek(CFStringRef& dst);
        static bool pop(CFStringRef& dst);
#endif

    private:
        NDC(const NDC&);
        NDC& operator=(const NDC&);
        static LogString& getMessage(DiagnosticContext& ctx);
        static LogString& getFullMessage(DiagnosticContext& ctx);
}; // class NDC;
}  // namespace log4cxx

#if defined(_MSC_VER)
    #pragma warning (pop)
#endif


#endif // _LOG4CXX_NDC_H