Clean up deprecated code and fix multiple issues

- Remove deprecated markdown_preview plugin and re-wrote
- Renamed alt_provider.py under words completer
- Fix words completion provider logic and cache handling
- Fix container orientations (VERTICAL -> HORIZONTAL) and add Separators
- Remove unused Gtk imports from search_replace plugin
- Fix event creation parameter order in source_file.py
- Fix typo in source_view.py (_load_pretify_json -> _load_prettify_json)
- Refactor webkit_ui with new load methods and enhanced settings

plugins/code/completers/words_completer/default_provider.py

@@ -32,8 +32,23 @@ class Provider(GtkSource.CompletionWords):
         return 'Words Completion'
 
     def do_match(self, context):
+        # Note: If provider is in interactive activation then need to check
+        # view focus as otherwise non focus views start trying to grab it.
+        completion = context.get_property("completion")
+        if not completion.get_view().has_focus(): return
+
         word = self.response_cache.get_word(context)
         if not word or len(word) < 2: return False
+
+        iter = self.response_cache.get_iter_correctly(context)
+        iter.backward_char()
+        ch = iter.get_char()
+        # NOTE: Look to re-add or apply supprting logic to use spaces
+        # As is it slows down the editor in certain contexts...
+        # if not (ch in ('_', '.', ' ') or ch.isalnum()):
+        if not (ch in ('_', '.') or ch.isalnum()):
+            return False
+
         return True
 
     def do_get_priority(self):

plugins/code/completers/words_completer/default_provider_response_cache.py

@@ -0,0 +1,29 @@
+# Python imports
+
+# Lib imports
+
+# Application imports
+from libs.event_factory import Code_Event_Types
+
+from core.widgets.code.completion_providers.provider_response_cache_base import ProviderResponseCacheBase
+
+
+
+class ProviderResponseCache(ProviderResponseCacheBase):
+    def __init__(self):
+        super(ProviderResponseCache, self).__init__()
+
+        self.matchers: dict = {}
+
+
+    def process_file_load(self, event: Code_Event_Types.AddedNewFileEvent):
+        ...
+
+    def process_file_close(self, event: Code_Event_Types.RemovedFileEvent):
+        ...
+
+    def process_file_save(self, event: Code_Event_Types.SavedFileEvent):
+        ...
+
+    def process_file_change(self, event: Code_Event_Types.TextChangedEvent):
+        ...

plugins/code/completers/words_completer/provider.py

@@ -18,7 +18,7 @@ class Provider(GObject.GObject, GtkSource.CompletionProvider):
         This is a Words Completion Provider.
         # NOTE: used information from here --> https://warroom.rsmus.com/do-that-auto-complete/
     """
-    # __gtype_name__ = 'WordsCompletionProvider'
+    __gtype_name__ = 'WordsCompletionProvider'
 
     def __init__(self):
         super(Provider, self).__init__()
@@ -37,6 +37,16 @@ class Provider(GObject.GObject, GtkSource.CompletionProvider):
 
         word = self.response_cache.get_word(context)
         if not word or len(word) < 2: return False
+
+        iter = self.response_cache.get_iter_correctly(context)
+        iter.backward_char()
+        ch = iter.get_char()
+        # NOTE: Look to re-add or apply supprting logic to use spaces
+        # As is it slows down the editor in certain contexts...
+        # if not (ch in ('_', '.', ' ') or ch.isalnum()):
+        if not (ch in ('_', '.') or ch.isalnum()):
+            return False
+
         return True
 
     def do_get_priority(self):

plugins/code/completers/words_completer/provider_response_cache.py

@@ -90,7 +90,8 @@ class ProviderResponseCache(ProviderResponseCacheBase):
         self.matchers[buffer] = set()
 
     def load_into_set(self, buffer, new_words):
-        self.matchers[buffer].update(new_words)
+        # self.matchers[buffer].update(new_words)
+        self.matchers[buffer] = new_words
 
     def load_as_new_set(self, buffer, data):
         self.matchers[buffer] = self.get_all_words(data)

plugins/code/markdown_preview/manifest.json

@@ -0,0 +1,7 @@
+{
+    "name": "Markdown Preview",
+    "author": "ITDominator",
+    "version": "0.0.1",
+    "support": "",
+    "requests": {}
+}

plugins/code/markdown_preview/markdown_preview.py

@@ -0,0 +1,101 @@
+# Python imports
+
+# Lib imports
+import gi
+gi.require_version('Gtk', '3.0')
+gi.require_version('Gdk', '3.0')
+
+from gi.repository import Gtk
+from gi.repository import Gdk
+
+# Application imports
+from core.widgets.webkit.webkit_ui import WebkitUI
+
+from .mixins.markdown_preview_mixin import MarkdownPreviewMixin
+
+
+
+class MarkdownPreview(Gtk.Popover, MarkdownPreviewMixin):
+    def __init__(self):
+        super(MarkdownPreview, self).__init__()
+
+        self.can_hide: bool          = True
+        self.is_preview_paused: bool = True # True by default b/c started hidden
+
+        self._setup_styling()
+        self._setup_signals()
+        self._load_widgets()
+
+
+    def _setup_styling(self):
+        ctx = self.get_style_context()
+        ctx.add_class("markdown-preview")
+
+        self.set_modal(False)
+        self.set_can_focus(False)
+        self.set_transitions_enabled(False)
+        self.set_size_request(480, 720)
+        self.override_background_color(
+            Gtk.StateFlags.NORMAL,
+            Gdk.RGBA(0, 0, 0, 0.0)
+        )
+        self.set_constrain_to(
+            Gtk.PopoverConstraint.WINDOW
+        )
+
+    def _setup_signals(self):
+        self.connect("hide", self._handle_hide)
+        self.connect("show", self._handle_show)
+
+    def _load_widgets(self):
+        box             = Gtk.Box()
+        bttn_box        = Gtk.ButtonBox()
+        scrolled_win    = Gtk.ScrolledWindow()
+        viewport        = Gtk.Viewport()
+        self._markdown_view       = WebkitUI()
+
+        self.start_stop_bttn = Gtk.ToggleButton()
+        settings_bttn   = Gtk.Button()
+
+        self.start_stop_bttn.set_label("gtk-media-pause")
+        self.start_stop_bttn.set_use_stock(True)
+
+        settings_bttn.set_image(
+            Gtk.Image.new_from_stock(
+                "gtk-justify-fill",  Gtk.IconSize.BUTTON
+            )
+        )
+
+        self._markdown_view.set_vexpand(True)
+        box.set_orientation(Gtk.Orientation.VERTICAL)
+
+        self.start_stop_bttn.connect("clicked", self._tggle_preview_updates)
+        settings_bttn.connect("clicked", self._handle_settings)
+
+        bttn_box.pack_end(self.start_stop_bttn, expand = False, fill = False, padding = 1)
+        bttn_box.pack_end(settings_bttn, expand = False, fill = False, padding = 1)
+        viewport.add(self._markdown_view)
+        scrolled_win.add(viewport)
+        box.add(bttn_box)
+        box.add(scrolled_win)
+        self.add(box)
+
+        box.show_all()
+
+
+    def _handle_hide(self, widget):
+        if self.can_hide:
+            self.is_preview_paused = True
+            return False
+
+        return True
+
+    def _handle_show(self, widget):
+        self.can_hide = False
+        self.is_preview_paused = self.start_stop_bttn.get_active()
+
+    def _tggle_preview_updates(self, widget):
+        self.is_preview_paused = not self.is_preview_paused
+
+    def _handle_settings(self, widget):
+        ...

plugins/code/markdown_preview/mixins/__init__.py

@@ -0,0 +1,3 @@
+"""
+    Pligin Module Mixins
+"""

plugins/code/markdown_preview/mixins/markdown_preview_mixin.py

@@ -0,0 +1,38 @@
+# Python imports
+
+# Lib imports
+
+# Application imports
+from .markdown_template_mixin import MarkdownTemplateMixin
+
+from .. import markdown
+
+
+
+class MarkdownPreviewMixin(MarkdownTemplateMixin):
+    def _do_markdown_translate(self, buffer):
+        if self.is_preview_paused: return
+
+        if not self.is_markdown(buffer):
+            data = self.wrap_html_to_body("<h1>Not a Markdown file...</h1>")
+            self._load_html(data)
+            return
+
+        data = self.get_rendered_markdown(buffer)
+        self._load_html(data)
+
+    def _load_html(self, data: str):
+        self._markdown_view.load_html(
+            content = data, base_uri = None
+        )
+
+    def get_rendered_markdown(self, buffer) -> str:
+        start_itr = buffer.get_start_iter()
+        end_itr   = buffer.get_end_iter()
+        text      = buffer.get_text(start_itr, end_itr, include_hidden_chars = False)
+        html      = markdown.markdown(text)
+
+        return self.wrap_html_to_body(html)
+    
+    def is_markdown(self, buffer) -> bool:
+        return buffer.get_language() and buffer.get_language().get_id() == "markdown"

plugins/code/markdown_preview/mixins/markdown_template_mixin.py

@@ -7,7 +7,7 @@
 
 
 class MarkdownTemplateMixin:
-    def wrap_html_to_body(self, html):
+    def wrap_html_to_body(self, html: str):
         return f"""\
 <!DOCTYPE html>
 <html lang="en" dir="ltr">
@@ -17,7 +17,8 @@ class MarkdownTemplateMixin:
     <style media="screen">
         html, body {{
             display: block;
-            background-color: #32383e00;
+            // background-color: #32383e64;
+            background-color: #32383e;
             color: #ffffff;
             text-wrap: wrap;
         }}

plugins/code/markdown_preview/plugin.py

@@ -0,0 +1,56 @@
+# Python imports
+
+# Lib imports
+
+# Application imports
+from libs.event_factory import Event_Factory, Code_Event_Types
+
+from plugins.plugin_types import PluginCode
+
+from .markdown_preview import MarkdownPreview
+
+
+
+markdown_preview = MarkdownPreview()
+
+
+
+class Plugin(PluginCode):
+    def __init__(self):
+        super(Plugin, self).__init__()
+
+
+    def _controller_message(self, event: Code_Event_Types.CodeEvent):
+        if isinstance(event, Code_Event_Types.FocusedViewEvent):
+            markdown_preview._do_markdown_translate(event.view.get_buffer())
+        elif isinstance(event, Code_Event_Types.TextChangedEvent):
+            markdown_preview._do_markdown_translate(event.buffer)
+
+    def load(self):
+        separator_right  = self.requests_ui_element("separator-right")
+        markdown_preview.set_relative_to(separator_right)
+
+        event = Event_Factory.create_event("register_command",
+            command_name = "tggle_markdown_preview",
+            command      = Handler,
+            binding_mode = "released",
+            binding      = "<Shift><Control>m"
+        )
+
+        self.message_to("source_views", event)
+
+    def run(self):
+        ...
+
+ 
+class Handler:
+    @staticmethod
+    def execute(
+        view: any
+    ):
+        logger.debug("Command: Markdown Preview")
+
+        if not markdown_preview.can_hide:
+            markdown_preview.can_hide = True
+
+        markdown_preview.popdown() if markdown_preview.is_visible() else markdown_preview.popup()

plugins/code/search_replace/plugin.py

@@ -1,9 +1,6 @@
 # Python imports
 
 # Lib imports
-import gi
-gi.require_version('Gtk', '3.0')
-from gi.repository import Gtk
 
 # Application imports
 from libs.event_factory import Event_Factory, Code_Event_Types
@@ -62,4 +59,5 @@ class Handler:
         view: any
     ):
         logger.debug("Command: Search/Replace")
+
         search_replace.hide() if search_replace.is_visible() else search_replace.show()

plugins/depricated/markdown_preview/manifest.json

@@ -1,11 +0,0 @@
-{
-    "name": "Markdown Preview",
-    "author": "ITDominator",
-    "version": "0.0.1",
-    "support": "",
-    "requests": {
-        "pass_events": true,
-        "pass_ui_objects": ["separator_right"],
-        "bind_keys": ["Markdown Preview||tggle_markdown_preview:<Shift><Control>m"]
-    }
-}

plugins/depricated/markdown_preview/markdown_preview.glade

@@ -1,121 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- Generated with glade 3.40.0 -->
-<interface>
-  <requires lib="gtk+" version="3.24"/>
-  <requires lib="webkit2gtk" version="2.28"/>
-  <object class="GtkImage" id="settings_img">
-    <property name="visible">True</property>
-    <property name="can-focus">False</property>
-    <property name="stock">gtk-justify-fill</property>
-  </object>
-  <object class="WebKitSettings" type-func="webkit_settings_get_type" id="web_view_settings">
-    <property name="enable-offline-web-application-cache">False</property>
-    <property name="enable-html5-local-storage">False</property>
-    <property name="enable-html5-database">False</property>
-    <property name="enable-xss-auditor">False</property>
-    <property name="enable-hyperlink-auditing">False</property>
-    <property name="enable-tabs-to-links">False</property>
-    <property name="enable-fullscreen">False</property>
-    <property name="print-backgrounds">False</property>
-    <property name="enable-webaudio">False</property>
-    <property name="enable-page-cache">False</property>
-    <property name="user-agent">Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.0 Safari/605.1.15</property>
-    <property name="enable-accelerated-2d-canvas">True</property>
-    <property name="allow-file-access-from-file-urls">True</property>
-    <property name="allow-universal-access-from-file-urls">True</property>
-    <property name="enable-webrtc">True</property>
-  </object>
-  <object class="GtkPopover" id="markdown_preview_dialog">
-    <property name="width-request">620</property>
-    <property name="height-request">480</property>
-    <property name="can-focus">False</property>
-    <property name="vexpand">True</property>
-    <property name="position">left</property>
-    <property name="modal">False</property>
-    <property name="transitions-enabled">False</property>
-    <property name="constrain-to">none</property>
-    <child>
-      <object class="GtkBox">
-        <property name="visible">True</property>
-        <property name="can-focus">False</property>
-        <property name="hexpand">True</property>
-        <property name="vexpand">True</property>
-        <property name="orientation">vertical</property>
-        <child>
-          <object class="GtkButtonBox">
-            <property name="visible">True</property>
-            <property name="can-focus">False</property>
-            <property name="layout-style">end</property>
-            <child>
-              <object class="GtkToggleButton">
-                <property name="label">gtk-media-pause</property>
-                <property name="visible">True</property>
-                <property name="can-focus">True</property>
-                <property name="receives-default">True</property>
-                <property name="use-stock">True</property>
-                <property name="always-show-image">True</property>
-                <signal name="toggled" handler="_tggle_preview_updates" swapped="no"/>
-              </object>
-              <packing>
-                <property name="expand">True</property>
-                <property name="fill">True</property>
-                <property name="position">0</property>
-              </packing>
-            </child>
-            <child>
-              <object class="GtkButton">
-                <property name="visible">True</property>
-                <property name="sensitive">False</property>
-                <property name="can-focus">True</property>
-                <property name="receives-default">True</property>
-                <property name="image">settings_img</property>
-                <signal name="clicked" handler="_handle_settings" swapped="no"/>
-              </object>
-              <packing>
-                <property name="expand">True</property>
-                <property name="fill">True</property>
-                <property name="position">1</property>
-              </packing>
-            </child>
-          </object>
-          <packing>
-            <property name="expand">False</property>
-            <property name="fill">True</property>
-            <property name="position">0</property>
-          </packing>
-        </child>
-        <child>
-          <object class="GtkScrolledWindow">
-            <property name="visible">True</property>
-            <property name="can-focus">True</property>
-            <property name="shadow-type">in</property>
-            <child>
-              <object class="GtkViewport">
-                <property name="visible">True</property>
-                <property name="can-focus">False</property>
-                <child>
-                  <object class="WebKitWebView" type-func="webkit_web_view_get_type" id="markdown_view">
-                    <property name="visible">True</property>
-                    <property name="can-focus">False</property>
-                    <property name="settings">web_view_settings</property>
-                    <property name="is-ephemeral">True</property>
-                    <property name="is-muted">True</property>
-                    <property name="default-content-security-policy">*</property>
-                    <child>
-                      <placeholder/>
-                    </child>
-                  </object>
-                </child>
-              </object>
-            </child>
-          </object>
-          <packing>
-            <property name="expand">True</property>
-            <property name="fill">True</property>
-            <property name="position">1</property>
-          </packing>
-        </child>
-      </object>
-    </child>
-  </object>
-</interface>

plugins/depricated/markdown_preview/plugin.py

@@ -1,114 +0,0 @@
-# Python imports
-import os
-
-# Lib imports
-import gi
-gi.require_version('Gtk', '3.0')
-gi.require_version('Gdk', '3.0')
-gi.require_version('WebKit2', '4.0')
-from gi.repository import Gtk
-from gi.repository import Gdk
-from gi.repository import WebKit2
-
-# Application imports
-from . import markdown
-from .markdown_template_mixin import MarkdownTemplateMixin
-from plugins.plugin_base import PluginBase
-
-
-
-class Plugin(MarkdownTemplateMixin, PluginBase):
-    def __init__(self):
-        super().__init__()
-
-        self.name               = "Markdown Preview"  # NOTE: Need to remove after establishing private bidirectional 1-1 message bus
-                                                      #       where self.name should not be needed for message comms
-        self.path               = os.path.dirname(os.path.realpath(__file__))
-        self._GLADE_FILE        = f"{self.path}/markdown_preview.glade"
-        
-        self.is_preview_paused  = False
-        self.is_md_file         = False
-
-
-    def run(self):
-        WebKit2.WebView()       # Need one initialized for webview to work from glade file
-
-        self._builder = Gtk.Builder()
-        self._builder.add_from_file(self._GLADE_FILE)
-        self._connect_builder_signals(self, self._builder)
-
-        separator_right         = self._ui_objects[0]
-        self._markdown_dialog   = self._builder.get_object("markdown_preview_dialog")
-        self._markdown_view     = self._builder.get_object("markdown_view")
-        self._web_view_settings = self._builder.get_object("web_view_settings")
-
-        self._markdown_dialog.set_relative_to(separator_right)
-        self._markdown_view.set_settings(self._web_view_settings)
-        self._markdown_view.set_background_color(Gdk.RGBA(0, 0, 0, 0.0))
-
-
-    def generate_reference_ui_element(self):
-        ...
-
-    def subscribe_to_events(self):
-        self._event_system.subscribe("tggle_markdown_preview", self._tggle_markdown_preview)
-        self._event_system.subscribe("set_active_src_view", self._set_active_src_view)
-        self._event_system.subscribe("buffer_changed", self._do_markdown_translate)
-
-    def _buffer_changed_first_load(self, buffer):
-        self._buffer = buffer
-
-        self._do_markdown_translate(buffer)
-
-    def _set_active_src_view(self, source_view):
-        self._active_src_view = source_view
-        self._buffer          = self._active_src_view.get_buffer()
-
-        self._do_markdown_translate(self._buffer)
-
-    def _handle_settings(self, widget = None, eve = None):
-        ...
-
-    def _tggle_preview_updates(self, widget = None, eve = None):
-        self.is_preview_paused = not self.is_preview_paused
-        widget.set_active(self.is_preview_paused)
-
-        if not self.is_preview_paused:
-            self._do_markdown_translate(self._buffer)
-
-    def _tggle_markdown_preview(self, widget = None, eve = None):
-        if not self._active_src_view: return
-
-        is_visible = self._markdown_dialog.is_visible()
-        buffer     = self._active_src_view.get_buffer()
-        data       = None
-
-        if not is_visible:
-            self._markdown_dialog.popup();
-            self._do_markdown_translate(buffer)
-        elif not data and is_visible:
-            self._markdown_dialog.popdown()
-
-    def _do_markdown_translate(self, buffer):
-        if self.is_preview_paused: return
-
-        self.is_markdown_check()
-        is_visible = self._markdown_dialog.is_visible()
-        if not is_visible or not self.is_md_file: return
-        self.render_markdown(buffer)
-
-    def render_markdown(self, buffer):
-        start_iter = buffer.get_start_iter()
-        end_iter   = buffer.get_end_iter()
-        text       = buffer.get_text(start_iter, end_iter, include_hidden_chars = False)
-        html       = markdown.markdown(text)
-
-        path       = self._active_src_view.get_current_file().get_parent().get_path()
-        data       = self.wrap_html_to_body(html)
-        self._markdown_view.load_html(content = data, base_uri = f"file://{path}/")
-    
-    def is_markdown_check(self):
-        self.is_md_file = self._active_src_view.get_filetype() == "markdown"
-        if not self.is_md_file:
-            data = self.wrap_html_to_body("<h1>Not a Markdown file...</h1>")
-            self._markdown_view.load_html(content = data, base_uri = None)