tests/PHPUnit/Util/Getopt.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.0.0
  45  */
  46
  47 require_once 'PHPUnit/Util/Filter.php';
  48
  49 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  50
  51 /**
  52  * Command-line options parsing class.
  53  *
  54  * @category   Testing
  55  * @package    PHPUnit
  56  * @author     Andrei Zmievski <andrei@php.net>
  57  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  58  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  59  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  60  * @version    Release: 3.3.17
  61  * @link       http://www.phpunit.de/
  62  * @since      Class available since Release 3.0.0
  63  * @abstract
  64  */
  65 class PHPUnit_Util_Getopt {
  66     public static function getopt(array $args, $short_options, $long_options = NULL)
  67     {
  68         if (empty($args)) {
  69             return array(array(), array());
  70         }
  71
  72         $opts     = array();
  73         $non_opts = array();
  74
  75         if ($long_options) {
  76             sort($long_options);
  77         }
  78
  79         if (isset($args[0]{0}) && $args[0]{0} != '-') {
  80             array_shift($args);
  81         }
  82
  83         reset($args);
  84
  85         while (list($i, $arg) = each($args)) {
  86             if ($arg == '--') {
  87                 $non_opts = array_merge($non_opts, array_slice($args, $i + 1));
  88                 break;
  89             }
  90
  91             if ($arg{0} != '-' || (strlen($arg) > 1 && $arg{1} == '-' && !$long_options)) {
  92                 $non_opts = array_merge($non_opts, array_slice($args, $i));
  93                 break;
  94             }
  95
  96             elseif (strlen($arg) > 1 && $arg{1} == '-') {
  97                 self::parseLongOption(substr($arg, 2), $long_options, $opts, $args);
  98             }
  99
 100             else {
 101                 self::parseShortOption(substr($arg, 1), $short_options, $opts, $args);
 102             }
 103         }
 104
 105         return array($opts, $non_opts);
 106     }
 107
 108     protected static function parseShortOption($arg, $short_options, &$opts, &$args)
 109     {
 110         $argLen = strlen($arg);
 111
 112         for ($i = 0; $i < $argLen; $i++) {
 113             $opt = $arg{$i};
 114             $opt_arg = NULL;
 115
 116             if (($spec = strstr($short_options, $opt)) === FALSE || $arg{$i} == ':') {
 117                 throw new RuntimeException("unrecognized option -- $opt");
 118             }
 119
 120             if (strlen($spec) > 1 && $spec{1} == ':') {
 121                 if (strlen($spec) > 2 && $spec{2} == ':') {
 122                     if ($i + 1 < $argLen) {
 123                         $opts[] = array($opt, substr($arg, $i + 1));
 124                         break;
 125                     }
 126                 } else {
 127                     if ($i + 1 < $argLen) {
 128                         $opts[] = array($opt, substr($arg, $i + 1));
 129                         break;
 130                     }
 131
 132                     else if (list(, $opt_arg) = each($args)) {
 133                     }
 134
 135                     else {
 136                         throw new RuntimeException("option requires an argument -- $opt");
 137                     }
 138                 }
 139             }
 140
 141             $opts[] = array($opt, $opt_arg);
 142         }
 143     }
 144
 145     protected static function parseLongOption($arg, $long_options, &$opts, &$args)
 146     {
 147         @list($opt, $opt_arg) = explode('=', $arg);
 148         $opt_len = strlen($opt);
 149
 150         for ($i = 0; $i < count($long_options); $i++) {
 151             $long_opt  = $long_options[$i];
 152             $opt_start = substr($long_opt, 0, $opt_len);
 153
 154             if ($opt_start != $opt) continue;
 155
 156             $opt_rest = substr($long_opt, $opt_len);
 157
 158             if ($opt_rest != '' && $opt{0} != '=' &&
 159                 $i + 1 < count($long_options) &&
 160                 $opt == substr($long_options[$i+1], 0, $opt_len)) {
 161                 throw new RuntimeException("option --$opt is ambiguous");
 162             }
 163
 164             if (substr($long_opt, -1) == '=') {
 165                 if (substr($long_opt, -2) != '==') {
 166                     if (!strlen($opt_arg) && !(list(, $opt_arg) = each($args))) {
 167                         throw new RuntimeException("option --$opt requires an argument");
 168                     }
 169                 }
 170             }
 171
 172             else if ($opt_arg) {
 173                 throw new RuntimeException("option --$opt doesn't allow an argument");
 174             }
 175
 176             $opts[] = array('--' . $opt, $opt_arg);
 177             return;
 178         }
 179
 180         throw new RuntimeException("unrecognized option --$opt");
 181     }
 182 }
 183 ?>