OpenJPH
Open-source implementation of JPEG2000 Part-15
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 ALL_MSG = 0, // uninitialized or print all message
55 INFO = 1, // info message
56 WARN = 2, // warning message
57 ERROR = 3, // error message (the highest severity)
58 NO_MSG = 4, // no message (higher severity for message printing only)
59 };
60
62
85
92 public:
104 virtual void operator() (int warn_code, const char* file_name,
105 int line_num, const char *fmt, ...) = 0;
106 };
107
109
113 {
114 public:
119 virtual void operator() (int info_code, const char* file_name,
120 int line_num, const char* fmt, ...);
121 };
122
124
132 void set_info_stream(FILE* s);
133
135
143
145
156
158
162 {
163 public:
168 virtual void operator() (int warn_code, const char* file_name,
169 int line_num, const char* fmt, ...);
170 };
171
173
181 void set_warning_stream(FILE* s);
182
184
192
194
205
207
211 {
212 public:
217 virtual void operator() (int warn_code, const char* file_name,
218 int line_num, const char *fmt, ...);
219 };
220
222
230 void set_error_stream(FILE *s);
231
233
242
244
255
257
265}
266
268
271#if (defined OJPH_OS_WINDOWS)
272 #define __OJPHFILE__ \
273 (strrchr(__FILE__, '\\') ? strrchr(__FILE__, '\\') + 1 : __FILE__)
274#else
275 #define __OJPHFILE__ \
276 (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
277#endif
278
280
283#define OJPH_INFO(t, ...) \
284 { ojph::get_info()[0](t, __OJPHFILE__, __LINE__, __VA_ARGS__); }
285#define OJPH_WARN(t, ...) \
286 { ojph::get_warning()[0](t, __OJPHFILE__, __LINE__, __VA_ARGS__); }
287#define OJPH_ERROR(t, ...) \
288 { ojph::get_error()[0](t, __OJPHFILE__, __LINE__,__VA_ARGS__); }
289
290
291#endif // !OJPH_MESSAGE_H
This is the base class from which all messaging levels are derived.
Definition: ojph_message.h:91
Derived from message_base to handle error messages.
Definition: ojph_message.h:211
Derived from message_base to handle info messages.
Definition: ojph_message.h:113
Derived from message_base to handle warning messages.
Definition: ojph_message.h:162
OJPH_EXPORT message_info * get_info()
Get the info message object, whose operator() member class is called for info messages – See the macr...
message_warning warn
OJPH_EXPORT message_warning * get_warning()
Get the warning message object, whose operator() member class is called for warning messages – See th...
OJPH_EXPORT void set_error_stream(FILE *s)
Replaces the error output file from the default stderr to user defined output file.
message_info info
OJPH_EXPORT void configure_error(message_error *error)
This overrides the default behaviour of handling error messages.
OJPH_EXPORT message_error * get_error()
Get the error message object, whose operator() member class is called for error messages – See the ma...
OJPH_MSG_LEVEL
This enum is use to specify the level of severity of message while processing markers.
Definition: ojph_message.h:53
@ ERROR
Definition: ojph_message.h:57
@ WARN
Definition: ojph_message.h:56
@ INFO
Definition: ojph_message.h:55
@ NO_MSG
Definition: ojph_message.h:58
@ ALL_MSG
Definition: ojph_message.h:54
OJPH_EXPORT void set_warning_stream(FILE *s)
Replaces the warning output file from the default stdout to user defined output file.
OJPH_EXPORT void set_info_stream(FILE *s)
Replaces the info output file from the default stdout to user defined output file.
OJPH_EXPORT void configure_warning(message_warning *warn)
This overrides the default behaviour of handling warning messages.
OJPH_EXPORT void configure_info(message_info *info)
This overrides the default behaviour of handling info messages.
OJPH_EXPORT void set_message_level(OJPH_MSG_LEVEL level)
Sets the minimum severity of the message to be reported.
message_error error
#define OJPH_EXPORT
Definition: ojph_arch.h:119