src/lib/openjp2/event.h

   1 /*
   2  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24  * POSSIBILITY OF SUCH DAMAGE.
  25  */
  26 #ifndef __EVENT_H
  27 #define __EVENT_H
  28 /**
  29 @file event.h
  30 @brief Implementation of a event callback system
  31
  32 The functions in EVENT.C have for goal to send output messages (errors, warnings, debug) to the user.
  33 */
  34 /**
  35 Message handler object
  36 used for
  37 <ul>
  38 <li>Error messages
  39 <li>Warning messages
  40 <li>Debugging messages
  41 </ul>
  42 */
  43 #if 0
  44 typedef struct opj_event_mgr
  45 {
  46         /** Data to call the event manager upon */
  47         void *                  m_error_data;
  48         /** Data to call the event manager upon */
  49         void *                  m_warning_data;
  50         /** Data to call the event manager upon */
  51         void *                  m_info_data;
  52         /** Error message callback if available, NULL otherwise */
  53         opj_msg_callback error_handler;
  54         /** Warning message callback if available, NULL otherwise */
  55         opj_msg_callback warning_handler;
  56         /** Debug message callback if available, NULL otherwise */
  57         opj_msg_callback info_handler;
  58 } opj_event_mgr_t;
  59 #endif
  60
  61 #define EVT_ERROR       1       /**< Error event type */
  62 #define EVT_WARNING     2       /**< Warning event type */
  63 #define EVT_INFO        4       /**< Debug event type */
  64
  65 /** @defgroup EVENT EVENT - Implementation of a event callback system */
  66 /*@{*/
  67
  68 /** @name Exported functions (see also openjpeg.h) */
  69 /*@{*/
  70 /* ----------------------------------------------------------------------- */
  71
  72
  73 /* ----------------------------------------------------------------------- */
  74
  75 /**
  76  * Write formatted data to a string and send the string to a user callback.
  77  *
  78  * @param event_mgr                     Event handler
  79  * @param event_type            Event type or callback to use to send the message
  80  * @param fmt                           Format-control string (plus optional arguments)
  81  *
  82  * @return Returns true if successful, returns false otherwise
  83  */
  84 opj_bool opj_event_msg_v2(opj_event_mgr_t* event_mgr, int event_type, const char *fmt, ...);
  85 /* ----------------------------------------------------------------------- */
  86
  87 /**
  88  * Set the event manager with the default callback function for the 3 levels.
  89  */
  90 void opj_set_default_event_handler(opj_event_mgr_t * p_manager);
  91
  92 /*@}*/
  93
  94 /*@}*/
  95
  96 #endif /* __EVENT_H */