release/man3/getsubopt.3

   1 .\" Copyright (C) 2007 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\" and Copyright (C) 2007 Justin Pryzby <pryzbyj@justinpryzby.com>
   3 .\"
   4 .\" %%%LICENSE_START(PERMISSIVE_MISC)
   5 .\" Permission is hereby granted, free of charge, to any person obtaining
   6 .\" a copy of this software and associated documentation files (the
   7 .\" "Software"), to deal in the Software without restriction, including
   8 .\" without limitation the rights to use, copy, modify, merge, publish,
   9 .\" distribute, sublicense, and/or sell copies of the Software, and to
  10 .\" permit persons to whom the Software is furnished to do so, subject to
  11 .\" the following conditions:
  12 .\"
  13 .\" The above copyright notice and this permission notice shall be
  14 .\" included in all copies or substantial portions of the Software.
  15 .\"
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  19 .\" IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  20 .\" CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  21 .\" TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  22 .\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\"*******************************************************************
  26 .\"
  27 .\" This file was generated with po4a. Translate the source file.
  28 .\"
  29 .\"*******************************************************************
  30 .TH GETSUBOPT 3 2010\-09\-26 GNU "Linux Programmer's Manual"
  31 .SH 名前
  32 getsubopt \- 文字列中のサブオプション引き数の解釈を行う
  33 .SH 書式
  34 \fB#include <stdlib.h>\fP
  35
  36 \fBint getsubopt(char **\fP\fIoptionp\fP\fB, char * const *\fP\fItokens\fP\fB, char
  37 **\fP\fIvaluep\fP\fB);\fP
  38 .sp
  39 .in -4n
  40 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  41 .in
  42 .sp
  43 \fBgetsubopt\fP():
  44 .ad l
  45 .RS 4
  46 .PD 0
  47 _XOPEN_SOURCE\ >= 500 || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  48 .br
  49 || /* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200809L
  50 .PD
  51 .RE
  52 .ad
  53 .SH 説明
  54 \fBgetsubopt\fP()  は、 \fIoptionp\fP で与えられたカンマ区切りのサブオプション・リストを解析する。
  55 (このようなサブオプション・リストは \fBgetopt\fP(3)  を使ってコマンドラインを解釈した場合に現れることが多い。 例えば、
  56 \fBmount\fP(8)  の \fI\-o\fP オプションを見るとよい。)  それぞれのサブオプションには対応する値を指定することができる。
  57 サブオプションの名前と対応する値は等号 (\(aq=\(aq) で区切られる。 例えば、以下のような文字列を \fIoptionp\fP に渡すことができる。
  58 .sp
  59 .in +4n
  60 \fBro,name=xyz\fP
  61 .in
  62
  63 \fItokens\fP 引き数はトークンへのポインタの配列へのポインタで、 配列は NULL で終端される。 \fBgetsubopt\fP()
  64 はこのトークンを \fIoptionp\fP 内で探す。 それぞれのトークンは、NULL 終端された 1文字以上の文字列で、
  65 他のトークンと区別できる必要がある。 また、等号とカンマを含んではならない。
  66
  67 \fBgetsubopt\fP()  は呼び出されるたびに、 \fIoptionp\fP 中の次の未処理のサブオプションの情報を返す。
  68 サブオプション内に等号があった場合、最初の等号は そのサブオプションの名前と値の区切りと解釈される。 区切りから次のカンマ
  69 (最後のサブオプションの場合、文字列の末尾)  までが、サブオプションの値となる。 サブオプションの名前が \fItokens\fP
  70 内の名前と一致し、値を表す文字列が見つかった場合、 \fBgetsubopt\fP()  は \fI*valuep\fP を値を表す文字列のアドレスに設定する。
  71 \fIoptionp\fP 中の最初のカンマはヌルバイトで上書きされる。そのため、 \fI*valuep\fP はそのサブオプションの「値の文字列」そのものとなる。
  72
  73 サブオプションが認識されたが、値を表す文字列が見つからなかった場合、 *\fIvaluep\fP は NULL に設定される。
  74
  75 \fBgetsubopt\fP()  が返る時、 \fIoptionp\fP は次のサブオプションを指している。 ちょうど最後のサブオプションが処理された場合は、
  76 文字列末尾のヌルバイト (\(aq\e0\(aq) を指している。
  77 .SH 返り値
  78 \fIoptionp\fP 内でサブオプションが見つかった場合、 \fBgetsubopt\fP()  は最初のサブオプションにマッチする \fItokens\fP
  79 の要素の添字を返す。 見つからなかった場合、\-1 を返す。この場合、 \fI*valuep\fP は \fIname\fP\fB[=\fP\fIvalue\fP\fB]\fP
  80 の文字列全体となる。
  81
  82 \fI*optionp\fP は変更されるので、 \fBgetsubopt\fP()  を呼び出す前の最初のサブオプションは \fBgetsubopt\fP()
  83 を呼び出し後のサブオプションと必ずしも同じとは限らない。
  84 .SH 準拠
  85 POSIX.1\-2001.
  86 .SH 注意
  87
  88 \fBgetsubopt\fP()  は、文字列 *\fIoptionp\fP 中に見つけたカンマを上書きするので、文字列 \fI*optionp\fP
  89 は書き込み可能でなければならず、 文字列定数にすることはできない。
  90 .SH 例
  91 以下のプログラムは "\-o" オプションに続いてサブオプションがあることを 期待している。
  92
  93 .nf
  94 #define _XOPEN_SOURCE 500
  95 #include <stdlib.h>
  96 #include <assert.h>
  97 #include <stdio.h>
  98
  99 int main(int argc, char **argv)
 100 {
 101     enum {
 102         RO_OPT = 0,
 103         RW_OPT,
 104         NAME_OPT
 105     };
 106     char *const token[] = {
 107         [RO_OPT]   = "ro",
 108         [RW_OPT]   = "rw",
 109         [NAME_OPT] = "name",
 110         NULL
 111     };
 112     char *subopts;
 113     char *value;
 114     int opt;
 115
 116     int readonly = 0;
 117     int readwrite = 0;
 118     char *name = NULL;
 119     int errfnd = 0;
 120
 121     while ((opt = getopt(argc, argv, "o:")) != \-1) {
 122         switch (opt) {
 123         case \(aqo\(aq:
 124             subopts = optarg;
 125             while (*subopts != \(aq\e0\(aq && !errfnd) {
 126
 127             switch (getsubopt(&subopts, token, &value)) {
 128             case RO_OPT:
 129                 readonly = 1;
 130                 break;
 131
 132             case RW_OPT:
 133                 readwrite = 1;
 134                 break;
 135
 136             case NAME_OPT:
 137                 if (value == NULL) {
 138                     fprintf(stderr, "Missing value for "
 139                             "suboption \(aq%s\(aq\en", token[NAME_OPT]);
 140                     errfnd = 1;
 141                     continue;
 142                 }
 143
 144                 name = value;
 145                 break;
 146
 147             default:
 148                 fprintf(stderr, "No match found "
 149                         "for token: /%s/\en", value);
 150                 errfnd = 1;
 151                 break;
 152             }
 153         }
 154         if (readwrite && readonly) {
 155             fprintf(stderr, "Only one of \(aq%s\(aq and \(aq%s\(aq can be "
 156                     "specified\en", token[RO_OPT], token[RW_OPT]);
 157             errfnd = 1;
 158         }
 159         break;
 160
 161         default:
 162             errfnd = 1;
 163         }
 164     }
 165
 166     if (errfnd || argc == 1) {
 167         fprintf(stderr, "\enUsage: %s \-o <suboptstring>\en", argv[0]);
 168         fprintf(stderr, "suboptions are \(aqro\(aq, \(aqrw\(aq, "
 169                 "and \(aqname=<value>\(aq\en");
 170         exit(EXIT_FAILURE);
 171     }
 172
 173     /* Remainder of program... */
 174
 175     exit(EXIT_SUCCESS);
 176 }
 177 .fi
 178 .SH 関連項目
 179 \fBgetopt\fP(3)
 180 .SH この文書について
 181 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
 182 である。プロジェクトの説明とバグ報告に関する情報は
 183 http://www.kernel.org/doc/man\-pages/ に書かれている。