← Back to branch summary

~ubuntu-branches/ubuntu/wily/sflphone/wily

« back to all changes in this revision

Viewing changes to daemon/libs/pjproject-2.2.1/pjlib-util/include/pjlib-util/getopt.h

  • Committer: Package Import Robot
  • Author(s): Jonathan Riddell
  • Date: 2015-01-07 14:51:16 UTC
  • mfrom: (4.3.5 sid)
  • Revision ID: package-import@ubuntu.com-20150107145116-yxnafinf4lrdvrmx
Tags: 1.4.1-0.1ubuntu1
* Merge with Debian, remaining changes:
 - Drop soprano, nepomuk build-dep
* Drop ubuntu patches, now upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
daemon/libs/pjproject-2.2.1/pjlib-util/include/pjlib-util/getopt.h
 
1
/* $Id: getopt.h 4578 2013-08-02 02:31:44Z ming $ */
 
2
/* Declarations for pj_getopt.
 
3
   Copyright (C) 1989,90,91,92,93,94,96,97,98 Free Software Foundation, Inc.
 
4
   This file is part of the GNU C Library.
 
5
 
 
6
   The GNU C Library is free software; you can redistribute it and/or
 
7
   modify it under the terms of the GNU Library General Public License as
 
8
   published by the Free Software Foundation; either version 2 of the
 
9
   License, or (at your option) any later version.
 
10
 
 
11
   The GNU C Library 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 GNU
 
14
   Library General Public License for more details.
 
15
 
 
16
   You should have received a copy of the GNU Library General Public
 
17
   License along with the GNU C Library; see the file COPYING.LIB.  If not,
 
18
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 
19
   Boston, MA 02111-1307, USA.  */
 
20
 
 
21
#ifndef __PJ_GETOPT_H__
 
22
#define __PJ_GETOPT_H__ 1
 
23
 
 
24
/**
 
25
 * @file getopt.h
 
26
 * @brief Compile time settings
 
27
 */
 
28
 
 
29
/**
 
30
 * @defgroup PJLIB_UTIL_GETOPT Getopt
 
31
 * @ingroup PJLIB_TEXT
 
32
 * @{
 
33
 */
 
34
 
 
35
#ifdef  __cplusplus
 
36
extern "C" {
 
37
#endif
 
38
 
 
39
/* For communication from `pj_getopt' to the caller.
 
40
   When `pj_getopt' finds an option that takes an argument,
 
41
   the argument value is returned here.
 
42
   Also, when `ordering' is RETURN_IN_ORDER,
 
43
   each non-option ARGV-element is returned here.  */
 
44
 
 
45
extern char *pj_optarg;
 
46
 
 
47
/* Index in ARGV of the next element to be scanned.
 
48
   This is used for communication to and from the caller
 
49
   and for communication between successive calls to `pj_getopt'.
 
50
 
 
51
   On entry to `pj_getopt', zero means this is the first call; initialize.
 
52
 
 
53
   When `pj_getopt' returns -1, this is the index of the first of the
 
54
   non-option elements that the caller should itself scan.
 
55
 
 
56
   Otherwise, `pj_optind' communicates from one call to the next
 
57
   how much of ARGV has been scanned so far.  */
 
58
 
 
59
extern int pj_optind;
 
60
 
 
61
/* Set to an option character which was unrecognized.  */
 
62
 
 
63
extern int pj_optopt;
 
64
 
 
65
/* Describe the long-named options requested by the application.
 
66
   The LONG_OPTIONS argument to pj_getopt_long or pj_getopt_long_only is a vector
 
67
   of `struct pj_getopt_option' terminated by an element containing a name which is
 
68
   zero.
 
69
 
 
70
   The field `has_arg' is:
 
71
   no_argument          (or 0) if the option does not take an argument,
 
72
   required_argument    (or 1) if the option requires an argument,
 
73
   optional_argument    (or 2) if the option takes an optional argument.
 
74
 
 
75
   If the field `flag' is not NULL, it points to a variable that is set
 
76
   to the value given in the field `val' when the option is found, but
 
77
   left unchanged if the option is not found.
 
78
 
 
79
   To have a long-named option do something other than set an `int' to
 
80
   a compiled-in constant, such as set a value from `pj_optarg', set the
 
81
   option's `flag' field to zero and its `val' field to a nonzero
 
82
   value (the equivalent single-letter option character, if there is
 
83
   one).  For long options that have a zero `flag' field, `pj_getopt'
 
84
   returns the contents of the `val' field.  */
 
85
 
 
86
struct pj_getopt_option
 
87
{
 
88
  const char *name;
 
89
  /* has_arg can't be an enum because some compilers complain about
 
90
     type mismatches in all the code that assumes it is an int.  */
 
91
  int has_arg;
 
92
  int *flag;
 
93
  int val;
 
94
};
 
95
 
 
96
/* Names for the values of the `has_arg' field of `struct pj_getopt_option'.  */
 
97
 
 
98
# define no_argument            0
 
99
# define required_argument      1
 
100
# define optional_argument      2
 
101
 
 
102
 
 
103
/* Get definitions and prototypes for functions to process the
 
104
   arguments in ARGV (ARGC of them, minus the program name) for
 
105
   options given in OPTS.
 
106
 
 
107
   Return the option character from OPTS just read.  Return -1 when
 
108
   there are no more options.  For unrecognized options, or options
 
109
   missing arguments, `pj_optopt' is set to the option letter, and '?' is
 
110
   returned.
 
111
 
 
112
   The OPTS string is a list of characters which are recognized option
 
113
   letters, optionally followed by colons, specifying that that letter
 
114
   takes an argument, to be placed in `pj_optarg'.
 
115
 
 
116
   If a letter in OPTS is followed by two colons, its argument is
 
117
   optional.  This behavior is specific to the GNU `pj_getopt'.
 
118
 
 
119
   The argument `--' causes premature termination of argument
 
120
   scanning, explicitly telling `pj_getopt' that there are no more
 
121
   options.
 
122
 
 
123
   If OPTS begins with `--', then non-option arguments are treated as
 
124
   arguments to the option '\0'.  This behavior is specific to the GNU
 
125
   `pj_getopt'.  */
 
126
 
 
127
int pj_getopt (int argc, char *const *argv, const char *shortopts);
 
128
 
 
129
int pj_getopt_long (int argc, char *const *argv, const char *options,
 
130
                        const struct pj_getopt_option *longopts, int *longind);
 
131
int pj_getopt_long_only (int argc, char *const *argv,
 
132
                             const char *shortopts,
 
133
                             const struct pj_getopt_option *longopts, int *longind);
 
134
 
 
135
 
 
136
#ifdef  __cplusplus
 
137
}
 
138
#endif
 
139
 
 
140
/**
 
141
 * @}
 
142
 */
 
143
 
 
144
#endif /* pj_getopt.h */
 
145