Merge pull request #810 from vssdeo/681-Plugin-Submission-Plugin-Utility-KeyBinding-Mouseless-Keyboard-URL-Open

681 Plugin submission mouseless keyboard url open decoupled code

terminatorlib/notebook.py

@@ -343,6 +343,10 @@ class Notebook(Container, Gtk.Notebook):
         self.set_current_page(tabpos)
         self.show_all()
         if maker.isinstance(term_widget, 'Terminal'):
+            #notify plugins of tab-change
+            dbg("emit tab-change for tabpos: %s " % tabpos)
+            term_widget.emit('tab-change', tabpos)
+            self.set_current_page(tabpos)
             widget.grab_focus()
 
     def wrapcloseterm(self, widget):

terminatorlib/plugins/mousefree_url_handler.py

@@ -0,0 +1,204 @@
+"""
+- With min changes to main code base, implementing mouse free url handling.
+- Using shortcuts to browse URL, next / previous, clear search. Selected URL
+is copied to clipboard.
+
+- Vishweshwar Saran Singh Deo vssdeo@gmail.com
+"""
+
+import gi
+gi.require_version('Vte', '2.91')  # vte-0.38 (gnome-3.14)
+from gi.repository import Vte
+
+from terminatorlib.terminator import Terminator
+
+from terminatorlib.config import Config
+import terminatorlib.plugin as plugin
+from terminatorlib.plugin import KeyBindUtil
+
+from terminatorlib.util import get_config_dir, err, dbg, gerr
+from terminatorlib import regex
+
+import re
+
+
+AVAILABLE = ['MouseFreeURLHandler']
+
+PluginUrlActFindNext = "plugin_url_find_next"
+PluginUrlActFindPrev = "plugin_url_find_prev"
+PluginUrlActEsc      = "plugin_url_esc"
+PluginUrlActLaunch   = "plugin_url_launch"
+
+
+PluginUrlFindNext = "Plugin Url Find Next"
+PluginUrlFindPrev = "Plugin Url Find Prev"
+PluginUrlEsc      = "Plugin Url Esc"
+PluginUrlLaunch   = "Plugin Url Launch"
+
+class MouseFreeURLHandler(plugin.Plugin):
+
+    capabilities = ['MouseFreeHandler']
+    handler_name = 'MouseFreeHandler'
+    nameopen     = None
+    namecopy     = None
+    match        = None
+
+    flag_http_on = False
+    config       = Config()
+    keyb         = KeyBindUtil(config)
+    matches      = []
+    matches_ptr  = -1
+    #basic pattern
+    searchtext  = "https?\:\/\/[^\s]+[\/\w]"
+
+    def __init__(self):
+        self.connect_signals()
+
+        self.keyb.bindkey_check_config(
+                [PluginUrlFindNext , PluginUrlActFindNext, "<Alt>j"])
+        self.keyb.bindkey_check_config(
+                [PluginUrlFindPrev , PluginUrlActFindPrev, "<Alt>k"])
+        self.keyb.bindkey_check_config(
+                [PluginUrlEsc   , PluginUrlActEsc,         "Escape"])
+        self.keyb.bindkey_check_config(
+                [PluginUrlLaunch, PluginUrlActLaunch,      "<Alt>Return"])
+
+    def connect_signals(self):
+        #this is not giving list off all connected terminals in window
+        dbg("direct terminals: %s" % Terminator().terminals)
+
+        #get list of all terminals indirectly
+        terms =  Terminator().terminals[0]
+        dbg("in-direct get terminals: %s" % terms.terminator.terminals)
+        
+        for term in terms.terminator.terminals:
+            dbg("signal connect term:%s" % term)
+            term.connect('tab-change', self.on_focus_in)
+
+        self.windows = Terminator().get_windows()
+        for window in self.windows:
+            window.connect('key-press-event', self.on_keypress)
+
+    def unload(self):
+        dbg("unloading")
+        #disconnect all signals and events
+        terms =  Terminator().terminals[0]
+        for term in terms.terminator.terminals:
+            try:
+                term.disconnect_by_func(self.on_focus_in)
+            except:
+                dbg("no connected signals")
+            
+        for window in self.windows:
+            try:
+                window.disconnect_by_func(self.on_keypress)
+            except:
+                dbg("no connected signals")
+
+        self.keyb.unbindkey(
+                [PluginUrlFindNext , PluginUrlActFindNext, "<Alt>j"])
+        self.keyb.unbindkey(
+                [PluginUrlFindPrev , PluginUrlActFindPrev, "<Alt>k"])
+        self.keyb.unbindkey(
+                [PluginUrlEsc   , PluginUrlActEsc,         "Escape"])
+        self.keyb.unbindkey(
+                [PluginUrlLaunch, PluginUrlActLaunch,      "<Alt>Return"])
+
+    def extract(self):
+        #can we do extract more efficiently
+        col, row =  self.vte.get_cursor_position()
+        (txt, attr) = self.vte.get_text_range(0,0,row, col)
+        self.matches = re.findall(self.searchtext, txt)
+        self.matches_ptr = len(self.matches)-1
+
+    def get_term(self):
+        return  Terminator().last_focused_term
+
+    def get_selected_url(self):
+        if len(self.matches):
+            dbg("found selected URL (%s %s %s)" %
+                (self.matches_ptr, self.matches[self.matches_ptr], self))
+            return self.matches[self.matches_ptr]
+        dbg("selected URL (%s %s)" % (self.matches_ptr, "not found"))
+        return None
+
+    def on_focus_in(self, widget, event):
+        dbg("focus-in clear url search buffer: %s" % self)
+        self.clear_search()
+
+    def on_keypress(self, widget, event):
+        act = self.keyb.keyaction(event)
+        dbg("keyaction: (%s) (%s)" % (str(act), event.keyval))
+
+        if act == PluginUrlActFindNext:
+            if not self.flag_http_on:
+                dbg("search URL on")
+                self.search()
+                self.extract()
+                #so when we start search last item be selected
+                self.vte.search_find_previous()
+                self.get_selected_url() # dbg url print
+                self.vte.copy_clipboard()
+                return True
+            else:
+                self.vte.search_find_next()
+
+            if (self.matches_ptr < len(self.matches)-1):
+                self.matches_ptr += 1
+            else:
+                self.matches_ptr = 0
+
+            self.vte.copy_clipboard()
+            self.get_selected_url() # dbg url print
+            return True
+
+        if act == PluginUrlActFindPrev:
+            if not self.flag_http_on:
+                self.search()
+                self.extract()
+                self.vte.search_find_previous()
+                self.get_selected_url() # dbg url print
+                self.vte.copy_clipboard()
+                return True
+
+            self.vte.search_find_previous()
+
+            if self.matches_ptr > 0:
+                self.matches_ptr -= 1
+            elif len(self.matches):
+                self.matches_ptr = len(self.matches)-1
+
+            self.vte.copy_clipboard()
+            self.get_selected_url() # dbg url print
+            return True
+
+        if act == PluginUrlActEsc:
+            self.clear_search()
+
+        if act == PluginUrlActLaunch:
+            url = self.get_selected_url()
+            if url:
+                self.get_term().open_url(url, prepare=False)
+
+
+    def clear_search(self):
+        self.matches = []
+        self.flag_http_on = False
+        self.matches_ptr  = -1
+        if self.get_term():
+            self.vte = self.get_term().get_vte()
+            self.vte.search_set_regex(None, 0)
+            dbg("search URL off")
+
+    def search(self):
+        dbg("searching text")
+        self.flag_http_on = True
+        self.vte = self.get_term().get_vte()
+
+        self.vte.search_set_wrap_around(True)
+        regex_flags_pcre2 = (regex.FLAGS_PCRE2 | regex.PCRE2_CASELESS)
+        searchre = Vte.Regex.new_for_search(self.searchtext,
+                        len(self.searchtext), regex_flags_pcre2)
+
+        self.vte.search_set_regex(searchre, 0)
+

terminatorlib/terminator.py

@@ -186,6 +186,13 @@ class Terminator(Borg):
         for terminal in self.terminals:
             dbg('checking: %s (%s)' % (terminal.uuid.urn, terminal))
             if terminal.uuid.urn == uuid:
+                if terminal.get_toplevel().is_child_notebook():
+                    topchild = terminal.get_toplevel().get_child()
+                    current_page = topchild.get_current_page()
+                    #we need to emit signal for plugin and retain same page 
+                    dbg("current_page for tab-change-signal:%s" % current_page)
+                    terminal.emit('tab-change', current_page)
+
                 return terminal
         return None
 
@@ -210,6 +217,7 @@ class Terminator(Borg):
         window.add(terminal)
         window.show(True)
         terminal.spawn_child()
+        terminal.emit('tab-change', 0)
 
         return(window, terminal)