debugTraceInterface.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Patrick P. Frey
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef _STRUS_DEBUG_TRACE_INTERFACE_HPP_INCLUDED
#define _STRUS_DEBUG_TRACE_INTERFACE_HPP_INCLUDED
#include "strus/errorCodes.hpp"
#include <string>
#include <vector>

namespace strus
{

struct DebugTraceMessage
{
        enum Type {Open, Close, Event};

        DebugTraceMessage( Type type_, const char* component_, const char* id_, const std::string& content_)
                :m_type(type_),m_component(component_),m_id(id_),m_content(content_){}
        DebugTraceMessage( const DebugTraceMessage& o)
                :m_type(o.m_type),m_component(o.m_component),m_id(o.m_id),m_content(o.m_content){}

        static const char* typeName( Type tp)
        {
                static const char* ar[] = {"open","close","event"};
                return ar[tp];
        }

        Type type() const                       {return m_type;}
        const char* component() const           {return m_component;}
        const char* id() const                  {return m_id;}
        const std::string& content() const      {return m_content;}

        const char* typeName() const    {return typeName( m_type);}

private:
        Type m_type;
        const char* m_component;
        const char* m_id;
        std::string m_content;
};

class DebugTraceContextInterface
{
public:
        virtual ~DebugTraceContextInterface(){}

        virtual void open( const char* type, const std::string& name=std::string())=0;

        virtual void close()=0;

        virtual void event( const char* eventid, const char* format, ...)
#ifdef __GNUC__
        __attribute__ ((format (printf, 3, 4)))
#endif
        =0;
};

class DebugTraceInterface
{
public:
        virtual ~DebugTraceInterface(){}

        virtual bool setMaxNofThreads( unsigned int maxNofThreads)=0;

        virtual bool enable( const std::string& component)=0;

        virtual void disable( const std::string& component)=0;

        virtual DebugTraceContextInterface* createTraceContext( const char* component) const=0;

        virtual void allocContext()=0;

        virtual void releaseContext()=0;

        virtual bool hasError() const=0;

        virtual std::vector<DebugTraceMessage> fetchMessages() const=0;
};

}//namespace
#endif