#include <unistd.h>
int getopt(int argc, char *argv[],
const char *chaine_options);
extern char *optarg;
extern int optind, opterr, optopt;
#include <getopt.h>
int getopt_long(int argc, char *argv[],
const char *chaine_options,
const struct option *longopts, int *longindex);
int getopt_long_only(int argc, char *argv[],
const char *chaine_options,
const struct option *longopts, int *longindex);
Exigences de macros de test de fonctionnalités pour la glibc (consulter feature_test_macros(7)) :
getopt() :
_POSIX_C_SOURCE >= 2 || _XOPEN_SOURCE
getopt_long(), getopt_long_only() :
_GNU_SOURCE
La variable optind est l'index de l'élément suivant à analyser dans argv. Le système initialise cette valeur à 1. L'appelant peut la remettre à 1 pour recommencer l'analyse du même tableau de paramètres argv ou pour en analyser un nouveau.
Si getopt() trouve un autre caractère d'option, elle renvoie ce caractère en mettant à jour la variable externe optind et la variable statique nextchar, de façon à ce que l'appel suivant à getopt() puisse continuer l'analyse avec le caractère d'option suivant ou l'élément suivant de 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 n'est pas une option.
chaine_options est une chaîne contenant l'ensemble des caractères d'option autorisés. Un caractère d'option autorisé est un caractère ascii(7) imprimable sur 1 octet (pour lequel isgraph(3) renverrait une valeur différente de zéro) autre que « - », « : » ou « ; ». Si un de ces caractères est suivi par un deux-points (« : »), l'option nécessite un argument, donc getopt() placera dans optarg un pointeur sur le texte suivant dans le même élément de argv ou sur le texte de l'élément de argv suivant. Un double deux-points (« :: ») signifie qu'une option prend un argument facultatif. 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 comme « -oarg »), il est renvoyé dans optarg, sinon optarg est défini à zéro. Il s'agit d'une extension GNU. Si chaine_options contient W suivi d'un point-virgule, -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, est pris en charge à partir de la version 2 de la bibliothèque glibc.
Par défaut, getopt() permute les éléments de argv au fur et à mesure de son analyse, de façon à ce qu'en fin de compte, les arguments ne constituant pas des options se trouvent à la fin. Deux autres modes d'analyse sont également implémentés : si le premier caractère de chaine_options vaut « + » ou si la variable d'environnement POSIXLY_CORRECT est définie, l'analyse s'arrête dès qu'un argument ne constituant pas une option est rencontré. Si le premier caractère de chaine_options est autre que « + », il est traité comme une option normale. Si le comportement induit par la définition de POSIXLY_CORRECT est requis, chaine_options contiendra deux symboles « + ». Si le premier caractère de chaine_options vaut « - », les arguments ne correspondant pas à une option sont manipulés comme s'ils étaient des arguments d'une option avec le code de caractère 1 (cela est utilisé par les programmes 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 deux types d'élément). L'argument spécial « -- » arrête l'analyse des options, quel que soit le mode d'analyse en cours.
getopt() peut détecter deux types d'erreur lors du traitement de la liste d'options : (1) un caractère d'option non spécifié dans chaine_options et (2) un argument d'option manquant (c'est-à-dire une option sans son argument attendu à la fin de la ligne de commande). Les erreurs de ce type sont traitées et signalées comme suit :
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 est différent de NULL, il pointe sur 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 « -- » peut indiquer 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 si elles en trouvent une. Pour les options longues, elles 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.
| Interface | Attribut | Valeur |
| getopt(), getopt_long(), getopt_long_only() | Sécurité des threads |
MT-Unsafe race:getopt env
|
Sur certaines anciennes implémentations, getopt() était déclarée dans <stdio.h>. SUSv1 permettait que la déclaration apparaisse soit dans <unistd.h>, soit dans <stdio.h>. POSIX.1-1996 considère la déclaration dans <stdio.h> comme « LEGACY » (obsolète), et POSIX.1-2001 n'exige pas que la déclaration soit dans <stdio.h>.
Les arguments de la ligne de commande sont analysés selon leur ordre strict, ce qui signifie qu'une option nécessitant un argument va consommer l'argument suivant, qu'il s'agisse de son argument correctement spécifié ou de l'option suivante (auquel cas l'utilisateur aura mal rédigé la ligne de commande). Par exemple, si chaine_options contient « 1n: » et si l'utilisateur fournit une ligne de commande incorrecte en spécifiant prog -n -1, l'option -n se verra affecter la valeur de optarg « -1 », et l'option -1 sera considérée comme non spécifiée.
#include <stdio.h>
#include <stdlib.h>
#include <unistd.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 'n':
flags = 1;
break;
case 't':
nsecs = atoi(optarg);
tfnd = 1;
break;
default: /* '?' */
fprintf(stderr, "Usage: %s [-t nsecs] [-n] name\n",
argv[0]);
exit(EXIT_FAILURE);
}
}
printf("flags=%d; tfnd=%d; nsecs=%d; optind=%d\n",
flags, tfnd, nsecs, 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);
}
#include <getopt.h>
#include <stdio.h> /* for printf */
#include <stdlib.h> /* for exit */
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", required_argument, 0, 0 },
{"append", no_argument, 0, 0 },
{"delete", required_argument, 0, 0 },
{"verbose", no_argument, 0, 0 },
{"create", required_argument, 0, 'c'},
{"file", required_argument, 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(" with arg %s", optarg);
printf("\n");
break;
case '0':
case '1':
case '2':
if (digit_optind != 0 && digit_optind != this_option_optind)
printf("digits occur in two different argv-elements.\n");
digit_optind = this_option_optind;
printf("option %c\n", c);
break;
case 'a':
printf("option a\n");
break;
case 'b':
printf("option b\n");
break;
case 'c':
printf("option c with value '%s'\n", optarg);
break;
case 'd':
printf("option d with value '%s'\n", optarg);
break;
case '?':
break;
default:
printf("?? getopt returned character code 0%o ??\n", c);
}
}
if (optind < argc) {
printf("non-option ARGV-elements: ");
while (optind < argc)
printf("%s ", argv[optind++]);
printf("\n");
}
exit(EXIT_SUCCESS);
}
Cette traduction est une documentation libre ; veuillez vous reporter à la GNU General Public License version 3 concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE.
Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à