home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / gnu / man / cat3 / getsubopt.0 < prev    next >
Text File  |  1993-12-07  |  4KB  |  133 lines
  1.  
  2. GETSUBOPT(3)               UNIX Programmer's Manual               GETSUBOPT(3)
  3.  
  4. NNAAMMEE
  5.      ggeettssuubboopptt - get sub options from an argument
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssttddiioo..hh>>
  9.  
  10.      _i_n_t
  11.      ggeettssuubboopptt(_c_h_a_r _*_*_o_p_t_i_o_n_p, _c_h_a_r _* _c_o_n_s_t _*_t_o_k_e_n_s, _c_h_a_r _*_*_v_a_l_u_e_p)
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.      The ggeettssuubboopptt() parses a string containing tokens delimited by one or
  15.      more tab, space or comma (`,') characters.  It is intended for use in
  16.      parsing groups of option arguments provided as part of a utility command
  17.      line.
  18.  
  19.      The argument _o_p_t_i_o_n_p is a pointer to a pointer to the string.  The argu­
  20.      ment _t_o_k_e_n_s is a pointer to a NULL­terminated array of pointers to
  21.      strings.
  22.  
  23.      The ggeettssuubboopptt() function returns the zero­based offset of the pointer in
  24.      the _t_o_k_e_n_s array referencing a string which matches the first token in
  25.      the string, or, -1 if the string contains no tokens or _t_o_k_e_n_s does not
  26.      contain a matching string.
  27.  
  28.      If the token is of the form ``name=value'', the location referenced by
  29.      _v_a_l_u_e_p will be set to point to the start of the ``value'' portion of the
  30.      token.
  31.  
  32.      On return from ggeettssuubboopptt(), _o_p_t_i_o_n_p will be set to point to the start of
  33.      the next token in the string, or the null at the end of the string if no
  34.      more tokens are present.  The external variable _s_u_b_o_p_t_a_r_g will be set to
  35.      point to the start of the current token, or NULL if no tokens were pre­
  36.      sent.  The argument _v_a_l_u_e_p will be set to point to the ``value'' portion
  37.      of the token, or NULL if no ``value'' portion was present.
  38.  
  39. EEXXAAMMPPLLEE
  40.      char *tokens[] = {
  41.              #define ONE     0
  42.                      "one",
  43.              #define TWO     1
  44.                      "two",
  45.              NULL
  46.      };
  47.  
  48.      ...
  49.  
  50.      extern char *optarg, *suboptarg;
  51.      char *options, *value;
  52.  
  53.      while ((ch = getopt(argc, argv, "ab:")) != -1) {
  54.              switch(ch) {
  55.              case 'a':
  56.                      /* process ``a'' option */
  57.                      break;
  58.              case 'b':
  59.                      options = optarg;
  60.                      while (*options) {
  61.                              switch(getsubopt(&options, tokens, &value)) {
  62.                              case ONE:
  63.                                      /* process ``one'' sub option */
  64.                                      break;
  65.                              case TWO:
  66.                                      /* process ``two'' sub option */
  67.                                      if (!value)
  68.                                              error("no value for two");
  69.                                      i = atoi(value);
  70.                                      break;
  71.                              case -1:
  72.                                      if (suboptarg)
  73.                                              error("illegal sub option %s",
  74.                                                suboptarg);
  75.                                      else
  76.                                              error("missing sub option");
  77.                                      break;
  78.                      }
  79.                      break;
  80.              }
  81.  
  82. SSEEEE AALLSSOO
  83.      getopt(3),  strsep(3)
  84.  
  85. HHIISSTTOORRYY
  86.      The ggeettssuubboopptt() function is currently under development.
  87.  
  88. BSD Experimental                 July 31, 1991                               2
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.