argp.h
| Paramètre d'argument |
| GNU C |
Description
Cette bibliothèque contient une interface pour analyser les vecteurs de paramètres de style Unix.
La bibliothèque argp fournit des fonctionnalités non disponibles dans l'interface getopt la plus couramment utilisée. Ces fonctionnalités incluent la production automatique de sortie en réponse aux
options «--help» et «--version», comme décrit dans les normes de codage GNU. L'utilisation d'argp rend moins probable que les programmeurs négligent de mettre en oeuvre ces options supplémentaires ou
de les maintenir à jour.
La bibliothèque argp offre également la possibilité de fusionner plusieurs analyseurs d'options définis indépendamment en un seul, en médiant les conflits entre eux et en rendant le résultat transparent.
Une bibliothèque peut exporter un analyseur d'options argp que les programmes utilisateur peuvent utiliser conjointement avec leurs propres analyseurs d'options, cette situation réduisant le travail des
programmes utilisateur. Certains programmes peuvent utiliser uniquement des analyseurs de paramètres (arguments) exportés par les bibliothèques, réalisant ainsi une analyse des options cohérente et efficace pour
les abstractions de mise en oeuvres par les bibliothèques.
L'interface principale d'argp est la fonction argp_parse. Dans de nombreux cas, appeler argp_parse est le seul code d'analyse
de paramètres nécessaire dans main.
Liste des fonctions
| Nom |
Description |
| ARGP_ERROR |
Cette fonction permet d'afficher une chaîne de caractères de format printf et ses paramètres, précédés du nom du programme et de «:», suivi du message «Try ... --help» et termine le programme avec le code de sortie spécifié. |
| ARGP_FAILURE |
Cette fonction permet de signaler une erreur GNU standard et d'afficher une chaîne de caractères de format printf et ses paramètres. |
| ARGP_HELP |
Cette fonction permet de fournir un message d'aide pour l'analyseur auquel l'état fait référence et le diffuse dans un flux de données. |
| ARGP_PARSE |
Cette fonction permet d'analyser les paramètres dans argv et de longueur argc en utilisant argp pour l'analyser. |
| ARGP_STATE_HELP |
Cette fonction permet de fournir un message d'aide pour l'analyseur argp auquel l'état fait référence et le diffuse dans un flux de données. |
| ARGP_USAGE |
Cette fonction permet d'afficher le message d'utilisation standard de l'analyseur argp référé par l'état spécifié et termine le programme avec exit. |
Liste des variables
| Nom |
Description |
| error_t argp_err_exit_status |
Cette variable contient l'état de sortie utilisé lorsque argp se termine en raison d'une erreur d'analyse. S'il n'est pas défini ou défini par le programme utilisateur, il s'agit par défaut de : EX_USAGE de <sysexits.h>. |
| argp_program_bug_address |
Cette variable contient, si elle est défini ou fixé par le programme utilisateur sur une valeur non nulle, argp_program_bug_address doit pointer vers une chaîne de caractères étant affichée à la fin de la sortie standard pour l'option «--help», incorporée dans une phrase disant «Report bugs to address.». |
| argp_program_version |
Cette variable contient, si elle est défini ou fixé par le programme utilisateur sur une valeur non nulle, une option «--version» ajoutée lors de l'analyse avec argp_parse, affichant la chaîne de caractères «--version» suivie d'une nouvelle ligne et quitte immédiatement. L'exception à cette situation est si le drapeau ARGP_NO_EXIT est utilisé. |
| argp_program_version_hook |
Cette variable contient, si elle est définie ou fixé par le programme utilisateur sur une valeur non nulle, une option «--version» est ajoutée lors de l'analyse avec argp_parse, affichant la version du programme et se terminant avec un état de zéro. Ce n'est pas le cas si le drapeau ARGP_NO_HELP est utilisé. |
Dernière mise à jour : Samedi, le 23 mai 2020
