vigilem-evdev 0.1.3

data/lib/vigilem/evdev/dom/input_event_utils.rb

@@ -0,0 +1,48 @@
+module Vigilem
+module Evdev
+module DOM
+  # 
+  module InputEventUtils
+    
+    include Vigilem::DOM::Utils
+    
+    # takes a InputEvent#code and returns a String
+    # representing the keycode value
+    # @param  [Integer] event_code, the number to convert
+    # @return [String] i.e. "keycode30"
+    def event_code_to_keycode_str(event_code)
+      "keycode#{event_code}"
+    end
+    
+    # takes a keycode_name and returns a common location string
+    # if available
+    # @param  [String || Symbol] keycode_name, i.e. KEY_RIGTHCTRL
+    # @return [String || NilClass] a common locaiton string i.e. 'Right'
+    def location_str_from_keycode_name(keycode_name)
+      if loc = keycode_name.to_s.gsub('KP', 'NUMPAD').scan(/LEFT|RIGHT|NUMPAD/i).first
+        loc.downcase.tap {|obj| obj[0] = obj[0].upcase }
+      end
+    end
+    
+    # takes a keycode name and returns the keymap modifier name
+    # @todo  meta
+    # @param [String ||Symbol] keycode_name, i.e. KEY_RIGHTCTRL
+    # @return [String] keymap_name of the modifier
+    def modifier_keymap_name(keycode_name)
+      if (keycode_name) =~ /caps|shift|alt|c(on)?tro?l/i
+        if keycode_name == :KEY_CAPSLOCK
+          'capsshift'
+        else
+          keycode_name.to_s.gsub(/KEY_/, '').split(/ight|eft/i).reverse.join.downcase
+        end
+      end
+    end
+    
+    extend self
+    
+    extend Support::Utils
+    
+  end
+end
+end
+end

data/lib/vigilem/evdev/dom/key_values_tables.rb

@@ -0,0 +1,248 @@
+require 'vigilem/support/key_map'
+
+require 'vigilem/evdev/system'
+
+module Vigilem
+module Evdev::DOM
+  module KeyValuesTables
+    
+    include Evdev::System::Input::KeysAndButtons
+    
+    SpecialKeyValues = Support::KeyMap.new({'Unidentified' => nil })
+    ModifierKeys = Support::KeyMap.new.fuse!({
+      :'?'              => 'Accel',
+      KEY_LEFTALT       => 'Alt',
+      KEY_RIGHTALT      => 'Alt'}, {
+      :'?'              => 'AltGraph',
+      KEY_CAPSLOCK      => 'CapsLock',
+      'CtrlL_Lock'      => 'CapsLock',
+      KEY_LEFTCTRL      => 'Control',
+      KEY_RIGHTCTRL     => 'Control',
+      'Control'         => 'Control'}, {
+      :'?'              => ['Fn', 'FnLock', 'Hyper'],
+      KEY_LEFTMETA      => 'Meta',
+      KEY_RIGHTMETA     => 'Meta',
+      KEY_NUMLOCK       => 'NumLock',
+      KEY_LEFTMETA      => 'OS',
+      KEY_SCROLLLOCK    => 'ScrollLock',
+      KEY_LEFTSHIFT     => 'Shift',
+      KEY_RIGHTSHIFT    => 'Shift'}, {
+      :'?'              => ['Super', 'Symbol', 'SymbolLock']
+    })
+    
+    WhitespaceKeys = Support::KeyMap.new({
+      KEY_ENTER        => 'Enter',
+      'KP_Enter'       => 'Enter',
+      :'?'             => 'Separator',
+      'Tab'            => 'Tab',
+      KEY_TAB          => 'Tab'
+    })
+    # Space
+    
+    NavigationKeys = Support::KeyMap.new({
+      KEY_DOWN     => 'ArrowDown',
+      'Down'       => 'ArrowDown',
+      'KP_2'       => 'ArrowDown',
+      KEY_LEFT     => 'ArrowLeft',
+      'Left'       => 'ArrowLeft',
+      'KP_4'       => 'ArrowLeft',
+      KEY_RIGHT    => 'ArrowRight',
+      'Right'      => 'ArrowRight',
+      'KP_6'       => 'ArrowRight',
+      KEY_UP       => 'ArrowUp', 
+      'Up'         => 'ArrowUp', 
+      'KP_8'       => 'ArrowUp', 
+      KEY_END      => 'End',
+      'KP_1'       => 'End',
+      KEY_HOME     => 'Home',
+      'KP_7'       => 'Home',
+      KEY_PAGEDOWN => 'PageDown',
+      'KP_3'       => 'PageDown',
+      KEY_PAGEUP   => 'PageUp',
+      'KP_9'       => 'PageUp'
+    })
+
+    EditingKeys = Support::KeyMap.new.fuse!({
+      KEY_BACKSPACE => 'Backspace',
+      KEY_CLEAR     => 'Clear', 
+      KEY_COPY      => 'Copy', 
+      :'?'          => 'CrSel', 
+      KEY_CUT       => 'Cut',
+      KEY_DELETE    => 'Delete'}, {
+      :'?'          => ['EraseEof', 'ExSel'],
+      KEY_INSERT    => 'Insert',
+      KEY_PASTE     => 'Paste', 
+      KEY_REDO      => 'Redo', 
+      KEY_UNDO      => 'Undo'
+    })
+    UIKeys = Support::KeyMap.new.fuse!({
+      :'?'        => 'Accept',
+      KEY_AGAIN   => 'Again'}, {
+      :'?'        => 'Attn',
+      KEY_CANCEL  => 'Cancel',
+      KEY_COMPOSE => 'ContextMenu',
+      KEY_ESC     => 'Escape'}, {
+      :'?'        => 'Execute',
+      KEY_FIND    => 'Find',
+      KEY_HELP    => 'Help',
+      KEY_PAUSE   => 'Pause',
+      KEY_PLAY    => 'Play',
+      KEY_PROPS   => 'Props',
+      KEY_SELECT  => 'Select',
+      KEY_ZOOMIN  => 'ZoomIn',
+      KEY_ZOOMOUT => 'ZoomOut'
+    })
+    
+    DeviceKeys = Support::KeyMap.new.fuse!({
+      :'?'                => ['BrightnessDown', 'BrightnessUp'],
+      KEY_CAMERA          => 'Camera',
+      KEY_EJECTCD         => 'Eject', 
+      KEY_EJECTCLOSECD    => 'Eject'}, {
+      :'?'                => ['LogOff', 'Power', 'PowerOff'],
+      KEY_PRINT           => 'PrintScreen'}, {
+      :'?'                => ['Hibernate', 'Standby', 'WakeUp']
+    })
+    IMEandCompositionKeys = Support::KeyMap.new.fuse!({
+      :'?'                         => ['AllCandidates', 'Alphanumeric', 
+                                                          'CodeInput'],
+      KEY_COMPOSE                  => 'Compose'}, {
+      :'?'                         => ['Convert', 'Dead', 'FinalMode', 
+                                            'GroupFirst', 'GroupLast'],
+      KEY_KBDINPUTASSIST_NEXTGROUP => 'GroupNext',
+      KEY_KBDINPUTASSIST_PREVGROUP => 'GroupPrevious',
+      KEY_MODE                     => 'ModeChange'}, {
+      :'?'                         => ['NextCandidate', 'NonConvert', 
+                                        'PreviousCandidate', 'Process', 
+                                                      'SingleCandidate']
+    })
+    KeysspecifictoKoreankeyboards = Support::KeyMap.new.fuse!({
+      KEY_HANGEUL => 'HangulMode',
+      KEY_HANJA   => 'HanjaMode',
+      :'?'        => 'JunjaMode'
+    })
+    KeysspecifictoJapanesekeyboards = Support::KeyMap.new.fuse!({
+      :'?'                  => ['Eisu', 'Hankaku'],
+      KEY_HIRAGANA          => 'Hiragana',
+      KEY_KATAKANAHIRAGANA  => 'HiraganaKatakana'}, {
+      :'?'                  => ['KanaMode', 'KanjiMode'],
+      KEY_KATAKANA          => 'Katakana'}, {
+      :'?'                  => ['Romaji', 'Zenkaku'],
+      KEY_ZENKAKUHANKAKU    => 'ZenkakuHankaku'
+    })
+    General_PurposeFunctionKeys = Support::KeyMap.new({
+      KEY_F1  => 'F1',
+      KEY_F2  => 'F2',
+      KEY_F3  => 'F3',
+      KEY_F4  => 'F4',
+      KEY_F5  => 'F5',
+      KEY_F6  => 'F6',
+      KEY_F7  => 'F7',
+      KEY_F8  => 'F8',
+      KEY_F9  => 'F9',
+      KEY_F10 => 'F10',
+      KEY_F11 => 'F11',
+      KEY_F12 => 'F12',
+      :'?'    => ['Soft1', 'Soft2', 'Soft3', 'Soft4']
+    })
+    
+    MultimediaKeys = Support::KeyMap.new.fuse!({
+      KEY_CLOSECD         => 'Close',
+      KEY_EJECTCLOSECD    => 'Close', 
+      KEY_FORWARDMAIL     => 'MailForward', 
+      KEY_REPLY           => 'MailReply', 
+      :'?'                => 'MailSend'}, {
+      KEY_PLAYPAUSE       => 'MediaPlayPause', 
+      :'?'                => 'MediaSelect', #too many option need to test
+      KEY_STOPCD          => 'MediaStop', 
+      KEY_NEXTSONG        => 'MediaTrackNext', 
+      KEY_PREVIOUSSONG    => 'MediaTrackPrevious',
+      KEY_NEW             => 'New', 
+      KEY_OPEN            => 'Open',
+      KEY_PRINT           => 'Print',
+      KEY_SAVE            => 'Save',
+      KEY_SPELLCHECK      => 'SpellCheck',
+      KEY_VOLUMEDOWN      => 'VolumeDown', 
+      KEY_VOLUMEUP        => 'VolumeUp',
+      KEY_MUTE            => 'VolumeMute'
+    })
+    
+    ApplicationKeys = Support::KeyMap.new({
+      KEY_CALC          => 'LaunchCalculator',
+      KEY_CALENDAR      => 'LaunchCalendar',
+      KEY_MAIL          => 'LaunchMail', 
+      KEY_PLAYER        => ['LaunchMediaPlayer', 'LaunchMusicPlayer'],
+      KEY_PC            => 'LaunchMyComputer',
+      KEY_COFFEE        => 'LaunchScreenSaver', 
+      KEY_SPREADSHEET   => 'LaunchSpreadsheet',
+      KEY_WWW           => 'LaunchWebBrowser', 
+      :'?'              => 'LaunchWebCam', #how's this differ from KEY_CAMERA?
+      KEY_WORDPROCESSOR => 'LaunchWordProcessor'
+    })
+    
+    BrowserKeys = Support::KeyMap.new({
+      :'?' => ['BrowserBack','BrowserFavorites', 'BrowserForward', 
+                'BrowserHome', 'BrowserRefresh', 'BrowserSearch', 
+                                                     'BrowserStop']
+    })
+    
+    MediaControllerKeys = Support::KeyMap.new().fuse!({
+      :'?'                  => ['AudioBalanceLeft', 'AudioBalanceRight']}, {
+      KEY_BASSBOOST         => ['AudioBassBoostDown', 'AudioBassBoostUp'],
+      :'?'                  => ['AudioFaderFront', 'AudioFaderRear', 
+                                'AudioSurroundModeNext', 'AVRInput', 'AVRPower'],
+      KEY_CHANNELDOWN       => 'ChannelDown',
+      KEY_CHANNELUP         => 'ChannelUp',
+      KEY_RED               => 'ColorF0Red',
+      KEY_GREEN             => 'ColorF1Green',
+      KEY_YELLOW            => 'ColorF2Yellow',
+      KEY_BLUE              => 'ColorF3Blue'}, {
+      :'?'                  => ['ColorF4Grey', 'ColorF5Brown', 'ClosedCaptionToggle', 
+                                'Dimmer', 'DisplaySwap', 'Exit', 
+                                'FavoriteClear0', 'FavoriteClear1', 
+                                'FavoriteClear2', 'FavoriteClear3', 
+                                'FavoriteRecall0', 'FavoriteRecall1', 
+                                'FavoriteRecall2', 'FavoriteRecall3', 
+                                'FavoriteStore0', 'FavoriteStore1', 
+                                'FavoriteStore2', 'FavoriteStore3', 
+                                'Guide', 'GuideNextDay', 'GuidePreviousDay', 
+                                'Info',   'InstantReplay', 'Link', 
+                                'ListProgram', 'LiveContent', 'Lock', 
+                                'MediaApps', 'MediaFastForward', 'MediaLast', 
+                                'pMediaPause', 'MediaPlay', 'MediaRecord'],
+      KEY_REWIND            =>  'MediaRewind'}, {
+      :'?'                  =>  ['MediaSkip', 'NextFavoriteChannel', 
+                                'NextUserProfile', 'OnDemand', 'PinPDown', 
+                                'PinPMove', 'PinPToggle', 'PinPUp', 
+                                'PlaySpeedDown', 'PlaySpeedReset', 
+                                'PlaySpeedUp', 'RandomToggle', 'RcLowBattery', 
+                                'RecordSpeedNext', 'RfBypass', 
+                                'ScanChannelsToggle', 'ScreenModeNext', 
+                                'Settings', 'SplitScreenToggle', 'STBInput', 
+                                'STBPower', 'Subtitle', 'Teletext', 'TV', 
+                                'TVInput', 'TVPower', 'VideoModeNext', 
+                                'Wink', 'ZoomToggle', 'BrowserBack', 
+                                'BrowserForward', 'ContextMenu', 'Eject', 
+                                'End', 'Enter', 'Home', 'MediaPlayPause', 
+                                'MediaStop', 'MediaNextTrack', 'MediaPreviousTrack', 
+                                'Power', 'VolumeDown', 'VolumeUp', 'VolumeMute']
+    })
+  end
+  
+  KeyTable = KeyValuesTables.constants.each_with_object(Support::KeyMap.new) do |table_name, memo| 
+    if (key_map = KeyValuesTables.const_get(table_name)).is_a? Hash
+      key_map.right_side_alias(:dom_code)
+      key_map.right_side_alias(:dom_codes)
+      key_map.left_side_alias(:keycode)
+      key_map.left_side_alias(:keycodes)
+      key_map.left_side_alias(:keysym)
+      key_map.left_side_alias(:keysyms)
+      memo.merge! key_map
+    end
+  end
+  
+  KeyTable.right_side_alias(:dom_code)
+  KeyTable.right_side_alias(:dom_codes)
+  KeyTable.left_side_alias(:keycode)
+  KeyTable.left_side_alias(:keycodes)
+end
+end

data/lib/vigilem/evdev/dom/kp_table.rb

@@ -0,0 +1,52 @@
+require 'vigilem/support/key_map'
+
+require 'vigilem/evdev/system/input'
+
+module Vigilem
+module Evdev
+module DOM
+  # keycode or sym...
+  KPTable = Support::KeyMap.new({
+    'KP_Space'      => "\u0020",
+    'KP_Tab'        => "\u0009",
+    'KP_Enter'      => "\u000d",
+    'KP_F1'         => "\u0000",
+    'KP_F2'         => "\u0000",
+    'KP_F3'         => "\u0000",
+    'KP_F4'         => "\u0000",
+    'KP_Home'       => "\u0000",
+    'KP_Left'       => "\u0000",
+    'KP_Up'         => "\u0000",
+    'KP_Right'      => "\u0000",
+    'KP_Down'       => "\u0000",
+    'KP_Prior'      => "\u0000",
+    'KP_Next'       => "\u0000",
+    'KP_End'        => "\u0000",
+    'KP_Begin'      => "\u0000",
+    'KP_Insert'     => "\u0000",
+    'KP_Delete'     => "\u0000",
+    'KP_Multiply'   => "\u002a",
+    'KP_Add'        => "\u002b",
+    'KP_Separator'  => "\u002c",
+    'KP_Subtract'   => "\u002d",
+    'KP_Decimal'    => "\u002e",
+    'KP_Period'     => "\u002e",
+    'KP_Divide'     => "\u002f",
+    'KP_0'          => "\u0030",
+    'KP_1'          => "\u0031",
+    'KP_2'          => "\u0032",
+    'KP_3'          => "\u0033",
+    'KP_4'          => "\u0034",
+    'KP_5'          => "\u0035",
+    'KP_6'          => "\u0036",
+    'KP_7'          => "\u0037",
+    'KP_8'          => "\u0038",
+    'KP_9'          => "\u0039",
+    'KP_Equal'      => "\u003d",
+  })
+  KPTable.right_side_alias(:char)
+  KPTable.left_side_alias(:sym)
+  KPTable.left_side_alias(:keysym)
+end
+end
+end

data/lib/vigilem/evdev/focus_context_filter.rb

@@ -0,0 +1,124 @@
+require 'vigilem/_evdev'
+
+require 'vigilem/evdev/context_filter'
+
+require 'vigilem/x11/stat'
+
+module Vigilem
+module Evdev
+  # 
+  # allows input_events through when the window has focus
+  class FocusContextFilter
+    
+    include Evdev::ContextFilter
+    
+    class << self
+      
+      # 
+      # @return [String || NilClass]
+      def env_display
+        ENV['DISPLAY']
+      end
+      
+      # 
+      # 
+      def lazy_require
+        require 'vigilem/x11/terminal_window_utils'
+        require 'vigilem/x11/input_system_handler'
+      end
+      
+      # 
+      # @param  [String] display
+      # @param  [Integer ||NilClass] xwindow_id
+      # @param  [FocusContextFilter || NilClass]
+      # @return [NilClass || self]
+      def new_if_installed(display=env_display, xwindow_id=nil)
+        if X11::Stat.default.installed?
+          new(display, xwindow_id)
+        end
+      end
+      
+      # 
+      # @param  [String] display
+      # @param  [Integer || NilClass] xwindow_id
+      # @raise  [RuntimeError] 
+      # @return [NilClass || self]
+      def new_if_installed!(display=env_display, xwindow_id=nil)
+        new_if_installed(display, xwindow_id) || raise('InputSystem unavailable')
+      end
+      
+    end
+    
+    attr_accessor :input_system_handler
+    
+    def_delegators :input_system_handler, :display, :window_xid
+    
+    # 
+    # @param  [String]
+    # @param  [Integer || NilClass]
+    def initialize(display=self.class.env_display, xwindow_id=nil)
+      self.class.lazy_require
+      window_xid = xwindow_id || X11::TerminalWindowUtils.window_id
+      
+      @input_system_handler = X11::InputSystemHandler.new(window_xid, display, Xlib::FocusChangeMask)
+    end
+    
+    # 
+    # @return [TrueClass || FalseClass]
+    def has_focus?
+      with_focus = X11.get_input_focus(self.display, window_xid)[1]
+      with_focus == self.window_xid or
+        self.window_xid == X11.query_tree(self.display, with_focus)[:parent_return]
+    end
+    
+    alias_method :had_focus?, :was_off?
+    
+    # 
+    # @return [TrueClass || FalseClass]
+    def on?
+      if gained_focus?
+        on_change(OFF)
+      elsif lost_focus?
+        on_change(ON)
+      end
+      was_on?
+    end
+    
+    # 
+    # @return [TrueClass || FalseClass]
+    def off?
+      not on?
+    end
+    
+    # 
+    # @return [TrueClass || FalseClass]
+    def gained_focus?
+      (not had_focus?) and has_focus?
+    end
+    
+    # 
+    # @return [TrueClass || FalseClass]
+    def lost_focus?
+      had_focus? and not has_focus?
+    end
+    
+    # 
+    # @param  [Array] events
+    # @return [Array]
+    def process(*events)
+      if on?
+        []
+      else
+        events
+      end
+    end
+    
+   private
+    # 
+    # @param  [TrueClass || FalseClass] bool
+    # @return 
+    alias_method :had_focus= ,:was_off=
+    
+  end
+end
+end