src/lib/openjp3d/event.h

   1 /*
   2  * The copyright in this software is being made available under the 2-clauses
   3  * BSD License, included below. This software may be subject to other third
   4  * party and contributor rights, including patent rights, and no such rights
   5  * are granted under this license.
   6  *
   7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31 #ifndef __EVENT_H
  32 #define __EVENT_H
  33 /**
  34 @file event.h
  35 @brief Implementation of a event callback system
  36
  37 The functions in EVENT.C have for goal to send output messages (errors, warnings, debug) to the user.
  38 */
  39
  40 #define EVT_ERROR       1       /**< Error event type */
  41 #define EVT_WARNING     2       /**< Warning event type */
  42 #define EVT_INFO        4       /**< Debug event type */
  43
  44 /** @defgroup EVENT EVENT - Implementation of a event callback system */
  45 /*@{*/
  46
  47 /** @name Funciones generales (see also openjp3d.h) */
  48 /*@{*/
  49 /* ----------------------------------------------------------------------- */
  50 /**
  51 Write formatted data to a string and send the string to a user callback.
  52 @param cinfo Codec context info
  53 @param event_type Event type or callback to use to send the message
  54 @param fmt Format-control string (plus optionnal arguments)
  55 @return Returns true if successful, returns false otherwise
  56 */
  57 bool opj_event_msg(opj_common_ptr cinfo, int event_type, const char *fmt, ...);
  58 /* ----------------------------------------------------------------------- */
  59 /*@}*/
  60
  61 /*@}*/
  62
  63 #endif /* __EVENT_H */