rbnput-darwin-minimal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 594358ceb0f0f0e7221573889dc49812811c4650bacfc7ac83632f9a34c786ea
+  data.tar.gz: a796a9ad610243fdfe74a3f35ccadf1cb27700bd7c38c72219c5f50767922d4f
+SHA512:
+  metadata.gz: a8927a2cbc7c1253c5cf79c68393c2008824688147a8086ba8fb41c46e53ba01b6efb682c2b33c02b4d420eec584e3d47470dbee78762b2c7f5b9cdcdbd4a80e
+  data.tar.gz: fafd61a4756920e3c8c32012e9e6717fb8af19c6459862aec7b413bc2949081dc50e0dfd44a3a16e0b4904a275efe0a9f973fbe408c7b53f5f5a13434eac89ce

data/lib/rbnput/darwin_ffi.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module Rbnput::DarwinFFI
+  extend FFI::Library
+  ffi_lib ['/System/Library/Frameworks/ApplicationServices.framework/ApplicationServices',
+            '/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation']
+
+  # CoreFoundation types
+  typedef :pointer, :CFMachPortRef
+  typedef :pointer, :CFRunLoopSourceRef
+  typedef :pointer, :CFRunLoopRef
+  typedef :pointer, :CFStringRef
+  typedef :pointer, :CGEventTapProxy
+  typedef :pointer, :CGEventRef
+  
+  # Constants
+  KCGSessionEventTap = 0
+  KCGHeadInsertEventTap = 0
+  KCGEventTapOptionDefault = 0x00000000
+  KCGEventTapOptionListenOnly = 0x00000001
+  
+  KCFRunLoopRunFinished = 1
+  KCFRunLoopRunStopped = 2
+  KCFRunLoopRunTimedOut = 3
+  KCFRunLoopRunHandledSource = 4
+
+  KCGEventSourceUnixProcessID = 1
+  KCGKeyboardEventKeycode = 9
+
+  KCGScrollWheelEventDeltaAxis1 = 11 # Y
+  KCGScrollWheelEventDeltaAxis2 = 12 # X 
+
+  KCGEventKeyDown = 10
+  KCGEventKeyUp = 11
+  KCGEventFlagsChanged = 12
+  
+  # We need to get the kCFRunLoopDefaultMode constant value
+  # It's a CFStringRef. For simplicity in FFI, we can often pass NULL (0) for default mode in some APIs,
+  # but CFRunLoopAddSource requires a mode.
+  # A common workaround is to look it up or define it if we know the symbol name.
+  # However, getting the actual pointer value of a constant exported by a dylib in FFI can be tricky.
+  # We'll try to attach it.
+  attach_variable :kCFRunLoopDefaultMode, :kCFRunLoopDefaultMode, :pointer
+
+  # CGEventTapCallback
+  callback :CGEventTapCallback, [:pointer, :int, :pointer, :pointer], :pointer
+
+  # Functions
+  attach_function :CGEventTapCreate, [:int, :int, :int, :uint64, :CGEventTapCallback, :pointer], :CFMachPortRef
+  attach_function :CGEventTapEnable, [:CFMachPortRef, :bool], :void
+  attach_function :CFMachPortCreateRunLoopSource, [:pointer, :CFMachPortRef, :long], :CFRunLoopSourceRef
+  attach_function :CFRunLoopGetCurrent, [], :CFRunLoopRef
+  attach_function :CFRunLoopAddSource, [:CFRunLoopRef, :CFRunLoopSourceRef, :pointer], :void
+  attach_function :CFRunLoopRunInMode, [:pointer, :double, :bool], :int
+  attach_function :CFRunLoopStop, [:CFRunLoopRef], :void
+  attach_function :CFRelease, [:pointer], :void
+  attach_function :AXIsProcessTrusted, [], :bool
+  attach_function :CGEventGetIntegerValueField, [:pointer, :int], :int64
+  attach_function :CGEventGetType, [:pointer], :int
+  attach_function :CGEventGetFlags, [:pointer], :uint64
+  attach_function :CGEventCreateKeyboardEvent, [:pointer, :uint16, :bool], :pointer
+  attach_function :CGEventPost, [:int, :pointer], :void
+  attach_function :CGEventSourceCreate, [:int], :pointer
+  attach_function :CFRelease, [:pointer], :void
+  attach_function :CGEventSetFlags, [:pointer, :uint64], :void
+end

data/lib/rbnput/darwin_listener.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'set'
+require_relative './key_code'
+require_relative './simple_mutex_thread'
+require_relative './darwin_ffi'
+
+module Rbnput
+  # Base listener for keyboard events
+  class DarwinListener < Rbnput::SimpleMutexThread
+    def initialize(on_press: nil, on_release: nil, **kwargs)
+      super(*kwargs)
+      @on_press = on_press
+      @on_release = on_release
+
+      @loop = nil
+      @tap = nil
+      @callback_proc = nil # Keep reference to prevent GC
+    end
+    attr_reader :on_press, :on_release
+
+    def on_press(&proc)
+      @on_press = proc
+    end
+    def on_release(&proc)
+      @on_press = proc
+    end
+
+    def _run
+      unless Rbnput::DarwinFFI.AXIsProcessTrusted()
+        @log.warn("Process is not trusted! Input monitoring will not work until added to accessibility clients.")
+      end
+
+      # Create the callback
+      @callback_proc = FFI::Function.new(:pointer, [:pointer, :int, :pointer, :pointer]) do |proxy, type, event, refcon|
+        key_code = DarwinFFI
+          .CGEventGetIntegerValueField(event, Rbnput::DarwinFFI::KCGKeyboardEventKeycode)
+          .then { |vk| KeyCode.from_vk(vk) }
+        
+        case type
+        when Rbnput::DarwinFFI::KCGEventKeyDown;      @on_press&.call(key_code)
+        when Rbnput::DarwinFFI::KCGEventKeyUp;        @on_release&.call(key_code)
+        when Rbnput::DarwinFFI::KCGEventFlagsChanged; @on_press&.call(key_code)
+        end
+        event
+      end
+
+      @tap = Rbnput::DarwinFFI.CGEventTapCreate(
+        Rbnput::DarwinFFI::KCGSessionEventTap,
+        Rbnput::DarwinFFI::KCGHeadInsertEventTap,
+        Rbnput::DarwinFFI::KCGEventTapOptionDefault,
+        (1 << Rbnput::DarwinFFI::KCGEventKeyDown)  | (1 << Rbnput::DarwinFFI::KCGEventKeyUp) | (1 << Rbnput::DarwinFFI::KCGEventFlagsChanged),
+        @callback_proc,
+        nil
+      )
+
+      if @tap.null?
+        @log.error("Failed to create event tap")
+        return
+      end
+
+      # Create run loop source
+      source = Rbnput::DarwinFFI.CFMachPortCreateRunLoopSource(nil, @tap, 0)
+      
+      # Add to current run loop
+      @loop = Rbnput::DarwinFFI.CFRunLoopGetCurrent()
+      Rbnput::DarwinFFI.CFRunLoopAddSource(@loop, source, Rbnput::DarwinFFI.kCFRunLoopDefaultMode)
+      
+      # Enable tap
+      Rbnput::DarwinFFI.CGEventTapEnable(@tap, true)
+      
+      # Run loop
+      while @running
+        _result = Rbnput::DarwinFFI.CFRunLoopRunInMode(Rbnput::DarwinFFI.kCFRunLoopDefaultMode, 0.1, false)
+        
+        # 0.1 second timeout allows us to check @running flag
+      end
+    ensure
+      Rbnput::DarwinFFI.CFRelease(@tap) if @tap && !@tap.null?
+      Rbnput::DarwinFFI.CFRelease(source) if source && !source.null?
+      @tap = nil
+      @loop = nil
+    end
+
+    def stop
+      super
+      Rbnput::DarwinFFI.CFRunLoopStop(@loop) if @loop && !@loop.null?
+    end
+
+  end
+end

data/lib/rbnput/key_code.rb

@@ -0,0 +1,45 @@
+require_relative "./key_code_const"
+
+class Rbnput::KeyCode
+  attr_reader :vk, :is_media
+
+  def initialize(vk: nil, is_media: false)
+    @vk = vk
+    @is_media = is_media
+  end
+
+  def to_s
+    [
+      @vk.nil? ? "" : "vk=#{@vk}",
+      @is_media ? "media" : "",
+    ]
+    .reject(&:empty?)
+    .join(", ")
+    .then { "KeyCode(#{_1}, #{key})" }
+  end
+
+  def key
+    KEY_CODE_HEX_TO_NAME[@vk] || "UNKNOW"
+  end
+
+  def ==(other)
+    return false unless other.is_a?(KeyCode)
+    @vk == other.vk && @is_media == other.is_media
+  end
+
+  alias eql? ==
+
+  def hash
+    [@vk, @is_media].hash
+  end
+
+  def self.from_vk(vk, **kwargs)
+    new(vk: vk, is_media: false, **kwargs)
+  end
+
+  def self.from_media(vk, **kwargs)
+    new(vk: vk, is_media: true, **kwargs)
+  end
+
+end
+

data/lib/rbnput/key_code_const.rb

@@ -0,0 +1,128 @@
+KEY_CODE_NAME_TO_HEX = {
+  :kVK_ANSI_A => 0x00,
+  :kVK_ANSI_S => 0x01,
+  :kVK_ANSI_D => 0x02,
+  :kVK_ANSI_F => 0x03,
+  :kVK_ANSI_H => 0x04,
+  :kVK_ANSI_G => 0x05,
+  :kVK_ANSI_Z => 0x06,
+  :kVK_ANSI_X => 0x07,
+  :kVK_ANSI_C => 0x08,
+  :kVK_ANSI_V => 0x09,
+  :kVK_ANSI_B => 0x0B,
+  :kVK_ANSI_Q => 0x0C,
+  :kVK_ANSI_W => 0x0D,
+  :kVK_ANSI_E => 0x0E,
+  :kVK_ANSI_R => 0x0F,
+  :kVK_ANSI_Y => 0x10,
+  :kVK_ANSI_T => 0x11,
+  :kVK_ANSI_1 => 0x12,
+  :kVK_ANSI_2 => 0x13,
+  :kVK_ANSI_3 => 0x14,
+  :kVK_ANSI_4 => 0x15,
+  :kVK_ANSI_6 => 0x16,
+  :kVK_ANSI_5 => 0x17,
+  :kVK_ANSI_Equal => 0x18,
+  :kVK_ANSI_9 => 0x19,
+  :kVK_ANSI_7 => 0x1A,
+  :kVK_ANSI_Minus => 0x1B,
+  :kVK_ANSI_8 => 0x1C,
+  :kVK_ANSI_0 => 0x1D,
+  :kVK_ANSI_RightBracket => 0x1E,
+  :kVK_ANSI_O => 0x1F,
+  :kVK_ANSI_U => 0x20,
+  :kVK_ANSI_LeftBracket => 0x21,
+  :kVK_ANSI_I => 0x22,
+  :kVK_ANSI_P => 0x23,
+  :kVK_ANSI_L => 0x25,
+  :kVK_ANSI_J => 0x26,
+  :kVK_ANSI_Quote => 0x27,
+  :kVK_ANSI_K => 0x28,
+  :kVK_ANSI_Semicolon => 0x29,
+  :kVK_ANSI_Backslash => 0x2A,
+  :kVK_ANSI_Comma => 0x2B,
+  :kVK_ANSI_Slash => 0x2C,
+  :kVK_ANSI_N => 0x2D,
+  :kVK_ANSI_M => 0x2E,
+  :kVK_ANSI_Period => 0x2F,
+  :kVK_ANSI_Grave => 0x32,
+  :kVK_ANSI_KeypadDecimal => 0x41,
+  :kVK_ANSI_KeypadMultiply => 0x43,
+  :kVK_ANSI_KeypadPlus => 0x45,
+  :kVK_ANSI_KeypadClear => 0x47,
+  :kVK_ANSI_KeypadDivide => 0x4B,
+  :kVK_ANSI_KeypadEnter => 0x4C,
+  :kVK_ANSI_KeypadMinus => 0x4E,
+  :kVK_ANSI_KeypadEquals => 0x51,
+  :kVK_ANSI_Keypad0 => 0x52,
+  :kVK_ANSI_Keypad1 => 0x53,
+  :kVK_ANSI_Keypad2 => 0x54,
+  :kVK_ANSI_Keypad3 => 0x55,
+  :kVK_ANSI_Keypad4 => 0x56,
+  :kVK_ANSI_Keypad5 => 0x57,
+  :kVK_ANSI_Keypad6 => 0x58,
+  :kVK_ANSI_Keypad7 => 0x59,
+  :kVK_ANSI_Keypad8 => 0x5B,
+  :kVK_ANSI_Keypad9 => 0x5C,
+  :kVK_F1 => 0x7A,
+  :kVK_F2 => 0x78,
+  :kVK_F3 => 0x63,
+  :kVK_F4 => 0x76,
+  :kVK_F5 => 0x60,
+  :kVK_F6 => 0x61,
+  :kVK_F7 => 0x62,
+  :kVK_F8 => 0x64,
+  :kVK_F9 => 0x65,
+  :kVK_F10 => 0x6D,
+  :kVK_F11 => 0x67,
+  :kVK_F12 => 0x6F,
+  :kVK_F13 => 0x69,
+  :kVK_F14 => 0x6B,
+  :kVK_F15 => 0x71,
+  :kVK_F16 => 0x6A,
+  :kVK_F17 => 0x40,
+  :kVK_F18 => 0x4F,
+  :kVK_F19 => 0x50,
+  :kVK_F20 => 0x5A,
+  :kVK_Space =>  0x31,
+  :kVK_Return =>  0x24,
+  :kVK_Tab =>  0x30,
+  :kVK_Delete =>  0x33,
+  :kVK_Escape =>  0x35,
+  :kVK_LeftCommand =>  0x37,
+  :kVK_LeftShift =>  0x38,
+  :kVK_CapsLock =>  0x39,
+  :kVK_LeftOption =>  0x3A,
+  :kVK_LeftControl =>  0x3B,
+  :kVK_RightShift =>  0x3C,
+  :kVK_RightOption =>  0x3D,
+  :kVK_RightControl =>  0x3E,
+  :kVK_RightCommand =>  0x36,   # ใช่ ตัวนี้! Apple ไม่บอก แต่ใช้อันนี้
+  :kVK_Function =>  0x3F,
+  :kVK_Home =>  0x73,
+  :kVK_PageUp =>  0x74,
+  :kVK_ForwardDelete =>  0x75,
+  :kVK_End =>  0x77,
+  :kVK_PageDown =>  0x79,
+  :kVK_LeftArrow =>  0x7B,
+  :kVK_RightArrow =>  0x7C,
+  :kVK_DownArrow =>  0x7D,
+  :kVK_UpArrow =>  0x7E
+
+  # Not Implement Yet
+  # •	NSEvent.otherEventWithType(NSSystemDefined)
+	# •	subtype = 8
+	# •	data1 = (0xA << 16) | (keycode << 8)
+  # NX_KEYTYPE_SOUND_UP = 0
+  # NX_KEYTYPE_SOUND_DOWN = 1
+  # NX_KEYTYPE_MUTE = 7
+  # NX_KEYTYPE_PLAY = 16
+  # NX_KEYTYPE_NEXT = 17
+  # NX_KEYTYPE_PREVIOUS = 18
+  # NX_KEYTYPE_ILLUMINATION_UP = 21
+  # NX_KEYTYPE_ILLUMINATION_DOWN = 20
+  # NX_KEYTYPE_FAST = 19
+  # NX_KEYTYPE_REWIND = 20
+}
+
+KEY_CODE_HEX_TO_NAME = KEY_CODE_NAME_TO_HEX.invert

data/lib/rbnput/simple_mutex_thread.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'thread'
+
+class Rbnput::SimpleMutexThread
+
+  protected
+  # Platform-specific run implementation
+  # Must be implemented by subclasses
+  def _run; raise NotImplementedError, "Subclasses must implement _run" end
+
+  public
+  attr_reader :running
+  def initialize
+    @running = false
+    @thread = nil
+    @mutex = Mutex.new
+  end
+
+  # Start the listener in a separate thread
+  def start
+    @mutex.synchronize do
+      return if @running
+      @running = true
+      @thread = Thread.new do
+        begin; _run
+        ensure; @running = false end
+      end
+    end
+    self
+  end
+
+  # Stop the listener
+  def stop
+    @mutex.synchronize do; @running = false end
+    @thread&.join(5) # Wait up to 5 seconds
+    self
+  end
+
+  def join; @thread&.join end
+  def alive?; @running && @thread&.alive? end
+
+
+end

data/lib/rbnput/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Rbnput
+  VERSION = "0.1.0"
+  AUTHOR = "Krist Ponpairin"
+end

data/lib/rbnput-darwin-minimal.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Rbnput - Ruby Input Library
+# Copyright (C) 2025
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+
+require_relative "rbnput/version"
+require_relative "rbnput/darwin_listener"
+# require_relative "rbnput/mouse"
+
+# The main Rbnput module
+#
+# This module imports keyboard and mouse submodules for controlling
+# and monitoring input devices.
+module Rbnput
+  Listener = ::Rbnput::DarwinListener
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rbnput-darwin-minimal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Krist Ponpairin
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: A Ruby library for keyboard monitoring in mac
+email:
+- krist7599555@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rbnput-darwin-minimal.rb
+- lib/rbnput/darwin_ffi.rb
+- lib/rbnput/darwin_listener.rb
+- lib/rbnput/key_code.rb
+- lib/rbnput/key_code_const.rb
+- lib/rbnput/simple_mutex_thread.rb
+- lib/rbnput/version.rb
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Ruby Input library (rbnput)
+test_files: []