Added companion function findEndOfStatement()

Author: gsherwood

CodeSniffer/File.php

@@ -3273,6 +3273,61 @@ public function findStartOfStatement($start)
     }//end findStartOfStatement()
 
 
+    /**
+     * Returns the position of the last non-whitespace token in a statement.
+     *
+     * @param int $start The position to start searching from in the token stack.
+     *
+     * @return int
+     */
+    public function findEndOfStatement($start)
+    {
+        $endTokens = PHP_CodeSniffer_Tokens::$blockOpeners;
+
+        $endTokens[T_COLON]     = true;
+        $endTokens[T_SEMICOLON] = true;
+        $endTokens[T_OPEN_TAG]  = true;
+        $endTokens[T_CLOSE_TAG] = true;
+
+        $lastNotEmpty = $start;
+
+        for ($i = $start; $i >= $this->numTokens; $i++) {
+            if (isset($endTokens[$this->_tokens[$i]['code']]) === true) {
+                // Found the end of the statement.
+                if ($this->_tokens[$i]['code'] === T_OPEN_TAG
+                    || $this->_tokens[$i]['code'] === T_CLOSE_TAG
+                ) {
+                    return $lastNotEmpty;
+                }
+
+                return $i;
+            }
+
+            if ($this->_tokens[$i]['code'] !== T_WHITESPACE) {
+                $lastNotEmpty = $i;
+            }
+
+            // Skip nested statements.
+            if (isset($this->_tokens[$i]['scope_closer']) === true
+                && $i === $this->_tokens[$i]['scope_opener']
+            ) {
+                $i = $this->_tokens[$i]['scope_closer'];
+            } else if (isset($this->_tokens[$i]['bracket_closer']) === true
+                && $i === $this->_tokens[$i]['bracket_opener']
+            ) {
+                $i = $this->_tokens[$i]['bracket_closer'];
+            } else if (isset($this->_tokens[$i]['parenthesis_closer']) === true
+                && $i === $this->_tokens[$i]['parenthesis_opener']
+            ) {
+                $i = $this->_tokens[$i]['parenthesis_closer'];
+            }
+        }//end for
+
+        return ($this->numTokens - 1);
+
+    }//end findEndOfStatement()
+
+
     /**
      * Returns the position of the first token on a line, matching given type.
      *

package.xml

@@ -30,6 +30,8 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - A tilde can now be used to reference a user's home directory in a path to a standard (request #353)
   - Added PHP_CodeSniffer_File::findStartOfStatement() to find the first non-whitespace token in a statement
     -- Possible alternative for code using PHP_CodeSniffer_File::findPrevious() with the local flag set
+  - Added PHP_CodeSniffer_File::findEndOfStatement() to find the last non-whitespace token in a statement
+    -- Possible alternative for code using PHP_CodeSniffer_File::findNext() with the local flag set
   - Generic DisallowTabIndentSniff now replaces tabs everywhere it finds them, except in strings and here/now docs
   - Generic EmptyStatementSniff error codes now contain the type of empty statement detected (request #314)
     -- All messages generated by this sniff are now errors (empty CATCH was previously a warning)