Pass start and end offset as number of Unicode characters

Author: clue

README.md

@@ -420,16 +420,17 @@ input buffer is `hello exit `, which may or may not be what you need depending
 on your particular use case.
 
 In order to give your more control over this behavior, the autocomplete function
-actually receives two arguments (similar to `ext-readline`'s
+actually receives three arguments (similar to `ext-readline`'s
 [`readline_completion_function()`](http://php.net/manual/en/function.readline-completion-function.php)):
 The first argument will be the current incomplete word according to current
-cursor position and word boundaries, while the second argument will be the
-offset of this word within the complete input buffer.
-The above examples will be invoked as `$fn('he', 0)`, `$fn('e', 0)` and
-`$fn('ex', 6)` respectively.
-You may want to use the `$offset` argument to check if the current word is an
-argument or a root command and the `$word` argument to autocomplete partial
-filename matches like this:
+cursor position and word boundaries, while the second and third argument will be
+the start and end offset of this word within the complete input buffer measured
+in (Unicode) characters.
+The above examples will be invoked as `$fn('he', 0, 2)`, `$fn('e', 0, 1)` and
+`$fn('ex', 6, 8)` respectively.
+You may want to use this as an `$offset` argument to check if the current word
+is an argument or a root command and the `$word` argument to autocomplete
+partial filename matches like this:
 
 ```php
 $readline->setAutocomplete(function ($word, $offset) {
@@ -445,7 +446,7 @@ $readline->setAutocomplete(function ($word, $offset) {
 
 > Note that the user may also use quotes and/or leading whitespace around the
 root command, for example `"hell [TAB]`, in which case the offset will be
-advanced such as this will be invoked as `$fn('hell', 1)`.
+advanced such as this will be invoked as `$fn('hell', 1, 4)`.
 Unless you use a more sophisticated argument parser, a decent approximation may
 be using `$offset <= 1` to check this is a root command. 
 

src/Readline.php

@@ -509,7 +509,8 @@ public function onKeyTab()
         // current word prefix and offset for start of word in input buffer
         // "echo foo|bar world" will return just "foo" with word offset 5
         $word = $this->substr($this->linebuffer, 0, $this->linepos);
-        $offset = 0;
+        $start = 0;
+        $end = $this->linepos;
 
         // buffer prefix and postfix for everything that will *not* be matched
         // above example will return "echo " and "bar world"
@@ -519,22 +520,22 @@ public function onKeyTab()
         // skip everything before last space
         $pos = strrpos($word, ' ');
         if ($pos !== false) {
-            $offset = $pos + 1;
-            $prefix = (string)substr($word, 0, $offset);
-            $word = (string)substr($word, $offset);
+            $prefix = (string)substr($word, 0, $pos + 1);
+            $word = (string)substr($word, $pos + 1);
+            $start = $this->strlen($prefix);
         }
 
         // skip double quote (") or single quote (') from argument
         $quote = null;
         if (isset($word[0]) && ($word[0] === '"' || $word[0] === '\'')) {
             $quote = $word[0];
-            ++$offset;
+            ++$start;
             $prefix .= $word[0];
             $word = (string)substr($word, 1);
         }
 
         // invoke autocomplete callback
-        $words = call_user_func($this->autocomplete, $word, $offset);
+        $words = call_user_func($this->autocomplete, $word, $start, $end);
 
         // return early if autocomplete does not return anything
         if ($words === null) {

tests/ReadlineTest.php

@@ -530,14 +530,14 @@ public function testAutocompleteWillNotBeCalledAfterUnset()
 
     public function testAutocompleteWillBeCalledWithEmptyBuffer()
     {
-        $this->readline->setAutocomplete($this->expectCallableOnceWith('', 0));
+        $this->readline->setAutocomplete($this->expectCallableOnceWith('', 0, 0));
 
         $this->readline->onKeyTab();
     }
 
     public function testAutocompleteWillBeCalledWithCompleteWord()
     {
-        $this->readline->setAutocomplete($this->expectCallableOnceWith('hello', 0));
+        $this->readline->setAutocomplete($this->expectCallableOnceWith('hello', 0, 5));
 
         $this->readline->setInput('hello');
 
@@ -546,7 +546,7 @@ public function testAutocompleteWillBeCalledWithCompleteWord()
 
     public function testAutocompleteWillBeCalledWithWordPrefix()
     {
-        $this->readline->setAutocomplete($this->expectCallableOnceWith('he', 0));
+        $this->readline->setAutocomplete($this->expectCallableOnceWith('he', 0, 2));
 
         $this->readline->setInput('hello');
         $this->readline->moveCursorTo(2);
@@ -556,7 +556,7 @@ public function testAutocompleteWillBeCalledWithWordPrefix()
 
     public function testAutocompleteWillBeCalledWithLastWord()
     {
-        $this->readline->setAutocomplete($this->expectCallableOnceWith('world', 6));
+        $this->readline->setAutocomplete($this->expectCallableOnceWith('world', 6, 11));
 
         $this->readline->setInput('hello world');
 
@@ -565,14 +565,34 @@ public function testAutocompleteWillBeCalledWithLastWord()
 
     public function testAutocompleteWillBeCalledWithLastWordPrefix()
     {
-        $this->readline->setAutocomplete($this->expectCallableOnceWith('wo', 6));
+        $this->readline->setAutocomplete($this->expectCallableOnceWith('wo', 6, 8));
 
         $this->readline->setInput('hello world');
         $this->readline->moveCursorTo(8);
 
         $this->readline->onKeyTab();
     }
 
+    public function testAutocompleteWillBeCalledWithLastWordPrefixUnicode()
+    {
+        $this->readline->setAutocomplete($this->expectCallableOnceWith('wö', 6, 8));
+
+        $this->readline->setInput('hällö wörld');
+        $this->readline->moveCursorTo(8);
+
+        $this->readline->onKeyTab();
+    }
+
+    public function testAutocompleteWillBeCalledWithLastWordPrefixQuotedUnicode()
+    {
+        $this->readline->setAutocomplete($this->expectCallableOnceWith('wö', 9, 11));
+
+        $this->readline->setInput('"hällö" "wörld"');
+        $this->readline->moveCursorTo(11);
+
+        $this->readline->onKeyTab();
+    }
+
     public function testAutocompleteAddsSpaceAfterComplete()
     {
         $this->readline->setAutocomplete(function () { return array('exit'); });

tests/bootstrap.php

@@ -32,18 +32,7 @@ protected function expectCallableOnceWith($value)
         $mock
             ->expects($this->once())
             ->method('__invoke')
-            ->with($this->equalTo($value));
-
-        return $mock;
-    }
-
-    protected function expectCallableOnceParameter($type)
-    {
-        $mock = $this->createCallableMock();
-        $mock
-            ->expects($this->once())
-            ->method('__invoke')
-            ->with($this->isInstanceOf($type));
+            ->withConsecutive(func_get_args());
 
         return $mock;
     }