Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
File

This group discusses the functions to handle files and directories. More...

Data Structures

struct  _Eina_File_Direct_Info
 The structure to store information of a path. More...
 
struct  _Eina_Stat
 The structure to store some file statistics. More...
 
struct  _Eina_File_Line
 The structure to store information of a line. More...
 
struct  _Eina_File
 This is the underlying data structure that represents a file in Eina. More...
 
struct  _Eina_File_Map
 This represents a memory mapped region of a file. More...
 
struct  _Eina_Lines_Iterator
 This represents a line iterator a file. More...
 

Macros

#define EINA_PATH_MAX   8192
 Definition for the constant defined as the highest value for PATH_MAX.
 
#define EINA_PATH_SEP_C   '/'
 The constant defined the path separator as the character '\' on Windows and '/' otherwise. More...
 
#define EINA_PATH_SEP_S   "/"
 The constant defined the path separator as the string "\" on Windows and "/" otherwise. More...
 
#define EINA_FILE_DIR_LIST_CB(function)   ((Eina_File_Dir_List_Cb)function)
 The macro to cast to an Eina_File_Dir_List_Cb. More...
 
#define EINA_LOG_COLOR_DEFAULT   EINA_COLOR_CYAN
 Set the color for Eina log entries.
 
#define ERR(...)   EINA_LOG_DOM_ERR(_eina_file_log_dom, __VA_ARGS__)
 Macro for logging Eina errors.
 
#define WRN(...)   EINA_LOG_DOM_WARN(_eina_file_log_dom, __VA_ARGS__)
 Macro for logging Eina warnings.
 
#define INF(...)   EINA_LOG_DOM_INFO(_eina_file_log_dom, __VA_ARGS__)
 Macro for logging Eina info messages.
 
#define DBG(...)   EINA_LOG_DOM_DBG(_eina_file_log_dom, __VA_ARGS__)
 Macro for logging Eina debug messages.
 

Typedefs

typedef struct _Eina_File_Direct_Info Eina_File_Direct_Info
 A type for _Eina_File_Direct_Info.
 
typedef struct _Eina_Stat Eina_Stat
 A type for _Eina_Stat. More...
 
typedef struct _Eina_File_Line Eina_File_Line
 A type for _Eina_File_Line.
 
typedef void(* Eina_File_Dir_List_Cb) (const char *name, const char *path, void *data)
 Type for a callback to be called when iterating over the files of a directory. More...
 
typedef struct _Eina_File Eina_File
 A file handle.
 
typedef Eina_Bool(* Eina_File_Copy_Progress) (void *data, unsigned long long done, unsigned long long total)
 Type for a callback to report file copy progress. More...
 
typedef struct _Eina_File_Map Eina_File_Map
 Type definition for an Eina File Map.
 
typedef struct _Eina_Lines_Iterator Eina_Lines_Iterator
 Type definition for an Eina Lines Iterator.
 

Enumerations

enum  Eina_File_Type {
  EINA_FILE_UNKNOWN,
  EINA_FILE_FIFO,
  EINA_FILE_CHR,
  EINA_FILE_DIR,
  EINA_FILE_BLK,
  EINA_FILE_REG,
  EINA_FILE_LNK,
  EINA_FILE_SOCK,
  EINA_FILE_WHT
}
 Type for enumeration of a file type. More...
 
enum  Eina_File_Populate {
  EINA_FILE_RANDOM,
  EINA_FILE_SEQUENTIAL,
  EINA_FILE_WILLNEED,
  EINA_FILE_POPULATE,
  EINA_FILE_DONTNEED,
  EINA_FILE_REMOVE
}
 Type for enumeration of a file access type. More...
 
enum  Eina_File_Copy_Flags {
  EINA_FILE_COPY_DATA = 0,
  EINA_FILE_COPY_PERMISSION = (1 << 0),
  EINA_FILE_COPY_XATTR = (1 << 1)
}
 Enumeration for a flag what to copy from file.
 

Functions

EAPI Eina_Bool eina_file_dir_list (const char *dir, Eina_Bool recursive, Eina_File_Dir_List_Cb cb, void *data) EINA_ARG_NONNULL(1
 Lists all the files on the directory by calling the function for every file found. More...
 
EAPI Eina_Bool EAPI Eina_Arrayeina_file_split (char *path) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC
 Splits a path according to the delimiter of the filesystem. More...
 
EAPI Eina_Iteratoreina_file_ls (const char *dir) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC
 Gets an iterator to list the content of a directory. More...
 
EAPI Eina_Iteratoreina_file_stat_ls (const char *dir) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC
 Gets an iterator to list the content of a directory, with direct information. More...
 
EAPI int eina_file_statat (void *container, Eina_File_Direct_Info *info, Eina_Stat *buf) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1
 Uses information provided by Eina_Iterator of eina_file_stat_ls() or eina_file_direct_ls() to call stat in the most efficient way on your system. More...
 
EAPI int EAPI int eina_file_mkstemp (const char *templatename, Eina_Tmpstr **path) EINA_ARG_NONNULL(1)
 Generates and creates a uniquely named temporary file from a template name. More...
 
EAPI Eina_Bool eina_file_mkdtemp (const char *templatename, Eina_Tmpstr **path) EINA_ARG_NONNULL(1
 Generates and creates a uniquely named temporary directory from a template name. More...
 
EAPI Eina_Bool EAPI Eina_Iteratoreina_file_direct_ls (const char *dir) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC
 Gets an iterator to list the content of a directory, with direct information. More...
 
EAPI char * eina_file_path_sanitize (const char *path)
 Sanitizes the file path. More...
 
EAPI Eina_Bool eina_file_copy (const char *src, const char *dst, Eina_File_Copy_Flags flags, Eina_File_Copy_Progress cb, const void *cb_data) EINA_ARG_NONNULL(1
 Copies one file to another using the fastest possible way and report progress. More...
 
EAPI Eina_Bool EAPI Eina_Fileeina_file_open (const char *name, Eina_Bool shared) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC
 Gets a read-only handler to a file. More...
 
EAPI Eina_Fileeina_file_virtualize (const char *virtual_name, const void *data, unsigned long long length, Eina_Bool copy) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1)
 Creates a virtual file from a memory pointer. More...
 
EAPI Eina_Bool eina_file_virtual (Eina_File *file) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1)
 Tells if a file is a real file or only exist in memory. More...
 
EAPI Eina_Bool eina_file_refresh (Eina_File *file)
 Refreshes file information. More...
 
EAPI Eina_Fileeina_file_dup (const Eina_File *file)
 Duplicates a read-only handler of a previously open file. More...
 
EAPI void eina_file_close (Eina_File *file)
 Unrefs the file handler. More...
 
EAPI size_t eina_file_size_get (const Eina_File *file)
 Gets the file size at open time. More...
 
EAPI time_t eina_file_mtime_get (const Eina_File *file)
 Gets the last modification time of an open file. More...
 
EAPI const char * eina_file_filename_get (const Eina_File *file)
 Gets the filename of an open file. More...
 
EAPI Eina_Iteratoreina_file_xattr_get (Eina_File *file)
 Gets the extended attribute of an open file. More...
 
EAPI Eina_Iteratoreina_file_xattr_value_get (Eina_File *file)
 Gets the extended attribute of an open file. More...
 
EAPI void * eina_file_map_all (Eina_File *file, Eina_File_Populate rule)
 Maps all the files to a buffer. More...
 
EAPI void * eina_file_map_new (Eina_File *file, Eina_File_Populate rule, unsigned long int offset, unsigned long int length)
 Maps a part of the file. More...
 
EAPI void eina_file_map_free (Eina_File *file, void *map)
 Unrefs and unmaps memory if possible. More...
 
EAPI void eina_file_map_populate (Eina_File *file, Eina_File_Populate rule, const void *map, unsigned long int offset, unsigned long int length)
 Asks the OS to populate or otherwise pages of memory in file mapping. More...
 
EAPI Eina_Iteratoreina_file_map_lines (Eina_File *file)
 Maps line by line in the memory efficiently using an Eina_Iterator. More...
 
EAPI Eina_Bool eina_file_map_faulted (Eina_File *file, void *map)
 Tells whether there has been an IO error during the life of a mmaped file. More...
 
static size_t eina_file_path_join_len (char *dst, size_t size, const char *a, size_t a_len, const char *b, size_t b_len)
 Joins two paths of known length. More...
 
static size_t eina_file_path_join (char *dst, size_t size, const char *a, const char *b)
 Joins two paths of known length. More...
 
EAPI Eina_Bool eina_file_unlink (const char *pathname)
 Unlinks file. More...
 
EAPI Eina_Bool eina_file_close_on_exec (int fd, Eina_Bool on)
 Make sure a file descriptor will be closed on exec. More...
 
Eina_Bool eina_file_path_relative (const char *path)
 Determines if a path is relative or absolute. More...
 
Eina_Tmpstreina_file_current_directory_get (const char *path, size_t len)
 Gets the current directory and optionally appends a path to it. More...
 
char * eina_file_cleanup (Eina_Tmpstr *path)
 Cleans up Eina after a file is no longer needed. More...
 
void eina_file_clean_close (Eina_File *file)
 Closes and cleans up after an Eina file. More...
 
void eina_file_real_close (Eina_File *file)
 Closes a file from the OS perspective. More...
 
void eina_file_flush (Eina_File *file, unsigned long int length)
 Resets the internal housekeeping structures after a file has changed. More...
 
void eina_file_common_map_free (Eina_File *file, void *map, void(*free_func)(Eina_File_Map *map))
 Removes a mapped region from the file and frees the resources. More...
 
void * eina_file_virtual_map_all (Eina_File *file)
 Map the entire contents fo a virtual file to a buffer. More...
 
void * eina_file_virtual_map_new (Eina_File *file, unsigned long int offset, unsigned long int length)
 Map a part of a virtual file to a buffer. More...
 
void eina_file_virtual_map_free (Eina_File *file, void *map)
 Unref and unmap memory if possible. More...
 
unsigned int eina_file_map_key_length (const void *key)
 Get the length of a map key. More...
 
int eina_file_map_key_cmp (const unsigned long long int *key1, int key1_length, const unsigned long long int *key2, int key2_length)
 Compares two map keys. More...
 
int eina_file_map_key_hash (const unsigned long long int *key, int key_length)
 Creates a hash from a map key. More...
 

Variables

Eina_Hash_eina_file_cache
 A pointer to the global Eina file cache. More...
 
Eina_Lock _eina_file_lock_cache
 The global file lock cache.
 
int _eina_file_log_dom
 The global Eina log file domain. More...
 

Detailed Description

This group discusses the functions to handle files and directories.

Functions to handle files and directories.

These functions make it easier to do a number of file and directory operations such as getting the list of files in a directory, splitting paths, and finding out file size and type.

Warning
All functions in this group are blocking, which means they may take a long time to return, use them carefully.

See an example here.

This module performs internal housekeeping and utility tasks for Eina_File. It also provides the underlying data types for things like file handles, file maps and file iterators.

Macro Definition Documentation

◆ EINA_PATH_SEP_C

#define EINA_PATH_SEP_C   '/'

The constant defined the path separator as the character '\' on Windows and '/' otherwise.

Since
1.16

◆ EINA_PATH_SEP_S

#define EINA_PATH_SEP_S   "/"

The constant defined the path separator as the string "\" on Windows and "/" otherwise.

Since
1.16

◆ EINA_FILE_DIR_LIST_CB

#define EINA_FILE_DIR_LIST_CB (   function)    ((Eina_File_Dir_List_Cb)function)

The macro to cast to an Eina_File_Dir_List_Cb.

This macro casts function to Eina_File_Dir_List_Cb.

Parameters
functionThe function to cast

Typedef Documentation

◆ Eina_Stat

A type for _Eina_Stat.

Since
1.2

◆ Eina_File_Dir_List_Cb

Eina_File_Dir_List_Cb

Type for a callback to be called when iterating over the files of a directory.

Parameters
nameThe file name EXCLUDING the path
pathThe path passed to eina_file_dir_list()
dataThe data passed to eina_file_dir_list()

◆ Eina_File_Copy_Progress

Eina_File_Copy_Progress

Type for a callback to report file copy progress.

This function is used to report progress during eina_file_copy(), where done is the bytes already copied and size is the total file size.

Note
If it returns EINA_FALSE, it will stop the copy.

Enumeration Type Documentation

◆ Eina_File_Type

Type for enumeration of a file type.

This type is used in Eina_File_Direct_Info.

Enumerator
EINA_FILE_UNKNOWN 

Unknown file type.

EINA_FILE_FIFO 

Named pipe (FIFO) type (unused on Windows)

EINA_FILE_CHR 

Character device type (unused on Windows)

EINA_FILE_DIR 

Directory type.

EINA_FILE_BLK 

Block device type (unused on Windows)

EINA_FILE_REG 

Regular file type.

EINA_FILE_LNK 

Symbolic link type.

EINA_FILE_SOCK 

UNIX domain socket type (unused on Windows)

EINA_FILE_WHT 

Whiteout file type (unused on Windows)

◆ Eina_File_Populate

Type for enumeration of a file access type.

This type is used in Eina_File_Direct_Info.

Enumerator
EINA_FILE_RANDOM 

Advise random memory access to the mapped memory.

EINA_FILE_SEQUENTIAL 

Advise sequential memory access to the mapped memory.

EINA_FILE_WILLNEED 

Advise need for all the mapped memory.

EINA_FILE_POPULATE 

Request for all the mapped memory.

EINA_FILE_DONTNEED 

Indicate that the memory is no longer needed.

This may result in the memory being removed from any caches if applicable.

Since
1.8
EINA_FILE_REMOVE 

This memory is to be released and any content will be lost.

Subsequent accesses will succeed but return fresh memory as if accessed for the first time. This may not suceed if the filesystem does not support it.

Since
1.8

Function Documentation

◆ eina_file_dir_list()

EAPI Eina_Bool eina_file_dir_list ( const char *  dir,
Eina_Bool  recursive,
Eina_File_Dir_List_Cb  cb,
void *  data 
)

Lists all the files on the directory by calling the function for every file found.

This function calls cb for each file that is in dir. To have cb called on the files that are in subdirectories of dir, recursive should be EINA_TRUE. In other words, if recursive is EINA_FALSE, only direct children of dir are operated on, if recursive is EINA_TRUE the entire tree of files that is below dir is operated on.

If cb or dir is NULL or if dir is a string of size 0, or if dir cannot be opened, this function returns EINA_FALSE immediately. Otherwise, it returns EINA_TRUE.

Parameters
[in]dirThe directory name
[in]recursiveIterate recursively in the directory
[in]cbThe callback to be called
[in]dataThe data to pass to the callback
Returns
EINA_TRUE on success, otherwise EINA_FALSE
Examples:
eina_file_01.c.

◆ eina_file_split()

EAPI Eina_Bool EAPI Eina_Array* eina_file_split ( char *  path)

Splits a path according to the delimiter of the filesystem.

This function splits path according to the delimiter of the used filesystem. If path is NULL or if the array cannot be created, NULL is returned, otherwise an array with each part of path is returned.

Parameters
[in]pathThe path to split
Returns
An array of the parts of the path to split

◆ eina_file_ls()

EAPI Eina_Iterator* eina_file_ls ( const char *  dir)

Gets an iterator to list the content of a directory.

This returns an iterator for shared strings, the name of each file in dir is only fetched when advancing the iterator, which means there is very little cost associated with creating the list and stopping halfway through it.

Parameters
[in]dirThe name of the directory to list
Returns
An Eina_Iterator that walks over the files and directories in dir. On failure, it returns NULL.
Note
The iterator hands the user a stringshared value with the full path. The user must free the string using eina_stringshare_del() on it.
The container for the iterator is of type DIR*.
The iterator walks over '.' and '..' without returning them.
See also
eina_file_direct_ls()

◆ eina_file_stat_ls()

EAPI Eina_Iterator* eina_file_stat_ls ( const char *  dir)

Gets an iterator to list the content of a directory, with direct information.

This returns an iterator for Eina_File_Direct_Info, the name of each file in dir is only fetched when advancing the iterator, which means there is cost associated with creating the list and stopping halfway through it.

Parameters
[in]dirThe name of the directory to list
Returns
An Eina_Iterator that walks over the files and directories in dir. On failure, it returns NULL.
Warning
The Eina_File_Direct_Info returned by the iterator must not be modified in any way.
When the iterator is advanced or deleted the Eina_File_Direct_Info returned is no longer valid.
Note
The container for the iterator is of type DIR*.
The iterator walks over '.' and '..' without returning them.
The difference between this function and eina_file_direct_ls() is that it guarantees the file type information to be correct by incurring a possible performance penalty.
See also
eina_file_direct_ls()

References eina_file_direct_ls().

◆ eina_file_statat()

EAPI int eina_file_statat ( void *  container,
Eina_File_Direct_Info info,
Eina_Stat buf 
)

Uses information provided by Eina_Iterator of eina_file_stat_ls() or eina_file_direct_ls() to call stat in the most efficient way on your system.

This function calls fstatat or stat depending on what your system supports. This makes it efficient and simple to use on your side without complex detection already done inside Eina on what the system can do.

Parameters
[in]containerThe container returned by Eina_Iterator using eina_iterator_container_get()
[in]infoThe content of the current Eina_File_Direct_Info provided by Eina_Iterator
[in]bufThe location put the result of the stat
Returns
0 is returned on success, otherwise -1 is returned on error and errno is set appropriately
See also
eina_file_direct_ls()
eina_file_stat_ls()
Since
1.2

◆ eina_file_mkstemp()

EAPI int EAPI int eina_file_mkstemp ( const char *  templatename,
Eina_Tmpstr **  path 
)

Generates and creates a uniquely named temporary file from a template name.

The generated file is opened with the open(2) O_EXCL flag.

This function calls mkstemp(), generates a unique temporary filename from template, creates and opens the file, and returns an open file descriptor for the file.

Parameters
[in]templatenameThis is a string. It must contain the six characters 'XXXXXX' at the end or directly followed by an extension as in 'prefixXXXXXX.ext'.
[out]pathThe path to the created temporary file, or NULL in case of failure. It must be released by eina_tmpstr_del().
Returns
On success file descriptor of the temporary file is returned, On error -1 is returned, in which case errno is set appropriately.
Note
If a filename extension was specified in templatename, then the new path will also contain this extension (since 1.10).
If the templatename is a simple file name (no relative or absolute path to another directory), then a temporary file will be created inside the system temporary directory (
See also
eina_environment_tmp_get()). If the templatename contains a directory separator ('/', or '\' on Windows) then the file will be created inside this directory, which must exist and be writeable. Use ./filename.XXXXXX to create files in the current working directory. (since 1.17)
eina_file_mkdtemp()
Since
1.8

◆ eina_file_mkdtemp()

EAPI Eina_Bool eina_file_mkdtemp ( const char *  templatename,
Eina_Tmpstr **  path 
)

Generates and creates a uniquely named temporary directory from a template name.

This function calls mkdtemp(). The directory is then created with permissions 0700.

Parameters
[in]templatenameThis is a string. The last six characters of templatename must be XXXXXX.
[out]pathThe path to the created temporary directory, or NULL in case of failure. It must be released by eina_tmpstr_del().
Returns
On success EINA_TRUE is returned, On error EINA_FALSE is returned, in which case errno is set appropriately.
Note
If the templatename is a simple directory name (no relative or absolute path to another directory), then a temporary directory will be created inside the system temporary directory (
See also
eina_environment_tmp_get()). If the templatename contains a directory separator ('/', or '\' on Windows) then the temporary directory will be created inside that other directory, which must exist and be writeable. (since 1.17)
eina_file_mkstemp()
Since
1.8

◆ eina_file_direct_ls()

EAPI Eina_Bool EAPI Eina_Iterator* eina_file_direct_ls ( const char *  dir)

Gets an iterator to list the content of a directory, with direct information.

This returns an iterator for Eina_File_Direct_Info, the name of each file in dir is only fetched when advancing the iterator, which means there is cost associated with creating the list and stopping halfway through it.

Parameters
[in]dirThe name of the directory to list
Returns
An Eina_Iterator that walks over the files and directories in dir. On failure, it returns NULL.
Warning
If readdir_r doesn't contain file type information, file type is EINA_FILE_UNKNOWN.
The Eina_File_Direct_Info returned by the iterator must not be modified in any way.
When the iterator is advanced or deleted the Eina_File_Direct_Info returned is no longer valid.
Note
The container for the iterator is of type DIR*.
The iterator walks over '.' and '..' without returning them.
The difference between this function and eina_file_stat_ls() is that it may not get the file type information however it is likely to be faster.
See also
eina_file_ls()

Referenced by ecore_file_dir_is_empty(), ecore_file_ls(), edje_available_modules_get(), and eina_file_stat_ls().

◆ eina_file_path_sanitize()

EAPI char* eina_file_path_sanitize ( const char *  path)

Sanitizes the file path.

This function takes care of adding the current working directory if its a relative path and also removes all '..' and '//' references in the original path.

Parameters
[in]pathThe path to sanitize
Returns
An allocated string with the sanitized path
Since
1.1

References eina_file_current_directory_get(), eina_file_path_relative(), eina_tmpstr_del(), and eina_tmpstr_len().

Referenced by efreet_icon_deprecated_user_dir_get(), efreet_icon_user_dir_get(), and eina_file_unlink().

◆ eina_file_copy()

EAPI Eina_Bool eina_file_copy ( const char *  src,
const char *  dst,
Eina_File_Copy_Flags  flags,
Eina_File_Copy_Progress  cb,
const void *  cb_data 
)

Copies one file to another using the fastest possible way and report progress.

This function tries to splice if it is available. It is blocked until the whole file is copied or it fails.

Parameters
[in]srcThe source file.
[in]dstThe destination file.
[in]flagsControls what is copied (data is always copied).
[in]cbIf it is provided will be called with file copy progress information.
[in]cb_dataContext data to provide to cb during copy.
Returns
EINA_TRUE on success, EINA_FALSE otherwise (and dst will be deleted)
Note
During the progress it may call back cb with the progress summary.

◆ eina_file_open()

EAPI Eina_Bool EAPI Eina_File* eina_file_open ( const char *  name,
Eina_Bool  shared 
)

Gets a read-only handler to a file.

This opens a file in the read-only mode. name should be an absolute path. An Eina_File handle can be shared among multiple instances if shared is EINA_TRUE, otherwise.

Parameters
[in]nameThe filename to open
[in]sharedRequested a shm
Returns
An Eina_File handle to the file
Since
1.1

Referenced by edje_file_collection_list(), edje_file_data_get(), edje_file_group_exists(), eet_identity_open(), and eet_open().

◆ eina_file_virtualize()

EAPI Eina_File* eina_file_virtualize ( const char *  virtual_name,
const void *  data,
unsigned long long  length,
Eina_Bool  copy 
)

Creates a virtual file from a memory pointer.

Parameters
[in]virtual_nameA virtual name for Eina_File, if NULL, a generated one will be given
[in]dataThe memory pointer to take data from
[in]lengthThe length of the data in memory
[in]copyEINA_TRUE if the data must be copied
Returns
Eina_File handle to the file
Since
1.8

Referenced by eina_file_dup().

◆ eina_file_virtual()

EAPI Eina_Bool eina_file_virtual ( Eina_File file)

Tells if a file is a real file or only exist in memory.

Parameters
fileThe file to test
Returns
EINA_TRUE if the file is a virtual file
Since
1.8

References EINA_FALSE.

◆ eina_file_refresh()

EAPI Eina_Bool eina_file_refresh ( Eina_File file)

Refreshes file information.

All current map continue to exist. You need to manually delete and recreate them to have the new correct mapping.

Parameters
fileThe file to refresh
Returns
EINA_TRUE if the file has changed
Since
1.8

References EINA_FALSE.

◆ eina_file_dup()

EAPI Eina_File* eina_file_dup ( const Eina_File file)

Duplicates a read-only handler of a previously open file.

Parameters
fileTo duplicate a reference to
Returns
Eina_File handle of the duplicated file
Note
Opens a file in read-only mode.
Since
1.8

References eina_file_virtualize(), eina_lock_release(), eina_lock_take(), EINA_TRUE, _Eina_File::filename, _Eina_File::global_map, _Eina_File::length, _Eina_File::lock, and _Eina_File::refcount.

Referenced by eet_mmap(), elm_theme_extension_mmap_add(), and elm_theme_overlay_mmap_add().

◆ eina_file_close()

EAPI void eina_file_close ( Eina_File file)

◆ eina_file_size_get()

EAPI size_t eina_file_size_get ( const Eina_File file)

Gets the file size at open time.

Parameters
[in]fileThe file handler to request the size from
Returns
The length of the file
Since
1.1

References _Eina_File::length.

Referenced by eet_identity_open(), eet_mmap(), eet_open(), and elua_io_loadfile().

◆ eina_file_mtime_get()

EAPI time_t eina_file_mtime_get ( const Eina_File file)

Gets the last modification time of an open file.

Parameters
[in]fileThe file handler to request the modification time from
Returns
The last modification time
Since
1.1

References _Eina_File::mtime.

◆ eina_file_filename_get()

EAPI const char* eina_file_filename_get ( const Eina_File file)

◆ eina_file_xattr_get()

EAPI Eina_Iterator* eina_file_xattr_get ( Eina_File file)

Gets the extended attribute of an open file.

Parameters
[in]fileThe file handler to request the extended attribute from
Returns
An iterator
Note
The iterator lists all the extended attribute names without allocating them, so you need to copy them yourself if needed.
Since
1.2

◆ eina_file_xattr_value_get()

EAPI Eina_Iterator* eina_file_xattr_value_get ( Eina_File file)

Gets the extended attribute of an open file.

Parameters
[in]fileThe file handler to request the extended attribute from
Returns
An iterator
Note
The iterator lists all the extended attribute names without allocating them, so you need to copy them yourself if needed. It returns the Eina_Xattr structure.
Since
1.2

◆ eina_file_map_all()

EAPI void* eina_file_map_all ( Eina_File file,
Eina_File_Populate  rule 
)

Maps all the files to a buffer.

Parameters
[in]fileThe file handler to map in the memory
[in]ruleThe rule to apply to the mapped memory
Returns
A pointer to a buffer that maps all the file content
NULL if it fails
Since
1.1

Referenced by eet_identity_open(), eet_mmap(), eet_open(), eina_file_map_lines(), and elua_io_loadfile().

◆ eina_file_map_new()

EAPI void* eina_file_map_new ( Eina_File file,
Eina_File_Populate  rule,
unsigned long int  offset,
unsigned long int  length 
)

Maps a part of the file.

Parameters
[in]fileThe file handler to map in the memory
[in]ruleThe rule to apply to the mapped memory
[in]offsetThe offset inside the file
[in]lengthThe length of the memory to map
Returns
A valid pointer to the system memory with length valid bytes in it
And NULL if not inside the file or anything else goes wrong.
Note
This does handle reference counting so it can share the same memory area.
Since
1.1

◆ eina_file_map_free()

EAPI void eina_file_map_free ( Eina_File file,
void *  map 
)

Unrefs and unmaps memory if possible.

Parameters
[in]fileThe file handler to unmap memory from
[in]mapThe memory map to unref and unmap
Since
1.1

Referenced by eet_clearcache(), eet_identity_open(), eina_file_filename_get(), and elua_io_loadfile().

◆ eina_file_map_populate()

EAPI void eina_file_map_populate ( Eina_File file,
Eina_File_Populate  rule,
const void *  map,
unsigned long int  offset,
unsigned long int  length 
)

Asks the OS to populate or otherwise pages of memory in file mapping.

This advises the operating system as to what to do with the memory mapped to the given file. This affects a specific range of memory and may not be honoured if the system chooses to ignore the request.

Parameters
[in]fileThe file handle from which the map comes
[in]ruleThe rule to apply to the mapped memory
[in]mapMemory that was mapped inside of which the memory range is
[in]offsetThe offset in bytes from the start of the map address
[in]

Referenced by eet_clearcache().

◆ eina_file_map_lines()

EAPI Eina_Iterator* eina_file_map_lines ( Eina_File file)

Maps line by line in the memory efficiently using an Eina_Iterator.

This function returns an iterator that acts like fgets without useless memcpy. Be aware that once eina_iterator_next has been called, nothing can guarantee that the memory is still going to be mapped.

Parameters
[in]fileThe file to run over
Returns
An Eina_Iterator that produces Eina_File_Line
Since
1.3

References _Eina_Lines_Iterator::boundary, _Eina_Lines_Iterator::current, EINA_FALSE, eina_file_map_all(), EINA_FILE_SEQUENTIAL, eina_lock_release(), eina_lock_take(), EINA_MAGIC_SET, EINA_TRUE, _Eina_Lines_Iterator::end, _Eina_File_Line::end, ERR, _Eina_Lines_Iterator::fp, _Eina_Iterator::free, FUNC_ITERATOR_FREE, FUNC_ITERATOR_GET_CONTAINER, FUNC_ITERATOR_NEXT, _Eina_Iterator::get_container, _Eina_File_Line::index, INF, _Eina_Lines_Iterator::iterator, _Eina_File::length, _Eina_File_Line::length, _Eina_File::lock, _Eina_Lines_Iterator::map, _Eina_Iterator::next, pipe, _Eina_File::refcount, _Eina_File_Line::start, and _Eina_Iterator::version.

◆ eina_file_map_faulted()

EAPI Eina_Bool eina_file_map_faulted ( Eina_File file,
void *  map 
)

Tells whether there has been an IO error during the life of a mmaped file.

Parameters
[in]fileThe file handler to the mmaped file
[in]mapThe memory map to check if an error occurred on it
Returns
EINA_TRUE if there has been an IO error, otherwise EINA_FALSE
Since
1.2

References EINA_FALSE.

◆ eina_file_path_join_len()

static size_t eina_file_path_join_len ( char *  dst,
size_t  size,
const char *  a,
size_t  a_len,
const char *  b,
size_t  b_len 
)
inlinestatic

Joins two paths of known length.

This function is similar to eina_str_join_len(), but the separator is '\' on Windows and '/' otherwise.

Parameters
dstThe buffer to store the result.
sizeSize (in byte) of the buffer.
aFirst path to use.
a_lenlength of a.
bSecond path to use.
b_lenlength of b.
Returns
The number of characters printed.
See also
eina_str_join_len()
eina_file_path_join()
Since
1.16

◆ eina_file_path_join()

static size_t eina_file_path_join ( char *  dst,
size_t  size,
const char *  a,
const char *  b 
)
inlinestatic

Joins two paths of known length.

This function is similar to eina_file_path_join_len(), but will compute the length of a and b using strlen(). The path separator is '\' on Windows and '/' otherwise.

Parameters
dstThe buffer to store the result.
sizeSize (in byte) of the buffer.
aFirst string to use.
bSecond string to use.
Returns
The number of characters printed.
See also
eina_file_path_join_len()
Since
1.16

◆ eina_file_unlink()

EAPI Eina_Bool eina_file_unlink ( const char *  pathname)

Unlinks file.

This function is a wrapper around the unlink() system call. It removes a link to a file.

Parameters
pathnameFile name to unlink.
Returns
EINA_TRUE if the unlink was successfull, EINA_FALSE otherwise..
Since
1.19

References _eina_file_cache, EINA_FALSE, eina_file_path_sanitize(), eina_hash_find(), and EINA_TRUE.

◆ eina_file_close_on_exec()

EAPI Eina_Bool eina_file_close_on_exec ( int  fd,
Eina_Bool  on 
)

Make sure a file descriptor will be closed on exec.

This function is a wrapper around the fnctl() system call. It makes sure that the fd will be closed whenever exec is called.

Parameters
fdFile descriptor to enforce close on exec on.
onEINA_TRUE will turn close on exec on, EINA_FALSE will turn it off.
Returns
EINA_TRUE if it will be closed on exec, EINA_FALSE otherwise..
Since
1.20
Examples:
ecore_fd_handler_gnutls_example.c.

References EINA_FALSE, EINA_TRUE, ERR, and fcntl().

Referenced by ecore_pipe_full_add(), and eina_mmap_safety_enabled_set().

◆ eina_file_path_relative()

Eina_Bool eina_file_path_relative ( const char *  path)

Determines if a path is relative or absolute.

The implementation simply chekcs if the fist char in the path is '/'. If it is not, the path is considered relative.

Parameters
pathThe path to check.
Returns
EINA_TRUE if the path is relative, EINA_FALSE otherwise.

References EINA_FALSE, EINA_TRUE, and evil_path_is_absolute().

Referenced by eina_file_path_sanitize().

◆ eina_file_current_directory_get()

Eina_Tmpstr* eina_file_current_directory_get ( const char *  path,
size_t  len 
)

Gets the current directory and optionally appends a path to it.

If a string was passed in via the path parameter, it will be appended to the current working directory. Presumably, this will be a relative path.

Parameters
pathThe path to append to the current directory.
lenThe length of path.
Returns
A pointer to a string that contains the absolute path to the current working directory plus any path you send in.

References alloca(), and eina_tmpstr_add_length().

Referenced by eina_file_path_sanitize().

◆ eina_file_cleanup()

char* eina_file_cleanup ( Eina_Tmpstr path)

Cleans up Eina after a file is no longer needed.

Parameters
pathThe path of the file.
Returns
On success, it will return the path string. If path is NULL, it will return and empty string.

References eina_tmpstr_del().

◆ eina_file_clean_close()

void eina_file_clean_close ( Eina_File file)

Closes and cleans up after an Eina file.

Parameters
fileThe path of the file.

References eina_file_real_close(), eina_hash_free(), EINA_MAGIC_SET, _Eina_File::map, and _Eina_File::rmap.

Referenced by eina_file_close().

◆ eina_file_real_close()

void eina_file_real_close ( Eina_File file)

Closes a file from the OS perspective.

Parameters
fileThe path of the file.

Referenced by eina_file_clean_close().

◆ eina_file_flush()

void eina_file_flush ( Eina_File file,
unsigned long int  length 
)

Resets the internal housekeeping structures after a file has changed.

Despite the name, this routine does not write anything to disk. It invalidates the memory maps for the file. If the file has shrunk, it also adds any mapped regions past the end of the file to the dead_map.

Parameters
fileThe file.
lengthThe current length of the file after the change.

References _Eina_File::dead_map, eina_hash_del(), eina_hash_iterator_data_new(), EINA_ITERATOR_FOREACH, eina_iterator_free(), eina_list_append(), EINA_LIST_FOREACH, eina_list_merge(), eina_lock_release(), eina_lock_take(), _Eina_File::global_map, _Eina_File::global_refcount, _Eina_File::length, _Eina_File_Map::length, _Eina_File::lock, _Eina_File::map, _Eina_File_Map::map, _Eina_File_Map::offset, _Eina_File::refcount, _Eina_File_Map::refcount, and _Eina_File::rmap.

◆ eina_file_common_map_free()

void eina_file_common_map_free ( Eina_File file,
void *  map,
void(*)(Eina_File_Map *map)  free_func 
)

Removes a mapped region from the file and frees the resources.

This routine will remove a previously mapped region from the internal Eina File housekeeping and free the resources associated with it. In the case where the map is part of the dead_map, free_func will be called to handle the actual deallocation.

Parameters
fileThe file.
mapThe memory mapped region that is to be freed.
free_funcA pointer to a function that will be called to free up the resources used by the map.

References _Eina_File::dead_map, EINA_FALSE, eina_hash_del(), eina_hash_find(), EINA_LIST_FOREACH, eina_list_remove_list(), EINA_TRUE, _Eina_File_Map::length, _Eina_File::map, _Eina_File_Map::map, _Eina_File_Map::offset, _Eina_File_Map::refcount, and _Eina_File::rmap.

◆ eina_file_virtual_map_all()

void* eina_file_virtual_map_all ( Eina_File file)

Map the entire contents fo a virtual file to a buffer.

Parameters
fileThe virtual file to map in memory

References eina_lock_release(), eina_lock_take(), _Eina_File::global_map, _Eina_File::global_refcount, and _Eina_File::lock.

◆ eina_file_virtual_map_new()

void* eina_file_virtual_map_new ( Eina_File file,
unsigned long int  offset,
unsigned long int  length 
)

Map a part of a virtual file to a buffer.

Parameters
fileThe virtual file to map in memory
offsetThe offset inside the file to start mapping
lengthThe length of the region to map

References eina_hash_add(), eina_hash_direct_add(), eina_hash_find(), eina_lock_release(), eina_lock_take(), _Eina_File::global_map, _Eina_File_Map::length, _Eina_File::lock, _Eina_File::map, _Eina_File_Map::map, _Eina_File_Map::offset, _Eina_File_Map::refcount, and _Eina_File::rmap.

◆ eina_file_virtual_map_free()

void eina_file_virtual_map_free ( Eina_File file,
void *  map 
)

Unref and unmap memory if possible.

Parameters
fileThe file handler to unmap memory from.
mapMemory map to unref and unmap.

References eina_hash_del(), eina_hash_find(), eina_lock_release(), eina_lock_take(), _Eina_File::global_map, _Eina_File::global_refcount, _Eina_File_Map::length, _Eina_File::lock, _Eina_File::map, _Eina_File_Map::offset, _Eina_File_Map::refcount, and _Eina_File::rmap.

◆ eina_file_map_key_length()

unsigned int eina_file_map_key_length ( const void *  key)

Get the length of a map key.

Warning
This function is not yet implemented. At present it ony returns
sizeof (unsigned long int) * 2
Parameters
keyThe key for which length will be calcualted.
Returns
The length of the key.

◆ eina_file_map_key_cmp()

int eina_file_map_key_cmp ( const unsigned long long int *  key1,
int  key1_length,
const unsigned long long int *  key2,
int  key2_length 
)

Compares two map keys.

The implementation assumes that key1 and key2 are both pointers to an array with 2 elements, as is the case with the Eina file map keys.

Parameters
key1The first key.
key1_lengthThe length of the first key.
key2The second key.
key2_lengthThe length of the second key.
Returns
Positive number if Key1 > Key2, else a negative number. Will return zero if both elements of the key are exactly the same.

◆ eina_file_map_key_hash()

int eina_file_map_key_hash ( const unsigned long long int *  key,
int  key_length 
)

Creates a hash from a map key.

Parameters
keyA pointer to the key.
key_lengthThe length of the key.
Returns
A key hash.

References eina_hash_int64().

Variable Documentation

◆ _eina_file_cache

Eina_Hash* _eina_file_cache

A pointer to the global Eina file cache.

Referenced by eina_file_close(), and eina_file_unlink().

◆ _eina_file_log_dom

int _eina_file_log_dom

The global Eina log file domain.