Korektor rasporeda „xswitcher“ za linux: korak drugi

Budući da prethodni post (hxwitcher u fazi „dokaz koncepta“) dobio je prilično mnogo konstruktivnih povratnih informacija (što je prijatno), nastavio sam trošiti svoje slobodno vreme na razvoj projekta. Sada želim da potrošim malo vašeg... Drugi korak neće biti sasvim uobičajen: predlog/rasprava o dizajnu konfiguracije.

Korektor rasporeda „xswitcher“ za linux: korak drugi

Čini se da je normalnim programerima podešavanje svih tih opcija ekstremno dosadno.

Da ne budem bez dokaza, unutra je primer iz onoga s čim se bavim.
Odlično sve u celini zamišljeno (i dobro realizovano) Apache Kafka & ZooKeeper.
— Konfiguracija? Pa to je dosadno! Kažem ‘na brzinu’ xml (jer ‘iz kutije’).
— Oh, a želite i ACL? Pa to je toliko naporno! Naflaka… Tako to ide.

A u mom radu je potpuno suprotno. Tačno (nažalost, prvi put skoro nikad ne uspe) izgrađena modela omogućava lagano i nespretno (pa, skoro) izgradnju šeme.

Nedavno sam naišao na članak na Habréu o teškom radu data-scientista...
Ispostavlja se da se taj trenutak kod njih u potpunosti realizuje. A u mojoj praksi, kao što se kaže, „light verzija“. Višekratni modeli, iskusni programeri s OOP-om i tako dalje — sve to će se pojaviti kasnije/ako uspe. A konstruisatelj mora ovde i sada s nečim da počne.

Prilikom posla. Kao sintaktičku osnovu uzeo sam TOML od ovog građanina.

Zato što je (TOML) s jedne strane uređiv ljudima. A s druge strane — prevodi se 1:1 u bilo koji od popularnijih sintaksisa: XML, JSON, YAML.
Štaviše, realizacija koju sam koristio sa „github.com/BurntSushi/toml“ iako nije najmodernija (sintaksa 1.4), ali je sintaktički kompatibilna s istim („ugrađenim“) JSON-om.

Dakle, ako želite, možete jednostavno reći „idi od mene s tim tvojim TOML, ja želim XXX“ i „prošlost kod jedne linije.“

Tako, ako želite da napišete neke prozore za podešavanje hxwitcher (sigurno ne ja) problem „s tim vašim dosadnim konfiguracijama“ — ne predviđa se.

Za sve druge sintaksu na bazi „ključ = vrednost“ (i bukvalno s nekoliko opcija teže, poput = [neki, niz]) smatram
intuitivno korisnom.
Što je zanimljivo, sam bacio žig približno u to isto vreme (oko 2013. godine). Samo, za razliku od mene, autor TOML je pristupio sa odgovarajućim zamahom.

Zato mi je sada lakše prilagoditi njegovu implementaciju sebi, a ne obrnuto.

U suštini, uzimamo TOML (vrlo sličan starom Windows INI). I postavljamo konfiguraciju u kojoj opisujemo kako povezati niz hookova u zavisnosti od skupa poslednjih sken-kodova sa tastature. Ispod su delovi — ono što je trenutno urađeno. I objašnjenja zašto sam to tako odlučio.

0. Osnovne apstrakcije

  • Oznake sken-kodova. S tim se obavezno mora nešto raditi, jer su samo numerički kodovi apsolutno nečitljivi za ljude (to sam ja u vrtu loloswitcher).
    Izdvojio sam «ecodes.go» iz «golang-evdev» (leni sam bio da idem u primarni izvor, iako je kod autora prilično kulturno navedeno). Malo (za sada) sam ispravio nešto što je zaista bilo strašno. Tipa «LEFTBRACE» → «L_BRACE».
  • Dodatno, uveo sam pojam «tastate sa stanjem». S obzirom da korišćena regularna gramatika ne omogućava duge pasuse. (Ali omogućava proveru s minimalnim troškovima. Ako se koristi samo «direktno» snimanje.)
  • Biće ugrađeni «deduplifikator» pritisnutih tastera. Tako će stanje «ponovi»=2 biti zabeleženo jedno putu.

1. Odeljak šablona

[Templates] # "@name@" za pojednostavljenje izraza
 # Reči mogu da se sastoje od ovih karaktera (regex)
 "WORD" = "([0-9A-Z`;']|[LR]_BRACE|COMMA|DOT|SLASH|KP[0-9])"

Od čega se sastoji reč ljudskog jezika sa fonetskim zapisom (neuporedivo s grafemima aka «hieroglifi»)? Какая-то ужасная «простыня». Поэтому сразу закладываю понятие «шаблона».

2. Šta raditi kada se nešto pritisne (stigao je još jedan sken-kod)

[ActionKeys]
 # Prikupi taster i uradi test za sekvencu komandi
 # !!! Ponavljajući kodovi (code=2) moraju se prikupiti samo jednom po tasteru!
 Add = ["1..0", "=", "BS", "Q..]", "L_CTRL..CAPS", "N_LOCK", "S_LOCK",
        "KP7..KPDOT", "R_CTRL", "KPSLASH", "R_ALT", "KPEQUAL..PAUSE",
        "KPCOMMA", "L_META..COMPOSE", "KPLEFTPAREN", "KPRIGHTPAREN"]

 # Odbaci sve skupljene tastere, uključujući ovaj. Ovo je podrazumevana akcija.
 Drop = ["ESC", "-", "TAB", "ENTER", "KPENTER", "LINEFEED..POWER"]
 # Skladišti dodatnu mapu za ove tastere, kada je bilo koji u stanju "down".
 # Stanje se proverava putem "OFF:"|"ON:" uslova u akciji.
 # (Takođe, stanje ovih tastera mora da traje između odbacivanja bafera.)
 # ??? Kako se nositi sa CAPS i "LOCK"-tasterima ???
 StateKeys = ["L_CTRL", "L_SHIFT", "L_ALT", "L_META", "CAPS", "N_LOCK", "S_LOCK",
              "R_CTRL", "R_SHIFT", "R_ALT", "R_META"]

 # Test samo, ali ne prikupljaj.
 # Na primer, koristim F12 umesto BREAK na glupim laptopima sa lošim tastaturama (novi ThinkPadi)
 Test = ["F1..F10", "ZENKAKUHANKAKU", "102ND", "F11", "F12",
          "RO..KPJPCOMMA", "SYSRQ", "SCALE", "HANGEUL..YEN",
          "STOP..SCROLLDOWN", "NEW..MAX"]

Ukupno je predviđeno 768 kodova. (Ali «za svaki slučaj» sam ubacio u kod xswitcher praćenje «iznenađenja»).
Unutra sam opisao popunjavanje niza linkovima na funkcije «šta raditi». Na golang-u to (iznenada) ispalo je zgodno i očigledno.

  • Planiram skratiti «Drop» na minimum na ovom mestu. U korist fleksibilnije obrade (pokazaću u nastavku).

3. Tabela sa klasama prozora

# Some behaviour can depend on application currently doing the input.
[[WindowClasses]]
 # VNC, VirtualBox, qemu etc. emulates there input independently, so never intercept.
 # With the exception of some stupid VNC clients, which does high-level (layout-based) keyboard input.
 Regex = "^VirtualBox"
 Actions = "" # Do nothing while focus stays in VirtualBox

[[WindowClasses]]
 Regex = "^konsole"
 # In general, mouse clicks leads to unpredictable (at the low-level where xswitcher resides) cursor jumps.
 # So, it's good choise to drop all buffers after click.
 # But some windows, e.g. terminals, can stay out of this problem.
 MouseClickDrops = 0
 Actions = "Actions"

[[WindowClasses]] # Default behaviour: no Regex (or wildcard like ".")
 MouseClickDrops = 1
 Actions = "Actions"

Redovi tabele su u duplim uglastim zagradama sa njenim imenom. Nije bilo lakše odmah. U zavisnosti od trenutno aktivnog prozora, mogu se odabrati opcije:

  • Svoj set «vrućih tastera» «Actions = …». Ako nema/je prazan — ništa ne raditi.
  • Prekidač «MouseClickDrops» — šta raditi pri otkrivanju klika mišem. Pošto na tački uključivanja xswitcher nema detalja «gdje se klikće», po default-u brišemo bafer. Ali u terminalima (na primer) to ne mora biti tako. (obično).

4. Jedna (ili više) sekvenci pritisaka pokreću određeni hook

# action = [ regex1, regex2, ... ]
# "CLEAN" state: all keys are released
[Actions]
# Inverse regex is hard to understand, so extract negation to external condition.
# Expresions will be checked in direct order, one-by-one. Condition succceds when ALL results are True.
 # Maximum key sequence length, extra keys will be dropped. More length - more CPU.
 SeqLength = 8
 # Drop word buffer and start collecting new one
 NewWord = [ "OFF:(CTRL|ALT|META)  SEQ:(((BACK)?SPACE|[LR]_SHIFT):[01],)*(@WORD@:1)", # "@WORD@:0" then collects the char
             "SEQ:(@WORD@:2,@WORD@:0)", # Drop repeated char at all: unlikely it needs correction
             "SEQ:((KP)?MINUS|(KP)?ENTER|ESC|TAB)" ] # Be more flexible: chars line "-" can start new word, but must not completelly invalidate buffer!
 # Drop all buffers
 NewSentence = [ "SEQ:(ENTER:0)" ]

 # Single char must be deleted by single BS, so there is need in compose sequence detector.
 Compose = [ "OFF:(CTRL|L_ALT|META|SHIFT)  SEQ:(R_ALT:1,(R_ALT:2,)?(,@WORD@:1,@WORD@:0){2},R_ALT:0)" ]

 "Action.RetypeWord" = [ "OFF:(CTRL|ALT|META|SHIFT)  SEQ:(PAUSE:0)" ]
 "Action.CyclicSwitch" = [ "OFF:(R_CTRL|ALT|META|SHIFT)  SEQ:(L_CTRL:1,L_CTRL:0)" ] # Single short LEFT CONTROL
 "Action.Respawn" = [ "OFF:(CTRL|ALT|META|SHIFT)  SEQ:(S_LOCK:2,S_LOCK:0)" ] # Long-pressed SCROLL LOCK

 "Action.Layout0" = [ "OFF:(CTRL|ALT|META|R_SHIFT)  SEQ:(L_SHIFT:1,L_SHIFT:0)" ] # Single short LEFT SHIFT
 "Action.Layout1" = [ "OFF:(CTRL|ALT|META|L_SHIFT)  SEQ:(R_SHIFT:1,R_SHIFT:0)" ] # Single short RIGHT SHIFT

 "Action.Hook1" = [ "OFF:(CTRL|R_ALT|META|SHIFT)  SEQ:(L_ALT:1,L_ALT:0)" ]

Hookovi su podeljeni u dva tipa. Ugrađeni, sa «govorećim» imenima (NewWord, NewSentence, Compose) i programski.

Imena programskih počinju sa «Action.». Pošto je TOML v1.4, imena sa tačkama moraju biti u navodnicima.

Ispod mora biti opisan deo za svaki sa istim imenom.

Kako ne bih šokirao ljude «golim» regularnim izrazima (na osnovu iskustva, njih napisati- može jedan od deset profesionalaca), odmah implementiram dodatnu sintaksu.

  • «OFF:» (ili «ON:») ispred regexp (regularnog izraza) zahtevaju da navedeni tasteri budu pušteni (ili pritisnuti).
    Dalje planiram napraviti «nepošteni» regularni izraz. Sa odvojenim proverama delova između cevi "|". S ciljem smanjenja broja zapisa kao "[LR]_SHIFT" (gde to očigledno nije potrebno).
  • «SEQ:» Ako je prethodni uslov ispunjen (ili odsutan), dalje proveravamo u odnosu na «običan» regularni izraz. Za detalje odmah šaljem na ^W biblioteku «regexp». Jer se sam do sada nisam potrudilo da saznam stepen kompatibilnosti sa mojim omiljenim pcre («perl compatible»).
  • Izraz se zapisuje u obliku «KNOBA_1: KOD1, KNOBA_2: KOD2» i tako dalje, u redosledu dolaska sken-kodova.
  • Provera se uvek «pritisne» na kraj sekvence, zato "$" na kraju nije potrebno dodavati.
  • Sve provere u jednom redu se izvode jedna za drugom i spajaju po «I». Ali pošto je vrednost opisana u obliku niza, može se nakon zareza napisati alternativna provera. Ako je to iz nekog razloga potrebno.
  • Vrednost «SeqLength = 8» ograničava veličinu bafera, u odnosu na koji se izvršavaju sve provere. Budući da u životu dosad nisam sreo beskrajne resurse.

5. Postavljanje hookova koje smo naveli u prethodnoj sekciji

# Action is the array, so actions could be chained (m.b., infinitely... Have I to check this?).
# For each action type, extra named parameters could be collected. Invalid parameters will be ignored(?).
[Action.RetypeWord] # Switch layout, drop last word and type it again
 Action = [ "Action.CyclicSwitch", "RetypeWord" ] # Call Switch() between layouts tuned below, then RetypeWord()

[Action.CyclicSwitch] # Cyclic layout switching
 Action = [ "Switch" ] # Internal layout switcher func
 Layouts = [0, 1]

[Action.Layout0] # Direct layout selection
 Action = [ "Layout" ] # Internal layout selection func
 Layout = 0

[Action.Layout1] # Direct layout selection
 Action = [ "Layout" ] # Internal layout selection func
 Layout = 1

[Action.Respawn] # Completely respawn xswitcher. Reload config as well
 Action = [ "Respawn" ]

[Action.Hook1] # Run external commands
  Action = [ "Exec" ]
  Exec = "/path/to/exec -a -b --key_x"
  Wait = 1
  SendBuffer = "Word" # External hook can process collected buffer by it's own means.

Osnovno ovde je — «Action = [Niz]». Slično prethodnoj sekciji, postoji ograničen skup ugrađenih akcija, ali neograničena mogućnost povezivanja. (napisati «Action.XXX» i ne zaboraviti da dodate još jednu sekciju za to).
Uključujući ponovni unos reči u ispravnom rasporedu, deli se na dva dela: «promeni raspored kao što je ovde navedeno» i «ponovno unesi» («RetypeWord»).

Ostali parametri se zapisuju u «rečnik» («map» u golangu) za ovu akciju, njihov spisak zavisi od onoga što je napisano u «Action».

Nekoliko različitih akcija može se opisati u jednom paketu (sekcije). Takođe se može da se raspodeli, kao što sam ranije pokazao.

Odmah postavljam akciju «Exec» — izvrši spoljašnji skript. Uz opciju da mu gurnem u stdin zapisani bafer.

  • «Wait = 1» — čekaj da proces koji je pokrenut završi.
  • Verovatno, «zajedno» ćeš želeti da postaviš dodatne informacije u okruženje kao što je ime klase prozora iz kojeg je preuzeto.
    «Želite li da povežete svoj handler? Idite ovde.»

Uf (uzdahnuo sam). Čini se da ništa nisam zaboravio.

Uh! Da, nisam zaboravio…
A gde je konfiguracija pokretanja? U hard-kodu? Približno ovako:

[ScanDevices]
 # Mora postojati na početku. Samoobnavljanje ako je mlađe od 30s
 Test = "\/dev\/input\/event0"
 Respawn = 30
 # Maske pretrage
 Search = "\/dev\/input\/event*"
 # Na mojim ThinkPad-ima postoje takve pseudo-tastature sa brdom bespotrebnih događaja
 Bypass = "(?i)Video|Camera" # "(?i)" se očigledno razlikuje od „klasičnog“ pcre-a.

A gde sam zaboravio/napravio grešku (bez ovoga — nikako), veoma se nadam da pažljivi čitatelji neće zaboraviti da me podsetite.

Sretno!

Izvor: habr.com

Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere 🔥 Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere | ProHoster