From 4974219e0fce55973bb109793479887791e5cf96 Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Thu, 10 Nov 2022 21:38:59 +0530
Subject: [PATCH] Add function to shlex for completion

Also remove the google header since we have diverged from
the original a fair bit. Add a link to the original for credit.
---
 tools/utils/shlex/shlex.go      | 50 ++++++++++++++++++++++-----------
 tools/utils/shlex/shlex_test.go | 17 +++++++++++
 2 files changed, 51 insertions(+), 16 deletions(-)

diff --git a/tools/utils/shlex/shlex.go b/tools/utils/shlex/shlex.go
index 409996e5f..2e0d1a106 100644
--- a/tools/utils/shlex/shlex.go
+++ b/tools/utils/shlex/shlex.go
@@ -1,19 +1,3 @@
-/*
-Copyright 2012 Google Inc. All Rights Reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
 /*
 Package shlex implements a simple lexer which splits input in to tokens using
 shell-style rules for quoting.
@@ -38,6 +22,10 @@ To access the raw token stream (which includes tokens for spaces):
 */
 package shlex
 
+// Based on https://pkg.go.dev/github.com/google/shlex with many improvements
+// Relicensed to GPLv3 since all my additions.changes are GPLv3 which makes the
+// original work with was APL2 also GPLv3
+
 import (
 	"errors"
 	"fmt"
@@ -410,3 +398,33 @@ func Split(s string) ([]string, error) {
 		subStrings = append(subStrings, word)
 	}
 }
+
+// SplitForCompletion partitions a string into a slice of strings. It differs from Split in being
+// more relaxed about errors and also adding an empty string at the end if s ends with a SpaceToken.
+func SplitForCompletion(s string) (argv []string, position_of_last_arg int) {
+	t := NewTokenizer(strings.NewReader(s))
+	argv = make([]string, 0, len(s)/4)
+	token := &Token{}
+	for {
+		ntoken, err := t.Next()
+		if err == io.EOF {
+			if token.Type == SpaceToken {
+				argv = append(argv, "")
+				token.Pos += int64(len(token.Value))
+			}
+			return argv, int(token.Pos)
+		}
+		if ntoken == nil {
+			return []string{}, -1
+		}
+		switch ntoken.Type {
+		case WordToken:
+			argv = append(argv, ntoken.Value)
+		case SpaceToken:
+			// skip spaces
+		default:
+			return []string{}, -1
+		}
+		token = ntoken
+	}
+}
diff --git a/tools/utils/shlex/shlex_test.go b/tools/utils/shlex/shlex_test.go
index 611a0e23d..4882a8aec 100644
--- a/tools/utils/shlex/shlex_test.go
+++ b/tools/utils/shlex/shlex_test.go
@@ -116,3 +116,20 @@ func TestSplit(t *testing.T) {
 		}
 	}
 }
+
+func TestSplitForCompletion(t *testing.T) {
+	test := func(cmdline string, last_arg_pos int, expected ...string) {
+		actual, actual_pos := SplitForCompletion(cmdline)
+		if diff := cmp.Diff(expected, actual); diff != "" {
+			t.Fatalf("Failed to split: %s\n%s", cmdline, diff)
+		}
+		if last_arg_pos != actual_pos {
+			t.Fatalf("Failed to split: %s\n Last arg pos: %d != %d", cmdline, last_arg_pos, actual_pos)
+		}
+	}
+	test("a b", 2, "a", "b")
+	test("a b ", 4, "a", "b", "")
+	test("a b  ", 5, "a", "b", "")
+	test(`a "b c"`, 2, "a", "b c")
+	test(`a "b c`, 2, "a", "b c")
+}