Tizen Native API
3.0
|
Functions | |
int | ecore_file_init (void) |
Initializes the Ecore_File library. | |
int | ecore_file_shutdown (void) |
Shuts down the Ecore_File library. | |
long long | ecore_file_mod_time (const char *file) |
Gets the time of the last modification to the given file. | |
long long | ecore_file_size (const char *file) |
Gets the size of the given file. | |
Eina_Bool | ecore_file_exists (const char *file) |
Checks if the given file exists. | |
Eina_Bool | ecore_file_is_dir (const char *file) |
Checks if the given file is a directory. | |
Eina_Bool | ecore_file_mkdir (const char *dir) |
Creates a new directory. | |
int | ecore_file_mkdirs (const char **dirs) |
Creates complete directory in a batch. | |
int | ecore_file_mksubdirs (const char *base, const char **subdirs) |
Creates complete list of sub-directories in a batch (optimized). | |
Eina_Bool | ecore_file_rmdir (const char *dir) |
Deletes the given empty directory. | |
Eina_Bool | ecore_file_recursive_rm (const char *dir) |
Deletes the given directory and all its contents. | |
Eina_Bool | ecore_file_mkpath (const char *path) |
Creates a complete path. | |
int | ecore_file_mkpaths (const char **paths) |
Creates complete paths in a batch. | |
Eina_Bool | ecore_file_cp (const char *src, const char *dst) |
Copies the given file to the given destination. | |
Eina_Bool | ecore_file_mv (const char *src, const char *dst) |
Moves the given file to the given destination. | |
Eina_Bool | ecore_file_symlink (const char *src, const char *dest) |
Creates a symbolic link. | |
char * | ecore_file_realpath (const char *file) |
Gets the canonicalized absolute path name. | |
Eina_Bool | ecore_file_unlink (const char *file) |
Deletes the given file. | |
Eina_Bool | ecore_file_remove (const char *file) |
Removes the given file or directory. | |
const char * | ecore_file_file_get (const char *path) |
Gets the filename from a given path. | |
char * | ecore_file_dir_get (const char *path) |
Gets the directory where the given file resides. | |
Eina_Bool | ecore_file_can_read (const char *file) |
Checks if the given file can be read. | |
Eina_Bool | ecore_file_can_write (const char *file) |
Checks if the given file can be written. | |
Eina_Bool | ecore_file_can_exec (const char *file) |
Checks if the given file can be executed. | |
char * | ecore_file_readlink (const char *link) |
Gets the path pointed by the given link. | |
Eina_List * | ecore_file_ls (const char *dir) |
Gets the list of the files and directories in the given directory. | |
char * | ecore_file_app_exe_get (const char *app) |
Returns the executable from the given command. | |
char * | ecore_file_escape_name (const char *filename) |
Adds the escape sequence ('\') to the given file name. | |
char * | ecore_file_strip_ext (const char *file) |
Removes the extension from the given file name. | |
int | ecore_file_dir_is_empty (const char *dir) |
Checks if the given directory is empty. | |
Ecore_File_Monitor * | ecore_file_monitor_add (const char *path, Ecore_File_Monitor_Cb func, void *data) |
Monitors the given path using inotify, Windows notification, or polling. | |
void | ecore_file_monitor_del (Ecore_File_Monitor *ecore_file_monitor) |
Stops the monitoring of the given path. | |
const char * | ecore_file_monitor_path_get (Ecore_File_Monitor *ecore_file_monitor) |
Gets the monitored path. | |
Eina_Bool | ecore_file_download (const char *url, const char *dst, Ecore_File_Download_Completion_Cb completion_cb, Ecore_File_Download_Progress_Cb progress_cb, void *data, Ecore_File_Download_Job **job_ret) |
Downloads the given url to the given destination. | |
Eina_Bool | ecore_file_download_full (const char *url, const char *dst, Ecore_File_Download_Completion_Cb completion_cb, Ecore_File_Download_Progress_Cb progress_cb, void *data, Ecore_File_Download_Job **job_ret, Eina_Hash *headers) |
Downloads the given url to the given destination with additional headers. | |
void | ecore_file_download_abort_all (void) |
Aborts all downloads. | |
void | ecore_file_download_abort (Ecore_File_Download_Job *job) |
Aborts the given download job and call the completion_cb callbck with a status of 1 (error). | |
Eina_Bool | ecore_file_download_protocol_available (const char *protocol) |
Checks if the given protocol is available. | |
Typedefs | |
typedef struct _Ecore_File_Monitor | Ecore_File_Monitor |
typedef struct _Ecore_File_Download_Job | Ecore_File_Download_Job |
typedef void(* | Ecore_File_Monitor_Cb )(void *data, Ecore_File_Monitor *em, Ecore_File_Event event, const char *path) |
typedef void(* | Ecore_File_Download_Completion_Cb )(void *data, const char *file, int status) |
typedef int(* | Ecore_File_Download_Progress_Cb )(void *data, const char *file, long int dltotal, long int dlnow, long int ultotal, long int ulnow) |
Typedef Documentation
Callback type used when a download is finished.
Abstract type used when aborting a download.
Callback type used while a download is in progress.
Abstract type used when monitoring a directory.
Callback type used when a monitored directory has changes.
Enumeration Type Documentation
enum _Ecore_File_Event |
The event type returned when a file or directory is monitored.
- Enumerator:
Function Documentation
char* ecore_file_app_exe_get | ( | const char * | app | ) |
Returns the executable from the given command.
- Parameters:
-
app The application command, with parameters.
- Returns:
- The executable from
app
as a newly allocated string. Arguments are removed and escape characters are handled. Ifapp
isNULL
, or on failure, the function returnsNULL
. When not needed anymore, the returned value must be freed.
- Since :
- 3.0
Eina_Bool ecore_file_can_exec | ( | const char * | file | ) |
Checks if the given file can be executed.
- Parameters:
-
file The name of the file.
- Returns:
EINA_TRUE
if thefile
can be executed,EINA_FALSE
otherwise.
This function returns EINA_TRUE
if file
can be executed, EINA_FALSE
otherwise.
- Since :
- 3.0
Eina_Bool ecore_file_can_read | ( | const char * | file | ) |
Checks if the given file can be read.
- Parameters:
-
file The name of the file.
- Returns:
EINA_TRUE
if thefile
is readable,EINA_FALSE
otherwise.
This function returns EINA_TRUE
if file
can be read, EINA_FALSE
otherwise.
- Since :
- 3.0
Eina_Bool ecore_file_can_write | ( | const char * | file | ) |
Checks if the given file can be written.
- Parameters:
-
file The name of the file.
- Returns:
EINA_TRUE
if thefile
is writable,EINA_FALSE
otherwise.
This function returns EINA_TRUE
if file
can be written, EINA_FALSE
otherwise.
- Since :
- 3.0
Eina_Bool ecore_file_cp | ( | const char * | src, |
const char * | dst | ||
) |
Copies the given file to the given destination.
- Parameters:
-
src The name of the source file. dst The name of the destination file.
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise.
This function copies src
to dst
. If the absolute path name of src
and dst
can not be computed, or if they are equal, or if the copy fails, the function returns EINA_FALSE
, otherwise it returns EINA_TRUE
.
- Since :
- 3.0
char* ecore_file_dir_get | ( | const char * | path | ) |
Gets the directory where the given file resides.
- Parameters:
-
file The name of the file.
- Returns:
- The directory name.
This function returns the directory where file
resides as anewly allocated string. If file
is NULL
or on error, this function returns NULL
. When not needed anymore, the returned value must be freed.
- Since :
- 3.0
int ecore_file_dir_is_empty | ( | const char * | dir | ) |
Checks if the given directory is empty.
- Parameters:
-
dir The name of the directory to check.
- Returns:
1
if directory is empty,0
if it has at least one file, or-1
in case of errors.
This functions checks if dir
is empty. The '.' and '..' files will be ignored. If dir
is empty, 1 is returned, if it contains at least one file, 0
is returned. On failure, -1
is returned.
- Since :
- 3.0
Eina_Bool ecore_file_download | ( | const char * | url, |
const char * | dst, | ||
Ecore_File_Download_Completion_Cb | completion_cb, | ||
Ecore_File_Download_Progress_Cb | progress_cb, | ||
void * | data, | ||
Ecore_File_Download_Job ** | job_ret | ||
) |
Downloads the given url to the given destination.
- Parameters:
-
url The complete url to download. dst The local file to save the downloaded to. completion_cb A callback called on download complete. progress_cb A callback called during the download operation. data User data passed to both callbacks. job_ret Job used to abort the download.
- Returns:
EINA_TRUE
if the download start orEINA_FALSE
on failure.
This function starts the download of the URL url
and saves it to dst
. url
must provide the protocol, including 'http://', 'ftp://' or 'file://'. Ecore_File must be compiled with CURL to download using http and ftp protocols. If dst
is ill-formed, or if it already exists, the function returns EINA_FALSE
. When the download is complete, the callback completion_cb
is called and data
is passed to it. The status
parameter of completion_cb
will be filled with the status of the download (200, 404,...). The progress_cb
is called during the download operation, each time a packet is received or when CURL wants. It can be used to display the percentage of the downloaded file. Return 0 from this callback, if provided, to continue the operation or anything else to abort the download. The only operations that can be aborted are those with protocol 'http' or 'ftp'. In that case job_ret
can be passed to ecore_file_download_abort() to abort that download job. Similarly ecore_file_download_abort_all() can be used to abort all download operations. This function returns EINA_TRUE
if the download starts, EINA_FALSE
otherwise.
- Since :
- 3.0
void ecore_file_download_abort | ( | Ecore_File_Download_Job * | job | ) |
Aborts the given download job and call the completion_cb callbck with a status of 1 (error).
- Parameters:
-
job The download job to abort.
This function aborts a download operation started by ecore_file_download(). job
is the Ecore_File_Download_Job structure filled by ecore_file_download(). If it is NULL
, this function does nothing. To abort all the currently downloading operations, call ecore_file_download_abort_all().
- Since :
- 3.0
void ecore_file_download_abort_all | ( | void | ) |
Aborts all downloads.
This function aborts all the downloads that have been started by ecore_file_download(). It loops over the started downloads and call ecore_file_download_abort() for each of them. To abort only one specific download operation, call ecore_file_download_abort().
- Since :
- 3.0
Eina_Bool ecore_file_download_full | ( | const char * | url, |
const char * | dst, | ||
Ecore_File_Download_Completion_Cb | completion_cb, | ||
Ecore_File_Download_Progress_Cb | progress_cb, | ||
void * | data, | ||
Ecore_File_Download_Job ** | job_ret, | ||
Eina_Hash * | headers | ||
) |
Downloads the given url to the given destination with additional headers.
- Parameters:
-
url The complete url to download. dst The local file to save the downloaded to. completion_cb A callback called on download complete. progress_cb A callback called during the download operation. data User data passed to both callbacks. job_ret Job used to abort the download. headers pointer of header lists.
- Returns:
EINA_TRUE
if the download start orEINA_FALSE
on failure.
- Since :
- 3.0
Eina_Bool ecore_file_download_protocol_available | ( | const char * | protocol | ) |
Checks if the given protocol is available.
- Parameters:
-
protocol The protocol to check.
- Returns:
EINA_TRUE
if protocol is handled,EINA_FALSE
otherwise.
This function returns EINA_TRUE
if protocol
is supported, EINA_FALSE
otherwise. protocol
can be 'http://', 'ftp://' or 'file://'. Ecore_FILE must be compiled with CURL to handle http and ftp protocols.
- Since :
- 3.0
char* ecore_file_escape_name | ( | const char * | filename | ) |
Adds the escape sequence ('\') to the given file name.
- Parameters:
-
filename The file name.
- Returns:
- The file name with special characters escaped.
This function adds the escape sequence ('\') to the given file name and returns the result as a newly allocated string. If the length of the returned string is longer than PATH_MAX, or on failure, NULL
is returned. When not needed anymore, the returned value must be freed.
- Since :
- 3.0
Eina_Bool ecore_file_exists | ( | const char * | file | ) |
Checks if the given file exists.
- Parameters:
-
file The name of the file.
- Returns:
EINA_TRUE
if thefile
exists,EINA_FALSE
otherwise.
This function returns EINA_TRUE
if file
exists on local filesystem, EINA_FALSE
otherwise.
- Since :
- 3.0
const char* ecore_file_file_get | ( | const char * | path | ) |
Gets the filename from a given path.
- Parameters:
-
path The complete path.
- Returns:
- The file name.
This function returns the file name of path
. If path
is NULL
, the functions returns NULL
.
- Since :
- 3.0
int ecore_file_init | ( | void | ) |
Initializes the Ecore_File library.
- Returns:
1
or greater on success, otherwise0
on error.
This function sets up Ecore_File and the services it will use (monitoring, downloading, PATH related feature). It returns 0 on failure, otherwise it returns the number of times it has already been called.
When Ecore_File is not used anymore, call ecore_file_shutdown() to shut down the Ecore_File library.
- Since :
- 3.0
Eina_Bool ecore_file_is_dir | ( | const char * | file | ) |
Checks if the given file is a directory.
- Parameters:
-
file The name of the file.
- Returns:
EINA_TRUE
if the file exists and is a directory,EINA_FALSE
otherwise.
This function returns EINA_TRUE
if file
exists exists and is a directory on local filesystem, EINA_FALSE
otherwise.
- Since :
- 3.0
Eina_List* ecore_file_ls | ( | const char * | dir | ) |
Gets the list of the files and directories in the given directory.
- Parameters:
-
dir The name of the directory to list
- Returns:
- Return an Eina_List containing all the files in the directory; on failure it returns NULL.
This function returns a list of allocated strings of all the files and directories contained in dir
. The list will be sorted with strcoll as compare function. That means that you may want to set the current locale for the category LC_COLLATE with setlocale(). For more information see the manual pages of strcoll and setlocale. The list will not contain the directory entries for '.' and '..'. On failure, NULL
is returned. When not needed anymore, the list elements must be freed.
- Since :
- 3.0
Eina_Bool ecore_file_mkdir | ( | const char * | dir | ) |
Creates a new directory.
- Parameters:
-
dir The name of the directory to create
- Returns:
EINA_TRUE
on successful creation,EINA_FALSE
otherwise.
This function creates the directory dir
, with the mode S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH on UNIX (mode is unsued on Windows). On success, it returns EINA_TRUE
, EINA_FALSE
otherwise.
- Since :
- 3.0
int ecore_file_mkdirs | ( | const char ** | dirs | ) |
Creates complete directory in a batch.
- Parameters:
-
dirs The list of directories, null terminated.
- Returns:
- The number of successful directories created, -1 if dirs is
NULL
.
This function creates all the directories that are in the null terminated array dirs
. The function loops over the directories and call ecore_file_mkdir(). This function returns -1 if dirs
is NULL
, otherwise if returns the number of successfully created directories.
- Since :
- 3.0
Eina_Bool ecore_file_mkpath | ( | const char * | path | ) |
Creates a complete path.
- Parameters:
-
path The path to create
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise.
This function creates path
and all the subdirectories it contains. The separator is '/' or '\'. If path
exists, this function returns EINA_TRUE
immediately. It returns EINA_TRUE
on success, EINA_FALSE
otherwise.
- Since :
- 3.0
int ecore_file_mkpaths | ( | const char ** | paths | ) |
Creates complete paths in a batch.
- Parameters:
-
paths list of paths, null terminated.
- Returns:
- The number of successful paths created,
-1
if paths is NULL.
This function creates all the directories that are in the null terminated array paths
. The function loops over the directories and call ecore_file_mkpath(), hence on Windows, '\' must be replaced by '/' before calling that function. This function returns -1 if paths
is NULL
. Otherwise if returns the number of successfully created directories.
- Since :
- 3.0
int ecore_file_mksubdirs | ( | const char * | base, |
const char ** | subdirs | ||
) |
Creates complete list of sub-directories in a batch (optimized).
- Parameters:
-
base The base directory to act on. subdirs The list of directories, null terminated.
- Returns:
- The number of successful directories created,
-1
on failure.
This function creates all the directories that are in the null terminated array subdirs
in the base
directory. If base
does not exist, it will be created. The function loops over the directories and call ecore_file_mkdir(). The whole path of the directories must exist. So if base/a/b/c wants to be created, subdirs
must contain "a", "a/b" and "a/b/c", in that order. This function returns -1 if subdirs
or base
are NULL
, or if base
is empty ("\0"). It returns 0 is base
is not a directory or invalid, or if it can't be created. Otherwise if returns the number of successfully created directories.
- Since :
- 3.0
long long ecore_file_mod_time | ( | const char * | file | ) |
Gets the time of the last modification to the given file.
- Parameters:
-
file The name of the file.
- Returns:
- Return the time of the last data modification, or
0
on failure.
This function returns the time of the last modification of file
. On failure, it returns 0.
- Since :
- 3.0
Ecore_File_Monitor* ecore_file_monitor_add | ( | const char * | path, |
Ecore_File_Monitor_Cb | func, | ||
void * | data | ||
) |
Monitors the given path using inotify, Windows notification, or polling.
- Parameters:
-
path The path to monitor. func The function to call on changes. data The data passed to func.
- Returns:
- An Ecore_File_Monitor pointer or NULL on failure.
This function monitors path
. If path
is NULL
, or is an empty string, or none of the notify methods (Inotify, Windows notification or polling) is available, or if path
does not exist the function returns NULL
. Otherwise, it returns a newly allocated Ecore_File_Monitor object and the monitoring begins. When one of the Ecore_File_Event event is notified, func
is called and data
is passed to func.Call
ecore_file_monitor_del() to stop the monitoring.
- Since :
- 3.0
void ecore_file_monitor_del | ( | Ecore_File_Monitor * | ecore_file_monitor | ) |
Stops the monitoring of the given path.
- Parameters:
-
em The Ecore_File_Monitor to stop.
This function stops the the monitoring of the path that has been monitored by ecore_file_monitor_add(). em
must be the value returned by ecore_file_monitor_add(). If em
is NULL
, or none of the notify methods (Inotify, Windows notification or polling) is availablethis function does nothing.
- Since :
- 3.0
const char* ecore_file_monitor_path_get | ( | Ecore_File_Monitor * | ecore_file_monitor | ) |
Gets the monitored path.
- Parameters:
-
em The Ecore_File_Monitor to query.
- Returns:
- The path that is monitored by
em
.
This function returns the monitored path that has been monitored by ecore_file_monitor_add(). em
must be the value returned by ecore_file_monitor_add(). If em
is NULL
, the function returns NULL
.
- Since :
- 3.0
Eina_Bool ecore_file_mv | ( | const char * | src, |
const char * | dst | ||
) |
Moves the given file to the given destination.
- Parameters:
-
src The name of the source file. dst The name of the destination file.
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise.
This function moves src
to dst
. It returns EINA_TRUE
on success, EINA_FALSE
otherwise.
- Since :
- 3.0
char* ecore_file_readlink | ( | const char * | link | ) |
Gets the path pointed by the given link.
- Parameters:
-
lnk The name of the link.
- Returns:
- The path pointed by link or NULL.
This function returns the path pointed by link
as a newly allocated string. This function does not work on Windows. On failure, the function returns NULL
. When not needed anymore, the returned value must be freed.
- Since :
- 3.0
char* ecore_file_realpath | ( | const char * | file | ) |
Gets the canonicalized absolute path name.
- Parameters:
-
file The file path.
- Returns:
- The canonicalized absolute pathname or an empty string on failure.
This function returns the absolute path name of file
as a newly allocated string. If file
is NULL
, or on error, this function returns an empty string. Otherwise, it returns the absolute path name. When not needed anymore, the returned value must be freed.
- Since :
- 3.0
Eina_Bool ecore_file_recursive_rm | ( | const char * | dir | ) |
Deletes the given directory and all its contents.
- Parameters:
-
dir The name of the directory to delete.
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise.
This function delete dir
and all its contents. If dir
is a link only the link is removed. It returns EINA_TRUE
on success, EINA_FALSE
otherwise.
- Since :
- 3.0
Eina_Bool ecore_file_remove | ( | const char * | file | ) |
Removes the given file or directory.
- Parameters:
-
file The name of the file or directory to delete.
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise.
This function removes file
. It returns EINA_TRUE
on success, EINA_FALSE
otherwise.
- Since :
- 3.0
Eina_Bool ecore_file_rmdir | ( | const char * | dir | ) |
Deletes the given empty directory.
- Parameters:
-
dir The name of the directory to delete.
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise.
This function deletes dir
. It returns EINA_TRUE
on success, EINA_FALSE
otherwise.
- Since :
- 3.0
int ecore_file_shutdown | ( | void | ) |
Shuts down the Ecore_File library.
- Returns:
0
when the library is completely shut down,1
or greater otherwise.
This function shuts down the Ecore_File library. It returns 0 when it has been called the same number of times than ecore_file_init(). In that case it shuts down all the services it uses.
- Since :
- 3.0
long long ecore_file_size | ( | const char * | file | ) |
Gets the size of the given file.
- Parameters:
-
file The name of the file.
- Returns:
- Return the size of the file in bytes, or
0
on failure.
This function returns the size of file
in bytes. On failure, it returns 0.
- Since :
- 3.0
char* ecore_file_strip_ext | ( | const char * | file | ) |
Removes the extension from the given file name.
- Parameters:
-
path The name of the file.
- Returns:
- A newly allocated string with the extension stripped out, or
NULL
on errors.
This function removes the extension from path
and returns the result as a newly allocated string. If path
is NULL
, or on failure, the function returns NULL
. When not needed anymore, the returned value must be freed.
- Since :
- 3.0
Eina_Bool ecore_file_symlink | ( | const char * | src, |
const char * | dest | ||
) |
Creates a symbolic link.
- Parameters:
-
src The name of the file to link. dest The name of link.
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise.
This function create the symbolic link dest
of src
. This function does not work on Windows. It returns EINA_TRUE
on success, EINA_FALSE
otherwise.
- Since :
- 3.0
Eina_Bool ecore_file_unlink | ( | const char * | file | ) |
Deletes the given file.
- Parameters:
-
file The name of the file to delete.
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise.
This function deletes file
. It returns EINA_TRUE
on success, EINA_FALSE
otherwise.
- Since :
- 3.0