Fix the incorrect display of the column and line in errors

src/Exception/ExceptionHelper.php

@@ -0,0 +1,163 @@
+<?php
+/**
+ * Hoa
+ *
+ *
+ * @license
+ *
+ * BSD 3-Clause License
+ *
+ * Copyright © 2007-2017, Hoa community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    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 OR CONTRIBUTORS 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.
+ *
+ */
+
+namespace Hoa\Compiler\Exception;
+
+/**
+ * Class \Hoa\Compiler\Exception.
+ *
+ * Extending the \Hoa\Exception\Exception class.
+ *
+ * @copyright  Copyright © 2007-2017 Hoa community
+ * @license    New BSD License
+ */
+trait ExceptionHelper
+{
+    /**
+     * This is an auxiliary method that returns the line number, shift,
+     * and line of code by shift relative to the beginning of the file.
+     *
+     * @param   string $text        The source code
+     * @param   int    $bytesOffset Offset in bytes
+     * @return  array
+     */
+    protected static function getErrorPositionByOffset($text, $bytesOffset)
+    {
+        $result = self::getErrorInfo($text, $bytesOffset);
+        $code   = self::getAffectedCodeAsString($result['trace']);
+
+        $column = self::getMbColumnPosition($code, $result['column']);
+
+        return [
+            'line'      => $result['line'],
+            'code'      => $code,
+            'column'    => $column,
+            'highlight' => self::getStringHighligher($column),
+        ];
+    }
+
+    /**
+     * Returns the last line with an error. If the error occurred on
+     * the line where there is no visible part, before complements
+     * it with the previous ones.
+     *
+     * @param array|string[] $textLines List of code lines
+     * @return string
+     */
+    private static function getAffectedCodeAsString(array $textLines)
+    {
+        $result = '';
+        $i      = 0;
+
+        while (\count($textLines) && ++$i) {
+            $textLine = \array_pop($textLines);
+            $result   = $textLine . ($i > 1 ? "\n" . $result : '');
+
+            if (\trim($textLine)) {
+                break;
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * The method draws the highlight of the error place.
+     *
+     * @param  int $charsOffset Error offset in symbols
+     * @return string
+     */
+    private static function getStringHighligher($charsOffset)
+    {
+        $prefix = '';
+
+        if ($charsOffset > 0) {
+            $prefix = \str_repeat(' ', $charsOffset);
+        }
+
+        return $prefix . '↑';
+    }
+
+    /**
+     * Returns the error location in UTF characters by the offset in bytes.
+     *
+     * @param  string $line        The code line from which we get a offset in the characters
+     * @param  int    $bytesOffset Length of offset in bytes
+     * @return int
+     */
+    private static function getMbColumnPosition($line, $bytesOffset)
+    {
+        $slice = \substr($line, 0, $bytesOffset);
+
+        return \mb_strlen($slice, 'UTF-8');
+    }
+
+    /**
+     * Returns information about the error location: line, column and affected text lines.
+     *
+     * @param string $text        The source code in which we search for a line and a column
+     * @param int    $bytesOffset Offset in bytes relative to the beginning of the source code
+     * @return array
+     */
+    private static function getErrorInfo($text, $bytesOffset)
+    {
+        $result = [
+            'line'   => 1,
+            'column' => 0,
+            'trace'  => [],
+        ];
+
+        $current = 0;
+
+        foreach (\explode("\n", $text) as $line => $code) {
+            $previous = $current;
+            $current += \strlen($code) + 1;
+            $result['trace'][] = $code;
+
+            if ($current > $bytesOffset) {
+                return [
+                    'line'   => $line + 1,
+                    'column' => $bytesOffset - $previous,
+                    'trace'  => $result['trace']
+                ];
+            }
+        }
+
+        return $result;
+    }
+}

src/Exception/UnrecognizedToken.php

@@ -48,15 +48,15 @@
  */
 class UnrecognizedToken extends Exception
 {
+    use ExceptionHelper;
+
     /**
      * Column.
      *
      * @var int
      */
     protected $column = 0;
 
-
-
     /**
      * Override line and add column support.
      *
@@ -76,6 +76,25 @@ public function __construct($message, $code, $arg, $line, $column)
         return;
     }
 
+    /**
+     * @param   string  $message        Formatted message.
+     * @param   string  $text           Source code
+     * @param   int     $offsetInBytes  Error offset in bytes
+     * @param   int     $code           Code (the ID).
+     * @return  static
+     */
+    public static function fromOffset($message, $text, $offsetInBytes, $code = 0)
+    {
+        $info     = self::getErrorPositionByOffset($text, $offsetInBytes);
+
+        // Formatted message
+        $message .= ' at line %s and column %s' . \PHP_EOL .
+            $info['code'] . \PHP_EOL .
+            $info['highlight'];
+
+        return new static($message, $code, [$info['line'], $info['column']], $info['line'], $info['column']);
+    }
+
     /**
      * Get column.
      *

src/Llk/Lexer.php

@@ -85,8 +85,6 @@ final class Lexer
      */
     protected $_pcreOptions = null;
 
-
-
     /**
      * Constructor.
      *
@@ -155,19 +153,9 @@ public function lexMe($text, array $tokens): \Generator
             $nextToken = $this->nextToken($offset);
 
             if (null === $nextToken) {
-                throw new Compiler\Exception\UnrecognizedToken(
-                    'Unrecognized token "%s" at line 1 and column %d:' .
-                    "\n" . '%s' . "\n" .
-                    str_repeat(' ', mb_strlen(substr($text, 0, $offset))) . '↑',
-                    0,
-                    [
-                        mb_substr(substr($text, $offset), 0, 1),
-                        $offset + 1,
-                        $text
-                    ],
-                    1,
-                    $offset
-                );
+                $error = \sprintf('Unrecognized token "%s"', \mb_substr(\substr($text, $offset), 0, 1));
+
+                throw Compiler\Exception\UnrecognizedToken::fromOffset($error, $text, $offset);
             }
 
             if (true === $nextToken['keep']) {

src/Llk/Parser.php

@@ -188,46 +188,18 @@ final public function parse(string $text, string $rule = null, bool $tree = true
             }
 
             if (false === $this->backtrack()) {
-                $token  = $this->_errorToken;
+                $token = $this->_errorToken;
 
                 if (null === $this->_errorToken) {
                     $token = $this->_tokenSequence->current();
                 }
 
-                $offset = $token['offset'];
-                $line   = 1;
-                $column = 1;
-
-                if (!empty($text)) {
-                    if (0 === $offset) {
-                        $leftnl = 0;
-                    } else {
-                        $leftnl = strrpos($text, "\n", -(strlen($text) - $offset) - 1) ?: 0;
-                    }
-
-                    $rightnl = strpos($text, "\n", $offset);
-                    $line    = substr_count($text, "\n", 0, $leftnl + 1) + 1;
-                    $column  = $offset - $leftnl + (0 === $leftnl);
-
-                    if (false !== $rightnl) {
-                        $text = trim(substr($text, $leftnl, $rightnl - $leftnl), "\n");
-                    }
-                }
+                $error = \vsprintf('Unexpected token "%s" (%s)', [
+                    $token['value'],
+                    $token['token'],
+                ]);
 
-                throw new Compiler\Exception\UnexpectedToken(
-                    'Unexpected token "%s" (%s) at line %d and column %d:' .
-                    "\n" . '%s' . "\n" . str_repeat(' ', $column - 1) . '↑',
-                    0,
-                    [
-                        $token['value'],
-                        $token['token'],
-                        $line,
-                        $column,
-                        $text
-                    ],
-                    $line,
-                    $column
-                );
+                throw Compiler\Exception\UnexpectedToken::fromOffset($error, $text, $token['offset']);
             }
         } while (true);