Add line number support to UnexpectedTokenException and OutputException

Author: sidkshatriya

lib/Sabberworm/CSS/Parser.php

@@ -109,10 +109,10 @@ private function parseListItem(CSSList $oList, $bIsRoot = false) {
 			$oAtRule = $this->parseAtRule();
 			if($oAtRule instanceof Charset) {
 				if(!$bIsRoot) {
-					throw new UnexpectedTokenException('@charset may only occur in root document', '', 'custom');
+					throw new UnexpectedTokenException('@charset may only occur in root document', '', 'custom', $this->iLineNum);
 				}
 				if(count($oList->getContents()) > 0) {
-					throw new UnexpectedTokenException('@charset must be the first parseable token in a document', '', 'custom');
+					throw new UnexpectedTokenException('@charset must be the first parseable token in a document', '', 'custom', $this->iLineNum);
 				}
 				$this->setCharset($oAtRule->getCharset()->getString());
 			}
@@ -164,10 +164,10 @@ private function parseAtRule() {
 			}
 			$this->consume(';');
 			if ($sPrefix !== null && !is_string($sPrefix)) {
-				throw new UnexpectedTokenException('Wrong namespace prefix', $sPrefix, 'custom');
+				throw new UnexpectedTokenException('Wrong namespace prefix', $sPrefix, 'custom', $iIdentifierLineNum);
 			}
 			if (!($mUrl instanceof CSSString || $mUrl instanceof URL)) {
-				throw new UnexpectedTokenException('Wrong namespace url of invalid type', $mUrl, 'custom');
+				throw new UnexpectedTokenException('Wrong namespace url of invalid type', $mUrl, 'custom', $iIdentifierLineNum);
 			}
 			return new CSSNamespace($mUrl, $sPrefix, $iIdentifierLineNum);
 		} else {
@@ -195,7 +195,7 @@ private function parseAtRule() {
 	private function parseIdentifier($bAllowFunctions = true, $bIgnoreCase = true) {
 		$sResult = $this->parseCharacter(true);
 		if ($sResult === null) {
-			throw new UnexpectedTokenException($sResult, $this->peek(5), 'identifier');
+			throw new UnexpectedTokenException($sResult, $this->peek(5), 'identifier', $this->iLineNum);
 		}
 		$sCharacter = null;
 		while (($sCharacter = $this->parseCharacter(true)) !== null) {
@@ -522,14 +522,14 @@ private function consume($mValue = 1) {
 			$iLineCount = substr_count($mValue, "\n");
 			$iLength = $this->strlen($mValue);
 			if (!$this->streql($this->substr($this->iCurrentPosition, $iLength), $mValue)) {
-				throw new UnexpectedTokenException($mValue, $this->peek(max($iLength, 5)));
+				throw new UnexpectedTokenException($mValue, $this->peek(max($iLength, 5)), $this->iLineNum);
 			}
 			$this->iLineNum += $iLineCount;
 			$this->iCurrentPosition += $this->strlen($mValue);
 			return $mValue;
 		} else {
 			if ($this->iCurrentPosition + $mValue > $this->iLength) {
-				throw new UnexpectedTokenException($mValue, $this->peek(5), 'count');
+				throw new UnexpectedTokenException($mValue, $this->peek(5), 'count', $this->iLineNum);
 			}
 			$sResult = $this->substr($this->iCurrentPosition, $mValue);
 			$iLineCount = substr_count($sResult, "\n");
@@ -544,7 +544,7 @@ private function consumeExpression($mExpression) {
 		if (preg_match($mExpression, $this->inputLeft(), $aMatches, PREG_OFFSET_CAPTURE) === 1) {
 			return $this->consume($aMatches[0][0]);
 		}
-		throw new UnexpectedTokenException($mExpression, $this->peek(5), 'expression');
+		throw new UnexpectedTokenException($mExpression, $this->peek(5), 'expression', $this->iLineNum);
 	}
 
 	private function consumeWhiteSpace() {
@@ -602,7 +602,7 @@ private function consumeUntil($aEnd, $bIncludeEnd = false, $consumeEnd = false)
 		}
 
 		$this->iCurrentPosition = $start;
-		throw new UnexpectedTokenException('One of ("'.implode('","', $aEnd).'")', $this->peek(5), 'search');
+		throw new UnexpectedTokenException('One of ("'.implode('","', $aEnd).'")', $this->peek(5), 'search', $this->iLineNum);
 	}
 
 	private function inputLeft() {

lib/Sabberworm/CSS/Parsing/OutputException.php

@@ -6,4 +6,13 @@
 * Thrown if the CSS parsers attempts to print something invalid
 */
 class OutputException extends \Exception {
+    private $iLineNum;
+    public function __construct($sMessage, $iLineNum = 0)
+    {
+        $this->$iLineNum = $iLineNum;
+        if (!empty($iLineNum)) {
+            $sMessage .= " [line no: $iLineNum]";
+        }
+        parent::__construct($sMessage);
+    }
 }

lib/Sabberworm/CSS/Parsing/UnexpectedTokenException.php

@@ -10,11 +10,13 @@ class UnexpectedTokenException extends \Exception {
 	private $sFound;
 	// Possible values: literal, identifier, count, expression, search
 	private $sMatchType;
+	private $iLineNum;
 
-	public function __construct($sExpected, $sFound, $sMatchType = 'literal') {
+	public function __construct($sExpected, $sFound, $sMatchType = 'literal', $iLineNum = 0) {
 		$this->sExpected = $sExpected;
 		$this->sFound = $sFound;
 		$this->sMatchType = $sMatchType;
+		$this->iLineNum = $iLineNum;
 		$sMessage = "Token “{$sExpected}” ({$sMatchType}) not found. Got “{$sFound}”.";
 		if($this->sMatchType === 'search') {
 			$sMessage = "Search for “{$sExpected}” returned no results. Context: “{$sFound}”.";
@@ -25,6 +27,11 @@ public function __construct($sExpected, $sFound, $sMatchType = 'literal') {
 		} else if($this->sMatchType === 'custom') {
 			$sMessage = trim("$sExpected $sFound");
 		}
+
+		if (!empty($iLineNum)) {
+			$sMessage .= " [line no: $iLineNum]";
+		}
+
 		parent::__construct($sMessage);
 	}
 }

lib/Sabberworm/CSS/RuleSet/DeclarationBlock.php

@@ -597,7 +597,7 @@ public function __toString() {
 	public function render(\Sabberworm\CSS\OutputFormat $oOutputFormat) {
 		if(count($this->aSelectors) === 0) {
 			// If all the selectors have been removed, this declaration block becomes invalid
-			throw new OutputException("Attempt to print declaration block with missing selector");
+			throw new OutputException("Attempt to print declaration block with missing selector", $this->iLineNum);
 		}
 		$sResult = $oOutputFormat->implode($oOutputFormat->spaceBeforeSelectorSeparator() . ',' . $oOutputFormat->spaceAfterSelectorSeparator(), $this->aSelectors) . $oOutputFormat->spaceBeforeOpeningBrace() . '{';
 		$sResult .= parent::render($oOutputFormat);