File: libfdata_array_type.h

package info (click to toggle)
libpff 20120802-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 13,524 kB
  • ctags: 6,784
  • sloc: ansic: 214,206; sh: 11,485; makefile: 1,229; python: 138; java: 137; sed: 16
file content (166 lines) | stat: -rw-r--r-- 4,149 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/* 
 * Array type functions
 *
 * Copyright (c) 2010-2012, Joachim Metz <joachim.metz@gmail.com>
 *
 * Refer to AUTHORS for acknowledgements.
 *
 * This software is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this software.  If not, see <http://www.gnu.org/licenses/>.
 */

#if !defined( _LIBFDATA_ARRAY_TYPE_H )
#define _LIBFDATA_ARRAY_TYPE_H

#include <common.h>
#include <types.h>

#include "libfdata_libcerror.h"

#if defined( __cplusplus )
extern "C" {
#endif

/* The array comparison definitions
 */
enum LIBFDATA_ARRAY_COMPARE_DEFINITIONS
{
	/* The first value is less than the second value
	 */
        LIBFDATA_ARRAY_COMPARE_LESS,

	/* The first and second values are equal
	 */
        LIBFDATA_ARRAY_COMPARE_EQUAL,

	/* The first value is greater than the second value
	 */
        LIBFDATA_ARRAY_COMPARE_GREATER
};

/* The array insert flag definitions
 */
enum LIBFDATA_ARRAY_INSERT_FLAGS
{
	/* Allow duplicate entries
	 */
	LIBFDATA_ARRAY_INSERT_FLAG_NON_UNIQUE_ENTRIES	= 0x00,

	/* Only allow unique entries, no duplicates
	 */
	LIBFDATA_ARRAY_INSERT_FLAG_UNIQUE_ENTRIES	= 0x01,
};

typedef struct libfdata_array libfdata_array_t;

struct libfdata_array
{
	/* The number of allocated entries
	 */
	int number_of_allocated_entries;

	/* The number of entries
	 */
	int number_of_entries;

	/* The entries
	 */
	intptr_t **entries;
};

int libfdata_array_initialize(
     libfdata_array_t **array,
     int number_of_entries,
     libcerror_error_t **error );

int libfdata_array_free(
     libfdata_array_t **array,
     int (*entry_free_function)(
            intptr_t **entry,
            libcerror_error_t **error ),
     libcerror_error_t **error );

int libfdata_array_empty(
     libfdata_array_t *array,
     int (*entry_free_function)(
            intptr_t **entry,
            libcerror_error_t **error ),
     libcerror_error_t **error );

int libfdata_array_clear(
     libfdata_array_t *array,
     int (*entry_free_function)(
            intptr_t **entry,
            libcerror_error_t **error ),
     libcerror_error_t **error );

int libfdata_array_clone(
     libfdata_array_t **destination_array,
     libfdata_array_t *source_array,
     int (*entry_free_function)(
            intptr_t **entry,
            libcerror_error_t **error ),
     int (*entry_clone_function)(
            intptr_t **destination,
            intptr_t *source,
            libcerror_error_t **error ),
     libcerror_error_t **error );

int libfdata_array_resize(
     libfdata_array_t *array,
     int number_of_entries,
     int (*entry_free_function)(
            intptr_t **entry,
            libcerror_error_t **error ),
     libcerror_error_t **error );

int libfdata_array_get_number_of_entries(
     libfdata_array_t *array,
     int *number_of_entries,
     libcerror_error_t **error );

int libfdata_array_get_entry_by_index(
     libfdata_array_t *array,
     int entry_index,
     intptr_t **entry,
     libcerror_error_t **error );

int libfdata_array_set_entry_by_index(
     libfdata_array_t *array,
     int entry_index,
     intptr_t *entry,
     libcerror_error_t **error );

int libfdata_array_append_entry(
     libfdata_array_t *array,
     int *entry_index,
     intptr_t *entry,
     libcerror_error_t **error );

int libfdata_array_insert_entry(
     libfdata_array_t *array,
     int *entry_index,
     intptr_t *entry,
     int (*entry_compare_function)(
            intptr_t *first_entry,
            intptr_t *second_entry,
            libcerror_error_t **error ),
     uint8_t insert_flags,
     libcerror_error_t **error );

#if defined( __cplusplus )
}
#endif

#endif