git.m6w6.name Git - pharext/pharext/blob - src/pharext/Cli/Args/Help.php

   1 <?php
   2
   3 namespace pharext\Cli\Args;
   4
   5 use pharext\Cli\Args;
   6
   7 class Help
   8 {
   9         private $args;
  10
  11         function __construct($prog, Args $args) {
  12                 $this->prog = $prog;
  13                 $this->args = $args;
  14         }
  15
  16         function __toString() {
  17                 $usage = "Usage:\n\n  \$ ";
  18                 $usage .= $this->prog;
  19
  20                 list($flags, $required, $optional, $positional) = $this->listSpec();
  21                 if ($flags) {
  22                         $usage .= $this->dumpFlags($flags);
  23                 }
  24                 if ($required) {
  25                         $usage .= $this->dumpRequired($required);
  26                 }
  27                 if ($optional) {
  28                         $usage .= $this->dumpOptional($optional);
  29                 }
  30                 if ($positional) {
  31                         $usage .= $this->dumpPositional($positional);
  32                 }
  33
  34                 $help = $this->dumpHelp($positional);
  35
  36                 return $usage . "\n\n" . $help . "\n";
  37         }
  38
  39         function listSpec() {
  40                 $flags = [];
  41                 $required = [];
  42                 $optional = [];
  43                 $positional = [];
  44                 foreach ($this->args->getSpec() as $spec) {
  45                         if (is_numeric($spec[0])) {
  46                                 $positional[] = $spec;
  47                         } elseif ($spec[3] & Args::REQUIRED) {
  48                                 $required[] = $spec;
  49                         } elseif ($spec[3] & (Args::OPTARG|Args::REQARG)) {
  50                                 $optional[] = $spec;
  51                         } else {
  52                                 $flags[] = $spec;
  53                         }
  54                 }
  55
  56                 return [$flags, $required, $optional, $positional]
  57                         + compact("flags", "required", "optional", "positional");
  58         }
  59
  60         function dumpFlags(array $flags) {
  61                 return sprintf(" [-%s]", implode("", array_column($flags, 0)));
  62         }
  63
  64         function dumpRequired(array $required) {
  65                 $dump = "";
  66                 foreach ($required as $req) {
  67                         $dump .= sprintf(" -%s <%s>", $req[0], $req[1]);
  68                 }
  69                 return $dump;
  70         }
  71
  72         function dumpOptional(array $optional) {
  73                 $req = array_filter($optional, function($a) {
  74                         return $a[3] & Args::REQARG;
  75                 });
  76                 $opt = array_filter($optional, function($a) {
  77                         return $a[3] & Args::OPTARG;
  78                 });
  79
  80                 $dump = "";
  81                 if ($req) {
  82                         $dump .= sprintf(" [-%s <arg>]", implode("|-", array_column($req, 0)));
  83                 }
  84                 if ($opt) {
  85                         $dump .= sprintf(" [-%s [<arg>]]", implode("|-", array_column($opt, 0)));
  86                 }
  87                 return $dump;
  88         }
  89
  90         function dumpPositional(array $positional) {
  91                 $dump = " [--]";
  92                 foreach ($positional as $pos) {
  93                         if ($pos[3] & Args::REQUIRED) {
  94                                 $dump .= sprintf(" <%s>", $pos[1]);
  95                         } else {
  96                                 $dump .= sprintf(" [<%s>]", $pos[1]);
  97                         }
  98                         if ($pos[3] & Args::MULTI) {
  99                                 $dump .= sprintf(" [<%s>]...", $pos[1]);
 100                         }
 101                 }
 102                 return $dump;
 103         }
 104
 105         function calcMaxLen() {
 106                 $spc = $this->args->getSpec();
 107                 $max = max(array_map("strlen", array_column($spc, 1)));
 108                 $max += $max % 8 + 2;
 109                 return $max;
 110         }
 111
 112         function dumpHelp() {
 113                 $max = $this->calcMaxLen();
 114                 $dump = "";
 115                 foreach ($this->args->getSpec() as $spec) {
 116                         $dump .= "    ";
 117                         if (is_numeric($spec[0])) {
 118                                 $dump .= sprintf("--   %s ", $spec[1]);
 119                         } elseif (isset($spec[0])) {
 120                                 $dump .= sprintf("-%s|", $spec[0]);
 121                         }
 122                         if (!is_numeric($spec[0])) {
 123                                 $dump .= sprintf("--%s ", $spec[1]);
 124                         }
 125                         if ($spec[3] & Args::REQARG) {
 126                                 $dump .= "<arg>  ";
 127                         } elseif ($spec[3] & Args::OPTARG) {
 128                                 $dump .= "[<arg>]";
 129                         } else {
 130                                 $dump .= "       ";
 131                         }
 132
 133                         $dump .= str_repeat(" ", $max-strlen($spec[1])+3*!isset($spec[0]));
 134                         $dump .= $spec[2];
 135
 136                         if ($spec[3] & Args::REQUIRED) {
 137                                 $dump .= " (REQUIRED)";
 138                         }
 139                         if ($spec[3] & Args::MULTI) {
 140                                 $dump .= " (MULTIPLE)";
 141                         }
 142                         if (isset($spec[4])) {
 143                                 $dump .= sprintf(" [%s]", $spec[4]);
 144                         }
 145                         $dump .= "\n";
 146                 }
 147                 return $dump;
 148         }
 149 }