Vim Mode 2022

.gitignore

@@ -7,9 +7,11 @@ interfacer/vendor
 interfacer/dist
 interfacer/interfacer
 interfacer/browsh
+interfacer/debug
 webextension.go
 webext/node_modules
 webext/dist/*
+webext/manifest.json~
 dist
 *.xpi
 

interfacer/go.mod

@@ -4,6 +4,7 @@ go 1.18
 
 require (
 	github.com/NYTimes/gziphandler v1.1.1
+	github.com/atotto/clipboard v0.1.4
 	github.com/gdamore/tcell v1.4.0
 	github.com/go-errors/errors v1.4.2
 	github.com/gorilla/websocket v1.5.0

interfacer/go.sum

@@ -40,6 +40,8 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03
 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
 github.com/NYTimes/gziphandler v1.1.1 h1:ZUDjpQae29j0ryrS0u/B8HZfJBtBQHjqw2rQ2cqUQ3I=
 github.com/NYTimes/gziphandler v1.1.1/go.mod h1:n/CVRwUEOgIxrgPvAQhUUr9oeUtvrhMomdKFjzJNB0c=
+github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
+github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=

interfacer/src/browsh/browsh.go

@@ -11,6 +11,7 @@ import (
 	"runtime"
 	"strconv"
 	"strings"
+	"time"
 
 	// TCell seems to be one of the best projects in any language for handling terminal
 	// standards across the major OSs.
@@ -23,7 +24,7 @@ import (
 
 var (
 	logo = `
-////  ////
+ ////  ////
  / /   / /
  //    //
  //    //    ,,,,,,,,
@@ -73,7 +74,7 @@ func Log(msg string) {
 		}
 		defer f.Close()
 
-		msg = msg + "\n"
+		msg = time.Now().Format("01-02T15:04:05.999 ") + msg + "\n"
 		if _, wErr := f.WriteString(msg); wErr != nil {
 			Shutdown(wErr)
 		}
@@ -159,6 +160,7 @@ func TTYStart(injectedScreen tcell.Screen) {
 	Log("Starting Browsh CLI client")
 	go readStdin()
 	startWebSocketServer()
+	setupLinkHints()
 }
 
 func toInt(char string) int {
@@ -185,6 +187,12 @@ func ttyEntry() {
 		// from tcell.
 		os.Setenv("TERM", "xterm-truecolor")
 	}
+	// This is for getting the clipboard (github.com/atotto/clipboard) to work
+	// with the applications xsel and xclip on systems with an X display server.
+	if os.Getenv("DISPLAY") == "" {
+		os.Setenv("DISPLAY", ":0")
+	}
+
 	realScreen, err := tcell.NewScreen()
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "%v\n", err)

interfacer/src/browsh/comms.go

@@ -62,7 +62,7 @@ func webSocketReader(ws *websocket.Conn) {
 				triggerSocketWriterClose()
 				return
 			}
-			Shutdown(err)
+			Shutdown(errors.New(err.Error()))
 		}
 	}
 }
@@ -88,8 +88,10 @@ func handleWebextensionCommand(message []byte) {
 		}
 	case "/screenshot":
 		saveScreenshot(parts[1])
+	case "/link_hints":
+		parseJSONLinkHints(strings.Join(parts[1:], ","))
 	default:
-		Log("WEBEXT: " + string(message))
+		Log("IGNORE " + string(message))
 	}
 }
 
@@ -128,7 +130,6 @@ func webSocketWriter(ws *websocket.Conn) {
 	defer ws.Close()
 	for {
 		message = <-stdinChannel
-		Log(fmt.Sprintf("TTY sending: %s", message))
 		if err := ws.WriteMessage(websocket.TextMessage, []byte(message)); err != nil {
 			if err == websocket.ErrCloseSent {
 				Log("Socket writer detected that the browser closed the websocket")

interfacer/src/browsh/config.go

@@ -74,6 +74,66 @@ func getFirefoxProfilePath() string {
 func setDefaults() {
 	// Temporary experimental configurable keybindings
 	viper.SetDefault("tty.keys.next-tab", []string{"\u001c", "28", "2"})
+
+	// Vim commands
+	vimKeyMap["normal gg"] = "scrollToTop"
+	vimKeyMap["normal G"] = "scrollToBottom"
+	vimKeyMap["normal j"] = "scrollDown"
+	vimKeyMap["normal k"] = "scrollUp"
+	vimKeyMap["normal h"] = "scrollLeft"
+	vimKeyMap["normal l"] = "scrollRight"
+	vimKeyMap["normal d"] = "scrollHalfPageDown"
+	vimKeyMap["normal <C-d>"] = "scrollHalfPageDown"
+	vimKeyMap["normal u"] = "scrollHalfPageUp"
+	vimKeyMap["normal <C-u>"] = "scrollHalfPageUp"
+	vimKeyMap["normal e"] = "editURL"
+	vimKeyMap["normal ge"] = "editURL"
+	vimKeyMap["normal gE"] = "editURLInNewTab"
+	vimKeyMap["normal H"] = "historyBack"
+	vimKeyMap["normal L"] = "historyForward"
+	vimKeyMap["normal J"] = "prevTab"
+	vimKeyMap["normal K"] = "nextTab"
+	vimKeyMap["normal r"] = "reload"
+	vimKeyMap["normal xx"] = "removeTab"
+	vimKeyMap["normal X"] = "restoreTab"
+	vimKeyMap["normal t"] = "newTab"
+	vimKeyMap["normal T"] = "searchForTab"
+	vimKeyMap["normal /"] = "findMode"
+	vimKeyMap["normal n"] = "findNext"
+	vimKeyMap["normal N"] = "findPrevious"
+	vimKeyMap["normal g0"] = "firstTab"
+	vimKeyMap["normal g$"] = "lastTab"
+	vimKeyMap["normal gu"] = "urlUp"
+	vimKeyMap["normal gU"] = "urlRoot"
+	vimKeyMap["normal <<"] = "moveTabLeft"
+	vimKeyMap["normal >>"] = "moveTabRight"
+	vimKeyMap["normal ^"] = "previouslyVisitedTab"
+	vimKeyMap["normal m"] = "makeMark"
+	vimKeyMap["normal '"] = "gotoMark"
+	vimKeyMap["normal i"] = "insertMode"
+	vimKeyMap["normal I"] = "insertModeHard"
+	vimKeyMap["normal yy"] = "copyURL"
+	vimKeyMap["normal p"] = "openClipboardURL"
+	vimKeyMap["normal P"] = "openClipboardURLInNewTab"
+	vimKeyMap["normal gi"] = "focusFirstTextInput"
+	vimKeyMap["normal f"] = "openLinkInCurrentTab"
+	vimKeyMap["normal F"] = "openLinkInNewTab"
+	vimKeyMap["normal <M-f>"] = "openMultipleLinksInNewTab"
+	vimKeyMap["normal yf"] = "copyLinkURL"
+	vimKeyMap["normal [["] = "followLinkLabeledPrevious"
+	vimKeyMap["normal ]]"] = "followLinkLabeledNext"
+	vimKeyMap["normal yt"] = "duplicateTab"
+	vimKeyMap["normal v"] = "visualMode"
+	vimKeyMap["normal ?"] = "viewHelp"
+	vimKeyMap["caret v"] = "visualMode"
+	vimKeyMap["caret h"] = "moveCaretLeft"
+	vimKeyMap["caret l"] = "moveCaretRight"
+	vimKeyMap["caret j"] = "moveCaretDown"
+	vimKeyMap["caret k"] = "moveCaretUp"
+	vimKeyMap["caret <Enter>"] = "clickAtCaretPosition"
+	vimKeyMap["visual c"] = "caretMode"
+	vimKeyMap["visual o"] = "swapVisualModeCursorPosition"
+	vimKeyMap["visual y"] = "copyVisualModeSelection"
 }
 
 func loadConfig() {

interfacer/src/browsh/firefox.go

@@ -87,7 +87,7 @@ func startHeadlessFirefox() {
 	}
 	in := bufio.NewScanner(stdout)
 	for in.Scan() {
-		Log("FF-CONSOLE: " + in.Text())
+		Log("start headless FF-CONSOLE: " + in.Text())
 	}
 }
 
@@ -185,7 +185,7 @@ func startWERFirefox() {
 			strings.Contains(in.Text(), "dbus") {
 			continue
 		}
-		Log("FF-CONSOLE: " + in.Text())
+		Log("start WER FF-CONSOLE: " + in.Text())
 	}
 	Log("WER Firefox unexpectedly closed")
 }

interfacer/src/browsh/frame_builder.go

@@ -89,6 +89,14 @@ func (f *frame) buildFrameText(incoming incomingFrameText) {
 	if !f.isIncomingFrameTextValid(incoming) {
 		return
 	}
+
+	var s = "/frame_text "
+	for _, c := range incoming.Text {
+		if c != "" {
+			s = s + c
+		}
+	}
+	Log(s)
 	f.updateInputBoxes(incoming)
 	f.populateFrameText(incoming)
 }
@@ -160,9 +168,9 @@ func (f *frame) updateInputBoxes(incoming incomingFrameText) {
 		inputBox := f.inputBoxes[incomingInputBox.ID]
 		inputBox.X = incomingInputBox.X
 		// TODO: Why do we have to add the 1 to the y coord??
-		inputBox.Y = (incomingInputBox.Y + 1) / 2
+		inputBox.Y = (incomingInputBox.Y + 0) / 2
 		inputBox.Width = incomingInputBox.Width
-		inputBox.Height = incomingInputBox.Height / 2
+		inputBox.Height = (incomingInputBox.Height / 2) + 1
 		inputBox.FgColour = incomingInputBox.FgColour
 		inputBox.TagName = incomingInputBox.TagName
 		inputBox.Type = incomingInputBox.Type
@@ -312,7 +320,7 @@ func (f *frame) maybeFocusInputBox(x, y int) {
 		left := inputBox.X
 		right := inputBox.X + inputBox.Width
 		if x >= left && x < right && y >= top && y < bottom {
-			urlBarFocus(false)
+			URLBarFocus(false)
 			inputBox.isActive = true
 			activeInputBox = inputBox
 		}

interfacer/src/browsh/input_box.go

@@ -12,7 +12,7 @@ var activeInputBox *inputBox
 // A box into which you can enter text. Generally will be forwarded to a standard
 // HTML input box in the real browser.
 //
-// Note that tcell alreay has some ready-made code in its 'views' concept for
+// Note that tcell already has some ready-made code in its 'views' concept for
 // dealing with input areas. However, at the time of writing it wasn't well documented,
 // so it was unclear how easy it would be to integrate the requirements of Browsh's
 // input boxes - namely overlaying them onto the existing graphics and having them
@@ -181,7 +181,7 @@ func (i *inputBox) handleEnterKey(modifier tcell.ModMask) {
 		} else {
 			sendMessageToWebExtension("/url_bar," + string(i.text))
 		}
-		urlBarFocus(false)
+		URLBarFocus(false)
 	}
 	if i.isMultiLine() && modifier != tcell.ModAlt {
 		i.cursorInsertRune([]rune("\n")[0])
@@ -237,6 +237,9 @@ func handleInputBoxInput(ev *tcell.EventKey) {
 	case tcell.KeyEnter:
 		activeInputBox.removeSelectedText()
 		activeInputBox.handleEnterKey(ev.Modifiers())
+	case tcell.KeyEscape:
+		activeInputBox.isActive = false
+		activeInputBox = nil
 	case tcell.KeyRune:
 		activeInputBox.removeSelectedText()
 		activeInputBox.cursorInsertRune(ev.Rune())

interfacer/src/browsh/input_multiline.go

@@ -28,7 +28,9 @@ func (m *multiLine) convert() []rune {
 		}
 		if m.isInsideWord() {
 			// TODO: This sometimes causes a panic :/
-			m.currentWordish += m.currentCharacter
+			if m.currentCharacter != "" {
+				m.currentWordish += m.currentCharacter
+			}
 		} else {
 			m.addWhitespace()
 		}

interfacer/src/browsh/tab.go

@@ -18,6 +18,9 @@ var tabsOrder []int
 // the tab being deleted, so we need to keep track of all deleted IDs
 var tabsDeleted []int
 
+// ID of the tab that was active before the current one
+var previouslyVisitedTabID int
+
 // A single tab synced from the browser
 type tab struct {
 	ID            int    `json:"id"`
@@ -61,6 +64,10 @@ func newTab(id int) {
 	}
 }
 
+func restoreTab() {
+	sendMessageToWebExtension("/restore_tab")
+}
+
 func removeTab(id int) {
 	if len(Tabs) == 1 {
 		quitBrowsh()
@@ -84,23 +91,63 @@ func removeTabIDfromTabsOrder(id int) {
 	}
 }
 
+func moveTabLeft(id int) {
+	// If the tab ID is already completely to the left in the tab order
+	// there's nothing to do
+	if tabsOrder[0] == id {
+		return
+	}
+
+	for i, tabID := range tabsOrder {
+		if tabID == id {
+			tabsOrder[i-1], tabsOrder[i] = tabsOrder[i], tabsOrder[i-1]
+			break
+		}
+	}
+}
+
+func moveTabRight(id int) {
+	// If the tab ID is already completely to the right in the tab order
+	// there's nothing to do
+	if tabsOrder[len(tabsOrder)-1] == id {
+		return
+	}
+
+	for i, tabID := range tabsOrder {
+		if tabID == id {
+			tabsOrder[i+1], tabsOrder[i] = tabsOrder[i], tabsOrder[i+1]
+			break
+		}
+	}
+}
+
+func duplicateTab(id int) {
+	sendMessageToWebExtension(fmt.Sprintf("/duplicate_tab,%d", id))
+}
+
 // Creating a new tab in the browser without a URI means it won't register with the
 // web extension, which means that, come the moment when we actually have a URI for the new
 // tab then we can't talk to it to tell it navigate. So we need to only create a real new
 // tab when we actually have a URL.
 func createNewEmptyTab() {
+	createNewEmptyTabWithURI("")
+}
+
+func createNewEmptyTabWithURI(URI string) {
 	if isNewEmptyTabActive() {
 		return
 	}
 	newTab(-1)
 	tab := Tabs[-1]
 	tab.Title = "New Tab"
-	tab.URI = ""
+	tab.URI = URI
 	tab.Active = true
 	CurrentTab = tab
 	CurrentTab.frame.resetCells()
 	renderUI()
-	urlBarFocus(true)
+	URLBarFocus(true)
+	// Allows for typing directly at the end of URI
+	urlInputBox.selectionOff()
 	renderCurrentTabWindow()
 }
 
@@ -116,15 +163,41 @@ func nextTab() {
 			} else {
 				i++
 			}
-			sendMessageToWebExtension(fmt.Sprintf("/switch_to_tab,%d", tabsOrder[i]))
-			CurrentTab = Tabs[tabsOrder[i]]
-			renderUI()
-			renderCurrentTabWindow()
+			switchToTab(tabsOrder[i])
+			break
+		}
+	}
+}
+
+func prevTab() {
+	for i := 0; i < len(tabsOrder); i++ {
+		if tabsOrder[i] == CurrentTab.ID {
+			if i-1 < 0 {
+				i = len(tabsOrder) - 1
+			} else {
+				i--
+			}
+			switchToTab(tabsOrder[i])
 			break
 		}
 	}
 }
 
+func previouslyVisitedTab() {
+	if previouslyVisitedTabID == 0 {
+		return
+	}
+	switchToTab(previouslyVisitedTabID)
+}
+
+func switchToTab(num int) {
+	sendMessageToWebExtension(fmt.Sprintf("/switch_to_tab,%d", num))
+	previouslyVisitedTabID = CurrentTab.ID
+	CurrentTab = Tabs[num]
+	renderUI()
+	renderCurrentTabWindow()
+}
+
 func isTabPreviouslyDeleted(id int) bool {
 	for i := 0; i < len(tabsDeleted); i++ {
 		if tabsDeleted[i] == id {