libopenjpeg/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 //typedef struct opj_event_mgr
  44 //{
  45 //      /** Data to call the event manager upon */
  46 //      void *                  m_error_data;
  47 //      /** Data to call the event manager upon */
  48 //      void *                  m_warning_data;
  49 //      /** Data to call the event manager upon */
  50 //      void *                  m_info_data;
  51 //      /** Error message callback if available, NULL otherwise */
  52 //      opj_msg_callback error_handler;
  53 //      /** Warning message callback if available, NULL otherwise */
  54 //      opj_msg_callback warning_handler;
  55 //      /** Debug message callback if available, NULL otherwise */
  56 //      opj_msg_callback info_handler;
  57 //} opj_event_mgr_t;
  58
  59 #define EVT_ERROR       1       /**< Error event type */
  60 #define EVT_WARNING     2       /**< Warning event type */
  61 #define EVT_INFO        4       /**< Debug event type */
  62
  63 /** @defgroup EVENT EVENT - Implementation of a event callback system */
  64 /*@{*/
  65
  66 /** @name Exported functions (see also openjpeg.h) */
  67 /*@{*/
  68 /* ----------------------------------------------------------------------- */
  69 /**
  70 Write formatted data to a string and send the string to a user callback.
  71 @param cinfo Codec context info
  72 @param event_type Event type or callback to use to send the message
  73 @param fmt Format-control string (plus optional arguments)
  74 @return Returns true if successful, returns false otherwise
  75 * FIXME Change by its v2 version this function after ended the merge
  76 */
  77 opj_bool opj_event_msg(opj_common_ptr cinfo, int event_type, const char *fmt, ...);
  78
  79 /* ----------------------------------------------------------------------- */
  80
  81 /**
  82  * Write formatted data to a string and send the string to a user callback.
  83  *
  84  * @param event_mgr                     Event handler
  85  * @param event_type            Event type or callback to use to send the message
  86  * @param fmt                           Format-control string (plus optional arguments)
  87  *
  88  * @return Returns true if successful, returns false otherwise
  89  */
  90 opj_bool opj_event_msg_v2(opj_event_mgr_t* event_mgr, int event_type, const char *fmt, ...);
  91 /* ----------------------------------------------------------------------- */
  92
  93 /**
  94  * Set the event manager with the default callback function for the 3 levels.
  95  */
  96 void opj_set_default_event_handler(opj_event_mgr_t * p_manager);
  97
  98 /*@}*/
  99
 100 /*@}*/
 101
 102 #endif /* __EVENT_H */