src/lib/openjp2/function_list.h

   1 /*
   2  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
   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
  27 #ifndef __FUNCTION_LIST_H
  28 #define __FUNCTION_LIST_H
  29
  30 /**
  31  * @file function_list.h
  32  * @brief Implementation of a list of procedures.
  33
  34  * The functions in validation.c aims to have access to a list of procedures.
  35 */
  36
  37 /** @defgroup VAL VAL - validation procedure*/
  38 /*@{*/
  39
  40 /**************************************************************************************************
  41  ***************************************** FORWARD DECLARATION ************************************
  42  **************************************************************************************************/
  43
  44 /**
  45  * declare a function pointer
  46  */
  47 typedef void (*opj_procedure)(void);
  48
  49 /**
  50  * A list of procedures.
  51 */
  52 typedef struct opj_procedure_list
  53 {
  54         /**
  55          * The number of validation procedures.
  56          */
  57         OPJ_UINT32 m_nb_procedures;
  58         /**
  59          * The number of the array of validation procedures.
  60          */
  61         OPJ_UINT32 m_nb_max_procedures;
  62         /**
  63          * The array of procedures.
  64          */
  65         opj_procedure * m_procedures;
  66
  67 } opj_procedure_list_t;
  68
  69 /* ----------------------------------------------------------------------- */
  70
  71 /**
  72  * Creates a validation list.
  73  *
  74  * @return      the newly created validation list.
  75  */
  76 opj_procedure_list_t *  opj_procedure_list_create();
  77
  78 /**
  79  * Destroys a validation list.
  80  *
  81  * @param p_list the list to destroy.
  82  */
  83 void  opj_procedure_list_destroy(opj_procedure_list_t * p_list);
  84
  85 /**
  86  * Adds a new validation procedure.
  87  *
  88  * @param       p_validation_list the list of procedure to modify.
  89  * @param       p_procedure             the procedure to add.
  90  *
  91  * @return      OPJ_FALSE if the procedure could ne added.
  92  */
  93 opj_bool opj_procedure_list_add_procedure (opj_procedure_list_t * p_validation_list, opj_procedure p_procedure);
  94
  95 /**
  96  * Gets the number of validation procedures.
  97  *
  98  * @param       p_validation_list the list of procedure to modify.
  99  *
 100  * @return the number of validation procedures.
 101  */
 102 OPJ_UINT32 opj_procedure_list_get_nb_procedures (opj_procedure_list_t * p_validation_list);
 103
 104 /**
 105  * Gets the pointer on the first validation procedure. This function is similar to the C++
 106  * iterator class to iterate through all the procedures inside the validation list.
 107  * the caller does not take ownership of the pointer.
 108  *
 109  * @param       p_validation_list the list of procedure to get the first procedure from.
 110  *
 111  * @return      a pointer to the first procedure.
 112  */
 113 opj_procedure* opj_procedure_list_get_first_procedure (opj_procedure_list_t * p_validation_list);
 114
 115
 116 /**
 117  * Clears the list of validation procedures.
 118  *
 119  * @param       p_validation_list the list of procedure to clear.
 120  *
 121  */
 122 void  opj_procedure_list_clear (opj_procedure_list_t * p_validation_list);
 123 /*@}*/
 124
 125 #endif /* __FUNCTION_LIST_H */
 126