#include <unistd.h> int getopt(int argc, char * const argv[], const char *optstring); extern char *optarg; extern int optind, opterr, optopt; #define _GNU_SOURCE #include <getopt.h> int getopt_long (int argc, char * const argv[], const char *optstring, const struct option *longopts, int *longindex); int getopt_long_only (int argc, char * const argv[], const char *optstring, const struct option *longopts, int *longindex);
Si getopt() trouve un autre caractère d'option, elle le renvoie, mettant à jour la variable externe optind et la variable statique nextchar, ainsi, getopt() peut continuer l'analyse avec le caractère suivant ou l'élément argv.
S'il n'y a plus de caractères d'option, getopt() renvoie -1. Alors, optind devient l'index du premier élément de argv qui ne soit pas une option.
optstring est une chaîne contenant l'ensemble des caractères d'option autorisés. Si un de ces caractères est suivi par un deux-point (« : »), l'option nécessite un argument supplémentaire, et getopt() placera un pointeur sur le texte suivant dans le même argv, ou sur le texte de l'élément argv suivant dans optarg. Un double deux-points (« :: ») signifie qu'une option prend un argument optionnel. S'il existe un texte dans le même élément de argv, (c'est-à-dire dans le même mot que le nom de l'option elle-même, par exemple « -oarg »), il est renvoyé dans optarg, sinon optarg est défini à zéro. Il s'agit d'une extension GNU. Si optstring contient W suivi d'un point-virgule, alors -W foo est traité comme l'option longue --foo. (L'option -W est réservée par POSIX.2 pour des extensions spécifiques à l'implémentation). Ce comportement, spécifique à la version GNU, n'est pas disponible avant la bibliothèque glibc 2.
Par défaut, getopt() permute les éléments de argv 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 optstring vaut « + », ou si la variable d'environnement POSIXLY_CORRECT est valide, alors l'analyse s'arrête aussitôt qu'un argument ne constituant pas une option est rencontré. Si le premier caractère de optstring 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 serait 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 argv dans n'importe quel ordre mais qui prennent en compte l'ordre de ces de types.
L'argument spécial « -- » arrête l'analyse des options, quelque soit le mode en cours.
Si getopt() 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 optopt, et renvoie « ? ». Le programme appelant peut empêcher l'affichage du message d'erreur en positionnant opterr à 0.
Si getopt() trouve dans argv un caractère d'option non inclus dans optstring, ou s'il manque un argument d'option, l'appel renvoie « ? » et remplit la variable externe optopt avec le vrai caractère trouvé. Si le premier caractère de optstring (suivi par « + » ou « - ») est un deux-points (« : »), alors getopt() renvoie « : » plutôt que « ? » pour indiquer un argument d'option manquant. Si une erreur est détectée, si le premier caractère de optstring n'est pas un deux-points, et si la variable externe opterr est non nulle, (non nulle par défaut), alors getopt() affiche un message d'erreur.
longopts est un pointeur sur le premier élément d'un tableau de structures struct option déclarées dans <getopt.h> ainsi :
struct option {
const char *name;
int has_arg;
int *flag;
int val;
};
La signification des différents champs est la suivante :
Le dernier élément de la table doit être rempli avec des zéros.
Si longindex n'est pas NULL, il pointe vers une variable qui est définie avec l'index de l'option longue correspondant à longopts.
getopt_long_only() fonctionne comme getopt_long(), 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 analysée en tant qu'option courte.
getopt_long() et getopt_long_only() renvoient également le caractère d'option courte s'ils en trouvent une. Pour les options longues, ils renvoient val si flag vaut NULL, et 0 sinon. Les erreurs et la fin des options sont gérées comme avec getopt(), en renvoyant de surcroît « ? » pour une correspondance ambiguë, ou un paramètre en trop.
Sur certaines anciennes implémentations, getopt() était déclarée dans <stdio.h>. SUSv1 a permis que la déclaration apparaisse soit dans <unistd.h> soit dans <stdio.h>. POSIX.1-2001 a marqué l'utilisation de <stdio.h> dans ce cas comme historique. POSIX.1-2001 ne permet pas que la déclaration apparaisse dans <stdio.h>.
#include <unistd.h> #include <stdlib.h> #include <stdio.h> int main(int argc, char *argv[]) { int flags, opt; int nsecs, tfnd; nsecs = 0; tfnd = 0; flags = 0; while ((opt = getopt(argc, argv, "nt:")) != -1) { switch (opt) { case aqnaq: flags = 1; break; case aqtaq: nsecs = atoi(optarg); tfnd = 1; break; default: /* aq?aq */ fprintf(stderr, "Usage: %s [-t nsecs] [-n] name\n", argv[0]); exit(EXIT_FAILURE); } } printf("flags=%d; tfnd=%d; optind=%d\n", flags, tfnd, optind); if (optind >= argc) { fprintf(stderr, "Expected argument after options\n"); exit(EXIT_FAILURE); } printf("name argument = %s\n", argv[optind]); /* Other code omitted */ exit(EXIT_SUCCESS); }
Le programme suivant illustre l'utilisation de getopt_long() avec la plupart de ses fonctionnalités.
#include <stdio.h> /* for printf */ #include <stdlib.h> /* for exit */ #include <getopt.h> int main(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, aqcaq}, {"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("\n"); break; case aq0aq: case aq1aq: case aq2aq: if (digit_optind != 0 && digit_optind != this_option_optind) printf("chiffre dans deux arguments.\n"); digit_optind = this_option_optind; printf("option %c\n", c); break; case aqaaq: printf("option a\n"); break; case aqbaq: printf("option b\n"); break; case aqcaq: printf("option c de valeur aq%saq\n", optarg); break; case aqdaq: printf("option d de valeur aq%saq\n", optarg); break; case aq?aq: break; default: printf("?? caractère de code 0%o ??\n", c); } } if (optind < argc) { printf("Arguments ne constituant pas des options : "); while (optind < argc) printf("%s ", argv[optind++]); printf("\n"); } exit(EXIT_SUCCESS); }
Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 28 octobre 1996 et révisée le 17 juillet 2008.
L'équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité. La version anglaise la plus à jour de ce document est toujours consultable via la commande : « LANG=C man 3 getopt ». N'hésitez pas à signaler à l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.
Dernière mise à jour : 17 juillet 2008