ndc.h

Go to the documentation of this file.

// Module:  Log4CPLUS
// File:    ndc.h
// Created: 6/2001
// Author:  Tad E. Smith
//
//
// Copyright (C) Tad E. Smith  All rights reserved.
//
// This software is published under the terms of the Apache Software
// License version 1.1, a copy of which has been included with this
// distribution in the LICENSE.APL file.
//

#ifndef _LO4CPLUS_NDC_HEADER_
#define _LO4CPLUS_NDC_HEADER_

#include <log4cplus/config.h>
#include <log4cplus/tstring.h>
#include <log4cplus/helpers/logloguser.h>
#include <log4cplus/helpers/threads.h>

#include <map>
#include <stack>

#if (defined(__MWERKS__) && defined(__MACOS__))
using std::size_t;
#endif


namespace log4cplus {
    // Forward declarations
    class NDC;
    struct DiagnosticContext;
    typedef std::stack<DiagnosticContext> DiagnosticContextStack;

    LOG4CPLUS_EXPORT NDC& getNDC();

    class LOG4CPLUS_EXPORT NDC : protected log4cplus::helpers::LogLogUser {
    public:
        void clear();

        DiagnosticContextStack cloneStack();

        void inherit(const DiagnosticContextStack& stack);

        log4cplus::tstring get();

        size_t getDepth();

        log4cplus::tstring pop();

        log4cplus::tstring peek();

        void push(const log4cplus::tstring& message);

        void remove();

        void setMaxDepth(size_t maxDepth);

      // Dtor
        ~NDC();

    private:
      // Methods
        DiagnosticContextStack* getPtr()
            { return static_cast<DiagnosticContextStack*>
                          (LOG4CPLUS_GET_THREAD_LOCAL_VALUE( threadLocal )); }

      // Data
        LOG4CPLUS_THREAD_LOCAL_TYPE threadLocal;

      // Disallow construction (and copying) except by getNDC()
        NDC();
        NDC(const NDC&);
        NDC& operator=(const NDC&);

      // Friends
        friend LOG4CPLUS_EXPORT NDC& getNDC();
    };



    struct LOG4CPLUS_EXPORT DiagnosticContext {
      // Ctors
        DiagnosticContext(const log4cplus::tstring& message, DiagnosticContext *parent);
        DiagnosticContext(const log4cplus::tstring& message);

      // Data
        log4cplus::tstring message; 
        log4cplus::tstring fullMessage; 
    };


    class LOG4CPLUS_EXPORT NDCContextCreator {
    public:
        NDCContextCreator(const log4cplus::tstring& msg) { getNDC().push(msg); }

        ~NDCContextCreator() { getNDC().pop(); }
    };

} // end namespace log4cplus


#endif // _LO4CPLUS_NDC_HEADER_

---