procon_bypass_man 0.1.6 → 0.1.10

data/lib/procon_bypass_man/bypass/usb_hid_logger.rb

@@ -0,0 +1,20 @@
+class ProconBypassMan::Bypass
+  module UsbHidLogger
+    extend ProconBypassMan::Callbacks::ClassMethods
+    include ProconBypassMan::Callbacks
+
+    define_callbacks :send_gadget_to_procon
+    define_callbacks :send_procon_to_gadget
+
+    set_callback :send_gadget_to_procon, :after, :log_send_gadget_to_procon
+    set_callback :send_procon_to_gadget, :after, :log_procon_to_gadget
+
+    def log_send_gadget_to_procon
+      ProconBypassMan.logger.debug { ">>> #{bypass_status.to_text}" }
+    end
+
+    def log_procon_to_gadget
+      ProconBypassMan.logger.debug { "<<< #{bypass_status.to_text}" }
+    end
+  end
+end

data/lib/procon_bypass_man/bypass.rb

@@ -1,5 +1,16 @@
+require "procon_bypass_man/bypass/usb_hid_logger"
+
 class ProconBypassMan::Bypass
-  attr_accessor :gadget, :procon, :monitor
+  include ProconBypassMan::Bypass::UsbHidLogger
+
+  class BypassStatus < Struct.new(:binary, :sent)
+    def to_text
+      "#{binary.unpack("H*").first} #{'x' unless sent}"
+    end
+  end
+
+  attr_accessor :gadget, :procon, :monitor, :bypass_status
+
   def initialize(gadget: , procon: , monitor: )
     self.gadget = gadget
     self.procon = procon
@@ -10,43 +21,64 @@ class ProconBypassMan::Bypass
   def send_gadget_to_procon!
     monitor.record(:start_function)
     input = nil
-    begin
-      sleep($will_interval_1_6)
-      input = self.gadget.read_nonblock(128)
-      ProconBypassMan.logger.debug { ">>> #{input.unpack("H*")}" }
-    rescue IO::EAGAINWaitReadable
-      monitor.record(:eagain_wait_readable_on_read)
-      return if $will_terminate_token
-      retry
-    end
+    self.bypass_status = BypassStatus.new(input, sent = false)
+
+    run_callbacks :send_gadget_to_procon do
+      begin
+        return if $will_terminate_token
+        # TODO blocking readにしたいが、接続時のフェーズによって長さが違宇野で厳しい
+        input = self.gadget.read_nonblock(64)
+        self.bypass_status.binary = input
+      rescue IO::EAGAINWaitReadable
+        monitor.record(:eagain_wait_readable_on_read)
+        sleep(0.001)
+        retry
+      end
 
-    begin
-      self.procon.write_nonblock(input)
-    rescue IO::EAGAINWaitReadable
-      monitor.record(:eagain_wait_readable_on_write)
-      return
+      begin
+        self.procon.write_nonblock(input)
+        self.bypass_status.sent = true
+      rescue IO::EAGAINWaitReadable
+        monitor.record(:eagain_wait_readable_on_write)
+        return
+      end
     end
+
     monitor.record(:end_function)
   end
 
   def send_procon_to_gadget!
     monitor.record(:start_function)
     output = nil
-    begin
-      sleep($will_interval_0_0_0_5)
-      output = self.procon.read_nonblock(128)
-      ProconBypassMan.logger.debug { "<<< #{output.unpack("H*")}" }
-    rescue IO::EAGAINWaitReadable
-      monitor.record(:eagain_wait_readable_on_read)
-      return if $will_terminate_token
-      retry
-    end
+    self.bypass_status = BypassStatus.new(output, sent = false)
+
+    run_callbacks(:send_procon_to_gadget) do
+      begin
+        return if $will_terminate_token
+        Timeout.timeout(1) do
+          output = self.procon.read(64)
+          self.bypass_status.binary = output
+        end
+      rescue Timeout::Error
+        ProconBypassMan.logger.debug { "read timeout! do sleep. by send_procon_to_gadget!" }
+        ProconBypassMan.error_logger.error { "read timeout! do sleep. by send_procon_to_gadget!" }
+        monitor.record(:eagain_wait_readable_on_read)
+        retry
+      rescue IO::EAGAINWaitReadable
+        ProconBypassMan.logger.debug { "EAGAINWaitReadable" }
+        monitor.record(:eagain_wait_readable_on_read)
+        sleep(0.005)
+        retry
+      end
 
-    begin
-      self.gadget.write_nonblock(ProconBypassMan::Processor.new(output).process)
-    rescue IO::EAGAINWaitReadable
-      monitor.record(:eagain_wait_readable_on_write)
-      return
+      begin
+        # ProconBypassMan::Procon::DebugDumper.new(binary: output).dump_analog_sticks
+        self.gadget.write_nonblock(ProconBypassMan::Processor.new(output).process)
+        self.bypass_status.sent = true
+      rescue IO::EAGAINWaitReadable
+        monitor.record(:eagain_wait_readable_on_write)
+        return
+      end
     end
     monitor.record(:end_function)
   end

data/lib/procon_bypass_man/callbacks.rb

@@ -0,0 +1,70 @@
+module ProconBypassMan
+  module Callbacks
+    class CallbacksChain
+      attr_accessor :filter, :chain_method
+      def initialize(filter: , chain_method: , block: )
+        @filter = filter
+        @chain_method = chain_method
+        @block = block
+      end
+    end
+
+    # TODO __callbacksをincludeしたクラス側で保持する. 今はnemespaceがない
+    module M
+      class << self
+        attr_accessor :__callbacks
+      end
+    end
+
+    module ClassMethods
+      def define_callbacks(name)
+        self.singleton_class.attr_accessor "_#{name}_callbacks"
+        send "_#{name}_callbacks=", [name] # CallbacksChain
+
+        module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def _run_#{name}_callbacks(&block)
+            __run_callbacks__(_#{name}_callbacks, &block)
+          end
+        RUBY
+      end
+
+      def set_callback(kind, filter, chain_method, &block)
+        ProconBypassMan::Callbacks::M.__callbacks ||= {}
+        ProconBypassMan::Callbacks::M.__callbacks[kind] = CallbacksChain.new(
+          filter: filter,
+          chain_method: chain_method,
+          block: block,
+        )
+      end
+    end
+
+    # TODO haltしたらcallbackを止める
+    # TODO 複数をチェインできるようにする
+    def run_callbacks(kind, &block)
+      chain = get_callbacks(kind) or raise("unknown callback")
+      case chain.filter
+      when :before
+        send chain.chain_method
+        block.call
+      when :after
+        block.call
+        send chain.chain_method
+      else
+        raise("unknown filter")
+      end
+    end
+
+    # def __run_callbacks__(name, &block)
+    #   puts "called"
+    # end
+
+    def get_callbacks(kind) # :nodoc:
+      ProconBypassMan::Callbacks::M.__callbacks[kind.to_sym]
+    end
+
+    def set_callbacks(name, callbacks) # :nodoc:
+      send "_#{name}_callbacks=", callbacks
+      ProconBypassMan::Callbacks::M.__callbacks[kind.to_sym] = callbacks
+    end
+  end
+end

data/lib/procon_bypass_man/configuration/layer.rb

@@ -1,13 +1,15 @@
 module ProconBypassMan
-  class Configuration
+  class ButtonsSettingConfiguration
     class Layer
-      attr_accessor :mode, :flips, :macros, :remaps
+      attr_accessor :mode, :flips, :macros, :remaps, :left_analog_stick_caps, :disables
 
-      def initialize(mode: :manual, &block)
+      def initialize(mode: :manual)
         self.mode = mode
         self.flips = {}
         self.macros = {}
         self.remaps = {}
+        self.left_analog_stick_caps = {}
+        self.disables = []
         instance_eval(&block) if block_given?
       end
 
@@ -50,7 +52,6 @@ module ProconBypassMan
         end
       end
 
-      PRESET_MACROS = [:fast_return]
       def macro(name, if_pressed: )
         if name.respond_to?(:name)
           macro_name = name.name.to_sym
@@ -72,6 +73,51 @@ module ProconBypassMan
         end
       end
 
+      def left_analog_stick_cap(cap: , if_pressed: nil, force_neutral: nil)
+        hash = { cap: cap }
+
+        case if_pressed
+        when TrueClass
+          raise "not support class"
+        when Symbol, String
+          if_pressed = [if_pressed]
+        when Array, FalseClass
+          # sono mama
+        when NilClass
+          if_pressed = nil
+        else
+          raise "not support if_pressed"
+        end
+
+        if force_neutral
+          case force_neutral
+          when TrueClass, FalseClass
+            raise "ボタンを渡してください"
+          when Symbol, String
+            hash[:force_neutral] = [force_neutral]
+          when Array
+            hash[:force_neutral] = force_neutral
+          end
+        end
+
+        left_analog_stick_caps[if_pressed] = hash
+      end
+
+      def disable(button)
+        case button
+        when TrueClass, FalseClass, NilClass
+          raise "not support class"
+        when Symbol
+          disables << button
+        when String
+          disables << button.to_sym
+        when Array
+          button.each { |b| disables << b }
+        else
+          raise "unknown"
+        end
+      end
+
       # @return [Array]
       def flip_buttons
         flips

data/lib/procon_bypass_man/configuration/loader.rb

@@ -1,10 +1,10 @@
 module ProconBypassMan
-  class Configuration
+  class ButtonsSettingConfiguration
     module Loader
       require 'digest/md5'
 
       def self.load(setting_path: )
-        ProconBypassMan::Configuration.switch_new_context(:validation) do |validation_instance|
+        ProconBypassMan::ButtonsSettingConfiguration.switch_new_context(:validation) do |validation_instance|
           yaml = YAML.load_file(setting_path) or raise "読み込みに失敗しました"
           validation_instance.instance_eval(yaml["setting"])
           validator = Validator.new(validation_instance)
@@ -20,25 +20,25 @@ module ProconBypassMan
         end
 
         yaml = YAML.load_file(setting_path)
-        ProconBypassMan::Configuration.instance.setting_path = setting_path
-        ProconBypassMan::Configuration.instance.reset!
+        ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path = setting_path
+        ProconBypassMan::ButtonsSettingConfiguration.instance.reset!
         ProconBypassMan.reset!
 
         case yaml["version"]
         when 1.0, nil
-          ProconBypassMan::Configuration.instance.instance_eval(yaml["setting"])
+          ProconBypassMan::ButtonsSettingConfiguration.instance.instance_eval(yaml["setting"])
         else
           ProconBypassMan.logger.warn "不明なバージョンです。failoverします"
-          ProconBypassMan::Configuration.instance.instance_eval(yaml["setting"])
+          ProconBypassMan::ButtonsSettingConfiguration.instance.instance_eval(yaml["setting"])
         end
 
         File.write(ProconBypassMan.digest_path, Digest::MD5.hexdigest(yaml["setting"]))
 
-        ProconBypassMan::Configuration.instance
+        ProconBypassMan::ButtonsSettingConfiguration.instance
       end
 
       def self.reload_setting
-        self.load(setting_path: ProconBypassMan::Configuration.instance.setting_path)
+        self.load(setting_path: ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path)
       end
     end
   end

data/lib/procon_bypass_man/configuration/validator.rb

@@ -1,5 +1,5 @@
 module ProconBypassMan
-  class Configuration
+  class ButtonsSettingConfiguration
     class Validator
       def initialize(config)
         @layers = config.layers

data/lib/procon_bypass_man/configuration.rb

@@ -1,86 +1,90 @@
-require "procon_bypass_man/configuration/validator"
-require "procon_bypass_man/configuration/loader"
-require "procon_bypass_man/configuration/layer"
+class ProconBypassMan::Configuration
+  module ClassAttributes
+    def root
+      config.root
+    end
 
-module ProconBypassMan
-  class Configuration
+    def logger
+      config.logger
+    end
 
-    attr_accessor :layers,
-      :setting_path,
-      :mode_plugins,
-      :macro_plugins,
-      :context,
-      :current_context_key
+    def error_logger
+      config.error_logger
+    end
 
-    def self.instance
-      @@current_context_key ||= :main
-      @@context ||= {}
-      @@context[@@current_context_key] ||= new
+    def pid_path
+      @@pid_path ||= File.expand_path("#{root}/pbm_pid", __dir__).freeze
     end
 
-    def self.switch_new_context(key)
-      @@context[key] = new
-      previous_key = @@current_context_key
-      if block_given?
-        @@current_context_key = key
-        value = yield(@@context[key])
-        @@current_context_key = previous_key
-        return value
-      else
-        @@current_context_key = key
-      end
+    def digest_path
+      config.digest_path
     end
 
-    def initialize
-      reset!
+    def cache
+      @@cache_table ||= ProconBypassMan::OnMemoryCache.new
     end
+  end
 
-    MODES = [:manual]
-    def layer(direction, mode: :manual, &block)
-      if mode.respond_to?(:name)
-        mode_name = mode.name.to_sym
-      else
-        mode_name = mode
-      end
-      unless (MODES + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
-        raise("#{mode_name} mode is unknown")
-      end
+  attr_reader :api_server
+  attr_accessor :enable_critical_error_logging
 
-      layer = Layer.new(mode: mode_name)
-      layer.instance_eval(&block) if block_given?
-      self.layers[direction] = layer
-      self
-    end
+  def root=(path)
+    @root = path
+    return self
+  end
 
-    def install_mode_plugin(klass)
-      ProconBypassMan::Procon::ModeRegistry.install_plugin(klass)
-      self
+  def root
+    if defined?(@root)
+      @root
+    else
+      File.expand_path('..', __dir__ || ".").freeze
     end
+  end
 
-    def install_macro_plugin(klass)
-      ProconBypassMan::Procon::MacroRegistry.install_plugin(klass)
-      self
+  def api_server=(api_server)
+    @api_server = api_server
+    return self
+  end
+
+  def logger=(logger)
+    @logger = logger
+    return self
+  end
+
+  def logger
+    if ENV["PBM_ENV"] == 'test'
+      return Logger.new($stdout)
     end
 
-    def prefix_keys_for_changing_layer(buttons)
-      @prefix_keys_for_changing_layer = buttons
-      self
+    if defined?(@logger) && @logger.is_a?(Logger)
+      @logger
+    else
+      Logger.new(File.open("/dev/null"))
     end
+  end
 
-    def prefix_keys
-      @prefix_keys_for_changing_layer
+  def error_logger
+    if enable_critical_error_logging
+      @@error_logger ||= Logger.new("#{ProconBypassMan.root}/error.log", 5, 1024 * 1024 * 10)
+    else
+      Logger.new(File.open("/dev/null"))
     end
+    self
+  end
+
+  def digest_path
+    "#{root}/.setting_yaml_digest"
+  end
 
-    def reset!
-      @prefix_keys_for_changing_layer = []
-      self.mode_plugins = {}
-      self.macro_plugins = {}
-      self.layers = {
-        up: Layer.new,
-        down: Layer.new,
-        left: Layer.new,
-        right: Layer.new,
-      }
+  # @return [String] pbm-webの接続先
+  def internal_api_servers
+    if !!ENV["INTERNAL_API_SERVER"]
+      [ENV["INTERNAL_API_SERVER"]]
+    else
+      [ ENV["INTERNAL_API_SERVER"],
+        'http://localhost:9090',
+        'http://localhost:8080',
+      ].compact
     end
   end
 end

data/lib/procon_bypass_man/device_connector.rb

@@ -12,23 +12,6 @@ class ProconBypassMan::DeviceConnector
   PROCON_PATH = "/dev/hidraw0"
   PROCON2_PATH = "/dev/hidraw1"
 
-  # 画面で再接続ができたが状況は変わらない
-  def self.reset_connection!
-    s = new
-    s.add([
-      ["0000"],
-      ["0000"],
-      ["8005"],
-      ["0000"],
-      ["8001"],
-    ], read_from: :switch)
-    s.drain_all
-    s.read_procon
-    s.write_switch("213c910080005db7723d48720a800300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000")
-    sleep(10) # いらないかも
-    s
-  end
-
   def self.connect
     s = new(throw_error_if_timeout: true, enable_at_exit: false)
     s.add([
@@ -37,16 +20,16 @@ class ProconBypassMan::DeviceConnector
       ["8005"],
       ["0010"],
     ], read_from: :switch)
-    # 1
+    # 1. Sends current connection status, and if the Joy-Con are connected,
     s.add([["8001"]], read_from: :switch)
     s.add([/^8101/], read_from: :procon) # <<< 81010003176d96e7a5480000000, macaddressとコントローラー番号を返す
-    # 2
+    # 2. Sends handshaking packets over UART to the Joy-Con or Pro Controller Broadcom chip. This command can only be called once per session.
     s.add([["8002"]], read_from: :switch)
     s.add([/^8102/], read_from: :procon)
     # 3
     s.add([/^0100/], read_from: :switch)
     s.add([/^21/], read_from: :procon)
-    # 4
+    # 4. Forces the Joy-Con or Pro Controller to only talk over USB HID without any timeouts. This is required for the Pro Controller to not time out and revert to Bluetooth.
     s.add([["8004"]], read_from: :switch)
     s.drain_all
     return [s.switch, s.procon]
@@ -75,7 +58,7 @@ class ProconBypassMan::DeviceConnector
         timer = ProconBypassMan::Timer.new
         begin
           timer.throw_if_timeout!
-          data = from_device(item).read_nonblock(128)
+          data = from_device(item).read_nonblock(64)
         rescue IO::EAGAINWaitReadable
           retry
         end
@@ -128,7 +111,7 @@ class ProconBypassMan::DeviceConnector
     timer = ProconBypassMan::Timer.new
     begin
       timer.throw_if_timeout!
-      data = switch.read_nonblock(128)
+      data = switch.read_nonblock(64)
       ProconBypassMan.logger.debug { " >>> #{data.unpack("H*")})" }
     rescue IO::EAGAINWaitReadable
       retry
@@ -163,7 +146,7 @@ class ProconBypassMan::DeviceConnector
     timer = ProconBypassMan::Timer.new
     begin
       timer.throw_if_timeout!
-      data = procon.read_nonblock(128)
+      data = procon.read_nonblock(64)
       ProconBypassMan.logger.error " <<< #{data.unpack("H*")})"
     rescue IO::EAGAINWaitReadable
       retry
@@ -184,7 +167,7 @@ class ProconBypassMan::DeviceConnector
     timer = ProconBypassMan::Timer.new
     begin
       timer.throw_if_timeout!
-      data = procon.read_nonblock(128)
+      data = procon.read_nonblock(64)
       ProconBypassMan.logger.debug { " <<< #{data.unpack("H*")})" }
     rescue IO::EAGAINWaitReadable
       retry
@@ -217,7 +200,7 @@ class ProconBypassMan::DeviceConnector
     timer = ProconBypassMan::Timer.new
     begin
       timer.throw_if_timeout!
-      data = switch.read_nonblock(128)
+      data = switch.read_nonblock(64)
       ProconBypassMan.logger.debug { " >>> #{data.unpack("H*")})" }
     rescue IO::EAGAINWaitReadable
       retry
@@ -281,7 +264,7 @@ class ProconBypassMan::DeviceConnector
 
     file = File.open(path, "w+")
     begin
-      file.read_nonblock(128)
+      file.read_nonblock(64)
     rescue EOFError
       file.close
       return false
@@ -303,12 +286,12 @@ class ProconBypassMan::DeviceConnector
     case
     when is_available_device?(PROCON_PATH)
       ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON_PATH}を使います"
-      @procon = File.open(PROCON_PATH, "w+")
-      @gadget = File.open('/dev/hidg0', "w+")
+      @procon = File.open(PROCON_PATH, "w+b")
+      @gadget = File.open('/dev/hidg0', "w+b")
     when is_available_device?(PROCON2_PATH)
       ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON2_PATH}を使います"
-      @procon = File.open(PROCON2_PATH, "w+")
-      @gadget = File.open('/dev/hidg0', "w+")
+      @procon = File.open(PROCON2_PATH, "w+b")
+      @gadget = File.open('/dev/hidg0', "w+b")
     else
       raise "/dev/hidraw0, /dev/hidraw1の両方見つかりませんでした"
     end

data/lib/procon_bypass_man/io_monitor.rb

@@ -62,10 +62,13 @@ module ProconBypassMan
           }.join(", ")
           max_output_length = line.length
           sleep 0.7
-          print "\r"
-          print " " * max_output_length
-          print "\r"
-          print line
+
+          if ENV["PBM_FOREGROUND"]
+            print "\r"
+            print " " * max_output_length
+            print "\r"
+            print line
+          end
           ProconBypassMan.logger.debug { line }
           break if $will_terminate_token
         end

data/lib/procon_bypass_man/on_memory_cache.rb

@@ -0,0 +1,34 @@
+class ProconBypassMan::OnMemoryCache
+  class CacheValue
+    attr_accessor :expired_at, :value
+
+    def initialize(expired_at: , value: )
+      self.expired_at = expired_at
+      self.value = value
+    end
+  end
+
+  def initialize
+    @table = {}
+  end
+
+  # @param [Integer] expires_in 秒数
+  # @param [String] key
+  def fetch(key: , expires_in: , &block)
+    now = Time.now
+    if @table[key].nil?
+      value = block.call
+      value_object = CacheValue.new(expired_at: now + expires_in, value: value)
+      @table[key] = value_object
+      return value
+    end
+
+    if @table[key].expired_at < now
+      value = block.call
+      @table[key] = CacheValue.new(expired_at: now + expires_in, value: value)
+      return value
+    else
+      return @table[key].value
+    end
+  end
+end