OpenJPH: /build/openjph/src/OpenJPH/src/core/others/ojph_message.cpp Source File

OpenJPH Open-source implementation of JPEG2000 Part-15

Loading...
Searching...
No Matches
ojph_message.cpp
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.cpp
34// Author: Aous Naman
35// Date: 29 August 2019
36//***************************************************************************/
37
38#include <cassert>
39#include <cstdio>
40#include <cstdarg>
41#include <stdexcept>
42
43#include "ojph_message.h"
44
45namespace ojph {
46
48 FILE* info_stream = stdout;
49
51 message_info info;
52 message_info* local_info = &info;
53 OJPH_MSG_LEVEL message_level = OJPH_MSG_ALL_MSG;
54
56 void configure_info(message_info* info)
57 {
58 local_info = info;
59 }
60
62 message_info* get_info()
63 {
64 return local_info;
65 }
66
68 void set_info_stream(FILE* s)
69 {
70 info_stream = s;
71 }
72
74 void message_info::operator()(int info_code, const char* file_name,
75 int line_num, const char* fmt, ...)
76 {
77 if (info_stream == NULL || message_level > OJPH_MSG_INFO)
78 return;
79
80 fprintf(info_stream, "ojph info 0x%08X at %s:%d: ",
81 info_code, file_name, line_num);
82 va_list args;
83 va_start(args, fmt);
84 vfprintf(info_stream, fmt, args);
85 fprintf(info_stream, "\n");
86 va_end(args);
87 }
88
90 FILE *warning_stream = stdout;
91
93 message_warning warn;
94 message_warning* local_warn = &warn;
95
97 void configure_warning(message_warning* warn)
98 {
99 local_warn = warn;
100 }
101
103 message_warning* get_warning()
104 {
105 return local_warn;
106 }
107
109 void set_warning_stream(FILE *s)
110 {
111 warning_stream = s;
112 }
113
115 void message_warning::operator()(int warn_code, const char* file_name,
116 int line_num, const char *fmt, ...)
117 {
118 if (warning_stream == NULL || message_level > OJPH_MSG_WARN)
119 return;
120
121 fprintf(warning_stream, "ojph warning 0x%08X at %s:%d: ",
122 warn_code, file_name, line_num);
123 va_list args;
124 va_start(args, fmt);
125 vfprintf(warning_stream, fmt, args);
126 fprintf(warning_stream, "\n");
127 va_end(args);
128 }
129
131 FILE *error_stream = stderr;
132
134 message_error error;
135 message_error* local_error = &error;
136
138 void configure_error(message_error* error)
139 {
140 local_error = error;
141 }
142
144 message_error* get_error()
145 {
146 return local_error;
147 }
148
150 void set_error_stream(FILE *s)
151 {
152 error_stream = s;
153 }
154
156 void message_error::operator()(int error_code, const char* file_name,
157 int line_num, const char *fmt, ...)
158 {
159 if (error_stream != NULL && message_level <= OJPH_MSG_ERROR)
160 {
161 fprintf(error_stream, "ojph error 0x%08X at %s:%d: ",
162 error_code, file_name, line_num);
163 va_list args;
164 va_start(args, fmt);
165 vfprintf(error_stream, fmt, args);
166 fprintf(error_stream, "\n");
167 va_end(args);
168 }
169
170 throw std::runtime_error("ojph error");
171 }
172
174 void set_message_level(OJPH_MSG_LEVEL level)
175 {
176 assert(level >= OJPH_MSG_ALL_MSG &&
177 level <= OJPH_MSG_NO_MSG);
178 message_level = level;
179 }
180
181}
ojph::message_error
Derived from message_base to handle error messages.
Definition ojph_message.h:212
ojph::message_error::operator()
virtual void operator()(int warn_code, const char *file_name, int line_num, const char *fmt,...)
See the base message_base::operator() for details about parameters.
Definition ojph_message.cpp:156
ojph::message_info
Derived from message_base to handle info messages.
Definition ojph_message.h:114
ojph::message_info::operator()
virtual void operator()(int info_code, const char *file_name, int line_num, const char *fmt,...)
See the base message_base::operator() for details about parameters.
Definition ojph_message.cpp:74
ojph::message_warning
Derived from message_base to handle warning messages.
Definition ojph_message.h:163
ojph::message_warning::operator()
virtual void operator()(int warn_code, const char *file_name, int line_num, const char *fmt,...)
See the base message_base::operator() for details about parameters.
Definition ojph_message.cpp:115
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::info_stream
FILE * info_stream
Definition ojph_message.cpp:48
ojph::message_level
OJPH_MSG_LEVEL message_level
Definition ojph_message.cpp:53
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::warning_stream
FILE * warning_stream
Definition ojph_message.cpp:90
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::local_warn
message_warning * local_warn
Definition ojph_message.cpp:94
ojph::local_info
message_info * local_info
Definition ojph_message.cpp:52
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::error_stream
FILE * error_stream
Definition ojph_message.cpp:131
ojph::local_error
message_error * local_error
Definition ojph_message.cpp:135
ojph_message.h