ndc.h

Go to the documentation of this file.

// -*- C++ -*-
// Module:  Log4CPLUS
// File:    ndc.h
// Created: 6/2001
// Author:  Tad E. Smith
//
//
// Copyright 2001-2017 Tad E. Smith
//
// Licensed 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 _LO4CPLUS_NDC_HEADER_
#define _LO4CPLUS_NDC_HEADER_
 
#include <log4cplus/config.hxx>
 
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
 
#include <log4cplus/tstring.h>
 
#include <map>
#include <deque>
 
 
namespace log4cplus {
    // Forward declarations
    struct DiagnosticContext;
    typedef std::deque<DiagnosticContext> DiagnosticContextStack;
 
    class LOG4CPLUS_EXPORT NDC
    {
    public:
        void clear();
 
        DiagnosticContextStack cloneStack() const;
 
        void inherit(const DiagnosticContextStack& stack);
 
        log4cplus::tstring const & get() const;
 
        std::size_t getDepth() const;
 
        log4cplus::tstring pop();
 
        void pop_void ();
 
        log4cplus::tstring const & peek() const;
 
        void push(const log4cplus::tstring& message);
        void push(tchar const * message);
 
        void remove();
 
        void setMaxDepth(std::size_t maxDepth);
 
        // Public ctor but only to be used by internal::DefaultContext.
        NDC();
 
      // Dtor
        virtual ~NDC();
 
    private:
      // Methods
        LOG4CPLUS_PRIVATE static DiagnosticContextStack* getPtr();
 
        template <typename StringType>
        LOG4CPLUS_PRIVATE
        void push_worker (StringType const &);
 
      // Disallow construction (and copying) except by getNDC()
        NDC(const NDC&);
        NDC& operator=(const NDC&);
    };
 
 
    LOG4CPLUS_EXPORT NDC& getNDC();
 
 
    struct LOG4CPLUS_EXPORT DiagnosticContext
    {
      // Ctors
        DiagnosticContext(const log4cplus::tstring& message,
            DiagnosticContext const * parent);
        DiagnosticContext(tchar const * message,
            DiagnosticContext const * parent);
        DiagnosticContext(const log4cplus::tstring& message);
        DiagnosticContext(tchar const * message);
        DiagnosticContext(DiagnosticContext const &);
        DiagnosticContext & operator = (DiagnosticContext const &);
        DiagnosticContext(DiagnosticContext &&);
        DiagnosticContext & operator = (DiagnosticContext &&);
 
        void swap (DiagnosticContext &);
 
      // Data
        log4cplus::tstring message; 
        log4cplus::tstring fullMessage; 
    };
 
 
    class LOG4CPLUS_EXPORT NDCContextCreator {
    public:
        explicit NDCContextCreator(const log4cplus::tstring& msg);
        explicit NDCContextCreator(tchar const * msg);
 
        NDCContextCreator() = delete;
        NDCContextCreator(NDCContextCreator const &) = delete;
        NDCContextCreator(NDCContextCreator &&) = delete;
        NDCContextCreator & operator= (NDCContextCreator const &) = delete;
        NDCContextCreator & operator= (NDCContextCreator &&) = delete;
 
        ~NDCContextCreator();
    };
 
} // end namespace log4cplus
 
 
#endif // _LO4CPLUS_NDC_HEADER_