traces.h

Go to the documentation of this file.

/*
    Copyright (c) 2006-2018, Alexis Royer, http://alexis.royer.free.fr/CLI

    All rights reserved.

    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

        * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        * Neither the name of the CLI library project nor the names of its contributors may be used to endorse or promote products derived from this software
          without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/



#ifndef _CLI_TRACES_H_
#define _CLI_TRACES_H_

#include "cli/namespace.h"
#include "cli/object.h"
#include "cli/help.h"
#include "cli/tk.h"


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class OutputDevice;


    class TraceClass : public Object
    {
    public:
        typedef tk::Queue<TraceClass> List;

    private:
        explicit TraceClass(void);

    public:
        TraceClass(
            const TraceClass& CLI_Class         
            );

        explicit TraceClass(
            const char* const STR_ClassName,    
            const Help& CLI_Help                
            );

        virtual ~TraceClass(void);

    public:
        const tk::String GetName(void) const;

        const Help& GetHelp(void) const;

    public:
        TraceClass& operator=(const TraceClass&);

    private:
        tk::String m_strName;

        Help m_cliHelp;
    };

    const bool operator==(
        const TraceClass& CLI_Class1,   
        const TraceClass& CLI_Class2    
        );

    #define INTERNAL_ERROR GetInternalErrorTraceClass()
    const TraceClass& GetInternalErrorTraceClass();


    class Traces : public Object
    {
    public:
        static Traces& GetInstance(void);

    protected:
        explicit Traces(void);

    public:
        virtual ~Traces(void);

    private:
        Traces(const Traces&);
        Traces& operator=(const Traces&);

    public:
        const OutputDevice& GetStream(void) const;

        const bool SetStream(
            OutputDevice& CLI_Stream                
            );

        const bool UnsetStream(
            OutputDevice& CLI_Stream                
            );

    public:
        const bool Declare(
            const TraceClass& CLI_Class     
            );

        const TraceClass::List GetAllClasses(void) const;

        const TraceClass::List GetCurrentFilter(void) const;

        const bool SetFilter(
            const TraceClass& CLI_Class,    
            const bool B_ShowTraces         
            );

        const bool SetAllFilter(
            const bool B_ShowTraces         
            );

    public:
        const bool IsTraceOn(
            const TraceClass& CLI_Class     
            ) const;

        const OutputDevice& Trace(
            const TraceClass& CLI_Class     
            );

        const OutputDevice& SafeTrace(
            const TraceClass& CLI_Class,        
            const Object& CLI_AvoidStream       
            );

    private:
        const OutputDevice& BeginTrace(
            const TraceClass& CLI_Class     
            );

        const bool TraceFilterState(
            const TraceClass& CLI_Class,    
            const bool B_ShowTraces         
            );

    private:
        class TraceClassFlag : public TraceClass
        {
        public:
            explicit TraceClassFlag(void);
            explicit TraceClassFlag(const TraceClass& CLI_Source, const bool B_Show);
            TraceClassFlag(const TraceClassFlag& CLI_Source);
            virtual ~TraceClassFlag(void);
        public:
            TraceClassFlag& operator=(const TraceClassFlag& CLI_Class);
        public:
            const bool IsVisible(void) const;
        private:
            bool m_bShow;
        };

        typedef tk::Map<tk::String, TraceClassFlag> ClassMap;

        ClassMap m_mapClasses;

        bool m_bTraceAll;

        tk::Queue<OutputDevice*> m_qStreams;
    };

    Traces& GetTraces(void);

CLI_NS_END(cli)

#endif // _CLI_TRACES_H_