php 용 getopt 함수 (shell mode)

뭐 pear 의 System.php 에 getopt 가 있기는 하지만.. 좀 다른 방식으로 구현을 해서 사용하는 코드 입니다. 이 함수는 원래 예전에 rrdexec 를 만들 때 glibc 의 getopt 를 사용했다가, rrdtool API 가 전부 내부적으로 getopt 를 사용하는 바람에 눈물을 머금고 하나 만들었던 것인데, 유용해서 C version/PHP version/Perl Version 용으로 만들어서 사용하는 놈입니다.

아래의 코드는 안녕의 Packages System 에서 사용하는 예제입니다.

function getopt_lib ( $no, $arry, $optstrs ) {
  global $gno, $optcno, $optarg, $optcmd, $longopt;

  if ( $gno < 0 ) $gno = 1;
  if ( $optcno < 0 ) $optcno = 0;
  while ( 1 ) {
    if ( $gno == $no ) return -1;
    /* case by long option */
    if ( preg_match ( "/^--[a-z]/i", $arry[$gno] ) ) {
      $longops = explode ('=', $arry[$gno]);
      $longname = trim (str_replace ('--', '', $longops[0]));
      $optarg = trim ($longops[1]);

      $opt = $longopt[$longname];

      if ( ! $opt ) {
        printf ("ERROR: option --%s don't support\n", $longname);
        usage ();
      }

      if ( preg_match ("/{$opt}:/", $optstrs) ) {
        $optarg = $optarg ? $optarg : $arry[$gno + 1];
        if ( ! trim ($optarg) ) {
          printf ("ERROR: option --%s must need values\n", $longname);
          uasge ();
        }

        if ( ! preg_match ('/=/', $arry[$gno]) ) $gno++;
      }
      break;
    /* case by short option */
    } else if ( preg_match ( "/^-[a-z]/i", $arry[$gno] ) ) {
      if ( $arry[$gno][2] ) {
        printf ("ERROR: option %s don't support\n", $arry[$gno]);
        usage ();
      }

      $opt = $arry[$gno][1];

      if ( preg_match ("/{$arry[$gno][1]}:/", $optstrs) ) {
        $optarg = $arry[$gno + 1];

        if ( ! trim ($optarg) ) {
          printf ("ERROR: option -%s must need values\n", $opt);
          usage ();
        }

        $gno++;
      } else {
        $tmp = preg_replace ('/[a-z]:/i', '', $optstrs);
        $tlen = strlen ($tmp);

        $_optok = 0;
        for ($i=0; $i<$tlen; $i++) {
          if ( $tmp[$i] == $opt ) {
            $_optok = 1;
            break;
          }
        }

        if ( ! $_optok ) {
        printf ("ERROR: option -%s don't support\n", $opt);
        usage ();
        }
      }
      break;
    /* case by command arg */
    } else {
      if ( $arry[$gno] == '--' ) {
        printf ("ERROR: - is unknown option\n");
        usage ();
      }

      $optcmd[$optcno] = $arry[$gno];
      $optcno++;
      $gno++;
      continue;
    }
  }
  
  $gno++;
  
  return $opt;
}

사용법은 glibc 에 있는 getopt 와 비슷합니다. long 옵션을 사용할 경우에는 $longopt = array(); 로 지정하여 사용할 수 있습니다. 뭐 예제 코드를 보는 것이 가장 간단하겠죠.

# usage 함수 정의 (getopt_lib 에서 사용하므로..)
function usage () {
  echo "USAGE: $0 [option] [cmdarg]\n";
  exit (1);
}

# 전역 변수 초기화
$gno    = -1;
$optcno = -1;

# long optiong 을 short option 에 매핑
$longopt = array (
  'getvalue'        => 'g',
  'nogetvalue'    => 'h'
);

# option variavles 초기화
$getvalue = "";
$nogetvalue = 0;

# g 옵션을 옵션 값이 있어야 하며, n 옵션은 옵션 값이 필요 없음
while ( ($opt = getopt_lib ($argc, $argv, 'g:n')) != -1 ) {
  switch ($opt) {
    case 'g' :
      /* 옵션의 값이 있는 경우 */
      $getvalue = $optarg;
      break; 
    case 'n' :
      /* 옵션의 값이 없는 경우 */
      $nogetvalue = 1;
      break;
    default :
      usage();
  }
}

# 옵션을 처리한 후에 command line argument 가 없으면 에러 처리
if ( $optcno < 1 ) usage ();

echo "OPTION debugging\n";
echo "--------------------------------------------------\n";
echo "-g (getvalue) option value     => $getvalue\n";
echo "-n (nogetvalue) option value   => $nogetvalue\n\n";

echo "Command Line Arguments\n";
echo "--------------------------------------------------\n";
foreach ( $optcmd as $_v )
  echo "CMDARG: $_v\n";

대충 getopt 를 사용하시는 분들은 거의 사용법이 비슷하다는 것을 알 수 있을 겁니다. 다만, 기존의 getopt 와 다른 점이라면 기존의 getopt 는 옵션을 처리한 후에, argv 배열을 재배열 하는데 이 함수는 $optcmd 라는 배열로 리턴을 합니다.
또한, 옵션값을 처리할 경우에는 while 루프 안에서 $optarg 라는 변수를 사용한다는 것이죠.

위의 코드의 결과를 보자면 아래 정도가 될 겁니다.

[oops@main tmp]$ ./a.php -g "값이 있어요" -n arg1 arg2 arg3
OPTION debugging
--------------------------------------------------
-g (getvalue) option value     => 값이 있어요
-n (nogetvalue) option value   => 1

Command Line Arguments
--------------------------------------------------
CMDARG: arg1
CMDARG: arg2
CMDARG: arg3

[oops@main tmp]$ ./a.php -g arg1
USAGE: $0 [option] [cmdarg]

이 경우는 -g 옵션의 경우 옵션 값이 있어야 하는데 command argument 가 -g 의 옵션값으로 대입이 되어 command line argument 수 $optcno 가 0 이 되어 에러가 발생합니다. 반대 급부로

[oops@main tmp]$ ./a.php -g 옵션값
USAGE: $0 [option] [cmdarg]

도 마찬가지가 됩니다.

long 옵션의 사용 경우에는 다음과 같이 할 수 있습니다.

[oops@main tmp]$ ./a.php --getvalue "값이 있어요" -n arg1 arg2 arg3
[oops@main tmp]$ ./a.php --getvluae="값이 있어요" -n arg1 arg2 arg3

두가지 방법이 모두 가능합니다. 단 short option 처리시에는 -[옵션][옵션값] 과 같이 short option 과 option value 를 붙여 쓰지는 못합니다.

마지막으로 command line argument 와 option 을 순서가 뒤바뀌어도 상관 없습니다.

[oops@main tmp]$ ./a.php -n arg1 --g "값이 있어요"  arg2 arg3

Perl 용을 원하신다면 byspam 소스 코드 안에 보면 Getopt.pm 인가로 패키지화를 해 놓았으니 이것도 편하게 사용하실 수 있을 겁니다.