$ sudo apt install python3 python3-pip x11-xserver-utils procps libnotify-bin xclip yad
$ pip3 install pynput Xlib --user

#!/usr/bin/env python3

# klavaro 2.0
# Copyright (c) 2019 Bruno "GNUser" Dantas <klavaro@dantas.airpost.net>
# This is free software, released under the terms of the ISC license:
# Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby
# granted, provided that the above copyright notice and this permission notice appear in all copies.
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE 
# FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 
# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, 
# ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 

from pynput import keyboard
from pynput import mouse
keyboard0 = keyboard.Controller()
mouse0 = mouse.Controller()
import os
import sys
import time

def log_it(keystroke):
	"""High level function that logs keystroke, checks if last keystrokes 
	match a hotsring/trigger, replaces trigger with corresponding Unicode character"""
	global mappings
	global last_strokes
	del last_strokes[0]
	last_strokes.append(keystroke)
	last_strokes_str = ''.join(last_strokes)
	#print("last strokes = " + last_strokes_str) # for debugging
	for trigger in mappings.keys():
		if last_strokes_str.endswith(trigger):
			character = mappings[trigger]
			backspaces = len(trigger)
			#print("replacing " + trigger + " with " + character) # for debugging
			while backspaces > 0:
				keyboard0.press(keyboard.Key.backspace)
				keyboard0.release(keyboard.Key.backspace)
				backspaces -= 1
			os.system('''xclip -o -selection clipboard | xclip -selection secondary''') # save clipboard contents to secondary
			os.system('''printf %s | xclip -selection clipboard''' % character) # feed unicode character to clipboard
			keyboard0.press(keyboard.Key.ctrl) # press Ctrl+v to paste from clipboard
			keyboard0.press('v')
			keyboard0.release('v')
			keyboard0.release(keyboard.Key.ctrl)
			time.sleep(0.5) # don't restore clipboard too quickly (some applications, e.g. qterminal, need a moment to react to Ctrl+v)
			os.system('''xclip -o -selection secondary | xclip -selection clipboard''') # restore clipboard contents from secondary

def on_press(key): 
	"""Keylogger runs this function on each keyboard event"""
	global capslock_in_effect
	output = str(key)
	if output == 'Key.caps_lock': # if capslock pressed, toggle capslock state
		capslock_in_effect = not capslock_in_effect
	if not output.startswith('Key'): # pynput calls special keys 'Key.foo'
		output = output[1:-1] # remove quotes around alphanumeric key names
		if capslock_in_effect:
			output = output.swapcase() 
			# .swapcase and not .upper because pressing Shift during CapsLock should log a lowercase letter
	if not output.startswith('Key.shift'): # log all keystrokes except shift (e.g., so that a~ is logged without an intervening Shift)
		if output.startswith('Key.'): # log special keystrokes as a space
			output=' '
		log_it(output)

def on_click(x, y, button, pressed):
	"""Keylogger runs this function on each mouse event"""
	button = str(button)
	if pressed and button == 'Button.left': # log left clicks as a space
		log_it(' ')

def start():
	# 1. Build mappings from klavaro.conf
	global mappings
	mappings = {}
	abspath=os.path.realpath(sys.argv[0])
	dirname=os.path.dirname(abspath)

	with open('%s/klavaro.conf' % dirname) as f:
		for line in f:
			(trigger, character) = line.split()
			mappings[trigger] = character

	# 2. Initialize an empty list to hold last few keystrokes
	global last_strokes
	last_strokes = [ '' ] * 5 
	
	# 3. Create taskbar icon
	os.system('''yad --notification --image=keyboard --text="Klavaro" --no-middle --menu="Exit!klavaro stop!application-exit" --listen & echo $! >/tmp/klavaro-icon-pid''')
	
	# 4. Get initial CapsLock state
	global capslock_in_effect
	exit_code = os.system('''xset q | grep -q 'Caps Lock:[[:space:]]*on' ''')
	if exit_code == 0:
		capslock_in_effect = True
	else:
		capslock_in_effect = False

	# 5. Finally, start keylogger
	with mouse.Listener(on_click=on_click) as listener:
		with keyboard.Listener(on_press=on_press) as listener:
			listener.join()
	
#####

def stop():
	os.system('''kill $(cat /tmp/klavaro-icon-pid); rm /tmp/klavaro-icon-pid''')
	os.system('''pkill -f klavaro''')

#####

if sys.argv[1] == "start":
	try:
		os.stat('/tmp/klavaro-icon-pid')
	except: 
		start()
	else: 
		os.system('''notify-send -i dialog-warning -t 2000 "Klavaro" "Klavaro is already running"''')
		sys.exit()

elif sys.argv[1] == "stop":
	stop()

A` À
a` à
A' Á
a' á
A^ Â
a^ â
A~ Ã
a~ ã
A:: Ä
a:: ä
E` È
e` è
E' É
e' é
E^ Ê
e^ ê
E~ Ẽ
e~ ẽ
E:: Ë
e:: ë
I` Ì
i` ì
I' Í
i' í
I^ Î
i^ î
I~ Ĩ
i~ ĩ
I:: Ï
i:: ï
O` Ò
o` ò
O' Ó
o' ó
O^ Ô
o^ ô
O~ Õ
o~ õ
O:: Ö
o:: ö
U` Ù
u` ù
U' Ú
u' ú
U^ Û
u^ û
U~ Ũ
u~ ũ
U:: Ü
u:: ü
C,, Ç
c,, ç
Cx Ĉ
CX Ĉ
cx ĉ
Gx Ĝ
GX Ĝ
gx ĝ
Hx Ĥ
HX Ĥ
hx ĥ
Jx Ĵ
JX Ĵ
jx ĵ
Sx Ŝ
SX Ŝ
sx ŝ
Ux Ŭ
UX Ŭ
ux ŭ

$ klavaro start &

$ klavaro stop