OpenJPH: /build/openjph/src/OpenJPH/src/core/openjph/ojph_message.h Source File

OpenJPH Open-source implementation of JPEG2000 Part-15

Loading...
Searching...
No Matches
ojph_message.h
Go to the documentation of this file.
1//***************************************************************************/
2// This software is released under the 2-Clause BSD license, included
3// below.
4//
5// Copyright (c) 2019, Aous Naman
6// Copyright (c) 2019, Kakadu Software Pty Ltd, Australia
7// Copyright (c) 2019, The University of New South Wales, Australia
8//
9// Redistribution and use in source and binary forms, with or without
10// modification, are permitted provided that the following conditions are
11// met:
12//
13// 1. Redistributions of source code must retain the above copyright
14// notice, this list of conditions and the following disclaimer.
15//
16// 2. Redistributions in binary form must reproduce the above copyright
17// notice, this list of conditions and the following disclaimer in the
18// documentation and/or other materials provided with the distribution.
19//
20// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31//***************************************************************************/
32// This file is part of the OpenJPH software implementation.
33// File: ojph_message.h
34// Author: Aous Naman
35// Date: 29 August 2019
36//***************************************************************************/
37
38#ifndef OJPH_MESSAGE_H
39#define OJPH_MESSAGE_H
40
41#include <cstring>
42#include "ojph_arch.h"
43
44namespace ojph {
45
47
52 enum OJPH_MSG_LEVEL : int
53 {
54 OJPH_MSG_ALL_MSG = 0, // uninitialized or print all message
55 OJPH_MSG_INFO = 1, // info message
56 OJPH_MSG_WARN = 2, // warning message
57 OJPH_MSG_ERROR = 3, // error message (the highest severity)
58 OJPH_MSG_NO_MSG = 4, // no message (higher severity for message printing
59 // only)
60 };
61
63
84
86
92 class OJPH_EXPORT message_base {
93 public:
105 virtual void operator() (int warn_code, const char* file_name,
106 int line_num, const char *fmt, ...) = 0;
107 };
108
110
113 class OJPH_EXPORT message_info : public message_base
114 {
115 public:
120 virtual void operator() (int info_code, const char* file_name,
121 int line_num, const char* fmt, ...);
122 };
123
125
132 OJPH_EXPORT
133 void set_info_stream(FILE* s);
134
136
142 OJPH_EXPORT
143 void configure_info(message_info* info);
144
146
155 OJPH_EXPORT
156 message_info* get_info();
157
159
162 class OJPH_EXPORT message_warning : public message_base
163 {
164 public:
169 virtual void operator() (int warn_code, const char* file_name,
170 int line_num, const char* fmt, ...);
171 };
172
174
181 OJPH_EXPORT
182 void set_warning_stream(FILE* s);
183
185
191 OJPH_EXPORT
192 void configure_warning(message_warning* warn);
193
195
204 OJPH_EXPORT
205 message_warning* get_warning();
206
208
211 class OJPH_EXPORT message_error : public message_base
212 {
213 public:
218 virtual void operator() (int warn_code, const char* file_name,
219 int line_num, const char *fmt, ...);
220 };
221
223
230 OJPH_EXPORT
231 void set_error_stream(FILE *s);
232
234
241 OJPH_EXPORT
242 void configure_error(message_error* error);
243
245
254 OJPH_EXPORT
255 message_error* get_error();
256
258
264 OJPH_EXPORT
265 void set_message_level(OJPH_MSG_LEVEL level);
266}
267
269
272#if (defined OJPH_OS_WINDOWS)
273 #define __OJPHFILE__ \
274 (strrchr(__FILE__, '\\') ? strrchr(__FILE__, '\\') + 1 : __FILE__)
275#else
276 #define __OJPHFILE__ \
277 (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
278#endif
279
281
284#define OJPH_INFO(t, ...) \
285 { ojph::get_info()[0](t, __OJPHFILE__, __LINE__, __VA_ARGS__); }
286#define OJPH_WARN(t, ...) \
287 { ojph::get_warning()[0](t, __OJPHFILE__, __LINE__, __VA_ARGS__); }
288#define OJPH_ERROR(t, ...) \
289 { ojph::get_error()[0](t, __OJPHFILE__, __LINE__,__VA_ARGS__); }
290
291
292#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:123