Insert Symbol based alternative implementation

Author: introt

inserttext.py

@@ -0,0 +1,209 @@
+
+# Copyright 2010 Jaap Karssenberg <jaap.karssenberg@gmail.com>
+# Copyright 2022 introt <introt@koti.fimnet.fi>
+
+from gi.repository import Gtk
+import logging
+
+from zim.plugins import PluginClass
+from zim.actions import action
+from zim.config import ConfigManager
+
+from zim.gui.pageview import PageViewExtension
+from zim.gui.widgets import Dialog, InputEntry, ScrolledWindow
+from zim.gui.applications import edit_config_file
+
+logger = logging.getLogger('zim.plugins.inserttext')
+
+
+VERBATIM = 'code'
+VERBATIM_BLOCK = 'pre'
+
+
+class InsertTextPlugin(PluginClass):
+
+	plugin_info = {
+		'name': _('Insert Text'), # T: plugin name
+		'description': _('''\
+This plugin adds the 'Insert Text' dialog and allows
+auto-replacing text snippets.
+
+This is not a core plugin shipping with zim.
+'''), # T: plugin description
+		'author': 'Jaap Karssenberg & introt',
+	}
+
+	def __init__(self):
+		PluginClass.__init__(self)
+		self.texts = {}
+		self.text_order = []
+
+	def load_file(self):
+		self.texts = {}
+		self.text_order = []
+		file = ConfigManager.get_config_file('texts.list')
+		for line in file.readlines():
+			line = line.strip()
+			if not line or line.startswith('#'):
+				continue
+			try:
+				if '#' in line:
+					line, _ = line.split('#', 1)
+					line = line.strip()
+				shortcut, code = line.split(maxsplit=1)
+				#text = chr(int(code))
+				if not shortcut in self.texts:
+					self.texts[shortcut] = code.replace(r'\n', '\n') #text
+					self.text_order.append(shortcut)
+				else:
+					logger.exception('Shortcut defined twice: %s', shortcut)
+			except:
+				logger.exception('Could not parse text: %s', line)
+
+	def get_texts(self):
+		for shortcut in self.text_order:
+			text = self.texts[shortcut]
+			yield text, shortcut
+
+
+class InsertTextPageViewExtension(PageViewExtension):
+
+	def __init__(self, plugin, pageview):
+		PageViewExtension.__init__(self, plugin, pageview)
+		self.connectto(pageview.textview, 'end-of-word')
+		if not plugin.texts:
+			plugin.load_file()
+
+	@action(_('Text...'), menuhints='insert') # T: menu item
+	def insert_text(self):
+		'''Run the InsertTextDialog'''
+		InsertTextDialog(self.pageview, self.plugin, self.pageview).run()
+
+	def on_end_of_word(self, textview, start, end, word, char, editmode):
+		'''Handler for the end-of-word signal from the textview'''
+		# We check for non-space char because e.g. typing "-->" will
+		# emit end-of-word with "--" as word and ">" as character.
+		# This should be distinguished from the case when e.g. typing
+		# "-- " emits end-of-word with "--" as word and " " (space) as
+		# the char.
+		if VERBATIM in editmode \
+		or VERBATIM_BLOCK in editmode \
+		or not (char.isspace() or char == ';'):
+			return
+
+		text = self.plugin.texts.get(word)
+		if not text and word.count('\\') == 1:
+			# do this after testing the whole word, we have e.g. "=\="
+			# also avoid replacing end of e.g. "C:\foo\bar\left",
+			# so match exactly one "\"
+			prefix, key = word.split('\\', 1)
+			text = self.plugin.texts.get('\\' + key)
+			if text:
+				start.forward_chars(len(prefix))
+
+		if not text:
+			return
+
+		# replace word with text
+		buffer = textview.get_buffer()
+		mark = buffer.create_mark(None, end, left_gravity=False)
+		if char == ';':
+			end = end.copy()
+			end.forward_char() # include the ';' in the delete
+			buffer.delete(start, end)
+		else:
+			buffer.delete(start, end)
+		iter = buffer.get_iter_at_mark(mark)
+		buffer.insert(iter, text)
+		buffer.delete_mark(mark)
+
+		# block other handlers
+		textview.stop_emission('end-of-word')
+
+
+class InsertTextDialog(Dialog):
+
+	def __init__(self, parent, plugin, pageview):
+		Dialog.__init__(
+			self,
+			parent,
+			_('Insert Text'), # T: Dialog title
+			button=_('_Insert'),  # T: Button label
+			defaultwindowsize=(350, 400)
+		)
+		self.plugin = plugin
+		self.pageview = pageview
+		if not plugin.texts:
+			plugin.load_file()
+
+		self.textentry = InputEntry()
+		self.vbox.pack_start(self.textentry, False, True, 0)
+
+		model = Gtk.ListStore(str, str) # text, shortcut
+		self.iconview = Gtk.IconView(model)
+		self.iconview.set_text_column(0)
+		self.iconview.set_column_spacing(0)
+		self.iconview.set_row_spacing(0)
+		self.iconview.set_property('has-tooltip', True)
+		self.iconview.set_property('activate-on-single-click', True)
+		self.iconview.connect('query-tooltip', self.on_query_tooltip)
+		self.iconview.connect('item-activated', self.on_activated)
+
+		swindow = ScrolledWindow(self.iconview)
+		self.vbox.pack_start(swindow, True, True, 0)
+
+		button = Gtk.Button.new_with_mnemonic(_('_Edit')) # T: Button label
+		button.connect('clicked', self.on_edit)
+		self.action_area.add(button)
+		self.action_area.reorder_child(button, 0)
+
+		self.load_texts()
+
+	def load_texts(self):
+		model = self.iconview.get_model()
+		model.clear()
+		for text, shortcut in self.plugin.get_texts():
+			model.append((text, shortcut))
+
+	def on_query_tooltip(self, iconview, x, y, keyboard, tooltip):
+		if keyboard:
+			return False
+
+		x, y = iconview.convert_widget_to_bin_window_coords(x, y)
+		path = iconview.get_path_at_pos(x, y)
+		if path is None:
+			return False
+
+		model = iconview.get_model()
+		iter = model.get_iter(path)
+		text = model.get_value(iter, 1)
+		if not text:
+			return False
+
+		tooltip.set_text(text)
+		return True
+
+	def on_activated(self, iconview, path):
+		model = iconview.get_model()
+		iter = model.get_iter(path)
+		text = model.get_value(iter, 0)
+		pos = self.textentry.get_position()
+		self.textentry.insert_text(text, pos)
+		self.textentry.set_position(pos + len(text))
+
+	def on_edit(self, button):
+		file = ConfigManager.get_config_file('texts.list')
+		if edit_config_file(self, file):
+			self.plugin.load_file()
+			self.load_texts()
+
+	def run(self):
+		self.iconview.grab_focus()
+		Dialog.run(self)
+
+	def do_response_ok(self):
+		text = self.textentry.get_text()
+		textview = self.pageview.textview
+		buffer = textview.get_buffer()
+		buffer.insert_at_cursor(text)
+		return True