Merge branch 'feature/improved-console-support' into develop

Author: weynhamz

PHPCtags.class.php

@@ -3,6 +3,8 @@ class PHPCtags
 {
     private $mFile;
 
+    private $mFiles;
+
     private static $mKinds = array(
         'c' => 'class',
         'm' => 'method',
@@ -48,6 +50,18 @@ public static function getMKinds()
         return self::$mKinds;
     }
 
+    public function addFile($file)
+    {
+        $this->mFiles[realpath($file)] = 1;
+    }
+
+    public function addFiles($files)
+    {
+        foreach ($files as $file) {
+            $this->addFile($file);
+        }
+    }
+
     private function getNodeAccess($node)
     {
         if ($node->isPrivate()) return 'private';
@@ -294,7 +308,20 @@ private function render()
         return $str;
     }
 
-    public function export($file)
+    public function export()
+    {
+        if (empty($this->mFiles)) {
+            throw new PHPCtagsException('No File specified.');
+        }
+
+        foreach (array_keys($this->mFiles) as $file) {
+            $this->process($file);
+        }
+
+        return $this->render();
+    }
+
+    private function process($file)
     {
         if (is_dir($file) && isset($this->mOptions['R'])) {
             $iterator = new RecursiveIteratorIterator(
@@ -329,7 +356,6 @@ public function export($file)
                 $this->struct($this->mParser->parse(file_get_contents($this->mFile)), TRUE)
             );
         }
-        return $this->render();
     }
 }
 

phpctags

@@ -12,19 +12,80 @@ if (file_exists($autoload = __DIR__ . '/vendor/autoload.php')) {
     );
 }
 
+$version = <<<'EOF'
+Version: 0.2
+
+Exuberant Ctags compatiable PHP enhancement, Copyright (C) 2012 Techlive Zheng
+Addresses: <techlivezheng@gmail.com>, https://github.com/techlivezheng/phpctags
+EOF;
+
 $options = getopt('af:Nno:RuV', array(
     'append::',
     'debug',
     'exclude:',
     'excmd::',
     'fields::',
     'format::',
+    'help',
     'recurse::',
     'sort::',
     'version',
     'memory::',
 ));
 
+$options_info = <<<'EOF'
+phpctags currently only supports a subset of the original ctags' options.
+
+Usage: phpctags [options] [file(s)]
+
+  -a   Append the tags to an existing tag file.
+  -f <name>
+       Write tags to specified file. Value of "-" writes tags to stdout
+       ["tags"].
+  -n   Equivalent to --excmd=number.
+  -N   Equivalent to --excmd=pattern.
+  -o   Alternative for -f.
+  -R   Equivalent to --recurse.
+  -u   Equivalent to --sort=no.
+  -V   Equivalent to --verbose.
+  --append=[yes|no]
+       Should tags should be appended to existing tag file [no]?
+  --debug
+       phpctags only
+       Repect PHP's error level configuration.
+  --exclude=pattern
+      Exclude files and directories matching 'pattern'.
+  --excmd=number|pattern|mix
+       Uses the specified type of EX command to locate tags [mix].
+  --fields=[+|-]flags
+      Include selected extension fields (flags: "afmikKlnsStz") [fks].
+  --format=level
+       Force output of specified tag file format [2].
+  --help
+       Print this option summary.
+  --memory=[-1|bytes|KMG]
+       phpctags only
+       Set how many memories phpctags could use.
+  --recurse=[yes|no]
+       Recurse into directories supplied on command line [no].
+  --sort=[yes|no|foldcase]
+       Should tags be sorted (optionally ignoring case) [yes]?.
+  --version
+       Print version identifier to standard output.
+EOF;
+
+// prune options and its value from the $argv array
+$argv_ = array();
+foreach ($options as $option => $value) {
+  foreach ($argv as $key => $chunk) {
+    $regex = '/^'. (isset($option[1]) ? '--' : '-') . $option . '/';
+    if ($chunk == $value && $argv[$key-1][0] == '-' || preg_match($regex, $chunk)) {
+      array_push($argv_, $key);
+    }
+  }
+}
+while ($key = array_pop($argv_)) unset($argv[$key]);
+
 // option -V is an alternative to --version
 if (isset($options['V'])) {
     $options['version'] = FALSE;
@@ -34,21 +95,21 @@ if (!isset($options['debug'])) {
     error_reporting(0);
 }
 
-if (isset($options['version'])) {
-    echo <<<'EOF'
-Version: 0.2
-
-Exuberant Ctags compatiable PHP enhancement, Copyright (C) 2012 Techlive Zheng
-Addresses: <techlivezheng@gmail.com>, https://github.com/techlivezheng/phpctags
+if (isset($options['help'])) {
+    echo $version;
+    echo PHP_EOL;
+    echo PHP_EOL;
+    echo $options_info;
+    exit;
+}
 
-EOF;
+if (isset($options['version'])) {
+    echo $version;
     exit;
 }
 
 array_shift($argv);
 
-$file = array_pop($argv);
-
 // option -o is an alternative to -f
 if (isset($options['o']) && !isset($options['f'])) {
     $options['f'] = $options['o'];
@@ -133,7 +194,8 @@ if (isset($options['recurse'])) {
 
 try {
     $ctags = new PHPCtags($options);
-    $result = $ctags->export($file);
+    $ctags->addFiles($argv);
+    $result = $ctags->export();
 } catch (Exception $e) {
     die("phpctags: {$e->getMessage()}");
 }

tests/PHPCtagsTest.php

@@ -59,9 +59,10 @@ public function testExport($testcase)
         $phpctags_object = new PHPCtags(
             $testcase_object->getOptions()
         );
-        $testcase_result = $phpctags_object->export(
+        $phpctags_object->addFile(
             $testcase_object->getExample()
         );
+        $testcase_result = $phpctags_object->export();
 
         $expected_result = __DIR__ . '/' . $testcase_id . '.testcase.expect';
         $acctural_result = __DIR__ . '/' . $testcase_id . '.testcase.result';