1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153 |
- <?php
- /**
- * Command-line interface parser that will make you smile.
- *
- * - http://docopt.org
- * - Repository and issue-tracker: https://github.com/docopt/docopt.php
- * - Licensed under terms of MIT license (see LICENSE-MIT)
- * - Copyright (c) 2013 Vladimir Keleshev, vladimir@keleshev.com
- * Blake Williams, <code@shabbyrobe.org>
- */
- namespace
- {
- class Docopt
- {
- /**
- * API compatibility with python docopt
- */
- static function handle($doc, $params=array())
- {
- $argv = null;
- if (isset($params['argv'])) {
- $argv = $params['argv'];
- unset($params['argv']);
- }
- elseif (is_string($params)) {
- $argv = $params;
- $params = array();
- }
- $h = new \Docopt\Handler($params);
- return $h->handle($doc, $argv);
- }
- }
- }
- namespace Docopt
- {
- /**
- * Return true if all cased characters in the string are uppercase and there is
- * at least one cased character, false otherwise.
- * Python method with no knowrn equivalent in PHP.
- */
- function is_upper($string)
- {
- return preg_match('/[A-Z]/', $string) && !preg_match('/[a-z]/', $string);
- }
- /**
- * Return True if any element of the iterable is true. If the iterable is empty, return False.
- * Python method with no known equivalent in PHP.
- */
- function any($iterable)
- {
- foreach ($iterable as $element) {
- if ($element)
- return true;
- }
- return false;
- }
- /**
- * The PHP version of this doesn't support array iterators
- */
- function array_filter($input, $callback, $reKey=false)
- {
- if ($input instanceof \ArrayIterator)
- $input = $input->getArrayCopy();
- $filtered = \array_filter($input, $callback);
- if ($reKey) $filtered = array_values($filtered);
- return $filtered;
- }
- /**
- * The PHP version of this doesn't support array iterators
- */
- function array_merge()
- {
- $values = func_get_args();
- $resolved = array();
- foreach ($values as $v) {
- if ($v instanceof \ArrayIterator)
- $resolved[] = $v->getArrayCopy();
- else
- $resolved[] = $v;
- }
- return call_user_func_array('array_merge', $resolved);
- }
- function ends_with($str, $test)
- {
- $len = strlen($test);
- return substr_compare($str, $test, -$len, $len) === 0;
- }
- function get_class_name($obj)
- {
- $cls = get_class($obj);
- return substr($cls, strpos($cls, '\\')+1);
- }
- function dumpw($val)
- {
- echo dump($val);
- echo PHP_EOL;
- }
- function dump($val)
- {
- $out = "";
- if (is_array($val) || $val instanceof \Traversable) {
- $out = '[';
- $cur = array();
- foreach ($val as $i) {
- if (is_object($i))
- $cur[] = $i->dump();
- elseif (is_array($i))
- $cur[] = dump($i);
- else
- $cur[] = dump_scalar($i);
- }
- $out .= implode(', ', $cur);
- $out .= ']';
- }
- else
- $out .=$val->dump();
- return $out;
- }
- function dump_scalar($scalar)
- {
- if ($scalar === null)
- return 'None';
- elseif ($scalar === false)
- return 'False';
- elseif ($scalar === true)
- return 'True';
- elseif (is_int($scalar) || is_float($scalar))
- return $scalar;
- else
- return "'$scalar'";
- }
- /**
- * Error in construction of usage-message by developer
- */
- class LanguageError extends \Exception
- {
- }
- /**
- * Exit in case user invoked program with incorrect arguments.
- * DocoptExit equivalent.
- */
- class ExitException extends \RuntimeException
- {
- public static $usage;
- public $status;
- public function __construct($message=null, $status=1)
- {
- parent::__construct(trim($message.PHP_EOL.static::$usage));
- $this->status = $status;
- }
- }
- class Pattern
- {
- public function __toString()
- {
- return serialize($this);
- }
- public function hash()
- {
- return crc32((string)$this);
- }
- public function fix()
- {
- $this->fixIdentities();
- $this->fixRepeatingArguments();
- return $this;
- }
- /**
- * Make pattern-tree tips point to same object if they are equal.
- */
- public function fixIdentities($uniq=null)
- {
- if (!isset($this->children) || !$this->children)
- return $this;
- if (!$uniq) {
- $uniq = array_unique($this->flat());
- }
- foreach ($this->children as $i=>$child) {
- if (!$child instanceof BranchPattern) {
- if (!in_array($child, $uniq)) {
- // Not sure if this is a true substitute for 'assert c in uniq'
- throw new \UnexpectedValueException();
- }
- $this->children[$i] = $uniq[array_search($child, $uniq)];
- }
- else {
- $child->fixIdentities($uniq);
- }
- }
- }
- /**
- * Fix elements that should accumulate/increment values.
- */
- public function fixRepeatingArguments()
- {
- $either = array();
- foreach (transform($this)->children as $child) {
- $either[] = $child->children;
- }
- foreach ($either as $case) {
- $counts = array();
- foreach ($case as $child) {
- $ser = serialize($child);
- if (!isset($counts[$ser]))
- $counts[$ser] = array('cnt'=>0, 'items'=>array());
- $counts[$ser]['cnt']++;
- $counts[$ser]['items'][] = $child;
- }
- $repeatedCases = array();
- foreach ($counts as $child) {
- if ($child['cnt'] > 1)
- $repeatedCases = array_merge($repeatedCases, $child['items']);
- }
- foreach ($repeatedCases as $e) {
- if ($e instanceof Argument || ($e instanceof Option && $e->argcount)) {
- if (!$e->value)
- $e->value = array();
- elseif (!is_array($e->value) && !$e->value instanceof \Traversable)
- $e->value = preg_split('/\s+/', $e->value);
- }
- if ($e instanceof Command || ($e instanceof Option && $e->argcount == 0))
- $e->value = 0;
- }
- }
- return $this;
- }
- public function name()
- {}
- public function __get($name)
- {
- if ($name == 'name')
- return $this->name();
- else
- throw new \BadMethodCallException("Unknown property $name");
- }
- }
- /**
- * Expand pattern into an (almost) equivalent one, but with single Either.
- *
- * Example: ((-a | -b) (-c | -d)) => (-a -c | -a -d | -b -c | -b -d)
- * Quirks: [-a] => (-a), (-a...) => (-a -a)
- */
- function transform($pattern)
- {
- $result = array();
- $groups = array(array($pattern));
- $parents = array('Required', 'Optional', 'OptionsShortcut', 'Either', 'OneOrMore');
- while ($groups) {
- $children = array_shift($groups);
- $types = array();
- foreach ($children as $c) {
- if (is_object($c)) {
- $types[get_class_name($c)] = true;
- }
- }
- if (array_intersect(array_keys($types), $parents)) {
- $child = null;
- foreach ($children as $currentChild) {
- if (in_array(get_class_name($currentChild), $parents)) {
- $child = $currentChild;
- break;
- }
- }
- unset($children[array_search($child, $children)]);
- $childClass = get_class_name($child);
- if ($childClass == 'Either') {
- foreach ($child->children as $c) {
- $groups[] = array_merge(array($c), $children);
- }
- }
- elseif ($childClass == 'OneOrMore') {
- $groups[] = array_merge($child->children, $child->children, $children);
- }
- else {
- $groups[] = array_merge($child->children, $children);
- }
- }
- else {
- $result[] = $children;
- }
- }
- $rs = array();
- foreach ($result as $e) {
- $rs[] = new Required($e);
- }
- return new Either($rs);
- }
- class LeafPattern extends Pattern
- {
- public function flat($types=array())
- {
- $types = is_array($types) ? $types : array($types);
- if (!$types || in_array(get_class_name($this), $types))
- return array($this);
- else
- return array();
- }
- public function match($left, $collected=null)
- {
- if (!$collected) $collected = array();
- list ($pos, $match) = $this->singleMatch($left);
- if (!$match)
- return array(false, $left, $collected);
- $left_ = $left;
- unset($left_[$pos]);
- $left_ = array_values($left_);
- $name = $this->name;
- $sameName = array_filter($collected, function ($a) use ($name) { return $name == $a->name; }, true);
- if (is_int($this->value) || is_array($this->value) || $this->value instanceof \Traversable) {
- if (is_int($this->value))
- $increment = 1;
- else
- $increment = is_string($match->value) ? array($match->value) : $match->value;
- if (!$sameName) {
- $match->value = $increment;
- return array(true, $left_, array_merge($collected, array($match)));
- }
- if (is_array($increment) || $increment instanceof \Traversable)
- $sameName[0]->value = array_merge($sameName[0]->value, $increment);
- else
- $sameName[0]->value += $increment;
- return array(true, $left_, $collected);
- }
- return array(true, $left_, array_merge($collected, array($match)));
- }
- }
- class BranchPattern extends Pattern
- {
- public $children = array();
- public function __construct($children=null)
- {
- if (!$children)
- $children = array();
- elseif ($children instanceof Pattern)
- $children = func_get_args();
- foreach ($children as $child) {
- $this->children[] = $child;
- }
- }
- public function flat($types=array())
- {
- $types = is_array($types) ? $types : array($types);
- if (in_array(get_class_name($this), $types))
- return array($this);
- $flat = array();
- foreach ($this->children as $c) {
- $flat = array_merge($flat, $c->flat($types));
- }
- return $flat;
- }
- public function dump()
- {
- $out = get_class_name($this).'(';
- $cd = array();
- foreach ($this->children as $c) {
- $cd[] = $c->dump();
- }
- $out .= implode(', ', $cd).')';
- return $out;
- }
- }
- class Argument extends LeafPattern
- {
- /* {{{ this stuff is against LeafPattern in the python version but it interferes with name() */
- public $name;
- public $value;
- public function __construct($name, $value=null)
- {
- $this->name = $name;
- $this->value = $value;
- }
- /* }}} */
- public function singleMatch($left)
- {
- foreach ($left as $n=>$pattern) {
- if ($pattern instanceof Argument) {
- return array($n, new Argument($this->name, $pattern->value));
- }
- }
- return array(null, null);
- }
- public static function parse($source)
- {
- $name = null;
- $value = null;
- if (preg_match_all('@(<\S*?'.'>)@', $source, $matches)) {
- $name = $matches[0][0];
- }
- if (preg_match_all('@\[default: (.*)\]@i', $source, $matches)) {
- $value = $matches[0][1];
- }
- return new static($name, $value);
- }
- public function dump()
- {
- return get_class_name($this)."(".dump_scalar($this->name).", ".dump_scalar($this->value).")";
- }
- }
- class Command extends Argument
- {
- public $name;
- public $value;
- public function __construct($name, $value=false)
- {
- $this->name = $name;
- $this->value = $value;
- }
- function singleMatch($left)
- {
- foreach ($left as $n=>$pattern) {
- if ($pattern instanceof Argument) {
- if ($pattern->value == $this->name)
- return array($n, new Command($this->name, true));
- else
- break;
- }
- }
- return array(null, null);
- }
- }
- class Option extends LeafPattern
- {
- public $short;
- public $long;
- public function __construct($short=null, $long=null, $argcount=0, $value=false)
- {
- if ($argcount != 0 && $argcount != 1)
- throw new \InvalidArgumentException();
- $this->short = $short;
- $this->long = $long;
- $this->argcount = $argcount;
- $this->value = $value;
- // Python checks "value is False". maybe we should check "$value === false"
- if (!$value && $argcount)
- $this->value = null;
- }
- public static function parse($optionDescription)
- {
- $short = null;
- $long = null;
- $argcount = 0;
- $value = false;
- $exp = explode(' ', trim($optionDescription), 2);
- $options = $exp[0];
- $description = isset($exp[1]) ? $exp[1] : '';
- $options = str_replace(',', ' ', str_replace('=', ' ', $options));
- foreach (preg_split('/\s+/', $options) as $s) {
- if (strpos($s, '--')===0)
- $long = $s;
- elseif ($s && $s[0] == '-')
- $short = $s;
- else
- $argcount = 1;
- }
- if ($argcount) {
- $value = null;
- if (preg_match('@\[default: (.*)\]@i', $description, $match)) {
- $value = $match[1];
- }
- }
- return new static($short, $long, $argcount, $value);
- }
- public function singleMatch($left)
- {
- foreach ($left as $n=>$pattern) {
- if ($this->name == $pattern->name) {
- return array($n, $pattern);
- }
- }
- return array(null, null);
- }
- public function name()
- {
- return $this->long ?: $this->short;
- }
- public function dump()
- {
- return "Option(".dump_scalar($this->short).", ".dump_scalar($this->long).", ".dump_scalar($this->argcount).", ".dump_scalar($this->value).")";
- }
- }
- class Required extends BranchPattern
- {
- public function match($left, $collected=null)
- {
- if (!$collected)
- $collected = array();
- $l = $left;
- $c = $collected;
- foreach ($this->children as $pattern) {
- list ($matched, $l, $c) = $pattern->match($l, $c);
- if (!$matched)
- return array(false, $left, $collected);
- }
- return array(true, $l, $c);
- }
- }
- class Optional extends BranchPattern
- {
- public function match($left, $collected=null)
- {
- if (!$collected)
- $collected = array();
- foreach ($this->children as $pattern) {
- list($m, $left, $collected) = $pattern->match($left, $collected);
- }
- return array(true, $left, $collected);
- }
- }
- /**
- * Marker/placeholder for [options] shortcut.
- */
- class OptionsShortcut extends Optional
- {
- }
- class OneOrMore extends BranchPattern
- {
- public function match($left, $collected=null)
- {
- if (count($this->children) != 1)
- throw new \UnexpectedValueException();
- if (!$collected)
- $collected = array();
- $l = $left;
- $c = $collected;
- $lnew = array();
- $matched = true;
- $times = 0;
- while ($matched) {
- # could it be that something didn't match but changed l or c?
- list ($matched, $l, $c) = $this->children[0]->match($l, $c);
- if ($matched) $times += 1;
- if ($lnew == $l)
- break;
- $lnew = $l;
- }
- if ($times >= 1)
- return array(true, $l, $c);
- else
- return array(false, $left, $collected);
- }
- }
- class Either extends BranchPattern
- {
- public function match($left, $collected=null)
- {
- if (!$collected)
- $collected = array();
- $outcomes = array();
- foreach ($this->children as $pattern) {
- list ($matched, $dump1, $dump2) = $outcome = $pattern->match($left, $collected);
- if ($matched)
- $outcomes[] = $outcome;
- }
- if ($outcomes) {
- // return min(outcomes, key=lambda outcome: len(outcome[1]))
- $min = null;
- $ret = null;
- foreach ($outcomes as $o) {
- $cnt = count($o[1]);
- if ($min === null || $cnt < $min) {
- $min = $cnt;
- $ret = $o;
- }
- }
- return $ret;
- }
- else
- return array(false, $left, $collected);
- }
- }
- class Tokens extends \ArrayIterator
- {
- public $error;
- public function __construct($source, $error='ExitException')
- {
- if (!is_array($source)) {
- $source = trim($source);
- if ($source)
- $source = preg_split('/\s+/', $source);
- else
- $source = array();
- }
- parent::__construct($source);
- $this->error = $error;
- }
- public static function fromPattern($source)
- {
- $source = preg_replace('@([\[\]\(\)\|]|\.\.\.)@', ' $1 ', $source);
- $source = preg_split('@\s+|(\S*<.*?>)@', $source, null, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
- return new static($source, 'LanguageError');
- }
- function move()
- {
- $item = $this->current();
- $this->next();
- return $item;
- }
- function left()
- {
- $left = array();
- while (($token = $this->move()) !== null) {
- $left[] = $token;
- }
- return $left;
- }
- function raiseException($message)
- {
- $class = __NAMESPACE__.'\\'.$this->error;
- throw new $class($message);
- }
- }
- /**
- * long ::= '--' chars [ ( ' ' | '=' ) chars ] ;
- */
- function parse_long($tokens, \ArrayIterator $options)
- {
- $token = $tokens->move();
- $exploded = explode('=', $token, 2);
- if (count($exploded) == 2) {
- $long = $exploded[0];
- $eq = '=';
- $value = $exploded[1];
- }
- else {
- $long = $token;
- $eq = null;
- $value = null;
- }
- if (strpos($long, '--') !== 0)
- throw new \UnexpectedValueExeption();
- $value = (!$eq && !$value) ? null : $value;
- $similar = array_filter($options, function($o) use ($long) { return $o->long && $o->long == $long; }, true);
- if ('ExitException' == $tokens->error && !$similar)
- $similar = array_filter($options, function($o) use ($long) { return $o->long && strpos($o->long, $long)===0; }, true);
- if (count($similar) > 1) {
- // might be simply specified ambiguously 2+ times?
- $tokens->raiseException("$long is not a unique prefix: ".implode(', ', array_map(function($o) { return $o->long; }, $similar)));
- }
- elseif (count($similar) < 1) {
- $argcount = $eq == '=' ? 1 : 0;
- $o = new Option(null, $long, $argcount);
- $options[] = $o;
- if ($tokens->error == 'ExitException') {
- $o = new Option(null, $long, $argcount, $argcount ? $value : true);
- }
- }
- else {
- $o = new Option($similar[0]->short, $similar[0]->long, $similar[0]->argcount, $similar[0]->value);
- if ($o->argcount == 0) {
- if ($value !== null) {
- $tokens->raiseException("{$o->long} must not have an argument");
- }
- }
- else {
- if ($value === null) {
- if ($tokens->current() === null || $tokens->current() == "--") {
- $tokens->raiseException("{$o->long} requires argument");
- }
- $value = $tokens->move();
- }
- }
- if ($tokens->error == 'ExitException') {
- $o->value = $value !== null ? $value : true;
- }
- }
- return array($o);
- }
- /**
- * shorts ::= '-' ( chars )* [ [ ' ' ] chars ] ;
- */
- function parse_shorts($tokens, \ArrayIterator $options)
- {
- $token = $tokens->move();
- if (strpos($token, '-') !== 0 || strpos($token, '--') === 0)
- throw new \UnexpectedValueExeption();
- $left = ltrim($token, '-');
- $parsed = array();
- while ($left != '') {
- $short = '-'.$left[0];
- $left = substr($left, 1);
- $similar = array();
- foreach ($options as $o) {
- if ($o->short == $short)
- $similar[] = $o;
- }
- $similarCnt = count($similar);
- if ($similarCnt > 1) {
- $tokens->raiseException("$short is specified ambiguously $similarCnt times");
- }
- elseif ($similarCnt < 1) {
- $o = new Option($short, null, 0);
- $options[] = $o;
- if ($tokens->error == 'ExitException')
- $o = new Option($short, null, 0, true);
- }
- else {
- $o = new Option($short, $similar[0]->long, $similar[0]->argcount, $similar[0]->value);
- $value = null;
- if ($o->argcount != 0) {
- if ($left == '') {
- if ($tokens->current() === null || $tokens->current() == '--')
- $tokens->raiseException("$short requires argument");
- $value = $tokens->move();
- }
- else {
- $value = $left;
- $left = '';
- }
- }
- if ($tokens->error == 'ExitException') {
- $o->value = $value !== null ? $value : true;
- }
- }
- $parsed[] = $o;
- }
- return $parsed;
- }
- function parse_pattern($source, \ArrayIterator $options)
- {
- $tokens = Tokens::fromPattern($source);
- $result = parse_expr($tokens, $options);
- if ($tokens->current() != null) {
- $tokens->raiseException('unexpected ending: '.implode(' ', $tokens->left()));
- }
- return new Required($result);
- }
- /**
- * expr ::= seq ( '|' seq )* ;
- */
- function parse_expr($tokens, \ArrayIterator $options)
- {
- $seq = parse_seq($tokens, $options);
- if ($tokens->current() != '|')
- return $seq;
- $result = null;
- if (count($seq) > 1)
- $result = array(new Required($seq));
- else
- $result = $seq;
- while ($tokens->current() == '|') {
- $tokens->move();
- $seq = parse_seq($tokens, $options);
- if (count($seq) > 1)
- $result[] = new Required($seq);
- else
- $result = array_merge($result, $seq);
- }
- if (count($result) > 1)
- return new Either($result);
- else
- return $result;
- }
- /**
- * seq ::= ( atom [ '...' ] )* ;
- */
- function parse_seq($tokens, \ArrayIterator $options)
- {
- $result = array();
- $not = array(null, '', ']', ')', '|');
- while (!in_array($tokens->current(), $not, true)) {
- $atom = parse_atom($tokens, $options);
- if ($tokens->current() == '...') {
- $atom = array(new OneOrMore($atom));
- $tokens->move();
- }
- if ($atom instanceof \ArrayIterator)
- $atom = $atom->getArrayCopy();
- if ($atom) {
- $result = array_merge($result, $atom);
- }
- }
- return $result;
- }
- /**
- * atom ::= '(' expr ')' | '[' expr ']' | 'options'
- * | long | shorts | argument | command ;
- */
- function parse_atom($tokens, \ArrayIterator $options)
- {
- $token = $tokens->current();
- $result = array();
- if ($token == '(' || $token == '[') {
- $tokens->move();
- static $index;
- if (!$index) $index = array('('=>array(')', __NAMESPACE__.'\Required'), '['=>array(']', __NAMESPACE__.'\Optional'));
- list ($matching, $pattern) = $index[$token];
- $result = new $pattern(parse_expr($tokens, $options));
- if ($tokens->move() != $matching)
- $tokens->raiseException("Unmatched '$token'");
- return array($result);
- }
- elseif ($token == 'options') {
- $tokens->move();
- return array(new OptionsShortcut);
- }
- elseif (strpos($token, '--') === 0 && $token != '--') {
- return parse_long($tokens, $options);
- }
- elseif (strpos($token, '-') === 0 && $token != '-' && $token != '--') {
- return parse_shorts($tokens, $options);
- }
- elseif (strpos($token, '<') === 0 && ends_with($token, '>') || is_upper($token)) {
- return array(new Argument($tokens->move()));
- }
- else {
- return array(new Command($tokens->move()));
- }
- }
- /**
- * Parse command-line argument vector.
- *
- * If options_first:
- * argv ::= [ long | shorts ]* [ argument ]* [ '--' [ argument ]* ] ;
- * else:
- * argv ::= [ long | shorts | argument ]* [ '--' [ argument ]* ] ;
- */
- function parse_argv($tokens, \ArrayIterator $options, $optionsFirst=false)
- {
- $parsed = array();
- while ($tokens->current() !== null) {
- if ($tokens->current() == '--') {
- while ($tokens->current() !== null) {
- $parsed[] = new Argument(null, $tokens->move());
- }
- return $parsed;
- }
- elseif (strpos($tokens->current(), '--')===0) {
- $parsed = array_merge($parsed, parse_long($tokens, $options));
- }
- elseif (strpos($tokens->current(), '-')===0 && $tokens->current() != '-') {
- $parsed = array_merge($parsed, parse_shorts($tokens, $options));
- }
- elseif ($optionsFirst) {
- return array_merge($parsed, array_map(function($v) { return new Argument(null, $v); }, $tokens->left()));
- }
- else {
- $parsed[] = new Argument(null, $tokens->move());
- }
- }
- return $parsed;
- }
- function parse_defaults($doc)
- {
- $defaults = array();
- foreach (parse_section('options:', $doc) as $s) {
- # FIXME corner case "bla: options: --foo"
- list (, $s) = explode(':', $s, 2);
- $splitTmp = array_slice(preg_split("@\n[ \t]*(-\S+?)@", "\n".$s, null, PREG_SPLIT_DELIM_CAPTURE), 1);
- $split = array();
- for ($cnt = count($splitTmp), $i=0; $i < $cnt; $i+=2) {
- $split[] = $splitTmp[$i] . (isset($splitTmp[$i+1]) ? $splitTmp[$i+1] : '');
- }
- $options = array();
- foreach ($split as $s) {
- if (strpos($s, '-') === 0)
- $options[] = Option::parse($s);
- }
- $defaults = array_merge($defaults, $options);
- }
- return new \ArrayIterator($defaults);
- }
- function parse_section($name, $source)
- {
- $ret = array();
- if (preg_match_all('@^([^\n]*'.$name.'[^\n]*\n?(?:[ \t].*?(?:\n|$))*)@im', $source, $matches, PREG_SET_ORDER)) {
- foreach ($matches as $match) {
- $ret[] = trim($match[0]);
- }
- }
- return $ret;
- }
- function formal_usage($section)
- {
- list (, $section) = explode(':', $section, 2); # drop "usage:"
- $pu = preg_split('/\s+/', trim($section));
- $ret = array();
- foreach (array_slice($pu, 1) as $s) {
- if ($s == $pu[0])
- $ret[] = ') | (';
- else
- $ret[] = $s;
- }
- return '( '.implode(' ', $ret).' )';
- }
- function extras($help, $version, $options, $doc)
- {
- $ofound = false;
- $vfound = false;
- foreach ($options as $o) {
- if ($o->value && ($o->name == '-h' || $o->name == '--help'))
- $ofound = true;
- if ($o->value && $o->name == '--version')
- $vfound = true;
- }
- if ($help && $ofound) {
- ExitException::$usage = null;
- throw new ExitException($doc, 0);
- }
- if ($version && $vfound) {
- ExitException::$usage = null;
- throw new ExitException($version, 0);
- }
- }
- class Handler
- {
- public $exit = true;
- public $exitFullUsage = false;
- public $help = true;
- public $optionsFirst = false;
- public $version;
- public function __construct($options=array())
- {
- foreach ($options as $k=>$v)
- $this->$k = $v;
- }
- function handle($doc, $argv=null)
- {
- try {
- if ($argv === null && isset($_SERVER['argv']))
- $argv = array_slice($_SERVER['argv'], 1);
- $usageSections = parse_section('usage:', $doc);
- if (count($usageSections) == 0)
- throw new LanguageError('"usage:" (case-insensitive) not found.');
- elseif (count($usageSections) > 1)
- throw new LanguageError('More than one "usage:" (case-insensitive).');
- $usage = $usageSections[0];
- // temp fix until python port provides solution
- ExitException::$usage = !$this->exitFullUsage ? $usage : $doc;
- $options = parse_defaults($doc);
- $formalUse = formal_usage($usage);
- $pattern = parse_pattern($formalUse, $options);
- $argv = parse_argv(new Tokens($argv), $options, $this->optionsFirst);
- $patternOptions = $pattern->flat('Option');
- foreach ($pattern->flat('OptionsShortcut') as $optionsShortcut) {
- $docOptions = parse_defaults($doc);
- $optionsShortcut->children = array_diff((array)$docOptions, $patternOptions);
- }
- extras($this->help, $this->version, $argv, $doc);
- list($matched, $left, $collected) = $pattern->fix()->match($argv);
- if ($matched && !$left) {
- $return = array();
- foreach (array_merge($pattern->flat(), $collected) as $a) {
- $name = $a->name;
- if ($name)
- $return[$name] = $a->value;
- }
- return new Response($return);
- }
- throw new ExitException();
- }
- catch (ExitException $ex) {
- $this->handleExit($ex);
- return new Response(null, $ex->status, $ex->getMessage());
- }
- }
- function handleExit(ExitException $ex)
- {
- if ($this->exit) {
- echo $ex->getMessage().PHP_EOL;
- exit($ex->status);
- }
- }
- }
- class Response implements \ArrayAccess, \IteratorAggregate
- {
- public $status;
- public $output;
- public $args;
- public function __construct($args, $status=0, $output='')
- {
- $this->args = $args ?: array();
- $this->status = $status;
- $this->output = $output;
- }
- public function __get($name)
- {
- if ($name == 'success')
- return $this->status === 0;
- else
- throw new \BadMethodCallException("Unknown property $name");
- }
- public function offsetExists($offset)
- {
- return isset($this->args[$offset]);
- }
- public function offsetGet($offset)
- {
- return $this->args[$offset];
- }
- public function offsetSet($offset, $value)
- {
- $this->args[$offset] = $value;
- }
- public function offsetUnset($offset)
- {
- unset($this->args[$offset]);
- }
- public function getIterator()
- {
- return new \ArrayIterator($this->args);
- }
- }
- }
|