Subversion-Projekte lars-tiefland.php_share

<?php

/**

 * Squiz_Sniffs_ControlStructures_SwitchDeclarationSniff.

 *

 * PHP version 5

 *

 * @category  PHP

 * @package   PHP_CodeSniffer

 * @author    Greg Sherwood <gsherwood@squiz.net>

 * @author    Marc McIntyre <mmcintyre@squiz.net>

 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)

 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence

 * @version   CVS: $Id: SwitchDeclarationSniff.php 270520 2008-12-04 06:07:51Z squiz $

 * @link      http://pear.php.net/package/PHP_CodeSniffer

 */

/**

 * Squiz_Sniffs_ControlStructures_SwitchDeclarationSniff.

 *

 * Ensures all the breaks and cases are aligned correctly according to their

 * parent switch's alignment and enforces other switch formatting.

 *

 * @category  PHP

 * @package   PHP_CodeSniffer

 * @author    Greg Sherwood <gsherwood@squiz.net>

 * @author    Marc McIntyre <mmcintyre@squiz.net>

 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)

 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence

 * @version   Release: 1.2.1

 * @link      http://pear.php.net/package/PHP_CodeSniffer

 */

class Squiz_Sniffs_ControlStructures_SwitchDeclarationSniff implements PHP_CodeSniffer_Sniff

{

    /**

     * A list of tokenizers this sniff supports.

     *

     * @var array

     */

    public $supportedTokenizers = array(

                                   'PHP',

                                   'JS',

                                  );

    /**

     * Returns an array of tokens this test wants to listen for.

     *

     * @return array

     */

    public function register()

    {

        return array(T_SWITCH);

    }//end register()

    /**

     * Processes this test, when one of its tokens is encountered.

     *

     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.

     * @param int                  $stackPtr  The position of the current token in the

     *                                        stack passed in $tokens.

     *

     * @return void

     */

    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)

    {

        $tokens = $phpcsFile->getTokens();

        $switch        = $tokens[$stackPtr];

        $nextCase      = $stackPtr;

        $caseAlignment = ($switch['column'] + 4);

        $caseCount     = 0;

        while (($nextCase = $phpcsFile->findNext(array(T_CASE, T_SWITCH), ($nextCase + 1), $switch['scope_closer'])) !== false) {

            // Skip nested SWITCH statements; they are handled on their own.

            if ($tokens[$nextCase]['code'] === T_SWITCH) {

                $nextCase = $tokens[$nextCase]['scope_closer'];

                continue;

            }

            $caseCount++;

            $content = $tokens[$nextCase]['content'];

            if ($content !== strtolower($content)) {

                $expected = strtolower($content);

                $error    = "CASE keyword must be lowercase; expected \"$expected\" but found \"$content\"";

                $phpcsFile->addError($error, $nextCase);

            }

            if ($tokens[$nextCase]['column'] !== $caseAlignment) {

                $error = 'CASE keyword must be indented 4 spaces from SWITCH keyword';

                $phpcsFile->addError($error, $nextCase);

            }

            if ($tokens[($nextCase + 1)]['type'] !== 'T_WHITESPACE' || $tokens[($nextCase + 1)]['content'] !== ' ') {

                $error = 'CASE keyword must be followed by a single space';

                $phpcsFile->addError($error, $nextCase);

            }

            $opener = $tokens[$nextCase]['scope_opener'];

            if ($tokens[($opener - 1)]['type'] === 'T_WHITESPACE') {

                $error = 'There must be no space before the colon in a CASE statement';

                $phpcsFile->addError($error, $nextCase);

            }

            $nextBreak = $phpcsFile->findNext(array(T_BREAK), ($nextCase + 1), $switch['scope_closer']);

            if ($nextBreak !== false && isset($tokens[$nextBreak]['scope_condition']) === true) {

                // Only check this BREAK statement if it matches the current CASE

                // statement. This stops the same break (used for multiple CASEs) being

                // checked more than once.

                if ($tokens[$nextBreak]['scope_condition'] === $nextCase) {

                    if ($tokens[$nextBreak]['column'] !== $caseAlignment) {

                        $error = 'BREAK statement must be indented 4 spaces from SWITCH keyword';

                        $phpcsFile->addError($error, $nextBreak);

                    }

                    /*

                        Ensure empty CASE statements are not allowed.

                        They must have some code content in them. A comment is not

                        enough.

                    */

                    $foundContent = false;

                    for ($i = ($tokens[$nextCase]['scope_opener'] + 1); $i < $nextBreak; $i++) {

                        if ($tokens[$i]['code'] === T_CASE) {

                            $i = $tokens[$i]['scope_opener'];

                            continue;

                        }

                        if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === false) {

                            $foundContent = true;

                            break;

                        }

                    }

                    if ($foundContent === false) {

                        $error = 'Empty CASE statements are not allowed';

                        $phpcsFile->addError($error, $nextCase);

                    }

                    /*

                        Ensure there is no blank line before

                        the BREAK statement.

                    */

                    $breakLine = $tokens[$nextBreak]['line'];

                    $prevLine  = 0;

                    for ($i = ($nextBreak - 1); $i > $stackPtr; $i--) {

                        if ($tokens[$i]['type'] !== 'T_WHITESPACE') {

                            $prevLine = $tokens[$i]['line'];

                            break;

                        }

                    }

                    if ($prevLine !== ($breakLine - 1)) {

                        $error = 'Blank lines are not allowed before BREAK statements';

                        $phpcsFile->addError($error, $nextBreak);

                    }

                    /*

                        Ensure the BREAK statement is followed by

                        a single blank line, or the end switch brace.

                    */

                    $breakLine = $tokens[$nextBreak]['line'];

                    $nextLine  = $tokens[$tokens[$stackPtr]['scope_closer']]['line'];

                    $semicolon = $phpcsFile->findNext(T_SEMICOLON, $nextBreak);

                    for ($i = ($semicolon + 1); $i < $tokens[$stackPtr]['scope_closer']; $i++) {

                        if ($tokens[$i]['type'] !== 'T_WHITESPACE') {

                            $nextLine = $tokens[$i]['line'];

                            break;

                        }

                    }

                    if ($nextLine !== ($breakLine + 2) && $i !== $tokens[$stackPtr]['scope_closer']) {

                        $error = 'BREAK statements must be followed by a single blank line';

                        $phpcsFile->addError($error, $nextBreak);

                    }

                }//end if

            } else {

                $nextBreak = $tokens[$nextCase]['scope_closer'];

            }//end if

            /*

                Ensure CASE statements are not followed by

                blank lines.

            */

            $caseLine = $tokens[$nextCase]['line'];

            $nextLine = $tokens[$nextBreak]['line'];

            for ($i = ($opener + 1); $i < $nextBreak; $i++) {

                if ($tokens[$i]['type'] !== 'T_WHITESPACE') {

                    $nextLine = $tokens[$i]['line'];

                    break;

                }

            }

            if ($nextLine !== ($caseLine + 1)) {

                $error = 'Blank lines are not allowed after CASE statements';

                $phpcsFile->addError($error, $nextCase);

            }

        }//end while

        $default = $phpcsFile->findPrevious(T_DEFAULT, $switch['scope_closer'], $switch['scope_opener']);

        // Make sure this default belongs to us.

        if ($default !== false) {

            $conditions = array_keys($tokens[$default]['conditions']);

            $owner      = array_pop($conditions);

            if ($owner !== $stackPtr) {

                $default = false;

            }

        }

        if ($default !== false) {

            $content = $tokens[$default]['content'];

            if ($content !== strtolower($content)) {

                $expected = strtolower($content);

                $error    = "DEFAULT keyword must be lowercase; expected \"$expected\" but found \"$content\"";

                $phpcsFile->addError($error, $default);

            }

            $opener = $tokens[$default]['scope_opener'];

            if ($tokens[($opener - 1)]['type'] === 'T_WHITESPACE') {

                $error = 'There must be no space before the colon in a DEFAULT statement';

                $phpcsFile->addError($error, $default);

            }

            if ($tokens[$default]['column'] !== $caseAlignment) {

                $error = 'DEFAULT keyword must be indented 4 spaces from SWITCH keyword';

                $phpcsFile->addError($error, $default);

            }

            $nextBreak = $phpcsFile->findNext(array(T_BREAK), ($default + 1), $switch['scope_closer']);

            if ($nextBreak !== false) {

                if ($tokens[$nextBreak]['column'] !== $caseAlignment) {

                    $error = 'BREAK statement must be indented 4 spaces from SWITCH keyword';

                    $phpcsFile->addError($error, $nextBreak);

                }

                /*

                    Ensure the BREAK statement is not followed by

                    a blank line.

                */

                $breakLine = $tokens[$nextBreak]['line'];

                $nextLine  = $tokens[$tokens[$stackPtr]['scope_closer']]['line'];

                $semicolon = $phpcsFile->findNext(T_SEMICOLON, $nextBreak);

                for ($i = ($semicolon + 1); $i < $tokens[$stackPtr]['scope_closer']; $i++) {

                    if ($tokens[$i]['type'] !== 'T_WHITESPACE') {

                        $nextLine = $tokens[$i]['line'];

                        break;

                    }

                }

                if ($nextLine !== ($breakLine + 1)) {

                    $error = 'Blank lines are not allowed after the DEFAULT case\'s BREAK statement';

                    $phpcsFile->addError($error, $nextBreak);

                }

            } else {

                $error = 'DEFAULT case must have a BREAK statement';

                $phpcsFile->addError($error, $default);

                $nextBreak = $tokens[$default]['scope_closer'];

            }//end if

            /*

                Ensure empty DEFAULT statements are not allowed.

                They must (at least) have a comment describing why

                the default case is being ignored.

            */

            $foundContent = false;

            for ($i = ($tokens[$default]['scope_opener'] + 1); $i < $nextBreak; $i++) {

                if ($tokens[$i]['type'] !== 'T_WHITESPACE') {

                    $foundContent = true;

                    break;

                }

            }

            if ($foundContent === false) {

                $error = 'Comment required for empty DEFAULT case';

                $phpcsFile->addError($error, $default);

            }

            /*

                Ensure DEFAULT statements are not followed by

                blank lines.

            */

            $defaultLine = $tokens[$default]['line'];

            $nextLine    = $tokens[$nextBreak]['line'];

            for ($i = ($opener + 1); $i < $nextBreak; $i++) {

                if ($tokens[$i]['type'] !== 'T_WHITESPACE') {

                    $nextLine = $tokens[$i]['line'];

                    break;

                }

            }

            if ($nextLine !== ($defaultLine + 1)) {

                $error = 'Blank lines are not allowed after DEFAULT statements';

                $phpcsFile->addError($error, $default);

            }

        } else {

            $error = 'All SWITCH statements must contain a DEFAULT case';

            $phpcsFile->addError($error, $stackPtr);

        }//end if

        if ($tokens[$switch['scope_closer']]['column'] !== $switch['column']) {

            $error = 'Closing brace of SWITCH statement must be aligned with SWITCH keyword';

            $phpcsFile->addError($error, $switch['scope_closer']);

        }

        if ($caseCount === 0) {

            $error = 'SWITCH statements must contain at least one CASE statement';

            $phpcsFile->addError($error, $stackPtr);

        }

    }//end process()

}//end class

?>