<?php
/**
 * Copyright (c) 2009 Stefan Priebsch <stefan@priebsch.de>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *   * Neither the name of Stefan Priebsch nor the names of contributors
 *     may be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER ORCONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @package    PHPca
 * @author     Stefan Priebsch <stefan@priebsch.de>
 * @copyright  Stefan Priebsch <stefan@priebsch.de>. All rights reserved.
 * @license    BSD License
 */

namespace spriebsch\PHPca;

/**
 * The Token class wraps one PHP tokenizer token.
 * Each token knows its line and column in the source file.
 * Where no PHP tokens exist (brackets, braces, etc.),
 * we have defined our own in Constants.
 *
 * @author     Stefan Priebsch <stefan@priebsch.de>
 * @copyright  Stefan Priebsch <stefan@priebsch.de>. All rights reserved.
 * @todo a token should know the function/method it is in
 * @todo a token should know the class it is in
 * @todo a token should know the namespace it is in (probably part of fn and class name thing)
 */
class Token
{
    /**
     * @var int
     */
    protected $id;

    /**
     * @var string
     */
    protected $text;

    /**
     * @var int
     */
    protected $line;

    /**
     * @var int
     */
    protected $column;

    /**
     * @var string
     */
    protected $file;

    /**
     * @var string
     */
    protected $namespace;

    /**
     * @var string
     */
    protected $class;

    /**
     * @var string
     */
    protected $interface;

    /**
     * @var string
     */
    protected $function;

    /**
     * @var int
     */
    protected $blockLevel;

    /**
     * Constructs the object
     *
     * @param int $id
     * @param string $text
     * @param int $line
     * @param int $column
     * @return void
     */
    public function __construct($id, $text, $line = 0, $column = 0)
    {
        $this->id       = $id;
        $this->text     = $text;
        $this->line     = $line;
        $this->column   = $column;
    }

    /**
     * Set the file name the token is part of.
     *
     * @param string $file
     * @return null
     */
    public function setFile($file)
    {
        $this->file = $file;
    }

    /**
     * Returns the file name the token is part of.
     *
     * @return string
     */
    public function getFile()
    {
        return $this->file;
    }

    /**
     * Set the namespace the token is part of.
     *
     * @param string $file
     * @return null
     */
    public function setNamespace($namespace)
    {
        $this->namespace = $namespace;
    }

    /**
     * Returns the namespace the token is part of.
     *
     * @return string
     */
    public function getNamespace()
    {
        return $this->namespace;
    }

    /**
     * Set the class the token is part of.
     *
     * @param string $file
     * @return null
     */
    public function setClass($class)
    {
        $this->class = $class;
    }

    /**
     * Returns the class the token is part of.
     *
     * @return string
     */
    public function getClass()
    {
        return $this->class;
    }

    /**
     * Set the interface the token is part of.
     *
     * @param string $interface
     * @return null
     */
    public function setInterface($interface)
    {
        $this->interface = $interface;
    }

    /**
     * Returns the interface the token is part of.
     *
     * @return string
     */
    public function getInterface()
    {
        return $this->interface;
    }

    /**
     * Set the function the token is part of.
     *
     * @param string $function
     */
    public function setFunction($function)
    {
        $this->function = $function;
    }

    /**
     * Returns the function the token is part of.
     *
     * @return string
     */
    public function getFunction()
    {
        return $this->function;
    }

    /**
     * Set the block level (number of open {'s) the token is in.
     *
     * @param int $level
     */
    public function setBlockLevel($blockLevel)
    {
        $this->blockLevel = $blockLevel;
    }

    /**
     * Returns the block level the token is part of.
     *
     * @return int
     */
    public function getBlockLevel()
    {
        return $this->blockLevel;
    }

    /**
     * Returns the numeric ID of the constant representing this token.
     *
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Returns the name of the constant representing this token as a string.
     *
     * @return string
     */
    public function getName()
    {
       return Constants::getTokenName($this->id);
    }

    /**
     * Returns the text (contents) of this token.
     *
     * @return string
     */
    public function getText()
    {
        return $this->text;
    }

    /**
     * Returns the source code line the token starts on.
     *
     * @return int
     */
    public function getStartLine()
    {
        // For whitespace with leading line breaks, we display
        // the "next" line number instead of the actual line number where the whitespace token starts
        if ($this->id == T_WHITESPACE) {
            preg_match("/^\\n*/m", $this->text, $matches);
            return $this->line + strlen($matches[0]);
        }

        return $this->line;
    }

    /**
     * Returns the source code line the token starts on.
     *
     * @return int
     */
    public function getLine()
    {
        return $this->getStartLine();
    }

    /**
     * Returns the source code column the token starts on.
     *
     * @return int
     */
    public function getStartColumn()
    {
        // If whitespace starts with newlines, we claim to be on column 1 of the "next" line
        if ($this->id == T_WHITESPACE) {
            if ($this->getStartLine() != $this->line) {
                return 1;
            }
        }

        return $this->column;
    }

    /**
     * Returns the source code column the token starts on.
     *
     * @return int
     */
    public function getColumn()
    {
        return $this->getStartColumn();
    }

    /**
     * Returns the line number the token ends on.
     *
     * @return int
     */
    public function getEndLine()
    {
        return $this->line + $this->getNewLineCount();
    }

    /**
     * Returns the column number the token ends on.
     *
     * @return int
     */
    public function getEndColumn()
    {
        if ($this->hasNewline()) {
            return 1 + $this->getTrailingWhitespaceCount();
        }

        return $this->column + $this->getLength();
    }

    /**
     * Returns the length in characters of this token.
     *
     * @return int
     */
    public function getLength()
    {
       return strlen($this->text);
    }

    /**
     * Check whether the token contains any new line characters.
     *
     * @return int
     */
    public function hasNewLine()
    {
        return strstr($this->text, "\n") !== false;
    }

    /**
      * Returns new line count of the token's text.
      * Only counts \n, no \r characters.
      *
      * @return int
      */
    public function getNewLineCount()
    {
        return substr_count($this->text, "\n");
    }

    /**
     * Check whether the token's text contains whitespace
     * (CR, LF, tab, or blank).
     *
     * @return bool
     */
    public function hasWhitespace()
    {
        return strstr($this->text, "\r") !== false ||
               strstr($this->text, "\n") !== false ||
               strstr($this->text, "\t") !== false ||
               strstr($this->text, " ")  !== false;
    }

    /**
     * Returns the trailing whitespace, that is the whitespace after
     * the last new line (if present).
     *
     * @return string
     */
    public function getTrailingWhitespace()
    {
        // no newline: count number of trailing whitespace characters
        if (!$this->hasNewLine()) {
            preg_match('/\s*$/', $this->text, $matches);
            return $matches[0];
        }

        // find last newline character
        $pos = strrpos($this->text, "\n");

        // no trailing whitespace if newline is the last character
        if ($pos >= strlen($this->text) - 1) {
            return '';
        }

        return substr($this->text, $pos + 1);
    }

    /**
     * Returns count of trailing whitespace characters.
     *
     * @return int
     */
    public function getTrailingWhitespaceCount()
    {
        return strlen($this->getTrailingWhitespace());
    }
}
?>