6 * - More events, move/rename of directory file
16 # ifdef EFL_ECORE_FILE_BUILD
18 # define EAPI __declspec(dllexport)
21 # endif /* ! DLL_EXPORT */
23 # define EAPI __declspec(dllimport)
24 # endif /* ! EFL_ECORE_FILE_BUILD */
28 # define EAPI __attribute__ ((visibility("default")))
39 * @brief Files utility functions
47 * @defgroup Ecore_File_Group Ecore_File - Files and directories convenience functions
53 * @typedef Ecore_File_Monitor
54 * Abstract type used when monitoring a directory.
56 typedef struct _Ecore_File_Monitor Ecore_File_Monitor;
59 * @typedef Ecore_File_Download_Job
60 * Abstract type used when aborting a download.
62 typedef struct _Ecore_File_Download_Job Ecore_File_Download_Job;
65 * @typedef _Ecore_File_Event
66 * The event type returned when a file or directory is monitored.
68 typedef enum _Ecore_File_Event
70 ECORE_FILE_EVENT_NONE, /**< No event. */
71 ECORE_FILE_EVENT_CREATED_FILE, /**< Created file event. */
72 ECORE_FILE_EVENT_CREATED_DIRECTORY, /**< Created directory event. */
73 ECORE_FILE_EVENT_DELETED_FILE, /**< Deleted file event. */
74 ECORE_FILE_EVENT_DELETED_DIRECTORY, /**< Deleted directory event. */
75 ECORE_FILE_EVENT_DELETED_SELF, /**< Deleted monitored directory event. */
76 ECORE_FILE_EVENT_MODIFIED, /**< Modified file or directory event. */
77 ECORE_FILE_EVENT_CLOSED /**< Closed file event */
81 * @typedef Ecore_File_Monitor_Cb
82 * Callback type used when a monitored directory has changes.
84 typedef void (*Ecore_File_Monitor_Cb)(void *data, Ecore_File_Monitor *em, Ecore_File_Event event, const char *path);
87 * @typedef Ecore_File_Download_Completion_Cb
88 * Callback type used when a download is finished.
90 typedef void (*Ecore_File_Download_Completion_Cb)(void *data, const char *file, int status);
93 * @typedef _Ecore_File_Progress_Return
94 * What to do with the download as a return from the
95 * Ecore_File_Download_Progress_Cb function, if provided.
97 typedef enum _Ecore_File_Progress_Return
99 ECORE_FILE_PROGRESS_CONTINUE = 0, /**< Continue the download. */
100 ECORE_FILE_PROGRESS_ABORT = 1 /**< Abort the download. */
101 } Ecore_File_Progress_Return;
104 * @typedef Ecore_File_Download_Progress_Cb
105 * Callback type used while a download is in progress.
107 typedef int (*Ecore_File_Download_Progress_Cb)(void *data,
114 /* File operations */
116 EAPI int ecore_file_init (void);
117 EAPI int ecore_file_shutdown (void);
118 EAPI long long ecore_file_mod_time (const char *file);
119 EAPI long long ecore_file_size (const char *file);
120 EAPI Eina_Bool ecore_file_exists (const char *file);
121 EAPI Eina_Bool ecore_file_is_dir (const char *file);
122 EAPI Eina_Bool ecore_file_mkdir (const char *dir);
123 EAPI int ecore_file_mkdirs (const char **dirs);
124 EAPI int ecore_file_mksubdirs (const char *base, const char **subdirs);
125 EAPI Eina_Bool ecore_file_rmdir (const char *dir);
126 EAPI Eina_Bool ecore_file_recursive_rm (const char *dir);
127 EAPI Eina_Bool ecore_file_mkpath (const char *path);
128 EAPI int ecore_file_mkpaths (const char **paths);
129 EAPI Eina_Bool ecore_file_cp (const char *src, const char *dst);
130 EAPI Eina_Bool ecore_file_mv (const char *src, const char *dst);
131 EAPI Eina_Bool ecore_file_symlink (const char *src, const char *dest);
132 EAPI char *ecore_file_realpath (const char *file);
133 EAPI Eina_Bool ecore_file_unlink (const char *file);
134 EAPI Eina_Bool ecore_file_remove (const char *file);
135 EAPI const char *ecore_file_file_get (const char *path);
136 EAPI char *ecore_file_dir_get (const char *path);
137 EAPI Eina_Bool ecore_file_can_read (const char *file);
138 EAPI Eina_Bool ecore_file_can_write (const char *file);
139 EAPI Eina_Bool ecore_file_can_exec (const char *file);
140 EAPI char *ecore_file_readlink (const char *link);
141 EAPI Eina_List *ecore_file_ls (const char *dir);
142 EAPI Eina_Iterator *ecore_file_ls_iterator (const char *dir);
143 EAPI char *ecore_file_app_exe_get (const char *app);
144 EAPI char *ecore_file_escape_name (const char *filename);
145 EAPI char *ecore_file_strip_ext (const char *file);
146 EAPI int ecore_file_dir_is_empty (const char *dir);
150 EAPI Ecore_File_Monitor *ecore_file_monitor_add(const char *path,
151 Ecore_File_Monitor_Cb func,
153 EAPI void ecore_file_monitor_del(Ecore_File_Monitor *ecore_file_monitor);
154 EAPI const char *ecore_file_monitor_path_get(Ecore_File_Monitor *ecore_file_monitor);
158 EAPI Eina_Bool ecore_file_path_dir_exists(const char *in_dir);
159 EAPI Eina_Bool ecore_file_app_installed(const char *exe);
160 EAPI Eina_List *ecore_file_app_list(void);
164 EAPI Eina_Bool ecore_file_download(const char *url,
166 Ecore_File_Download_Completion_Cb completion_cb,
167 Ecore_File_Download_Progress_Cb progress_cb,
169 Ecore_File_Download_Job **job_ret);
170 EAPI Eina_Bool ecore_file_download_full(const char *url,
172 Ecore_File_Download_Completion_Cb completion_cb,
173 Ecore_File_Download_Progress_Cb progress_cb,
175 Ecore_File_Download_Job **job_ret,
178 EAPI void ecore_file_download_abort_all(void);
179 EAPI void ecore_file_download_abort(Ecore_File_Download_Job *job);
180 EAPI Eina_Bool ecore_file_download_protocol_available(const char *protocol);