libcake 0.0.1
Librairie en C
Référence du fichier file.h

Fichier contenant les types et les prototypes de tout ce qui se réfère aux fichiers ou aux dossiers. Plus de détails...

Aller au code source de ce fichier.

Structures de données

struct  cake_filesnapshot
 
struct  cake_list_filesnapshot
 
struct  cake_file
 Structure pour ouvrir, lire et écrire dans des fichiers. Plus de détails...
 
struct  cake_folderwatcher
 Structure pour surveiller un dossier, par exemple lorsqu'un fichier a été modifié. Plus de détails...
 

Macros

#define cake_close_dir(x)   closedir(x)
 
#define cake_file_exists(filename)   (access(filename, F_OK) == 0)
 
#define cake_delete_file(filename)   unlink(filename)
 
#define cake_delete_folder(pathname)   rmdir(pathname)
 

Définitions de type

typedef DIR * cake_dir
 
typedef cake_bool(* ListFileFilter) (Cake_String_UTF8 *filename, void *args)
 
typedef struct cake_filesnapshot Cake_FileSnapshot
 
typedef struct cake_list_filesnapshot Cake_List_FileSnapshot
 
typedef struct cake_file Cake_File
 Structure pour ouvrir, lire et écrire dans des fichiers.
 
typedef struct cake_folderwatcher Cake_FolderWatcher
 Structure pour surveiller un dossier, par exemple lorsqu'un fichier a été modifié.
 

Fonctions

CAKE_C CAKE_API cake_bool __cake_open_file (Cake_File *dest, const char *filename, cake_mask accessMode, cake_mask shareMode, cake_mask openMode, cake_mask attributes)
 Fonction interne, favoriser l'appel de cake_open_file ou cake_open_folder.
 
cake_bool cake_open_file (Cake_File *dest, const char *filename, cake_mask accessMode, cake_mask shareMode, cake_mask openMode)
 Ouvre un fichier. Plus de détails...
 
cake_bool cake_open_folder (Cake_File *dest, const char *folderpath, cake_mask accessMode, cake_mask shareMode, cake_mask openMode)
 Ouvre un dossier. Plus de détails...
 
CAKE_C CAKE_API void cake_close_file (Cake_File *file)
 Ferme un fichier ou un dossier ouvert. Plus de détails...
 
CAKE_C CAKE_API cake_bool cake_file_read (Cake_File *file, void *buffer, cake_size size, cake_size *bytesRead)
 Lit le contenu du fichier à partir de la position interne géré par l'OS. Plus de détails...
 
CAKE_C CAKE_API cake_bool cake_file_write (Cake_File *file, void *buffer, cake_size size, cake_size *bytesWritten)
 Écrit du contenu dans le fichier à partir de la position interne géré par l'OS. Plus de détails...
 
CAKE_C CAKE_API cake_bool cake_folder_watcher_start (Cake_FolderWatcher *watcher)
 Attend qu'un fichier situé dans le dossier voit son contenu modifié. Plus de détails...
 
CAKE_C CAKE_API void cake_create_list_filesnapshot (Cake_List_FileSnapshot *list)
 
CAKE_C CAKE_API cake_bool cake_list_filesnapshot_add (Cake_String_UTF8 *newPath, Cake_List_FileSnapshot *list)
 
CAKE_C CAKE_API void cake_list_filesnapshot_remove_last (Cake_List_FileSnapshot *list)
 
CAKE_C CAKE_API void cake_list_files_recursive (const char *path, Cake_List_String_UTF8 *files, Cake_List_String_UTF8 *folders, ListFileFilter filter, void *args)
 
CAKE_C CAKE_API cake_bool cake_mkdirs (const char *filepath)
 Crée tous les dossiers du chemin passé. Plus de détails...
 

Description détaillée

Fichier contenant les types et les prototypes de tout ce qui se réfère aux fichiers ou aux dossiers.

Auteur
Tytraman

Documentation des fonctions

◆ cake_close_file()

CAKE_C CAKE_API void cake_close_file ( Cake_File file)

Ferme un fichier ou un dossier ouvert.

Paramètres
[in]fileLe fichier ou le dossier à fermer.

◆ cake_file_read()

CAKE_C CAKE_API cake_bool cake_file_read ( Cake_File file,
void *  buffer,
cake_size  size,
cake_size *  bytesRead 
)
inline

Lit le contenu du fichier à partir de la position interne géré par l'OS.

Paramètres
[in]fileLe fichier à lire.
[out]bufferDestination des octets lus.
[in]sizeNombre d'octets à lire.
[out]bytesReadNombre d'octets lus.
Renvoie
cake_false en cas d'erreur.

◆ cake_file_write()

CAKE_C CAKE_API cake_bool cake_file_write ( Cake_File file,
void *  buffer,
cake_size  size,
cake_size *  bytesWritten 
)
inline

Écrit du contenu dans le fichier à partir de la position interne géré par l'OS.

Paramètres
[out]fileLe fichier dans lequel écrire.
[in]bufferAdresse des valeurs sources à écrire.
[in]sizeTaille du buffer source.
[out]bytesWrittenNombre d'octets écris.
Renvoie
cake_false en cas d'erreur.

◆ cake_folder_watcher_start()

CAKE_C CAKE_API cake_bool cake_folder_watcher_start ( Cake_FolderWatcher watcher)

Attend qu'un fichier situé dans le dossier voit son contenu modifié.

Paramètres
[in]watcherLe dossier à surveiller.
Renvoie
La valeur du callback. cake_false si le callback est NULL.

◆ cake_mkdirs()

CAKE_C CAKE_API cake_bool cake_mkdirs ( const char *  filepath)

Crée tous les dossiers du chemin passé.

Paramètres
filepathChemin final voulu.
Renvoie
cake_false si une erreur est survenue.

◆ cake_open_file()

cake_bool cake_open_file ( Cake_File dest,
const char *  filename,
cake_mask  accessMode,
cake_mask  shareMode,
cake_mask  openMode 
)
inline

Ouvre un fichier.

Paramètres
[out]destStructure destination qui contiendra le descripteur de fichier.
[in]filenameChemin absolu ou relatif du fichier à ouvrir.
[in]accessModeMode d'accès au fichier.
[in]shareModeMode de partage du fichier.
[in]openModeMode d'ouverture du fichier.
Renvoie
cake_false en cas d'erreur.

◆ cake_open_folder()

cake_bool cake_open_folder ( Cake_File dest,
const char *  folderpath,
cake_mask  accessMode,
cake_mask  shareMode,
cake_mask  openMode 
)
inline

Ouvre un dossier.

Paramètres
[out]destStructure destination qui contiendra le descripteur de fichier.
[in]folderpathChemin absolu ou relatif du dossier à ouvrir.
[in]accessModeMode d'accès au dossier.
[in]shareModeMode de partage du dossier.
[in]openModeMode d'ouverture du dossier.
Renvoie
cake_false en cas d'erreur.