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 267 268 269 270 271 272 273
|
/*
* File functions
*
* Copyright (C) 2008-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( _LIBCFILE_FILE_H )
#define _LIBCFILE_FILE_H
#include <common.h>
#include <types.h>
#include "libcfile_extern.h"
#include "libcfile_libcerror.h"
#include "libcfile_types.h"
#if defined( __cplusplus )
extern "C" {
#endif
typedef struct libcfile_internal_file libcfile_internal_file_t;
struct libcfile_internal_file
{
#if defined( WINAPI )
/* The (file) handle
*/
HANDLE handle;
/* Value to indicate the filename indicate this is a device file
*/
uint8_t is_device_filename;
/* Value to indicate asynchronous IO should be used.
*/
uint8_t use_asynchronous_io;
#else
/* The (file) descriptor
*/
int descriptor;
#endif /* defined( WINAPI ) */
/* The access flags
*/
int access_flags;
/* The size
*/
size64_t size;
/* The current offset
*/
off64_t current_offset;
/* The block size
*/
size_t block_size;
/* The block data
*/
uint8_t *block_data;
/* The block data offset
*/
size_t block_data_offset;
/* The block data size
*/
size_t block_data_size;
};
LIBCFILE_EXTERN \
int libcfile_file_initialize(
libcfile_file_t **file,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_free(
libcfile_file_t **file,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_open(
libcfile_file_t *file,
const char *filename,
int access_flags,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_open_with_error_code(
libcfile_file_t *file,
const char *filename,
int access_flags,
uint32_t *error_code,
libcerror_error_t **error );
#if defined( HAVE_WIDE_CHARACTER_TYPE )
LIBCFILE_EXTERN \
int libcfile_file_open_wide(
libcfile_file_t *file,
const wchar_t *filename,
int access_flags,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_open_wide_with_error_code(
libcfile_file_t *file,
const wchar_t *filename,
int access_flags,
uint32_t *error_code,
libcerror_error_t **error );
#endif /* defined( HAVE_WIDE_CHARACTER_TYPE ) */
LIBCFILE_EXTERN \
int libcfile_file_close(
libcfile_file_t *file,
libcerror_error_t **error );
LIBCFILE_EXTERN \
ssize_t libcfile_file_read_buffer(
libcfile_file_t *file,
uint8_t *buffer,
size_t size,
libcerror_error_t **error );
#if defined( WINAPI )
ssize_t libcfile_internal_file_read_buffer_at_offset_with_error_code(
libcfile_internal_file_t *internal_file,
off64_t current_offset,
uint8_t *buffer,
size_t size,
uint32_t *error_code,
libcerror_error_t **error );
#endif /* defined( WINAPI ) */
LIBCFILE_EXTERN \
ssize_t libcfile_file_read_buffer_with_error_code(
libcfile_file_t *file,
uint8_t *buffer,
size_t size,
uint32_t *error_code,
libcerror_error_t **error );
LIBCFILE_EXTERN \
ssize_t libcfile_file_write_buffer(
libcfile_file_t *file,
const uint8_t *buffer,
size_t size,
libcerror_error_t **error );
LIBCFILE_EXTERN \
ssize_t libcfile_file_write_buffer_with_error_code(
libcfile_file_t *file,
const uint8_t *buffer,
size_t size,
uint32_t *error_code,
libcerror_error_t **error );
LIBCFILE_EXTERN \
off64_t libcfile_file_seek_offset(
libcfile_file_t *file,
off64_t offset,
int whence,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_resize(
libcfile_file_t *file,
size64_t size,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_is_open(
libcfile_file_t *file,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_get_offset(
libcfile_file_t *file,
off64_t *offset,
libcerror_error_t **error );
int libcfile_internal_file_get_size(
libcfile_internal_file_t *internal_file,
size64_t *size,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_get_size(
libcfile_file_t *file,
size64_t *size,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_is_device(
libcfile_file_t *file,
libcerror_error_t **error );
ssize_t libcfile_internal_file_io_control_read_with_error_code(
libcfile_internal_file_t *internal_file,
uint32_t control_code,
uint8_t *control_data,
size_t control_data_size,
uint8_t *data,
size_t data_size,
uint32_t *error_code,
libcerror_error_t **error );
LIBCFILE_EXTERN \
ssize_t libcfile_file_io_control_read(
libcfile_file_t *file,
uint32_t control_code,
uint8_t *control_data,
size_t control_data_size,
uint8_t *data,
size_t data_size,
libcerror_error_t **error );
LIBCFILE_EXTERN \
ssize_t libcfile_file_io_control_read_with_error_code(
libcfile_file_t *file,
uint32_t control_code,
uint8_t *control_data,
size_t control_data_size,
uint8_t *data,
size_t data_size,
uint32_t *error_code,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_set_access_behavior(
libcfile_file_t *file,
int access_behavior,
libcerror_error_t **error );
int libcfile_internal_file_set_block_size(
libcfile_internal_file_t *internal_file,
size_t block_size,
libcerror_error_t **error );
LIBCFILE_EXTERN \
int libcfile_file_set_block_size(
libcfile_file_t *file,
size_t block_size,
libcerror_error_t **error );
#if defined( __cplusplus )
}
#endif
#endif /* !defined( _LIBCFILE_FILE_H ) */
|