Loading...
Searching...
No Matches
ojph_message.h
Go to the documentation of this file.
//***************************************************************************/
// This software is released under the 2-Clause BSD license, included
// below.
//
// Copyright (c) 2019, Aous Naman
// Copyright (c) 2019, Kakadu Software Pty Ltd, Australia
// Copyright (c) 2019, The University of New South Wales, Australia
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 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
// HOLDER 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.
//***************************************************************************/
// This file is part of the OpenJPH software implementation.
// File: ojph_message.h
// Author: Aous Naman
// Date: 29 August 2019
//***************************************************************************/
#ifndef OJPH_MESSAGE_H
#define OJPH_MESSAGE_H
#include <cstring>
#include "ojph_arch.h"
namespace ojph {
enum OJPH_MSG_LEVEL : int
{
OJPH_MSG_ALL_MSG = 0, // uninitialized or print all message
OJPH_MSG_INFO = 1, // info message
OJPH_MSG_WARN = 2, // warning message
OJPH_MSG_ERROR = 3, // error message (the highest severity)
OJPH_MSG_NO_MSG = 4, // no message (higher severity for message printing
// only)
};
class OJPH_EXPORT message_base {
public:
virtual void operator() (int warn_code, const char* file_name,
int line_num, const char *fmt, ...) = 0;
};
class OJPH_EXPORT message_info : public message_base
{
public:
virtual void operator() (int info_code, const char* file_name,
int line_num, const char* fmt, ...);
};
OJPH_EXPORT
void set_info_stream(FILE* s);
OJPH_EXPORT
void configure_info(message_info* info);
OJPH_EXPORT
message_info* get_info();
class OJPH_EXPORT message_warning : public message_base
{
public:
virtual void operator() (int warn_code, const char* file_name,
int line_num, const char* fmt, ...);
};
OJPH_EXPORT
void set_warning_stream(FILE* s);
OJPH_EXPORT
void configure_warning(message_warning* warn);
OJPH_EXPORT
message_warning* get_warning();
class OJPH_EXPORT message_error : public message_base
{
public:
virtual void operator() (int warn_code, const char* file_name,
int line_num, const char *fmt, ...);
};
OJPH_EXPORT
void set_error_stream(FILE *s);
OJPH_EXPORT
void configure_error(message_error* error);
OJPH_EXPORT
message_error* get_error();
OJPH_EXPORT
void set_message_level(OJPH_MSG_LEVEL level);
}
#if (defined OJPH_OS_WINDOWS)
#define __OJPHFILE__ \
(strrchr(__FILE__, '\\') ? strrchr(__FILE__, '\\') + 1 : __FILE__)
#else
#define __OJPHFILE__ \
(strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
#endif
#define OJPH_INFO(t, ...) \
{ ojph::get_info()[0](t, __OJPHFILE__, __LINE__, __VA_ARGS__); }
#define OJPH_WARN(t, ...) \
{ ojph::get_warning()[0](t, __OJPHFILE__, __LINE__, __VA_ARGS__); }
#define OJPH_ERROR(t, ...) \
{ ojph::get_error()[0](t, __OJPHFILE__, __LINE__,__VA_ARGS__); }
#endif // !OJPH_MESSAGE_H
ojph::message_base
This is the base class from which all messaging levels are derived.
Definition ojph_message.h:92
ojph::message_error
Derived from message_base to handle error messages.
Definition ojph_message.h:212
ojph::message_info
Derived from message_base to handle info messages.
Definition ojph_message.h:114
ojph::message_warning
Derived from message_base to handle warning messages.
Definition ojph_message.h:163
ojph
Definition ojph_img_io.h:52
ojph::get_info
OJPH_EXPORT message_info * get_info()
Get the info message object, whose operator() member class is called for info messages – See the macr...
Definition ojph_message.cpp:62
ojph::warn
message_warning warn
Definition ojph_message.cpp:93
ojph::get_warning
OJPH_EXPORT message_warning * get_warning()
Get the warning message object, whose operator() member class is called for warning messages – See th...
Definition ojph_message.cpp:103
ojph::set_error_stream
OJPH_EXPORT void set_error_stream(FILE *s)
Replaces the error output file from the default stderr to user defined output file.
Definition ojph_message.cpp:150
ojph::info
message_info info
Definition ojph_message.cpp:51
ojph::configure_error
OJPH_EXPORT void configure_error(message_error *error)
This overrides the default behaviour of handling error messages.
Definition ojph_message.cpp:138
ojph::get_error
OJPH_EXPORT message_error * get_error()
Get the error message object, whose operator() member class is called for error messages – See the ma...
Definition ojph_message.cpp:144
ojph::OJPH_MSG_LEVEL
OJPH_MSG_LEVEL
This enum is use to specify the level of severity of message while processing markers.
Definition ojph_message.h:53
ojph::OJPH_MSG_INFO
@ OJPH_MSG_INFO
Definition ojph_message.h:55
ojph::OJPH_MSG_ERROR
@ OJPH_MSG_ERROR
Definition ojph_message.h:57
ojph::OJPH_MSG_ALL_MSG
@ OJPH_MSG_ALL_MSG
Definition ojph_message.h:54
ojph::OJPH_MSG_WARN
@ OJPH_MSG_WARN
Definition ojph_message.h:56
ojph::OJPH_MSG_NO_MSG
@ OJPH_MSG_NO_MSG
Definition ojph_message.h:58
ojph::set_warning_stream
OJPH_EXPORT void set_warning_stream(FILE *s)
Replaces the warning output file from the default stdout to user defined output file.
Definition ojph_message.cpp:109
ojph::set_info_stream
OJPH_EXPORT void set_info_stream(FILE *s)
Replaces the info output file from the default stdout to user defined output file.
Definition ojph_message.cpp:68
ojph::configure_warning
OJPH_EXPORT void configure_warning(message_warning *warn)
This overrides the default behaviour of handling warning messages.
Definition ojph_message.cpp:97
ojph::configure_info
OJPH_EXPORT void configure_info(message_info *info)
This overrides the default behaviour of handling info messages.
Definition ojph_message.cpp:56
ojph::set_message_level
OJPH_EXPORT void set_message_level(OJPH_MSG_LEVEL level)
Sets the minimum severity of the message to be reported.
Definition ojph_message.cpp:174
ojph::error
message_error error
Definition ojph_message.cpp:134
ojph_arch.h
OJPH_EXPORT
#define OJPH_EXPORT
Definition ojph_arch.h:119