מתקן פריסת Xswitcher עבור לינוקס: שלב שני

כמו פרסום קודם (xswitcher בשלב "הוכחת הרעיון") קיבל די הרבה משוב בונה (זה נחמד), המשכתי להשקיע את זמני הפנוי בפיתוח הפרויקט. עכשיו אני רוצה לבלות קצת ממך... השלב השני לא יהיה די רגיל: הצעה/דיון בעיצוב תצורה.

איכשהו מתברר שלמתכנתים רגילים זה משעמם להפליא להגדיר את כל הפקדים האלה.

כדי לא להיות מופרך, בפנים יש דוגמה למה שאני מתמודד איתו.
באופן כללי, אפאצ'י קפקא ו-ZooKeeper מתוכננים מצוין (ומיושמים היטב).
- תצורה? אבל זה משעמם! xml מטומטם (כי זה "מחוץ לקופסה").
- אה, גם אתה רוצה ACL? אבל זה כל כך משעמם! טפו-בלופר... משהו כזה.

אבל בעבודה שלי זה בדיוק הפוך. ימין (אבוי, כמעט אף פעם לא בפעם הראשונה) הדגם הבנוי מאפשר לך להמשיך הלאה בקלות ובטבעיות (כִּמעַט) להרכיב תרשים.

לאחרונה נתקלתי במאמר על Habré על העבודה הקשה של מדעני נתונים...
מסתבר שהרגע הזה מומש עבורם במלואו. ובתרגול שלי, כמו שאומרים, "גרסה קלה". דגמים מרובים, מתכנתים ותיקים עם OOP מוכן וכו'. - כל זה יופיע מאוחר יותר כאשר/אם זה ימריא. אבל המעצב צריך להתחיל איפשהו כאן ועכשיו.

תגיע לנקודה. לקחתי את TOML כבסיס תחבירי מהאזרח הזה.

בגלל שהוא (TOML) מצד אחד, ניתן לעריכה אנושית. מצד שני, הוא מתורגם 1:1 לכל אחד מהתחביר הנפוצים יותר: XML, JSON, YAML.
יתרה מכך, המימוש שבו השתמשתי מ-"github.com/BurntSushi/toml", אם כי לא הכי אופנתי (עדיין תחביר 1.4), תואם תחבירית לאותו ("מובנה") JSON.

כלומר, אם תרצה, אתה יכול פשוט לומר "עבור דרך היער עם ה-TOML הזה שלך, אני רוצה XXX" ו"תתקן" את הקוד בשורה אחת בלבד.

לפיכך, אם אתה רוצה לכתוב כמה חלונות כדי להגדיר את xswitcher (אני לא בטוח) לא צפויות בעיות "עם התצורה הארורה הזו שלך."

עבור כל השאר, התחביר מבוסס על "מפתח = ערך" (וממש כמה אפשרויות מסובכות יותר, כמו = [כמה, זה, מערך]) אני מניח
נוח אינטואיטיבית.
מה שמעניין זה "שַׂרוּף" בערך באותו זמן (בסביבות 2013). רק שבניגוד אלי, מחבר TOML נכנס בקנה מידה ראוי.

לכן, עכשיו קל לי יותר להתאים את היישום שלו כך שיתאים לעצמי, ולא להיפך.

באופן כללי, אנו לוקחים TOML (דומה מאוד ל-Windows INI הישן). ויש לנו תצורה שבה אנו מתארים כיצד לחבר סדרה של ווים בהתאם לסט של קודי הסריקה העדכניים ביותר מהמקלדת. להלן, חלק אחר חלק, מה שקרה עד כה. והסבר למה החלטתי ככה.

0. הפשטות בסיסיות

• סרוק ייעודי קוד. בהחלט צריך לעשות משהו בקשר לזה, מכיוון שפשוט קודים דיגיטליים אינם ניתנים לקריאה אנושית (זה רק אני loloswitcher).
  הוצאתי את "ecodes.go" מ-"golang-evdev" (הייתי עצלן מכדי להסתכל על המקור המקורי, אם כי המחבר ציין זאת באופן תרבותי למדי). תיקנתי משהו קטן (בינתיים) שהיה די מפחיד. כמו "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).
בפנים תיארתי את מילוי המערך בקישורים לפונקציות "מה לעשות". בגולנג זה (פִּתְאוֹם) התברר שזה נוח ומובן מאליו.

• אני מתכנן לצמצם את "דרופ" למינימום במקום הזה. לטובת עיבוד גמיש יותר (אראה זאת בהמשך).

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" ואל תתעצל לכתוב עבורו קטע נוסף).
בפרט, הקלדה חוזרת של מילה בפריסה המתוקנת מחולקת לשני חלקים: "שנה את הפריסה כפי שצוין שם" и "retype" ("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