1 /* Internal declarations for getopt. 2 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2004, 2009-2012 Free Software 3 Foundation, Inc. 4 This file is part of the GNU C Library. 5 6 This program is free software: you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 3 of the License, or 9 (at your option) any later version. 10 11 This program is distributed in the hope that it will be useful, 12 but WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 GNU General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 18 19 #ifndef _GETOPT_INT_H 20 #define _GETOPT_INT_H 1 21 22 #include <getopt.h> 23 24 extern int _getopt_internal (int ___argc, char **___argv, 25 const char *__shortopts, 26 const struct option *__longopts, int *__longind, 27 int __long_only, int __posixly_correct); 28 29 30 /* Reentrant versions which can handle parsing multiple argument 31 vectors at the same time. */ 32 33 /* Describe how to deal with options that follow non-option ARGV-elements. 34 35 If the caller did not specify anything, 36 the default is REQUIRE_ORDER if the environment variable 37 POSIXLY_CORRECT is defined, PERMUTE otherwise. 38 39 REQUIRE_ORDER means don't recognize them as options; 40 stop option processing when the first non-option is seen. 41 This is what Unix does. 42 This mode of operation is selected by either setting the environment 43 variable POSIXLY_CORRECT, or using '+' as the first character 44 of the list of option characters, or by calling getopt. 45 46 PERMUTE is the default. We permute the contents of ARGV as we 47 scan, so that eventually all the non-options are at the end. 48 This allows options to be given in any order, even with programs 49 that were not written to expect this. 50 51 RETURN_IN_ORDER is an option available to programs that were 52 written to expect options and other ARGV-elements in any order 53 and that care about the ordering of the two. We describe each 54 non-option ARGV-element as if it were the argument of an option 55 with character code 1. Using '-' as the first character of the 56 list of option characters selects this mode of operation. 57 58 The special argument '--' forces an end of option-scanning regardless 59 of the value of 'ordering'. In the case of RETURN_IN_ORDER, only 60 '--' can cause 'getopt' to return -1 with 'optind' != ARGC. */ 61 62 enum __ord 63 { 64 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER 65 }; 66 67 /* Data type for reentrant functions. */ 68 struct _getopt_data 69 { 70 /* These have exactly the same meaning as the corresponding global 71 variables, except that they are used for the reentrant 72 versions of getopt. */ 73 int optind; 74 int opterr; 75 int optopt; 76 char *optarg; 77 78 /* Internal members. */ 79 80 /* True if the internal members have been initialized. */ 81 int __initialized; 82 83 /* The next char to be scanned in the option-element 84 in which the last option character we returned was found. 85 This allows us to pick up the scan where we left off. 86 87 If this is zero, or a null string, it means resume the scan 88 by advancing to the next ARGV-element. */ 89 char *__nextchar; 90 91 /* See __ord above. */ 92 enum __ord __ordering; 93 94 /* If the POSIXLY_CORRECT environment variable is set 95 or getopt was called. */ 96 int __posixly_correct; 97 98 99 /* Handle permutation of arguments. */ 100 101 /* Describe the part of ARGV that contains non-options that have 102 been skipped. 'first_nonopt' is the index in ARGV of the first 103 of them; 'last_nonopt' is the index after the last of them. */ 104 105 int __first_nonopt; 106 int __last_nonopt; 107 108 #if defined _LIBC && defined USE_NONOPTION_FLAGS 109 int __nonoption_flags_max_len; 110 int __nonoption_flags_len; 111 #endif 112 }; 113 114 /* The initializer is necessary to set OPTIND and OPTERR to their 115 default values and to clear the initialization flag. */ 116 #define _GETOPT_DATA_INITIALIZER { 1, 1 } 117 118 extern int _getopt_internal_r (int ___argc, char **___argv, 119 const char *__shortopts, 120 const struct option *__longopts, int *__longind, 121 int __long_only, struct _getopt_data *__data, 122 int __posixly_correct); 123 124 extern int _getopt_long_r (int ___argc, char **___argv, 125 const char *__shortopts, 126 const struct option *__longopts, int *__longind, 127 struct _getopt_data *__data); 128 129 extern int _getopt_long_only_r (int ___argc, char **___argv, 130 const char *__shortopts, 131 const struct option *__longopts, 132 int *__longind, 133 struct _getopt_data *__data); 134 135 #endif /* getopt_int.h */ 136