File: libfwevt_xml_value.h

package info (click to toggle)
libevtx 20240504-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 18,276 kB
  • sloc: ansic: 300,638; sh: 6,549; makefile: 1,779; python: 381; cpp: 171; sed: 16
file content (266 lines) | stat: -rw-r--r-- 7,755 bytes parent folder | download
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
/*
 * XML value functions
 *
 * Copyright (C) 2011-2024, Joachim Metz <joachim.metz@gmail.com>
 *
 * Refer to AUTHORS for acknowledgements.
 *
 * This program 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 program 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 program.  If not, see <https://www.gnu.org/licenses/>.
 */

#if !defined( _LIBFWEVT_XML_VALUE_H )
#define _LIBFWEVT_XML_VALUE_H

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

#include "libfwevt_data_segment.h"
#include "libfwevt_extern.h"
#include "libfwevt_libcdata.h"
#include "libfwevt_libcerror.h"
#include "libfwevt_libcnotify.h"
#include "libfwevt_types.h"

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

typedef struct libfwevt_internal_xml_value libfwevt_internal_xml_value_t;

struct libfwevt_internal_xml_value
{
	/* The value type
	 */
	uint8_t value_type;

	/* The data segments
	 */
	libcdata_array_t *data_segments;

	/* The data size
	 */
	size_t data_size;
};

int libfwevt_xml_value_initialize(
     libfwevt_xml_value_t **xml_value,
     uint8_t value_type,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_free(
     libfwevt_xml_value_t **xml_value,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_free(
     libfwevt_internal_xml_value_t **internal_xml_value,
     libcerror_error_t **error );

int libfwevt_xml_value_get_type(
     libfwevt_xml_value_t *xml_value,
     uint8_t *value_type,
     libcerror_error_t **error );

int libfwevt_xml_value_get_number_of_data_segments(
     libfwevt_xml_value_t *xml_value,
     int *number_of_data_segments,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_segment_with_cached_value(
     libfwevt_internal_xml_value_t *internal_xml_value,
     int data_segment_index,
     libfwevt_data_segment_t **data_segment,
     libcerror_error_t **error );

int libfwevt_xml_value_append_data_segment(
     libfwevt_xml_value_t *xml_value,
     const uint8_t *data,
     size_t data_size,
     int *data_segment_index,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_get_data_size(
     libfwevt_xml_value_t *xml_value,
     size_t *data_size,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_copy_data(
     libfwevt_xml_value_t *xml_value,
     uint8_t *data,
     size_t data_size,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_value_get_data_as_8bit_integer(
     libfwevt_xml_value_t *xml_value,
     uint8_t *value_8bit,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_value_get_data_as_32bit_integer(
     libfwevt_xml_value_t *xml_value,
     uint32_t *value_32bit,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_value_get_data_as_64bit_integer(
     libfwevt_xml_value_t *xml_value,
     uint64_t *value_64bit,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_value_get_data_as_filetime(
     libfwevt_xml_value_t *xml_value,
     uint64_t *filetime,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_segment_as_utf8_string_size(
     libfwevt_internal_xml_value_t *internal_xml_value,
     int data_segment_index,
     libfwevt_data_segment_t *data_segment,
     size_t *utf8_string_size,
     uint8_t escape_characters,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_segment_as_utf8_string(
     libfwevt_internal_xml_value_t *internal_xml_value,
     int data_segment_index,
     libfwevt_data_segment_t *data_segment,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     size_t *utf8_string_index,
     uint8_t escape_characters,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_as_utf8_string_size(
     libfwevt_internal_xml_value_t *internal_xml_value,
     size_t *utf8_string_size,
     uint8_t escape_characters,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_as_utf8_string_with_index(
     libfwevt_internal_xml_value_t *internal_xml_value,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     size_t *utf8_string_index,
     uint8_t escape_characters,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_get_utf8_string_size(
     libfwevt_xml_value_t *xml_value,
     size_t *utf8_string_size,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_copy_to_utf8_string(
     libfwevt_xml_value_t *xml_value,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_get_data_as_utf8_string_size(
     libfwevt_xml_value_t *xml_value,
     size_t *utf8_string_size,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_get_data_as_utf8_string(
     libfwevt_xml_value_t *xml_value,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_segment_as_utf16_string_size(
     libfwevt_internal_xml_value_t *internal_xml_value,
     int data_segment_index,
     libfwevt_data_segment_t *data_segment,
     size_t *utf16_string_size,
     uint8_t escape_characters,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_segment_as_utf16_string(
     libfwevt_internal_xml_value_t *internal_xml_value,
     int data_segment_index,
     libfwevt_data_segment_t *data_segment,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     size_t *utf16_string_index,
     uint8_t escape_characters,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_as_utf16_string_size(
     libfwevt_internal_xml_value_t *internal_xml_value,
     size_t *utf16_string_size,
     uint8_t escape_characters,
     libcerror_error_t **error );

int libfwevt_internal_xml_value_get_data_as_utf16_string_with_index(
     libfwevt_internal_xml_value_t *internal_xml_value,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     size_t *utf16_string_index,
     uint8_t escape_characters,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_get_utf16_string_size(
     libfwevt_xml_value_t *xml_value,
     size_t *utf16_string_size,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_copy_to_utf16_string(
     libfwevt_xml_value_t *xml_value,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_get_data_as_utf16_string_size(
     libfwevt_xml_value_t *xml_value,
     size_t *utf16_string_size,
     libcerror_error_t **error );

LIBFWEVT_EXTERN \
int libfwevt_xml_value_get_data_as_utf16_string(
     libfwevt_xml_value_t *xml_value,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     libcerror_error_t **error );

#if defined( HAVE_DEBUG_OUTPUT )

int libfwevt_xml_value_debug_print(
     libfwevt_xml_value_t *xml_value,
     uint8_t escape_characters,
     libcerror_error_t **error );

int libfwevt_xml_value_debug_print_data_segment(
     libfwevt_xml_value_t *xml_value,
     int data_segment_index,
     uint8_t escape_characters,
     libcerror_error_t **error );

#endif /* defined( HAVE_DEBUG_OUTPUT ) */

#if defined( __cplusplus )
}
#endif

#endif /* !defined( _LIBFWEVT_XML_VALUE_H ) */