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