Blender V5.3
BLI_fileops.hh File Reference

File and directory operations. More...

#include <fstream>
#include <stdint.h>
#include <stdio.h>
#include <string>
#include <sys/stat.h>
#include <stddef.h>
#include <limits.h>
#include "BLI_compiler_attrs.hh"
#include "BLI_enum_flags.hh"
#include "BLI_fileops_types.hh"
#include "BLI_string_ref.hh"

Go to the source code of this file.

Classes

class  blender::fstream

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define PATH_MAX   4096

Functions

Directories
bool blender::BLI_is_dir (const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
bool blender::BLI_is_file (const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
bool blender::BLI_dir_create_recursive (const char *dirname) ATTR_NONNULL()
double blender::BLI_dir_free_space (const char *dir) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
char * blender::BLI_current_working_dir (char *dir, size_t maxncpy) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
const char * blender::BLI_dir_home ()
eFileAttributes blender::BLI_file_attributes (const char *path)
bool blender::BLI_change_working_dir (const char *dir)
File-List
unsigned int blender::BLI_filelist_dir_contents (const char *dirname, struct direntry **r_filelist)
void blender::BLI_filelist_entry_duplicate (struct direntry *dst, const struct direntry *src)
void blender::BLI_filelist_duplicate (struct direntry **dest_filelist, struct direntry *const src_filelist, unsigned int nrentries)
void blender::BLI_filelist_entry_free (struct direntry *entry)
void blender::BLI_filelist_free (struct direntry *filelist, unsigned int nrentries)
void blender::BLI_filelist_entry_size_to_string (const struct stat *st, uint64_t st_size_fallback, bool compact, char r_size[FILELIST_DIRENTRY_SIZE_LEN])
void blender::BLI_filelist_entry_mode_to_string (const struct stat *st, bool compact, char r_mode1[FILELIST_DIRENTRY_MODE_LEN], char r_mode2[FILELIST_DIRENTRY_MODE_LEN], char r_mode3[FILELIST_DIRENTRY_MODE_LEN])
void blender::BLI_filelist_entry_owner_to_string (const struct stat *st, bool compact, char r_owner[FILELIST_DIRENTRY_OWNER_LEN])

Common

#define FILE_ATTR_ANY_LINK
enum  blender::eFileAttributes {
  blender::FILE_ATTR_READONLY = 1 << 0 , blender::FILE_ATTR_HIDDEN = 1 << 1 , blender::FILE_ATTR_SYSTEM = 1 << 2 , blender::FILE_ATTR_ARCHIVE = 1 << 3 ,
  blender::FILE_ATTR_COMPRESSED = 1 << 4 , blender::FILE_ATTR_ENCRYPTED = 1 << 5 , blender::FILE_ATTR_RESTRICTED = 1 << 6 , blender::FILE_ATTR_TEMPORARY = 1 << 7 ,
  blender::FILE_ATTR_SPARSE_FILE = 1 << 8 , blender::FILE_ATTR_OFFLINE = 1 << 9 , blender::FILE_ATTR_ALIAS = 1 << 10 , blender::FILE_ATTR_REPARSE_POINT = 1 << 11 ,
  blender::FILE_ATTR_SYMLINK = 1 << 12 , blender::FILE_ATTR_JUNCTION_POINT = 1 << 13 , blender::FILE_ATTR_MOUNT_POINT = 1 << 14 , blender::FILE_ATTR_HARDLINK = 1 << 15
}
typedef struct stat blender::BLI_stat_t
bool blender::BLI_exists (const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
int blender::BLI_file_stat_mode (const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
int blender::BLI_copy (const char *path_src, const char *path_dst) ATTR_NONNULL()
int blender::BLI_path_move (const char *path_src, const char *path_dst) ATTR_NONNULL()
int blender::BLI_rename (const char *from, const char *to) ATTR_NONNULL()
int blender::BLI_rename_overwrite (const char *from, const char *to) ATTR_NONNULL()
int blender::BLI_delete (const char *path, bool dir, bool recursive) ATTR_NONNULL()
int blender::BLI_delete_soft (const char *filepath, const char **r_error_message) ATTR_NONNULL()
int blender::BLI_fstat (int fd, BLI_stat_t *buffer) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
int blender::BLI_stat (const char *path, BLI_stat_t *buffer) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
int64_t blender::BLI_ftell (FILE *stream) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
int blender::BLI_fseek (FILE *stream, int64_t offset, int whence)
int64_t blender::BLI_lseek (int fd, int64_t offset, int whence)
 blender::ENUM_OPERATORS (eFileAttributes)

Files

#define O_BINARY   0
FILE * blender::BLI_fopen (const char *filepath, const char *mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void * blender::BLI_gzopen (const char *filepath, const char *mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
int blender::BLI_open (const char *filepath, int oflag, int pmode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
int blender::BLI_access (const char *filepath, int mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
int64_t blender::BLI_read (int fd, void *buf, size_t nbytes)
bool blender::BLI_file_is_writable (const char *filepath) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
bool blender::BLI_file_touch (const char *filepath) ATTR_NONNULL(1)
bool blender::BLI_file_ensure_parent_dir_exists (const char *filepath) ATTR_NONNULL(1)
bool blender::BLI_file_alias_target (const char *filepath, char r_targetpath[768]) ATTR_WARN_UNUSED_RESULT
bool blender::BLI_file_magic_is_gzip (const char header[4])
size_t blender::BLI_file_zstd_from_mem_at_pos (void *buf, size_t len, FILE *file, size_t file_offset, int compression_level) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
size_t blender::BLI_file_unzstd_to_mem_at_pos (void *buf, size_t len, FILE *file, size_t file_offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
bool blender::BLI_file_magic_is_zstd (const char header[4])
size_t blender::BLI_file_descriptor_size (int file) ATTR_WARN_UNUSED_RESULT
size_t blender::BLI_file_size (const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
bool blender::BLI_file_older (const char *file1, const char *file2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
struct LinkNode * blender::BLI_file_read_as_lines (const char *filepath) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void * blender::BLI_file_read_data_as_mem_from_handle (FILE *fp, bool read_size_exact, size_t pad_bytes, size_t *r_size)
char * blender::BLI_file_read_text_as_mem (const char *filepath, size_t pad_bytes, size_t *r_size)
char * blender::BLI_file_read_text_as_mem_with_newline_as_nil (const char *filepath, bool trim_trailing_space, size_t pad_bytes, size_t *r_size)
void * blender::BLI_file_read_binary_as_mem (const char *filepath, size_t pad_bytes, size_t *r_size)
void blender::BLI_file_free_lines (struct LinkNode *lines)

External File Operations

enum  blender::FileExternalOperation {
  blender::FILE_EXTERNAL_OPERATION_OPEN = 1 , blender::FILE_EXTERNAL_OPERATION_FOLDER_OPEN , blender::FILE_EXTERNAL_OPERATION_EDIT , blender::FILE_EXTERNAL_OPERATION_NEW ,
  blender::FILE_EXTERNAL_OPERATION_FIND , blender::FILE_EXTERNAL_OPERATION_SHOW , blender::FILE_EXTERNAL_OPERATION_PLAY , blender::FILE_EXTERNAL_OPERATION_BROWSE ,
  blender::FILE_EXTERNAL_OPERATION_PREVIEW , blender::FILE_EXTERNAL_OPERATION_PRINT , blender::FILE_EXTERNAL_OPERATION_INSTALL , blender::FILE_EXTERNAL_OPERATION_RUNAS ,
  blender::FILE_EXTERNAL_OPERATION_PROPERTIES , blender::FILE_EXTERNAL_OPERATION_FOLDER_FIND , blender::FILE_EXTERNAL_OPERATION_FOLDER_CMD
}
bool blender::BLI_file_external_operation_supported (const char *filepath, FileExternalOperation operation)
bool blender::BLI_file_external_operation_execute (const char *filepath, FileExternalOperation operation)

Detailed Description

File and directory operations.

Definition in file BLI_fileops.hh.

Macro Definition Documentation

◆ FILE_ATTR_ANY_LINK

#define FILE_ATTR_ANY_LINK
Value:
(FILE_ATTR_ALIAS | FILE_ATTR_REPARSE_POINT | FILE_ATTR_SYMLINK | FILE_ATTR_JUNCTION_POINT | \
FILE_ATTR_MOUNT_POINT | FILE_ATTR_HARDLINK)

Definition at line 170 of file BLI_fileops.hh.

Referenced by blender::file_draw_indicator_icons(), and blender::filelist_geticon_file_type_ex().

◆ O_BINARY

◆ PATH_MAX