diguyLogChannel.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2019 VT MAK
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************/
#ifndef __diguyLogChannel_H
#define __diguyLogChannel_H

#ifdef SWIG
%module diguyLogChannel
#else
#define CPLUSPLUS_ONLY
#endif

#ifdef CPLUSPLUS_ONLY
class bdiLog;

#include <stdio.h> // for NULL definition
#include <diguy_constants.h>

typedef const char* diguyLogPrefixFunction(void* user_data);

#endif


#include <declspec_diguy.h>


/****************************************************************************/
class BDI_DECLSPEC_diguy diguyLogChannel
{

public:

        /*l
         *b  Description:
         **
         **    Print log message at the given notify level.
         */
        int print(int notify_level, const char* text);

        /*l
         *b  Description:
         **
         **    Set the text color to be used for messages on this channel.
         */
        void set_text_color(float r, float g, float b, float a);
        void get_text_color(float* r, float* g, float* b, float* a);

        void set_static_prefix(const char* prefix);
        const char* get_static_prefix();

#ifdef CPLUSPLUS_ONLY

        void set_prefix_function(diguyLogPrefixFunction* prefix_function,
                void* prefix_function_user_data);
        diguyLogPrefixFunction* get_prefix_function();
        void* get_prefix_function_user_data();

#endif

        int file_enable(int notify_level,
                const char* filename,
                int clear_file = 1);
        int file_disable();

#ifdef CPLUSPLUS_ONLY

        bdiLog* get_scripted_object() {return m_scripted_object;}

private:

        /*l
         **  A private constructor.
         */
        diguyLogChannel(bdiLog* scripted_object);

        /*l
         **  A pointer to internal data.
         */
        bdiLog* m_scripted_object;

        friend class bdiLog;

#endif

};

#endif /* __diguyLogChannel_H */