struct opj_j2k: remove unused fields, and add some documentation

[openjpeg.git] / src / lib / openjp2 / event.h

diff --git a/src/lib/openjp2/event.h b/src/lib/openjp2/event.h
index f80067ad2e487493619a8a99c725b76a490620fa..d880388d0741fa0a0b9b48ccad1576be2ef0c3cd 100644 (file)
--- a/src/lib/openjp2/event.h
+++ b/src/lib/openjp2/event.h
@@ -1,5 +1,12 @@
 /*
+ * The copyright in this software is being made available under the 2-clauses
+ * BSD License, included below. This software may be subject to other third
+ * party and contributor rights, including patent rights, and no such rights
+ * are granted under this license.
+ *
  * Copyright (c) 2005, Herve Drolon, FreeImage Team
+ * Copyright (c) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR
+ * Copyright (c) 2012, CS Systemes d'Information, France
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -23,8 +30,8 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-#ifndef __EVENT_H
-#define __EVENT_H
+#ifndef OPJ_EVENT_H
+#define OPJ_EVENT_H
 /**
 @file event.h
 @brief Implementation of a event callback system
@@ -33,34 +40,32 @@ The functions in EVENT.C have for goal to send output messages (errors, warnings
 */
 /**
 Message handler object
-used for 
+used for
 <ul>
 <li>Error messages
 <li>Warning messages
 <li>Debugging messages
 </ul>
 */
-#if 0
-typedef struct opj_event_mgr 
-{
-       /** Data to call the event manager upon */
-       void *                  m_error_data;
-       /** Data to call the event manager upon */
-       void *                  m_warning_data;
-       /** Data to call the event manager upon */
-       void *                  m_info_data;
-       /** Error message callback if available, NULL otherwise */
-       opj_msg_callback error_handler;
-       /** Warning message callback if available, NULL otherwise */
-       opj_msg_callback warning_handler;
-       /** Debug message callback if available, NULL otherwise */
-       opj_msg_callback info_handler;
+typedef struct opj_event_mgr {
+    /** Data to call the event manager upon */
+    void *          m_error_data;
+    /** Data to call the event manager upon */
+    void *          m_warning_data;
+    /** Data to call the event manager upon */
+    void *          m_info_data;
+    /** Error message callback if available, NULL otherwise */
+    opj_msg_callback error_handler;
+    /** Warning message callback if available, NULL otherwise */
+    opj_msg_callback warning_handler;
+    /** Debug message callback if available, NULL otherwise */
+    opj_msg_callback info_handler;
 } opj_event_mgr_t;
-#endif
 
-#define EVT_ERROR      1       /**< Error event type */
-#define EVT_WARNING    2       /**< Warning event type */
-#define EVT_INFO       4       /**< Debug event type */
+
+#define EVT_ERROR   1   /**< Error event type */
+#define EVT_WARNING 2   /**< Warning event type */
+#define EVT_INFO    4   /**< Debug event type */
 
 /** @defgroup EVENT EVENT - Implementation of a event callback system */
 /*@{*/
@@ -75,13 +80,14 @@ typedef struct opj_event_mgr
 /**
  * Write formatted data to a string and send the string to a user callback.
  *
- * @param event_mgr                    Event handler
- * @param event_type           Event type or callback to use to send the message
- * @param fmt                          Format-control string (plus optional arguments)
+ * @param event_mgr         Event handler
+ * @param event_type        Event type or callback to use to send the message
+ * @param fmt               Format-control string (plus optional arguments)
  *
  * @return Returns true if successful, returns false otherwise
  */
-opj_bool opj_event_msg(opj_event_mgr_t* event_mgr, int event_type, const char *fmt, ...);
+OPJ_BOOL opj_event_msg(opj_event_mgr_t* event_mgr, OPJ_INT32 event_type,
+                       const char *fmt, ...);
 /* ----------------------------------------------------------------------- */
 
 /**
@@ -89,8 +95,14 @@ opj_bool opj_event_msg(opj_event_mgr_t* event_mgr, int event_type, const char *f
  */
 void opj_set_default_event_handler(opj_event_mgr_t * p_manager);
 
+/*
+#ifdef __GNUC__
+#pragma GCC poison printf fprintf
+#endif
+*/
+
 /*@}*/
 
 /*@}*/
 
-#endif /* __EVENT_H */
+#endif /* OPJ_EVENT_H */