## Tcl8.6.17/Tk8.6.17 Documentation > Tk C API > ParseArgv

### Tcl/Tk Applications | Tcl Commands | Tk Commands | [incr Tcl] Package Commands | SQLite3 Package Commands | TDBC Package Commands | tdbc::mysql Package Commands | tdbc::odbc Package Commands | tdbc::postgres Package Commands | tdbc::sqlite3 Package Commands | Thread Package Commands | Tcl C API | Tk C API | [incr Tcl] Package C API | TDBC Package C API

  NAME
    Tk_ParseArgv — 命令行の指示項目を処理する process command-line options
  SYNOPSIS
    #include <tk.h>
    int
    Tk_ParseArgv(interp, tkwin, argcPtr, argv, argTable, flags)
  引数 ARGUMENTS
    Tcl_Interp *interp (入力in)
    Tk_Window tkwin (入力in)
    int argcPtr (入出力in/out)
    const char **argv (入出力in/out)
    Tk_ArgvInfo *argTable (入力in)
    int flags (入力in)
  説明 DESCRIPTION
    TK_ARGV_END
    TK_ARGV_CONSTANT
    TK_ARGV_INT
    TK_ARGV_FLOAT
    TK_ARGV_STRING
    TK_ARGV_UID
    TK_ARGV_CONST_OPTION
    TK_ARGV_OPTION_VALUE
    TK_ARGV_OPTION_NAME_VALUE
    TK_ARGV_HELP
    TK_ARGV_REST
    TK_ARGV_FUNC
    TK_ARGV_GENFUNC
  FLAGS
    TK_ARGV_DONT_SKIP_FIRST_ARG
    TK_ARGV_NO_ABBREV
    TK_ARGV_NO_LEFTOVERS
    TK_ARGV_NO_DEFAULTS
  実施例 EXAMPLE
  KEYWORDS

### NAME

Tk_ParseArgv — 命令行の指示項目を処理する process command-line options

### SYNOPSIS

#include <tk.h>
int
Tk_ParseArgv(interp, tkwin, argcPtr, argv, argTable, flags)

### 引数 ARGUMENTS

Tcl_Interp *interp (入力in)
  不都合伝言文の返却に使用する解釈実行機能｡ Interpreter to use for returning error messages.

Tk_Window tkwin (入力in)
  引数が Tk 指示項目を指定する時に使う窓｡もし NULL,であると Tk 指示項目は処理されない｡ Window to use when arguments specify Tk options. If NULL, then no Tk options will be processed.

int argcPtr (入出力in/out)
  argv 内の引数の個数へのポインタ; 呼出した後に未処理の引数の個数を保有する為に修正される｡ Pointer to number of arguments in argv; gets modified to hold number of unprocessed arguments that remain after the call.

const char **argv (入出力in/out)
  主算譜に渡される命令行引数｡呼出し後に未処理の引数を保持する為に修正される｡ Command line arguments passed to main program. Modified to hold unprocessed arguments that remain after the call.

Tk_ArgvInfo *argTable (入力in)
  引数記述子の配列､TK_ARGV_END型の要素が終端になる｡　 Array of argument descriptors, terminated by element with type TK_ARGV_END.

int flags (入力in)
  もし非零の場合､引数の解析を制御する一つ或いはそれ以上の旗印を指し示す｡ 異なる旗印は互いに論理輪されても好い｡現在､定めている旗印は､TK_ARGV_DONT_SKIP_FIRST_ARG と TK_ARGV_NO_ABBREV と TK_ARGV_NO_LEFTOVERS と TK_ARGV_NO_DEFAULTSである｡ If non-zero, then it specifies one or more flags that control the parsing of arguments. Different flags may be OR'ed together. The flags currently defined are TK_ARGV_DONT_SKIP_FIRST_ARG, TK_ARGV_NO_ABBREV, TK_ARGV_NO_LEFTOVERS, and TK_ARGV_NO_DEFAULTS.

### 説明 DESCRIPTION

Tk_ParseArgv は命令行の引数の配列を､期待されている引数の種類を記述している表に沿って処理する｡ argv 内のそれぞれの引数は順番に処理される: もしそれが argTable 内の一つの見出しに合致する場合､その引数はあの見出しに沿って処理されそして遺棄される｡どの argTable にも合致しない引数はargv の最初に書き写され(元々の順を保って)呼出し側に返される｡その呼び出しの終わりに Tk_ParseArgv は argv 内に残された引数の数を保持する為に *argcPtr を設定する､又､ argv[*argcPtr] は値 NULL.を保持する｡通常 Tk_ParseArgv は argv[0] が命令名であると仮定するので､それは引数の様に扱われるがそれは argTable に合致せず呼出し側に戻される; しかし､もし TK_ARGV_DONT_SKIP_FIRST_ARG ビットが flags 内に設定されていると､ argv[0] は argv の他の要素の如く処理される｡ Tk_ParseArgv processes an array of command-line arguments according to a table describing the kinds of arguments that are expected. Each of the arguments in argv is processed in turn: if it matches one of the entries in argTable, the argument is processed according to that entry and discarded. The arguments that do not match anything in argTable are copied down to the beginning of argv (retaining their original order) and returned to the caller. At the end of the call Tk_ParseArgv sets *argcPtr to hold the number of arguments that are left in argv, and argv[*argcPtr] will hold the value NULL. Normally, Tk_ParseArgv assumes that argv[0] is a command name, so it is treated like an argument that does not match argTable and returned to the caller; however, if the TK_ARGV_DONT_SKIP_FIRST_ARG bit is set in flags then argv[0] will be processed just like the other elements of argv.

Tk_ParseArgv は通常値 TCL_OK を返す｡もし引数を解析している間に不都合が生じると､ TCL_ERROR が返され､そして､ Tk_ParseArgv は不都合伝言文を標準的 Tcl 方式で解釈実行機能 interp の結果内に残す｡不都合を返す行事内で､ *argvPtr は修正されないが､ argv は部分的に修正されるかもしれない｡不都合を引起す可能性は下に説明される｡ Tk_ParseArgv normally returns the value TCL_OK. If an error occurs while parsing the arguments, then TCL_ERROR is returned and Tk_ParseArgv will leave an error message in the result of interpreter interp in the standard Tcl fashion. In the event of an error return, *argvPtr will not have been modified, but argv could have been partially modified. The possible causes of errors are explained below.

その argTable 配列は期待されている引数の種類を指定する; それぞれの見出しは次の構造を有する: The argTable array specifies the kinds of arguments that are expected; each of its entries has the following structure:

    typedef struct {
        const char *key;
        int type;
        char *src;
        char *dst;
        const char *help;
    } Tk_ArgvInfo;

その key 欄は “-display” や “-bg” の様な文字列であり､ argv.内の値と比較される｡ Type は key に合致する引数が如何に処理されるかを指し示す(更なる事は下に)｡ Src と dst は引数の処理に使われる追加的な値である｡その厳格な用途は type,に依存するが､典型的には src は値を指し示し､ dst は値を保存する場所を指し示す｡ src and dst の為の char * 宣言は記入子である: 実際の型は異なっているかもしれない｡最後に､ help はこの指示項目の簡単な記述を与える文字列である; この文字列は使用者が命令行指示項目について補助を求めた時に印刷される｡ The key field is a string such as “-display” or “-bg” that is compared with the values in argv. Type indicates how to process an argument that matches key (more on this below). Src and dst are additional values used in processing the argument. Their exact usage depends on type, but typically src indicates a value and dst indicates where to store the value. The char * declarations for src and dst are placeholders: the actual types may be different. Lastly, help is a string giving a brief description of this option; this string is printed when users ask for help about command-line options.

argv,内の引数を処理している時､ Tk_ParseArgv は引数を argTable.内のそれぞれの key's と比較する｡Tk_ParseArgv はその key が厳密に引数に合致する指定子が実在する場合､その最初の指示項目を選択する｡そうでない場合､ Tk_ParseArgv はそのための引数が唯一の短縮形である指定子を選択する｡もし引数が複数の指定子の唯一の短縮形である場合､不都合が返される｡もし argTable 内に合致する見出しがない場合､引数は飛越され呼出し者に返される｡ When processing an argument in argv, Tk_ParseArgv compares the argument to each of the key's in argTable. Tk_ParseArgv selects the first specifier whose key matches the argument exactly, if such a specifier exists. Otherwise Tk_ParseArgv selects a specifier for which the argument is a unique abbreviation. If the argument is a unique abbreviation for more than one specifier, then an error is returned. If there is no matching entry in argTable, then the argument is skipped and returned to the caller.

一度合致する引数が見付ると､ Tk_ParseArgv は指定子の type 欄に沿った引数を処理する｡ key に合致した引数は下に記述するように “合致する引数” と呼ばれる｡処理の一部として､ Tk_ParseArgv は引数の合致の後に argv 内の次の引数を使うかもしれない､それは “次の引数” と呼ばれる｡ type,に関する適正な値と､それが引起す処理は次の通り: Once a matching argument specifier is found, Tk_ParseArgv processes the argument according to the type field of the specifier. The argument that matched key is called “the matching argument” in the descriptions below. As part of the processing, Tk_ParseArgv may also use the next argument in argv after the matching argument, which is called “the following argument”. The legal values for type, and the processing that they cause, are as follows:

TK_ARGV_END
  表の末尾に印を附ける｡ argTable の最後の見出しはこの型を有さねばならない; その他の全ての欄は無視され､どの引数にも合致する事はない｡ Marks the end of the table. The last entry in argTable must have this type; all of its other fields are ignored and it will never match any arguments.

TK_ARGV_CONSTANT
  Src は整数として扱われ､ dst は整数へのポインターとして扱われる｡Src は *dst の箇所に保存される｡合致する引数は遺棄される｡ Src is treated as an integer and dst is treated as a pointer to an integer. Src is stored at *dst. The matching argument is discarded.

TK_ARGV_INT
  次の引数は strtol に受入れられ得る形式の整数文字列を含まなければならない(譬えば､それぞれ八進と十六進数を指定する “0” と “0x” 前置辞が使われるかもしれない)｡ Dst は整数のポインターとして扱われる; 次の引数は､整数に変換され､ *dst.の箇所に保存される｡ Src は無視される｡合致と次の引数は argv.から遺棄される｡ The following argument must contain an integer string in the format accepted by strtol (e.g. “0” and “0x” prefixes may be used to specify octal or hexadecimal numbers, respectively). Dst is treated as a pointer to an integer; the following argument is converted to an integer value and stored at *dst. Src is ignored. The matching and following arguments are discarded from argv.

TK_ARGV_FLOAT
  続きの引数は strtol.に受入れられる形式の浮動小数を含まねばならない｡ Dst は倍精度浮動小数点値の番地として扱われる; 次の引数は､倍精度浮動小数値に変換され､ *dst の箇所に保存される｡合致と次の引数は argv から遺棄される｡ The following argument must contain a floating-point number in the format accepted by strtol. Dst is treated as the address of a double-precision floating point value; the following argument is converted to a double-precision value and stored at *dst. The matching and following arguments are discarded from argv.

TK_ARGV_STRING
  この形式では dst は (char *) へのポインターとして扱われる; Tk_ParseArgv は *dst の箇所に次の引数のポインターを保存する､亦､合致と次の引数は argv から遺棄される｡ Src は無視される｡ In this form, dst is treated as a pointer to a (char *); Tk_ParseArgv stores at *dst a pointer to the following argument, and discards the matching and following arguments from argv. Src is ignored.

TK_ARGV_UID
  この形式は TK_ARGV_STRING, に似ているが､違いは､ Tk_GetUid.を呼ぶことにより､その引数が Tk_Uid に変えられることである｡ Dst はTk_Uid へのポインターとして扱われる; Tk_ParseArgv は *dst の箇所に次の引数に相当する Tk_Uid を保存する､亦合致と次の引数は argv.から遺棄される｡ Src は無視される｡ This form is similar to TK_ARGV_STRING, except that the argument is turned into a Tk_Uid by calling Tk_GetUid. Dst is treated as a pointer to a Tk_Uid; Tk_ParseArgv stores at *dst the Tk_Uid corresponding to the following argument, and discards the matching and following arguments from argv. Src is ignored.

TK_ARGV_CONST_OPTION
  この形式は Tk 指示項目の設定を引起す(恰も option 命令が起動されたかの如く)｡ src 欄は指示項目の値に与えられた文字列へのポインターとして扱われる､亦､ dst が指示項目の名前へのポインターとして扱われる｡合致する引数は遺棄される｡もし tkwin が NULL であると､この型の引数指定子は無視される(恰もそれが実在しないかの如く)｡ This form causes a Tk option to be set (as if the option command had been invoked). The src field is treated as a pointer to a string giving the value of an option, and dst is treated as a pointer to the name of the option. The matching argument is discarded. If tkwin is NULL, then argument specifiers of this type are ignored (as if they did not exist).

TK_ARGV_OPTION_VALUE
  この形式は TK_ARGV_CONST_OPTION,に似ているが､違いは指示項目の値は src から取る代りに次の引数としてから取る｡ Dst は指示項目の名前として使われる｡ Src は無視される｡合致と次の引数は遺棄される｡もし tkwin が NULL であると､型の引数指定子は無視される(恰もそれが実在しないかの如く)｡ This form is similar to TK_ARGV_CONST_OPTION, except that the value of the option is taken from the following argument instead of from src. Dst is used as the name of the option. Src is ignored. The matching and following arguments are discarded. If tkwin is NULL, then argument specifiers of this type are ignored (as if they did not exist).

TK_ARGV_OPTION_NAME_VALUE
  この場合次の引数が Tk 指示項目の名前として取られる､亦この後の引数はその指示項目の為の値と看做される｡ src と dst は両方とも無視される｡全ての三つの引数は argv から棄却される｡もし tkwin が NULL の場合､この型の引数指定子は無視される(恰もそれが実在しないかの如く)｡ In this case the following argument is taken as the name of a Tk option and the argument after that is taken as the value for that option. Both src and dst are ignored. All three arguments are discarded from argv. If tkwin is NULL, then argument specifiers of this type are ignored (as if they did not exist).

TK_ARGV_HELP
  この種の指示項目に遭遇した時､ Tk_ParseArgv は全ての適正な引数を記述した伝言文を書式化する為の argTable の help 欄を使う｡その伝言文は解釈実行機能 interp 内の結果に置かれ､亦､ Tk_ParseArgv は TCL_ERROR を返す｡之が生じた時､呼出し側は通常､説明伝言文を印刷し中断する｡もし､ TK_ARGV_HELP 指定子の key 欄が NULL の場合､指定子はどの引数にも合致することはない; この場合､指定子は単に臨時の説明を提供し､それは､何か他の TK_ARGV_HELP の見出しが返される補助情報を引起す時に含まれる｡ When this kind of option is encountered, Tk_ParseArgv uses the help fields of argTable to format a message describing all the valid arguments. The message is placed in interpreter interp's result and Tk_ParseArgv returns TCL_ERROR. When this happens, the caller normally prints the help message and aborts. If the key field of a TK_ARGV_HELP specifier is NULL, then the specifier will never match any arguments; in this case the specifier simply provides extra documentation, which will be included when some other TK_ARGV_HELP entry causes help information to be returned.

TK_ARGV_REST
  この指示項目は､最後の幾つかの指示項目が､幾つかの他の算譜の為の 名前 且つ/又は 指示項目 である事を許容する様な､算譜或は命令によって使われる｡もし､TK_ARGV_REST 引数が発見されると､ Tk_ParseArgv はどの残りの引数をも処理しない; それは､最初の時点の全ての argv を返す(他の未処理の引数に沿って)｡更に､ Tk_ParseArgv は､ dst を整数値の番地として扱い､返された argv.内の最初の TK_ARGV_REST 指示項目の索引である *dst の箇所に保存する｡之は算譜に､ TK_ARGV_REST に先行する未処理指示項目から TK_ARGV_REST を区別することを許容する｡ This option is used by programs or commands that allow the last several of their options to be the name and/or options for some other program. If a TK_ARGV_REST argument is found, then Tk_ParseArgv does not process any of the remaining arguments; it returns them all at the beginning of argv (along with any other unprocessed arguments). In addition, Tk_ParseArgv treats dst as the address of an integer value, and stores at *dst the index of the first of the TK_ARGV_REST options in the returned argv. This allows the program to distinguish the TK_ARGV_REST options from other unprocessed options that preceded the TK_ARGV_REST.

TK_ARGV_FUNC
  この種の引数について src は手続函数の番地として扱われる､その手続函数は次の引数を処理する為に起動される｡その手続函数は次の構造を有する: For this kind of argument, src is treated as the address of a procedure, which is invoked to process the following argument. The procedure should have the following structure:

      int
      func(dst, key, nextArg)
          char *dst;
          char *key;
          char *nextArg;
      {
      }

  dst と key 假引数は argTable の位置に対応する欄を含む､そして nextArg は argv から続きの引数を指す(又は argv 内に更なる引数が何もない場合は NULL )｡もし func が nextArg を使う場合(従って､ Tk_ParseArgv はそれを棄却するであろう)､ 1 を返すべきである｡そうでない場合､ 0 を返し､ TkParseArgv は続く引数を通常の方式で処理する｡両方の行事とも､合致する引数は棄却される｡ The dst and key parameters will contain the corresponding fields from the argTable entry, and nextArg will point to the following argument from argv (or NULL if there are not any more arguments left in argv). If func uses nextArg (so that Tk_ParseArgv should discard it), then it should return 1. Otherwise it should return 0 and TkParseArgv will process the following argument in the normal fashion. In either event the matching argument is discarded.

TK_ARGV_GENFUNC
  この形式はより一般的な手続き的例外処理を提供する｡それは src を手続函数の番地として扱い､全ての残りの引数を手続函数に渡す｡手続函数は次の形式を有するべきである: This form provides a more general procedural escape. It treats src as the address of a procedure, and passes that procedure all of the remaining arguments. The procedure should have the following form:

      int
      genfunc(dst, interp, key, argc, argv)
          char *dst;
          Tcl_Interp *interp;
          char *key;
          int argc;
          char **argv;
      {
      }

  dst and key 假引数は argTable の位置に対応する欄を含む｡ interp は Tcl_ParseArgv.への interp 引数と同じである｡ Argc と argv は指示項目に合致した後､全ての指示項目を参照する｡ Genfunc は Tk_ParseArgv に似た方式で振舞う: 可能な限り残りの多くの引数を解析する､次に argv の初め( argv[0] から始まる)への集約の残りのどれかが返される｡ Genfunc は argv 内に幾つの引数が残されているかの個数を返す; Tk_ParseArgv がそれを処理する｡もし genfunc が不都合に遭遇した場合､通常の Tcl の方式で解釈実行機能 interpの 内の結果に不都合伝言文を残し -1;を返す､もしそれが起ると､ Tk_ParseArgv はその処理を中断し TCL_ERROR を返す｡ The dst and key parameters will contain the corresponding fields from the argTable entry. Interp will be the same as the interp argument to Tcl_ParseArgv. Argc and argv refer to all of the options after the matching one. Genfunc should behave in a fashion similar to Tk_ParseArgv: parse as many of the remaining arguments as it can, then return any that are left by compacting them to the beginning of argv (starting at argv[0]). Genfunc should return a count of how many arguments are left in argv; Tk_ParseArgv will process them. If genfunc encounters an error then it should leave an error message in interpreter interp's result, in the usual Tcl fashion, and return -1; when this happens Tk_ParseArgv will abort its processing and return TCL_ERROR.

#### FLAGS

TK_ARGV_DONT_SKIP_FIRST_ARG
  通常 Tk_ParseArgv は argv[0] を算譜か命令の名前として取扱い､恰も argTable とは合致しなかったかの如く呼出し側に返す｡もしこの旗印が設定されていると argv[0] は特別の扱いは与えられない｡ Tk_ParseArgv normally treats argv[0] as a program or command name, and returns it to the caller just as if it had not matched argTable. If this flag is given, then argv[0] is not given special treatment.

TK_ARGV_NO_ABBREV
  通常 Tk_ParseArgv は argTable 内の key 値について唯一の短縮形を受入れる｡もしこの旗印が与えられると､厳密一致のみが受入れられる｡ Normally, Tk_ParseArgv accepts unique abbreviations for key values in argTable. If this flag is given then only exact matches will be acceptable.

TK_ARGV_NO_LEFTOVERS
  通常 Tk_ParseArgv は認識できない引数を呼出し側に返す｡もしこのビットが flags 内に設定されていると､ Tk_ParseArgv は argTable と合致しない場合､不都合を返す｡この規則の唯一の例外は argv[0] であり､それは､ TK_ARGV_DONT_SKIP_FIRST_ARG が指定されていない限り呼出し側に不都合無しを返す｡ Normally, Tk_ParseArgv returns unrecognized arguments to the caller. If this bit is set in flags then Tk_ParseArgv will return an error if it encounters any argument that does not match argTable. The only exception to this rule is argv[0], which will be returned to the caller with no errors as long as TK_ARGV_DONT_SKIP_FIRST_ARG is not specified.

TK_ARGV_NO_DEFAULTS
  通常 Tk_ParseArgv は argTable.に加えて､標準引数指定子の内部表を捜索する｡もしこのビットが flags 内に設定されている場合､ Tk_ParseArgv は argTable のみを使い省略時設定表を使わない｡ Normally, Tk_ParseArgv searches an internal table of standard argument specifiers in addition to argTable. If this bit is set in flags, then Tk_ParseArgv will use only argTable and not its default table.

### 実施例 EXAMPLE

此処にある例は argTable の定義と幾らかの指示項目を使う命令行の例である｡註意すべきは argc と argv の効果である; Tk_ParseArgv によって処理される引数は argv,から取除かれ､ argc は引数の個数を減らす為に更新される｡ Here is an example definition of an argTable and some sample command lines that use the options. Note the effect on argc and argv; arguments processed by Tk_ParseArgv are eliminated from argv, and argc is updated to reflect reduced number of arguments.

    /*
     * Define and set default values for globals.
     */
    int debugFlag = 0;
    int numReps = 100;
    char defaultFileName[] = "out";
    char *fileName = defaultFileName;
    Boolean exec = FALSE;

    /*
     * Define option descriptions.
     */
    Tk_ArgvInfo argTable[] = {
        {"-X", TK_ARGV_CONSTANT, (char *) 1, (char *) &debugFlag,
            "Turn on debugging printfs"},
        {"-N", TK_ARGV_INT, NULL, (char *) &numReps,
            "Number of repetitions"},
        {"-of", TK_ARGV_STRING, NULL, (char *) &fileName,
            "Name of file for output"},
        {"x", TK_ARGV_REST, NULL, (char *) &exec,
            "File to exec, followed by any arguments (must be last argument)."},
        {NULL, TK_ARGV_END, NULL, NULL,
            NULL}
    };

    main(argc, argv)
        int argc;
        char *argv[];
    {
        	...

        if (Tk_ParseArgv(interp, tkwin, &argc, argv, argTable, 0) != TCL_OK) {
            fprintf(stderr, "%s\n", Tcl_GetString(Tcl_GetObjResult(interp)));
            exit(1);
        }

        /*
         * Remainder of the program.
         */
    }

註意すべきは省略時設定値は argTable 内の変数の名前に代入され得る: もし特定の引数が argv 内に存在する場合､その変数は上書きされるだけである｡此処にある用例は命令行とその効果である｡ Note that default values can be assigned to variables named in argTable: the variables will only be overwritten if the particular arguments are present in argv. Here are some example command lines and their effects.

    prog -N 200 infile        # just sets the numReps variable to 200
    prog -of out200 infile    # sets fileName to reference "out200"
    prog -XN 10 infile        # sets the debug flag, also sets numReps

全ての上の用例では argc は Tk_ParseArgv により 2 に､ argv[0] は “prog” に､ argv[1] は “infile” に､ argv[2] は NULL.に設定される｡ In all of the above examples, argc will be set by Tk_ParseArgv to 2, argv[0] will be “prog”, argv[1] will be “infile”, and argv[2] will be NULL.

### KEYWORDS

arguments, command line, options
Copyright © 1990-1992 The Regents of the University of California.
Copyright © 1994-1996 Sun Microsystems, Inc.