1 /* $NetBSD: getopt.h,v 1.4 2000/07/07 10:43:54 ad Exp $ */ 2 /* $FreeBSD$ */ 3 4 /*- 5 * Copyright (c) 2000 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Dieter Baron and Thomas Klausner. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #pragma once 34 35 /** 36 * @file getopt.h 37 * @brief The getopt() and getopt_long() functions. 38 */ 39 40 #include <sys/cdefs.h> 41 42 #include <bits/getopt.h> 43 44 /** A `has_arg` value for `struct option`. */ 45 #define no_argument 0 46 /** A `has_arg` value for `struct option`. */ 47 #define required_argument 1 48 /** A `has_arg` value for `struct option`. */ 49 #define optional_argument 2 50 51 struct option { 52 /** 53 * Name of long option. Options must have a non-NULL name. 54 * A NULL name signals the end of the options array. 55 */ 56 const char * _Nullable name; 57 58 /** 59 * One of `no_argument`, `required_argument`, or `optional_argument`. 60 */ 61 int has_arg; 62 63 /** If not NULL, set `*flag` to val when option found. */ 64 int* _Nullable flag; 65 66 /** If `flag` not NULL, the value to assign to `*flag`; otherwise the return value. */ 67 int val; 68 }; 69 70 __BEGIN_DECLS 71 72 /** 73 * [getopt_long(3)](http://man7.org/linux/man-pages/man3/getopt.3.html) parses command-line options. 74 */ 75 int getopt_long(int __argc, char* _Nonnull const* _Nonnull __argv, const char* _Nonnull __options, const struct option* _Nonnull __long_options, int* _Nullable __long_index); 76 77 /** 78 * [getopt_long_only(3)](http://man7.org/linux/man-pages/man3/getopt.3.html) parses command-line options. 79 */ 80 int getopt_long_only(int __argc, char* _Nonnull const* _Nonnull __argv, const char* _Nonnull __options, const struct option* _Nonnull __long_options, int* _Nullable __long_index); 81 82 #ifndef _OPTRESET_DECLARED 83 #define _OPTRESET_DECLARED 84 /** 85 * Must be set to 1 to reset the `getopt` functions before scanning a new argument vector. 86 */ 87 extern int optreset; 88 #endif 89 90 __END_DECLS 91