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

OpenJPH Open-source implementation of JPEG2000 Part-15

Loading...
Searching...
No Matches
ojph_message.h File Reference
`#include <cstring>`
`#include "ojph_arch.h"`

Go to the source code of this file.

## Classes
class | ojph::message_base
| This is the base class from which all messaging levels are derived. More...
class | ojph::message_info
| Derived from message_base to handle info messages. More...
class | ojph::message_warning
| Derived from message_base to handle warning messages. More...
class | ojph::message_error
| Derived from message_base to handle error messages. More...

## Namespaces
namespace | ojph

## Macros
#define | __OJPHFILE__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
| MACROS to remove the directory name from the file name.
#define | OJPH_INFO(t, ...)
| MACROs to insert file and line number for info, warning, and error.
#define | OJPH_WARN(t, ...)
#define | OJPH_ERROR(t, ...)

## Enumerations
enum | ojph::OJPH_MSG_LEVEL : int { ojph::OJPH_MSG_ALL_MSG = 0 , ojph::OJPH_MSG_INFO = 1 , ojph::OJPH_MSG_WARN = 2 , ojph::OJPH_MSG_ERROR = 3 , ojph::OJPH_MSG_NO_MSG = 4 }
| This enum is use to specify the level of severity of message while processing markers. More...

## Functions
OJPH_EXPORT void | ojph::set_info_stream (FILE *s)
| Replaces the info output file from the default stdout to user defined output file.
OJPH_EXPORT void | ojph::configure_info (message_info *info)
| This overrides the default behaviour of handling info messages.
OJPH_EXPORT message_info * | ojph::get_info ()
| Get the info message object, whose operator() member class is called for info messages – See the macros below.
OJPH_EXPORT void | ojph::set_warning_stream (FILE *s)
| Replaces the warning output file from the default stdout to user defined output file.
OJPH_EXPORT void | ojph::configure_warning (message_warning *warn)
| This overrides the default behaviour of handling warning messages.
OJPH_EXPORT message_warning * | ojph::get_warning ()
| Get the warning message object, whose operator() member class is called for warning messages – See the macros below.
OJPH_EXPORT void | ojph::set_error_stream (FILE *s)
| Replaces the error output file from the default stderr to user defined output file.
OJPH_EXPORT void | ojph::configure_error (message_error *error)
| This overrides the default behaviour of handling error messages.
OJPH_EXPORT message_error * | ojph::get_error ()
| Get the error message object, whose operator() member class is called for error messages – See the macros below.
OJPH_EXPORT void | ojph::set_message_level (OJPH_MSG_LEVEL level)
| Sets the minimum severity of the message to be reported.

## Macro Definition Documentation

## ◆ __OJPHFILE__

#define __OJPHFILE__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)

MACROS to remove the directory name from the file name.

Definition at line 276 of file ojph_message.h.

## ◆ OJPH_ERROR

#define OJPH_ERROR | ( |  | t,
|  |  | ... )

Value:
{ ojph::get_error()[0](t, __OJPHFILE__, __LINE__,__VA_ARGS__); }
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
__OJPHFILE__
#define __OJPHFILE__
MACROS to remove the directory name from the file name.
Definition ojph_message.h:276

Definition at line 288 of file ojph_message.h.

Referenced by ojph::mem_fixed_allocator::alloc(), ojph::local::codestream::check_broadcast_validity(), ojph::local::codestream::check_imf_validity(), ojph::local::param_cod::check_validity(), ojph::local::param_siz::check_validity(), ojph::pfm_out::configure(), ojph::ppm_out::configure(), ojph::local::codeblock::decode(), ojph::local::codestream::enable_resilience(), ojph::mem_outfile::expand_storage(), ojph::local::resolution::finalize_alloc(), ojph::local::tile::finalize_alloc(), ojph::local::codestream::flush(), ojph::local::tile::flush(), ojph::net::socket_manager::get_error_message(), get_file_extension(), get_file_extension(), ojph::local::param_qcd::get_irrev_delta(), ojph::local::param_tlm::init(), main(), ojph::local::mel_emit_bit(), ojph::local::ms_encode(), ojph::local::ms_encode64(), ojph::local::ms_terminate(), ojph::dpx_in::open(), ojph::j2c_infile::open(), ojph::j2c_outfile::open(), ojph::pfm_in::open(), ojph::pfm_out::open(), ojph::ppm_in::open(), ojph::ppm_out::open(), ojph::raw_in::open(), ojph::raw_out::open(), ojph::yuv_in::open(), ojph::yuv_out::open(), ojph::local::tile::parse_tile_header(), ojph::local::codestream::pre_alloc(), ojph::local::resolution::pre_alloc(), ojph::local::tile::pre_alloc(), ojph::dpx_in::read(), ojph::local::codestream::read(), ojph::local::param_atk::read(), ojph::local::param_cap::read(), ojph::local::param_cod::read(), ojph::local::param_dfs::read(), ojph::local::param_nlt::read(), ojph::local::param_qcd::read(), ojph::local::param_siz::read(), ojph::local::param_sot::read(), ojph::pfm_in::read(), ojph::ppm_in::read(), ojph::raw_in::read(), ojph::yuv_in::read(), ojph::local::param_cod::read_coc(), ojph::local::codestream::read_headers(), ojph::local::param_qcd::read_qcc(), ojph::local::codestream::restrict_input_resolution(), ojph::yuv_in::set_bit_depth(), ojph::param_cod::set_block_dims(), ojph::comment_exchange::set_data(), ojph::yuv_in::set_img_props(), ojph::local::param_nlt::set_nonlinear_transform(), ojph::param_cod::set_num_decomposition(), ojph::param_cod::set_precinct_size(), ojph::local::codestream::set_profile(), ojph::param_cod::set_progression_order(), ojph::local::param_qcd::set_rev_quant(), ojph::comment_exchange::set_string(), ojph::local::skip_marker(), ojph::net::socket_manager::socket_manager(), ojph::local::terminate_mel_vlc(), ojph::local::param_cod::update_atk(), ojph::local::vlc_encode(), ojph::pfm_out::write(), ojph::ppm_out::write(), ojph::raw_out::write(), ojph::yuv_out::write(), ojph::local::codestream::write_headers(), and ojph::mem_outfile::write_to_file().

## ◆ OJPH_INFO

#define OJPH_INFO | ( |  | t,
|  |  | ... )

Value:
{ ojph::get_info()[0](t, __OJPHFILE__, __LINE__, __VA_ARGS__); }
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

MACROs to insert file and line number for info, warning, and error.

Definition at line 284 of file ojph_message.h.

Referenced by ojph::local::codeblock::decode(), ojph::local::param_qcd::get_irrev_delta(), ojph::local::param_qcd::get_Kmax(), main(), ojph::local::tile::parse_tile_header(), ojph::local::codestream::read(), ojph::local::param_dfs::read(), ojph::local::param_sot::read(), ojph::local::codestream::read_headers(), ojph::local::skip_marker(), ojph::local::param_nlt::trim_non_existing_components(), and ojph::local::codestream::write_headers().

## ◆ OJPH_WARN

#define OJPH_WARN | ( |  | t,
|  |  | ... )

Value:
{ ojph::get_warning()[0](t, __OJPHFILE__, __LINE__, __VA_ARGS__); }
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

Definition at line 286 of file ojph_message.h.

Referenced by ojph::local::codestream::check_broadcast_validity(), ojph::local::codestream::check_imf_validity(), main(), ojph::local::ojph_decode_codeblock32(), ojph::local::ojph_decode_codeblock64(), ojph::local::ojph_decode_codeblock_wasm(), ojph::ppm_out::open(), ojph::local::param_siz::read(), ojph::local::param_cod::read_coc(), ojph::local::skip_marker(), and ojph::local::codestream::write_headers().