Outils d'utilisateurs

Outils du Site


c_1y_file_system

Ceci est une ancienne révision du document !


C++1y - File System

Le Technical Specification — File System propose d'ajouter des fonctionnalités de gestion des fichiers et répertoires en C++. Jusqu'à maintenant, il fallait passer par des bibliothèques externes, comme par exemple Boost.Filesystem ou Qt, ou utiliser les bibliothèques fournies par le système d'exploitation (POSIX sur Linux, Win32 sur Windows). Ce TS devrait être validé cette année par le comité, l'implémentation dans les compilateurs devrait suivre très rapidement.

Les classes et énumérations

Le draft N3803 est relativement simple à lire, puisqu'il n'y a pas de modification du langage, mais simplement des ajouts sous forme de bibliothèque. Ceux qui ont déjà utilisé une bibliothèque de gestion de fichiers retrouveront des éléments familiers. Du coup, je ne vais pas reprendre en détail le document (ce qui reviendrait en gros à le traduire), mais je vais donner des exemples de code pour répondre à des problématique spécifiques. Pour ceux intéressé par les détails, je vais juste décrire l'organisation du draft.

Le document commence à définir un ensemble de notions généralistes sur les systèmes de fichiers : ce qu'est un fichier, un répertoire, un nom de fichier ou de répertoire, un lien, ainsi que les notions de chemin absolu, relatif ou canonique.

Ensuite, le document décrit les différentes types :

  • la classe path, qui représente un chemin vers un fichier ou répertoire ;
  • la classe filesystem_error pour la gestion des erreurs ;
  • l'énumération file_type pour lister les types (fichier, répertoire, lien, etc) ;
  • l'énumération copy_options pour lister les options possibles lors d'une copie (écraser les fichiers existants, parcourir les sous-répertoires, suivre les liens symboliques, et.) ;
  • l'énumération perms pour lister les permissions d'un fichier (propriétaire du fichier, groupe d'utilisateurs, etc) ;
  • la classe file_status pour gérer le type de fichier et les permissions d'accès ;
  • la classe directory_entry représente une entrée dans un répertoire, avec un chemin et les statuts du fichier ;
  • la classe directory_iterator est un itérateur permettant de parcourir les éléments d'un répertoire ;
  • la classe recursive_directory_iterator est un itérateur permettant de parcourir les éléments d'un répertoire et de ses sous-répertoires.

Pour terminer, le document définit l'ensemble des fonctions libres pour copier, renommer, déplacer ou supprimer des fichiers et répertoires, manipuler les chemins, tester le type et les accès des fichiers, créer des liens.

L'ensemble des fonctionnalités est accessible via l'en-tête <filesystem>.

La gestion des erreurs

Pour gérer les erreurs en C, il est classique d'utiliser un code d'erreur en retour de fonction. L'un des problèmes de cette approche est qu'il devient vite fastidieux d'ajouter du code pour tester toutes les erreurs et beaucoup de développeurs ne vérifient plus toutes les erreurs.

Le C++ ajoute une nouvelle approche pour la gestion des erreurs : les exceptions. Cette différence majeure par rapport au C fait qu'il est très dangereux de porter directement du code C en C++. Un code aussi simple que le suivant ne sera pas valide en C++ (risque de fuite mémoire).

Object p1 = new Object;
Object P2 = new Object;
if (!p1 || !p2) {
    delete p1;
    delete p2;
}

Il est donc conseillé en C++ d'utiliser des classes assurant le RAII : les pointeurs intelligents (shared_ptr, weak_ptr, unique_ptr), les conteneurs standards (vector, list, map, etc.) et plus généralement les outils de la STL (string, stream, etc). Je vous conseille la lecture de l'article Retour de fonctions ou exceptions ?

En complément, le C++11 introduit un nouveau mot-clé noexcept qui permet d'indiquer qu'une fonction ne retournera pas d'exception (c'est-à-dire qu'elle ne lance pas d'exception et qu'elle n'appelle que des fonctions noexcept).

Les fonctions de File System existent en deux versions, l'une utilisant la gestion d'erreur par exception et l'autre par un code d'erreur. Pour garder les signatures des fonctions similaires, le code d'erreur est passé comme argument (référence non constante) et non en retour de fonction.

Ainsi, pour tester l’existence d'un fichier, la fonction exists existe selon les deux signatures suivantes :

bool exists(const path& p);
bool exists(const path& p, error_code& ec) noexcept;

La première version ne prend pas de code d'erreur en argument, la second oui (et est donc déclarée en noexcept). Pour les utiliser :

// avec les exceptions
try {
    auto file_exists(R"(C:\Mon fichier.txt)");
} catch(...) {
    cerr << R"(Le fichier n'existe pas !)" << endl;
}
 
// avec code d'erreur
error_code ec;
auto file_exists(R"(C:\Mon fichier.txt)", ec);
if (ec) {
    cerr << R"(Le fichier n'existe pas !)" << endl;
}

(Je ne suis pas sûr du code pour tester le code d'erreur, le type error_code n'est pas défini).

Il est préférable d'utiliser la version avec exception par défaut.

Les fonctions libres

Beaucoup de fonction prennent en paramètre un objet de type path ou de type file_status. Comme il existe un constructeur (non explicit) de path prenant en paramètre une chaîne, il est possible d'appeler les fonctions directement avec une chaîne.

auto my_filename = R"(C:\mon fichier.exe)";
auto my_path = path(my_filename );
auto my_status = status(my_path);
auto my_another_status = status(my_filename);

Connaître le répertoire courant

auto current = current_path();

Les fonctions de tests

auto b1 = exists(my_filename);
auto b2 = equivalent(my_filename, "mon_fichier.exe");
 
auto b3 = is_directory(my_filename); // est un répertoire ?
auto b4 = is_regular_file(my_filename); // est un fichier ?
auto b5 = is_symlink(my_filename); // est un lien symbolique ?
auto b6 = is_other(my_filename); // est autre chose qu'un fichier, un répertoire et un lien ?
 
auto b7 = is_block_file(my_filename); // type block ?
auto b8 = is_character_file(my_filename); // type caractère ?
auto b9 = is_socket(m_filename); // type socket ?
auto b10 = is_fifo(my_filename); // type fifo ?

La date de la dernière modification

auto t = last_write_time(my_filename);
last_write_time(my_filename, chrono::system_clock::now());

Connaître la taille d'un fichier

auto size = file_size(my_filename);
auto b = is_empty(my_filename);

Chemin relatif, absolu, canonique

Un chemin n'est pas représenté par une écriture unique, plusieurs chaînes de caractères peuvent correspondre à un même chemin (et donc au même fichier ou même répertoire) :

  • le chemin relatif est le chemin défini à partir d'un emplacement (le plus souvent, l'application) ;
  • le chemin absolu est défini à partir de la racine, avec ou sans définir le chemin de base ;
  • le chemin canonique est le chemin absolu sans lien symbolique ou élément . et ..

Les fonction absolute et canonical permettent d'obtenir les chemins absolu et canonique :

auto path_absolute = absolute(old_path);
auto path_absolute = absolute("my_file.cpp");
auto path_absolute = absolute("my_file.cpp", "/home/me");
 
auto path_cononical = canonical(old_path);
auto path_canonical = canonical("my_file.cpp");
auto path_canonical = canonical("my_file.cpp", "/home/me");

Copie des fichiers et répertoires

Les options de copie sont définies dans l'énumération copy_options :

  • pour copy_file :
    • none (ne rien faire) ;
    • skip_existing (ignorer les existants) ;
    • overwrite_existing (écraser les existants) ;
    • update_existing (mettre à jour les existants).
  • pour les sous-répertoires :
    • none (ne rien faire) ;
    • recursive (parcourir les sous-répertoires).
  • lien symbolique :
    • none (ne rien faire) ;
    • copy_symlinks (copier les liens symboliques) ;
    • skip_symlinks (passer les liens symboliques).
  • type de copie :
    • none (ne rien faire) ;
    • directories_only (copier seulement les répertoires) ;
    • create_symlinks (créer des liens symboliques) ;
    • create_hard_links (créer des liens en dur).

La fonction copy permet de copier un fichier ou répertoire vers une destination :

copy("src_file.txt", "dest_file.txt");
copy("src_dir", "dest_dir");
copy("src_dir", "dest_dir", copy_options::recursive);

En complément, les fonctions suivantes permettent de copier uniquement les fichiers ou des liens symboliques :

copy_file("src", "dest");
copy_file("src", "dest", copy_options::recursive);
 
copy_symlink("src", "dest");

Créer des répertoires ou des liens symboliques

create_directory("/home/me/my_dir");
create_directories("/home/me/my_dir");
create_directory_symlink("/home/me/my_dir");
create_hard_link("/home/me/link");
create_symlink("/home/me/link");

Suppression des fichiers et répertoires

remove("/home/me/my_file"); // supprimer un fichier
remove_all("/home/me/my_file"); // supprime les fichiers d'un répertoire

Pour renommer

rename("/home/me/old_name", "/home/me/new_name");

Gérer les permissions

Les permissions sont définies dans l'énumération perms, pour le propriétaire, le groupe et les autres :

  • none (ne fait rien) ;
  • Pour le propriétaire :
    • owner_read (lecture) ;
    • owner_write (écriture) ;
    • owner_exec (exécutable) ;
    • owner_all (tout) ;
  • Pour le groupe :
    • group_read (lecture) ;
    • group_write (écriture) ;
    • groupe_exec (exécutable) ;
    • group_all (tout) ;
  • Pour les autres :
    • others_read (lecture) ;
    • others_write (écriture) ;
    • others_exec (exécutable) ;
    • others_all (tout) ;
  • all (toutes les permissions, pour tot le monde) ;

L'énumération ''perms” permet également de spécifier les modifications :

  • set_uid
  • set_gid
  • sticky_bit
  • mask
  • unknown
  • add_perms
  • remove_perms
  • resolve_symlinks
auto p = perms(owner_all | remove_perms);

Pour modifier les permissions :

permissions(my_path, perms);

connaître les permissions :

auto perms = status.permissions()

Divers

Nombre de hard link

hard_link_count("/home/me/file");
  • read_symlink
  • resize_file
  • space
  • statuts
  • status_known
  • symlink_status
  • system_complete
  • temp_directory_path
  • unique_path
c_1y_file_system.1394557271.txt.gz · Dernière modification: 2014/03/11 18:01 par gbdivers