Editer un article - Informaticien.be

Editer un article

Titre
Mots Clés
Texte	[size=18] [b]Nom[/b] [/size] getopt, getopt_long, getopt_long_only - Analyser les options en ligne de commande. [size=18] [b]Résumé[/b] [/size] .nf [b]#include <unistd.h>[/b] [b][i]int getopt (int argc , char * const argv[] ,[/i][/b] [b][i] const char * optstring );[/i][/b] [b][i]extern char * optarg ;[/i][/b] [b][i]extern int optind , opterr , optopt ;[/i][/b] [b]#define _GNU_SOURCE[/b] [b]#include <getopt.h>[/b] [b][i]int getopt_long (int argc , char * const argv[] ,[/i][/b] [b][i] const char * optstring ,[/i][/b] [b][i] const struct option * longopts , int * longindex );[/i][/b] [b][i]int getopt_long_only (int argc , char * const argv[] ,[/i][/b] [b][i] const char * optstring ,[/i][/b] [b][i] const struct option * longopts , int * longindex );[/i][/b] .fi [size=18] [b]Description[/b] [/size] La fonction [b]getopt()[/b] analyse les arguments de la ligne de commande. Ses éléments [i]argc[/i] et [i]argv[/i] correspondent aux nombres et à la table d'arguments qui sont transmis à la fonction [b]main()[/b] lors du lancement du programme. Un élément de [i]argv[/i] qui commence par `-' (et qui ne soit pas uniquement "-" ou "--") est considéré comme une option. Les caractères à la suite du '-' initial sont les caractères de l'option. Si [b]getopt()[/b] est appelée à plusieurs reprises, elle renverra successivement chaque caractère de chaque option. Si [b]getopt()[/b] trouve un caractère d'option, elle le renvoie, mettant à jour la variable externe [i]optind[/i] et la variable statique [i]nextchar[/i] pour préparer l'appel suivant a [b]getopt()[/b]. S'il n'y a plus de caractères d'option, [b]getopt()[/b] renvoie [b]EOF[/b]. Alors, [i]optind[/i] devient l'index du premier élément de [i]argv[/i] qui ne soit pas une option. [i]optstring[/i] est une chaîne contenant l'ensemble des caractères d'option autorisés. Si un de ces caractères est suivi par un double-point, l'option nécessite un argument supplémentaire, et [b]getopt[/b] placera un pointeur sur le texte correspondant de [i]argv[/i] dans [b]optarg .[/b] Deux doubles-points signifient qu'une option prend un argument optionnel. S'il existe un texte dans le même élément de [i]argv[/i], il est renvoyé dans [i]optarg[/i], sinon [i]optarg[/i] contient zéro. Il s'agit d'une extension GNU. Si [i]optstring[/i] contient [b]W[/b] suivi d'un point-virgule, alors [b]-W foo[/b] est traité comme l'option longue [b]--foo .[/b] (L'option [b]-W[/b] est réservée par POSIX.2 pour des extensions spécifique à l'implémentation). Ce comportement, spécifique à la version GNU, n'est pas disponible avant la bibliothèque GNU libc 2. Par défaut, [b]getopt()[/b] permute les éléments de [i]argv[/i] au fur et à mesure de son analyse, ainsi tous les arguments éventuels ne constituant pas des options se trouvent à la fin. Deux autres modes sont également implémentés : Si le premier caractère de [i]optstring[/i] vaut `+', ou si la variable d'environnement POSIXLY_CORRECT est validée, alors l'analyse s'arrête aussitot qu'un argument ne constituant pas une option est rencontré. Si le premier caractère de [i]optstring[/i] vaut `-', alors les arguments ne correspondant pas à une option sont manipulés comme s'ils étaient des arguments d'une option dont le caractère soit le caractère de code 1. Ceci est utilisé par les programmes qui sont conçus pour recevoir des options et d'autres éléments de [i]argv[/i] et qui prennent en compte l'ordre des arguments. L'argument spécial `--' arrête l'analyse des options, quelque soit le mode en cours. Si [b]getopt()[/b] ne reconnaît pas un caractère d'option, il affiche un message d'erreur sur la sortie standard stderr, stocke le caractère dans [i]optopt[/i], et renvoie `?'. Le programme appelant peut empêcher l'affichage du message d'erreur en positionnant [i]opterr[/i] à 0. Si [b]getopt()[/b] trouve dans [i]argv[/i] un caractère d'option non inclus dans [i]optstring[/i], ou s'il manque un argument d'option, l'appel renvoie `?' et remplit la variable externe [i]optopt[/i] avec le vrai caractère trouvé. Si le premier caractère de [i]optstring[/i] est un deux-points (`:'), alors [b]getopt()[/b] renvoie `:' plutôt que `?' pour indiquer un argument d'option manquant. Si une erreur est détectée, si le premier caractère de [i]optstring[/i] n'est PAS un deux-points, et si la variable externe [i]opterr[/i] est non-nulle, (nulle par défaut), alors [b]getopt()[/b] affiche un message d'erreur. La fonction [b]getopt_long()[/b] fonctionne comme [b]getopt()[/b] sauf qu'elle accepte également des noms longs d'option, commencant par deux tirets. Les noms longs d'option peuvent être abrégés, si l'abréviation est unique, ou si elle correspond exactement à une option définie. Une option longue peut prendre un argument, de la forme [b]--arg=param[/b] ou [b]--arg param .[/b] [i]longopts[/i] est un pointeur sur le premier élément d'un tableau de structures [b]struct option[/b] déclarées dans [b]<getopt.h>[/b] ainsi : .nf .in 10 struct option { .in 14 const char name; int has_arg; int flag; int val; .in 10 }; .fi La signification des différents champs est la suivante : [i]name[/i] [table][row][col]    [/col][col]est le nom de l'option longue.[/col][/row][/table] [i]has_arg[/i] [table][row][col]    [/col][col]vaut : [b]no_argument[/b] (ou 0), si l'option ne prend pas d'argument, [b]required_argument[/b] (ou 1) si l'option prend un argument, ou [b]optional_argument[/b] (ou 2) si l'option prend un argument optionnel.[/col][/row][/table] [i]flag[/i] [table][row][col]    [/col][col]spécifie la manière de renvoyer les résultats pour une option longue. Si [i]flag[/i] vaut [b]NULL[/b], alors [b]getopt_long()[/b] renvoie [i]val[/i]. (Par exemple le programme appelant peut remplir [i]val[/i] avec le caractère de l'option courte correspondante). Sinon, [b]getopt_long()[/b] renvoie 0, et [i]flag[/i] pointe sur une variable correspondant à [i]val[/i] si l'option est trouvée, mais reste inchangé si l'option est absente.[/col][/row][/table] [table][row][col]    [/col][col][i]val[/i] est la valeur à renvoyer, ou à charger dans la variable pointée par [i]flag[/i].[/col][/row][/table] Le dernier élément de la table doit être rempli avec des zéros. Si [i]longindex[/i] n'est pas [b]NULL[/b], il pointe sur une variable qui est remplie avec l'index de l'option longue correspondant à [b]longopts .[/b] [b]getopt_long_only()[/b] fonctionne comme [b]getopt_long()[/b], mais `-' tout comme `--' indiquent une option longue. Si une option commençant par `-' (et non `--') ne correspond pas à une option longue, mais correspond à une option courte, elle est analysee en tant qu'option courte. [size=18] [b]Valeur renvoyée[/b] [/size] La fonction [b]getopt()[/b] renvoie le caractère de l'option s'il en trouve une, `:' s'il manque un paramètre pour une option, `?' s'il y a un caractère inconnu, et [b]EOF[/b] (-1) à la fin de la liste des options. [b]getopt_long()[/b] et [b]getopt_long_only()[/b] renvoient également le caractère d'option courte s'ils en trouvent une. Pour les options longues, ils renvoient [i]val[/i] si [i]flag[/i] vaut [b]NULL[/b], et 0 sinon. Les erreurs et la fin des options sont gérées comme avec [b]getopt()[/b], en renvoyant de surcroît `?' pour une correspondance ambiguë, ou un paramètre en trop. [size=18] [b]Variables denvironnement[/b] [/size] [size=6][/size] [b]POSIXLY_CORRECT[/b] [table][row][col]    [/col][col]Si cette variable est positionnée, l'analyse s'arrête dès qu'un argument ne constituant pas une option est rencontré.[/col][/row][/table] [size=6][/size] [b]_<PID>_GNU_nonoption_argv_flags_[/b] [table][row][col]    [/col][col]Cette variable est utilisée par [b]bash[/b] 2.0 pour communiquer à la libc GNU quels arguments sont le résultat de l'expansion des caractères génériques, et ne doivent pas être considérés comme des options. Ce comportement à été supprimé de [b]bash[/b] version 2.01, mais il est toujours supporté par la libc GNU.[/col][/row][/table] [size=18] [b]Exemple[/b] [/size] Le programme suivant illustre l'utilisation de [b]getopt_long()[/b] avec la plupart de ses fonctionnaliteé. .nf #include <stdio.h> /* for printf / #include <stdlib.h> / for exit / #include <getopt.h> int main (argc, argv) int argc; char *argv; { int c; int digit_optind = 0; while (1) { int this_option_optind = optind ? optind : 1; int option_index = 0; static struct option long_options[] = { {"add", 1, 0, 0}, {"append", 0, 0, 0}, {"delete", 1, 0, 0}, {"verbose", 0, 0, 0}, {"create", 1, 0, 'c'}, {"file", 1, 0, 0}, {0, 0, 0, 0} }; c = getopt_long (argc, argv, "abc:d:012", long_options, &option_index); if (c == -1) break; switch (c) { case 0: printf ("option %s", long_options[option_index].name); if (optarg) printf (" avec argument %s", optarg); printf (" "); break; case '0': case '1': case '2': if (digit_optind != 0 && digit_optind != this_option_optind) printf ("chiffre dans deux arguments. "); digit_optind = this_option_optind; printf ("option %c ", c); break; case 'a': printf ("option a "); break; case 'b': printf ("option b "); break; case 'c': printf ("option c de valeur `%s' ", optarg); break; case 'd': printf ("option d de valeur `%s' ", optarg); break; case '?': break; default: printf ("?? caractère de code 0%o ?? ", c); } } if (optind < argc) { printf ("Arguments ne constituant pas des options: "); while (optind < argc) printf ("%s ", argv[optind++]); printf (" "); } exit (0); } .fi [size=18] [b]Bugs[/b] [/size] Les spécifications POSIX.2 de [b]getopt()[/b] contiennent une erreur technique décrite dans POSIX.2 interprétation 150. L'implémentation GNU (et probablement toutes les autres) adopte un comportement correct différent de la spécification. [size=18] [b]Conformité[/b] [/size] [table][row][col]    [/col][col][b]getopt()[/b]: POSIX.2, à condition que la variable d'environnement POSIXLY_CORRECT soit positionnée. Sinon, les éléments de [i]argv[/i] ne sont pas vraiment constants puisque l'on peut les permuter. On les déclare 'const' dans le prototype pour être compatible avec d'autres systèmes.[/col][/row][/table] [size=18] [b]Traduction[/b] [/size] Christophe Blaess, 1996-2003.
Fichier