Add support for --sort and -u options

Author: weynhamz

PHPCtags.class.php

@@ -48,6 +48,32 @@ private function getNodeAccess($node)
         return 'public';
     }
 
+    /**
+     * stringSortByLine
+     *
+     * Sort a string based on its line delimiter
+     *
+     * @author Techlive Zheng
+     *
+     * @access public
+     * @static
+     *
+     * @param string  $str     string to be sorted
+     * @param boolean $foldcse case-insensitive sorting
+     *
+     * @return string sorted string
+     **/
+    public static function stringSortByLine($str, $foldcase=FALSE)
+    {
+        $arr = explode("\n", $str);
+        if (!$foldcase)
+            sort($arr, SORT_STRING);
+        else
+            sort($arr, SORT_STRING | SORT_FLAG_CASE);
+        $str = implode("\n", $arr);
+        return $str;
+    }
+
     private static function helperSortByLine($a, $b) {
         return $a['line'] > $b['line'] ? 1 : 0;
     }
@@ -163,7 +189,10 @@ private function struct($node, $reset=FALSE, $parent=array())
 
         if(!empty($parent)) array_pop($scope);
 
-        usort($structs, 'self::helperSortByLine');
+        // if no --sort is given, sort by occurrence
+        if (!isset($options['sort']) || $options['sort'] == 'no') {
+            usort($structs, 'self::helperSortByLine');
+        }
 
         return $structs;
     }
@@ -243,6 +272,12 @@ private function render($structs, $options)
 
             $str .= "\n";
         }
+
+        // sort the result as instructed
+        if (isset($options['sort']) && ($options['sort'] == 'yes' || $options['sort'] == 'foldcase')) {
+            $str = self::stringSortByLine($str, $options['sort'] == 'foldcase');
+        }
+
         return $str;
     }
 

phpctags

@@ -12,14 +12,15 @@ if (file_exists($autoload = __DIR__ . '/vendor/autoload.php')) {
     );
 }
 
-$options = getopt('af:Nno:RV',array(
+$options = getopt('af:Nno:RuV',array(
     'append::',
     'debug',
     'exclude:',
     'excmd::',
     'fields::',
     'format::',
     'recurse::',
+    'sort::',
     'version',
     'memory::',
 ));
@@ -84,6 +85,28 @@ if(!isset($options['fields'])) {
     $options['fields'] = str_split($options['fields']);
 }
 
+// handle -u or --sort options
+if (isset($options['sort'])) {
+    // --sort or --sort=[Y,y,YES,Yes,yes]
+    if ($options['sort'] === FALSE || yes_or_no($options['sort']) == 'yes') {
+        $options['sort'] = 'yes';
+    // --sort=[N,n,NO,No,no]
+    } else if (yes_or_no($options['sort']) == 'no') {
+        $options['sort'] = 'no';
+    // --sort=foldcase, case insensitive sorting
+    } else if ($options['sort'] == 'foldcase') {
+        $options['sort'] = 'foldcase';
+    } else {
+        die('phpctags: Invalid value for "sort" option');
+    }
+// option -n is equivalent to --sort=no
+} else if (isset($options['u'])) {
+    $options['sort'] = 'no';
+// sort the result by default
+} else {
+    $options['sort'] = 'yes';
+}
+
 // if the memory limit option is set and is valid, adjust memory
 if (isset($options['memory'])) {
     $memory_limit = trim($options['memory']);