Xswitcher განლაგების კორექტორი Linux-ისთვის: ნაბიჯი მეორე

როგორც წინა პუბლიკაცია (xswitcher "კონცეფციის მტკიცებულების" ეტაპზე) მიიღო საკმაოდ ბევრი კონსტრუქციული გამოხმაურება (რაც სასიამოვნოა), გავაგრძელე თავისუფალი დროის დახარჯვა პროექტის შემუშავებაზე. ახლა მინდა დავხარჯო ცოტა შენი... მეორე ნაბიჯი არ იქნება საკმაოდ ჩვეულებრივი: წინადადება/განხილვა კონფიგურაციის დიზაინის შესახებ.

რატომღაც გამოდის, რომ ნორმალურ პროგრამისტებს წარმოუდგენლად მოსაწყენია ყველა ამ კონტროლის დაყენება.

უსაფუძვლო რომ არ იყოს, შიგნით არის მაგალითი იმისა, რასთან მაქვს საქმე.
მთლიანობაში შესანიშნავად ჩაფიქრებული (და კარგად განხორციელებული) Apache Kafka & ZooKeeper.
- კონფიგურაცია? მაგრამ მოსაწყენია! მუნჯი xml (იმიტომ, რომ ის არის "გარემოდან").
-აუ შენც გინდა ACL? მაგრამ ეს ძალიან მოსაწყენია! Tap-blooper... რაღაც ისეთი.

მაგრამ ჩემს შემოქმედებაში ეს ზუსტად საპირისპიროა. უფლება (სამწუხაროდ, თითქმის არასდროს პირველად) აშენებული მოდელი საშუალებას გაძლევთ გააგრძელოთ შემდგომი მარტივად და ბუნებრივად (თითქმის) შეკრიბეთ დიაგრამა.

ცოტა ხნის წინ წავაწყდი სტატიას ჰაბრეზე მონაცემთა მეცნიერთა შრომისმოყვარეობის შესახებ...
გამოდის, რომ მათთვის ეს მომენტი სრულად არის რეალიზებული. და ჩემს პრაქტიკაში, როგორც ამბობენ, "მსუბუქი ვერსია". მრავალტომიანი მოდელები, გამოცდილი პროგრამისტები მზადყოფნაში OOP-ით და ა.შ. — ეს ყველაფერი მოგვიანებით გამოჩნდება, როცა/თუ აფრინდება. მაგრამ დიზაინერმა უნდა დაიწყოს სადღაც აქ და ახლა.

გადადით აზრამდე. სინტაქსურ საფუძვლად ავიღე TOML ამ მოქალაქისგან.

Მის გამო (TOML) ერთი მხრივ, ადამიანის მიერ რედაქტირებადი. მეორეს მხრივ, ის ითარგმნება 1:1 ნებისმიერ უფრო გავრცელებულ სინტაქსად: XML, JSON, YAML.
უფრო მეტიც, იმპლემენტაცია, რომელიც მე გამოვიყენე „github.com/BurntSushi/toml“-დან, თუმცა არ არის ყველაზე მოდური (ჯერ კიდევ 1.4 სინტაქსი), სინტაქსურად თავსებადია იმავე („ჩაშენებული“) JSON-თან.

ანუ, თუ გსურთ, შეგიძლიათ უბრალოდ თქვათ "გაიარე ტყეში შენი TOML-ით, მე მინდა XXX" და "დააკრა" კოდი მხოლოდ ერთი ხაზით.

ამრიგად, თუ გსურთ დაწეროთ რამდენიმე ფანჯარა xswitcher-ის კონფიგურაციისთვის (Დარწმუნებული არ ვარ) არანაირი პრობლემა არ არის მოსალოდნელი "თქვენს ამ წყეულ კონფიგურაციასთან დაკავშირებით".

ყველა დანარჩენისთვის, სინტაქსი ეფუძნება "გასაღები = მნიშვნელობა" (და ფაქტიურად რამდენიმე უფრო რთული ვარიანტი, როგორიცაა = [ზოგიერთი, ეს, მასივი]) მგონი
ინტუიციურად მოსახერხებელი.
რა არის საინტერესო "დამწვარი" დაახლოებით ამავე დროს (დაახლოებით 2013 წელს). მხოლოდ, ჩემგან განსხვავებით, TOML-ის ავტორი სათანადო მასშტაბით შევიდა.

ამიტომ, ახლა ჩემთვის უფრო ადვილია მისი განხორციელების კორექტირება, რათა მოერგოს საკუთარ თავს და არა პირიქით.

ზოგადად, ჩვენ ვიღებთ TOML-ს (ძალიან ჰგავს ძველ Windows INI-ს). ჩვენ გვაქვს კონფიგურაცია, რომელშიც აღვწერთ, თუ როგორ უნდა დავამაგროთ კაკვების სერია კლავიატურიდან უახლესი სკანირების კოდების ნაკრებიდან გამომდინარე. ქვემოთ, ცალ-ცალკე, არის ის, რაც აქამდე მოხდა. და ახსნა, თუ რატომ გადავწყვიტე ასე.

0. ძირითადი აბსტრაქციები

• კოდის აღნიშვნების სკანირება. რაღაც აუცილებლად უნდა გაკეთდეს ამ საკითხთან დაკავშირებით, რადგან უბრალოდ ციფრული კოდები აბსოლუტურად არ იკითხება ადამიანის მიერ (ეს მხოლოდ მე ვარ ლოლოსვიჩერი).
  „გოლანგ-ევდევიდან“ გამოვძვერი „ecodes.go“ (ძალიან მეზარებოდა თავდაპირველი წყაროს ნახვა, თუმცა ავტორმა საკმაოდ კულტურულად მიუთითა). ცოტა გამოვასწორე (ამჟამად) რაღაც, რაც საკმაოდ საშინელი იყო. მოსწონს „LEFTBRACE“ → „L_BRACE“.
• გარდა ამისა, მან გააცნო კონცეფცია "სახელმწიფო გასაღებები". ვინაიდან გამოყენებული რეგულარული გრამატიკა არ იძლევა ხანგრძლივი პასაჟების საშუალებას. (მაგრამ ის საშუალებას გაძლევთ შეამოწმოთ მინიმალური ზედნადები. თუ იყენებთ მხოლოდ „პირდაპირ“ ჩაწერას.)
• იქნება ჩაშენებული „დედუპლიკატორი“, რაც დაჭერილია. ამგვარად, მდგომარეობა „გამეორება“=2 დაიწერება ერთი ჯერ

1. შაბლონების განყოფილება

[Templates] # "@name@" to simplify expressions
 # Words can consist of these chars (regex)
 "WORD" = "([0-9A-Z`;']|[LR]_BRACE|COMMA|DOT|SLASH|KP[0-9])"

რისგან შედგება ადამიანის ენის სიტყვა ფონეტიკური აღნიშვნით? (ან გრაფემების, ასევე „იეროგლიფების“ საკითხი)? რაღაც საშინელი "ფურცელი". ამიტომ, მე მაშინვე წარმოგიდგენთ "თარგის" კონცეფციას.

2. რა უნდა გააკეთო, როცა რამეზე დააწკაპუნებ (მოვიდა სხვა სკანირების კოდი)

[ActionKeys]
 # Collect key and do the test for command sequence
 # !!! Repeat codes (code=2) must be collected once per key!
 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"]

 # Drop all collected keys, including this.  This is default action.
 Drop = ["ESC", "-", "TAB", "ENTER", "KPENTER", "LINEFEED..POWER"]
 # Store extra map for these keys, when any is in "down" state.
 # State is checked via "OFF:"|"ON:" conditions in action.
 # (Also, state of these keys must persist between buffer drops.)
 # ??? How to deal with CAPS and "LOCK"-keys ???
 StateKeys = ["L_CTRL", "L_SHIFT", "L_ALT", "L_META", "CAPS", "N_LOCK", "S_LOCK",
              "R_CTRL", "R_SHIFT", "R_ALT", "R_META"]

 # Test only, but don't collect.
 # E.g., I use F12 instead of BREAK on dumb laptops whith shitty keyboards (new ThinkPads)
 Test = ["F1..F10", "ZENKAKUHANKAKU", "102ND", "F11", "F12",
          "RO..KPJPCOMMA", "SYSRQ", "SCALE", "HANGEUL..YEN",
          "STOP..SCROLLDOWN", "NEW..MAX"]

სულ არის 768 კოდი. (მაგრამ "ყოველ შემთხვევაში" მე ჩავდე "სიურპრიზების" დაჭერა xswitcher კოდში).
შიგნით მე აღვწერე მასივის შევსება ფუნქციების ბმულებით „რა უნდა გავაკეთო“. გოლანგში ეს არის (უცებ) აღმოჩნდა მოსახერხებელი და აშკარა.

• ამ ადგილას „Drop“-ის მინიმუმამდე შემცირებას ვგეგმავ. უფრო მოქნილი დამუშავების სასარგებლოდ (ქვემოთ გაჩვენებთ).

3. მაგიდა ფანჯრის კლასებით

# 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"

ცხრილის რიგები ორმაგ კვადრატულ ფრჩხილებშია მის სახელთან ერთად. ეს არ შეიძლებოდა ყოფილიყო უფრო ადვილი მაშინვე. ამჟამად აქტიური ფანჯრიდან გამომდინარე, შეგიძლიათ აირჩიოთ შემდეგი პარამეტრები:

• თქვენი საკუთარი ნაკრები "ცხელი კლავიშები" "მოქმედებები = ...". თუ არა/ცარიელი, არაფერი გააკეთოთ.
• გადართეთ „MouseClickDrops“ - რა უნდა გააკეთოთ, როდესაც მაუსის დაწკაპუნება აღმოჩენილია. ვინაიდან xswitcher-ის ჩართვის წერტილში არ არის დეტალები იმის შესახებ, თუ სად აწკაპუნებენ, ჩვენ სტანდარტულად გადავტვირთავთ ბუფერს. მაგრამ ტერმინალებში (მაგალითად) თქვენ არ გჭირდებათ ამის გაკეთება (ჩვეულებრივ).

4. ერთი (ან რამდენიმე) დაწკაპუნების თანმიმდევრობა იწვევს ამა თუ იმ კაუჭს

# 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)" ]

კაკვები იყოფა ორ ტიპად. ჩაშენებული, „სალაპარაკო“ სახელებით (NewWord, NewSentence, Compose) და პროგრამირებადი.

პროგრამირებადი სახელები იწყება "მოქმედებით". იმიტომ რომ TOML v1.4, სახელები წერტილებით უნდა იყოს ბრჭყალებში.

თითოეული განყოფილება უნდა იყოს აღწერილი ქვემოთ ამავე სახელწოდებით.

იმისათვის, რომ ხალხის გონება "შიშველი" რეგულარებით (გამოცდილებიდან, მათი წერენშესაძლოა ათიდან ერთი პროფესიონალები), მე დაუყოვნებლივ ვახორციელებ დამატებით სინტაქსს.

• "OFF:" (ან "ON:") სანამ regexp (რეგულარული გამოხატულება) მოითხოვს შემდეგი ღილაკების გათავისუფლებას (ან დაჭერას).
  შემდეგ მე ვაპირებ "უსამართლო" რეგულარულ გამოთქმას. მილებს შორის ნაწილების ცალკე შემოწმებით "|". იმისათვის, რომ შემცირდეს ჩანაწერების რაოდენობა, როგორიცაა "[LR]_SHIFT" (სადაც ეს აშკარად არ არის საჭირო).
• "SEQ:" თუ წინა პირობა დაკმაყოფილებულია (ან არ არსებობს), მაშინ ჩვენ ვამოწმებთ "ნორმალური" რეგულარულ გამონათქვამს. დეტალებისთვის, მე დაუყოვნებლივ ვუგზავნი ^W-ს "regexp" ბიბლიოთეკას. იმის გამო, რომ მე ჯერ კიდევ არ შევწუხდი ჩემს საყვარელ pcre-სთან ("perl თავსებადი") თავსებადობის ხარისხის გასარკვევად.
• გამოთქმა იწერება ფორმაში "BUTTON_1: CODE1, BUTTON_2: CODE2" და ა.შ., სკანირების კოდების მიღების თანმიმდევრობით.
• ჩეკი ყოველთვის "მიწებებულია" მიმდევრობის ბოლომდე, ასე რომ არ არის საჭირო კუდში "$"-ის დამატება.
• ყველა შემოწმება ერთ ხაზზე ხორციელდება ერთმანეთის მიყოლებით და გაერთიანებულია "მე"-ით. მაგრამ რადგან მნიშვნელობა აღწერილია როგორც მასივი, შეგიძლიათ დაწეროთ ალტერნატიული შემოწმება მძიმის შემდეგ. თუ ეს საჭიროა რაიმე მიზეზით.
• ღირებულება "SeqLength = 8" ზღუდავს ბუფერის ზომას, რომლის მიმართაც შესრულებულია ყველა შემოწმება. იმიტომ რომ ჩემს ცხოვრებაში (აქამდე) არასოდეს შემხვედრია გაუთავებელი რესურსები.

5. წინა ნაწილში აღწერილი კაკვების დაყენება

# 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.

აქ მთავარია "მოქმედება = [მასივი]". წინა განყოფილების მსგავსად, არის ჩაშენებული მოქმედებების შეზღუდული ნაკრები. და დოკინგის შესაძლებლობა პრინციპში შეზღუდული არ არის (დაწერეთ „Action.XXX“ და არ დაიზაროთ, რომ დაწეროთ სხვა განყოფილება).
კერძოდ, შესწორებულ განლაგებაში სიტყვის ხელახალი აკრეფა ორ ნაწილად იყოფა: "შეცვალეთ განლაგება, როგორც მითითებულია იქ" и "ხელახლა აკრეფა" ("RetypeWord").

დარჩენილი პარამეტრები იწერება "ლექსიკონში" ("რუკა" გოლანგზე) მოცემული მოქმედებისთვის მათი სია დამოკიდებულია იმაზე, თუ რა წერია „მოქმედებაში“.

რამდენიმე განსხვავებული ქმედება შეიძლება აღწერილი იყოს ერთ გროვაში (სექციები). ან შეგიძლიათ დაშალოთ იგი. როგორც ზემოთ ვაჩვენე.

მე მაშინვე დავაყენე "Exec" მოქმედება გარე სკრიპტის შესასრულებლად. ჩაწერილი ბუფერის stdin-ში გადასვლის ოფციით.

• "დაელოდე = 1" - დაელოდეთ გაშვებული პროცესის დასრულებას.
• ალბათ, „ბევრამდე“ მოგინდებათ გარემოში დამატებითი ადამიანების შეყვანა. ინფორმაცია, როგორიცაა ფანჯრის კლასის დასახელება, საიდანაც მოხდა მისი ჩარევა.
  „გსურთ თქვენი დამმუშავებლის დაკავშირება? ეს არის ის, სადაც თქვენ უნდა წახვიდეთ. ”

ფუ (ამოისუნთქა). როგორც ჩანს, არაფერი დამავიწყდა.

უი! ჰო, არ დამავიწყდა...
სად არის გაშვების კონფიგურაცია? მყარი კოდით? Ეგრე:

[ScanDevices]
 # Must exist on start. Self-respawn in case it is younger then 30s
 Test = "/dev/input/event0"
 Respawn = 30
 # Search mask
 Search = "/dev/input/event*"
 # In my thinkPads there are such a pseudo-keyboards whith tons of unnecessary events
 Bypass = "(?i)Video|Camera" # "(?i)" obviously differs from "classic" pcre's.

სად დამავიწყდა/დავუშვი შეცდომა? (ამის გარეშე არანაირად), დიდი იმედი მაქვს, რომ ყურადღებიან მკითხველებს არ დაეზარებათ ცხვირწინ.

გისურვებთ წარმატებას!

წყარო: www.habr.com