Blender V5.3
BLI_filereader.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
9
10#pragma once
11
12#ifdef WIN32
13# include "BLI_winstuff.hh"
14#else
15# include <sys/types.h>
16#endif
17
18#include "BLI_compiler_attrs.hh"
19#include "BLI_utildefines.hh"
20
21namespace blender {
22
23#if defined(_MSC_VER) || defined(__APPLE__) || defined(__HAIKU__) || defined(__NetBSD__) || \
24 defined(__OpenBSD__)
25typedef int64_t off64_t;
26#endif
27
28struct FileReader;
29
30typedef int64_t (*FileReaderReadFn)(struct FileReader *reader, void *buffer, size_t size);
31typedef off64_t (*FileReaderSeekFn)(struct FileReader *reader, off64_t offset, int whence);
32typedef void (*FileReaderCloseFn)(struct FileReader *reader);
33
42
43/* Functions for opening the various types of FileReader.
44 * They either succeed and return a valid FileReader, or fail and return NULL.
45 *
46 * If a FileReader is created, it has to be cleaned up and freed by calling its close()
47 * function unless another FileReader has taken ownership - for example, `Zstd` & `Gzip`
48 * take over the base FileReader and will clean it up when their clean() is called.
49 */
50
62
63} // namespace blender
Compatibility-like things for windows.
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
BMesh Iterators.
__int64 int64_t
Definition BKE_text.h:90
int64_t(*) FileReaderReadFn(struct FileReader *reader, void *buffer, size_t size)
FileReader * BLI_filereader_new_mmap(int filedes) ATTR_WARN_UNUSED_RESULT
FileReader * BLI_filereader_new_memory(const void *data, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void(*) FileReaderCloseFn(struct FileReader *reader)
BMesh const char void * data
off64_t(*) FileReaderSeekFn(struct FileReader *reader, off64_t offset, int whence)
FileReader * BLI_filereader_new_gzip(FileReader *base) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
bool ATTR_WARN_UNUSED_RESULT
FileReader * BLI_filereader_new_zstd(FileReader *base) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void ATTR_NONNULL(1, 2)
FileReader * BLI_filereader_new_file(int filedes) ATTR_WARN_UNUSED_RESULT
FileReaderCloseFn close
FileReaderSeekFn seek
FileReaderReadFn read