#include <cstdio>
#include <cstdlib>
#include <sys/types.h>
#include <sys/stat.h>
#include <cstring>
#include <fcntl.h>
#include <pwd.h>
#include <sys/ioctl.h>
#include <unistd.h>
#include "MEM_guardedalloc.h"
#include "BLI_fileops.h"
#include "BLI_linklist.h"
#include "BLI_path_utils.hh"
#include "BLI_string.h"
#include "BLI_threads.h"
#include "BLI_utildefines.h"

Functions
bool	BLI_change_working_dir (const char *dir)
char *	BLI_current_working_dir (char *dir, const size_t maxncpy)
const char *	BLI_dir_home ()
double	BLI_dir_free_space (const char *dir)
int64_t	BLI_ftell (FILE *stream)
int	BLI_fseek (FILE *stream, int64_t offset, int whence)
int64_t	BLI_lseek (int fd, int64_t offset, int whence)
size_t	BLI_file_descriptor_size (int file)
size_t	BLI_file_size (const char *path)
eFileAttributes	BLI_file_attributes (const char *path)
bool	BLI_file_alias_target (const char *filepath, char r_targetpath[FILE_MAXDIR])
int	BLI_exists (const char *path)
int	BLI_fstat (int fd, struct stat *buffer)
int	BLI_stat (const char path, struct stat buffer)
bool	BLI_is_dir (const char *path)
bool	BLI_is_file (const char *path)
void *	BLI_file_read_data_as_mem_from_handle (FILE fp, bool read_size_exact, size_t pad_bytes, size_t r_size)
void *	BLI_file_read_text_as_mem (const char filepath, size_t pad_bytes, size_t r_size)
void *	BLI_file_read_binary_as_mem (const char filepath, size_t pad_bytes, size_t r_size)
void *	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)
LinkNode *	BLI_file_read_as_lines (const char *filepath)
void	BLI_file_free_lines (LinkNode *lines)
bool	BLI_file_older (const char file1, const char file2)

Detailed Description

Some really low-level file operations.

Definition in file storage.cc.

Function Documentation

◆ BLI_change_working_dir()

bool BLI_change_working_dir ( const char * dir )

Changes the current working directory to the provided path.

Usage of this function is strongly discouraged as it is not thread safe. It will likely cause issues if there is an operation on another thread that does not expect the current working directory to change. This has been added to support USDZ export, which has a problematic "feature" described in this issue #99807. It will be removed if it is possible to resolve that issue upstream in the USD library.

Returns: true on success, false otherwise.

Definition at line 63 of file storage.cc.

◆ BLI_current_working_dir()

char * BLI_current_working_dir	(	char *	dir,
		size_t	maxncpy )

Copies the current working directory into *dir (max size maxncpy), and returns a pointer to same.

Note: can return NULL when the size is not big enough

Definition at line 81 of file storage.cc.

◆ BLI_dir_free_space()

double BLI_dir_free_space ( const char * dir )

Returns the number of free bytes on the volume containing the specified path.

Note: Not actually used anywhere.

Definition at line 121 of file storage.cc.

References dirname(), ELEM, FILE_MAXDIR, and len.

◆ BLI_dir_home()

const char * BLI_dir_home ( void )

Get the user's home directory, i.e.

Unix: $HOME or #passwd::pw_dir.
Windows: userprofile%

Returns: The home directory or null when it cannot be accessed.

Note: By convention, failure to access home means any derived directories fail as well instead of attempting to create a fallback such as /, /tmp, C:\\endiskip ... etc. Although there may be rare cases where a fallback is appropriate.

Definition at line 97 of file storage.cc.

References BLI_getenv().

Referenced by BKE_appdir_folder_default(), BKE_appdir_folder_documents(), BKE_appdir_font_folder_default(), file_expand_directory(), fsmenu_read_system(), get_thumb_dir(), and WM_window_title().

◆ BLI_exists()

int BLI_exists ( const char * path )

Returns the st_mode from stat-ing the specified path name, or 0 if stat fails (most likely doesn't exist or no access).

Definition at line 360 of file storage.cc.

References alloc_utf16_from_8(), BLI_assert, BLI_path_is_rel(), ELEM, free(), L, and len.

◆ BLI_file_alias_target()

bool BLI_file_alias_target	(	const char *	filepath,
		char	r_targetpath[FILE_MAXDIR] )

Definition at line 306 of file storage.cc.

References ARRAY_SIZE, BLI_path_extension_check(), conv_utf_16_to_8(), conv_utf_8_to_16(), FILE_MAXDIR, and UNUSED_VARS.

◆ BLI_file_attributes()

eFileAttributes BLI_file_attributes ( const char * path )

Definition at line 237 of file storage.cc.

◆ BLI_file_descriptor_size()

size_t BLI_file_descriptor_size ( int file )

Returns the file size of an opened file descriptor or size_t(-1) on failure.

Definition at line 217 of file storage.cc.

References BLI_fstat().

Referenced by BKE_packedfile_new(), buffer_from_filepath(), prefetch_read_file_to_memory(), and proxy_thread_next_frame().

◆ BLI_file_free_lines()

void BLI_file_free_lines ( struct LinkNode * lines )

Frees memory from a previous call to BLI_file_read_as_lines.

Definition at line 609 of file storage.cc.

References BLI_linklist_freeN().

Referenced by make(), studiolight_load_solid_light(), wm_history_file_read(), and wm_platform_support_check_approval().

◆ BLI_file_older()

bool BLI_file_older	(	const char *	file1,
		const char *	file2 )

Compare if one was last modified before the other.

Returns: true when is file1 older than file2.

Definition at line 614 of file storage.cc.

References BLI_stat().

Referenced by IMB_thumb_manage(), and blender::ed::asset::index::AssetIndexFile::is_older_than().

◆ BLI_file_read_as_lines()

LinkNode * BLI_file_read_as_lines ( const char * filepath )

Reads the contents of a text file.

Returns: the lines in a linked list (an empty list when file reading fails).

Definition at line 563 of file storage.cc.

References BLI_fopen(), BLI_fseek(), BLI_ftell(), BLI_linklist_append(), BLI_strdupn(), i, LinkNodePair::list, MEM_calloc_arrayN(), MEM_freeN(), size(), and UNLIKELY.

Referenced by make(), studiolight_load_solid_light(), wm_history_file_read(), and wm_platform_support_check_approval().

◆ BLI_file_read_binary_as_mem()

void * BLI_file_read_binary_as_mem	(	const char *	filepath,
		size_t	pad_bytes,
		size_t *	r_size )

Definition at line 522 of file storage.cc.

References BLI_file_read_data_as_mem_from_handle(), and BLI_fopen().

Referenced by BKE_icon_geom_from_file().

◆ BLI_file_read_data_as_mem_from_handle()

void * BLI_file_read_data_as_mem_from_handle	(	FILE *	fp,
		bool	read_size_exact,
		size_t	pad_bytes,
		size_t *	r_size )

Read the contents of fp, returning the result as a buffer or null when it can't be read.

Parameters

r_size The size of the file contents read into the buffer (excluding pad_bytes).

Definition at line 454 of file storage.cc.

References BLI_fseek(), BLI_fstat(), BLI_ftell(), L, MEM_freeN(), MEM_mallocN(), MEM_reallocN, and S_ISDIR.

Referenced by BLI_file_read_binary_as_mem(), BLI_file_read_text_as_mem(), and python_compat_wrapper_PyRun_FileExFlags().

◆ BLI_file_read_text_as_mem()

void * BLI_file_read_text_as_mem	(	const char *	filepath,
		size_t	pad_bytes,
		size_t *	r_size )

Definition at line 511 of file storage.cc.

References BLI_file_read_data_as_mem_from_handle(), and BLI_fopen().

Referenced by BKE_text_load_ex(), BKE_text_reload(), BLI_file_read_text_as_mem_with_newline_as_nil(), blender::io::csv::import_csv_as_pointcloud(), blender::nodes::node_geo_import_text::node_geo_exec(), blender::io::obj::MTLParser::parse_and_store(), paste_from_file(), blender::io::stl::read_stl_ascii(), blender::io::obj::read_temp_file_in_string(), blender::io::ply::read_temp_file_in_string(), blender::io::stl::read_temp_file_in_string(), and read_text_corpus().

◆ BLI_file_read_text_as_mem_with_newline_as_nil()

void * 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 )

Return the text file data with:

Newlines replaced with '\0'.
Optionally trim white-space, replacing trailing <space> & <tab> with '\0'.

This is an alternative to using BLI_file_read_as_lines, allowing us to loop over lines without converting it into a linked list with individual allocations.

Parameters

trim_trailing_space	Replace trailing spaces & tabs with nil. This arguments prevents the caller from counting blank lines (if that's important).
pad_bytes	When this is non-zero, the first byte is set to nil, to simplify parsing the file. It's recommended to pass in 1, so all text is nil terminated.
r_size	The size of the file contents read into the buffer (excluding pad_bytes).

Example looping over lines:

size_t data_len;
char *data = BLI_file_read_text_as_mem_with_newline_as_nil(filepath, true, 1, &data_len);
char *data_end = data + data_len;
for (char *line = data; line != data_end; line = strlen(line) + 1) {
 printf("line='%s'\n", line);
}