← Back to branch summary

~ubuntu-branches/ubuntu/raring/sflphone/raring

« back to all changes in this revision

Viewing changes to sflphone-common/libs/pjproject/pjlib-util/include/pjlib-util/getopt.h

  • Committer: Package Import Robot
  • Author(s): Francois Marier
  • Date: 2011-11-25 13:24:12 UTC
  • mfrom: (4.1.10 sid)
  • Revision ID: package-import@ubuntu.com-20111125132412-dc4qvhyosk74cd42
Tags: 1.0.1-4
http://bugs.debian.org/649726
Don't assume that arch:all packages will get built (closes: #649726)

Show diffs side-by-side

added added

removed removed

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