procon_bypass_man 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e4ad788ed57ca3bac1d4d17b1648285c8bc8d89d23a3c0a4ca4d5aaa58e4dfd
-  data.tar.gz: 512a1f754cf255c6692ab597c7997d6bad3f3004c2f1203a1ce6adaec603e655
+  metadata.gz: 1a0674ff73c1ac25e311e304e7a3736e3feadb9f8d1221453202abbce8e00372
+  data.tar.gz: 29e63c8ee818a1ca3fe62de9152779cdbea38167db19824e0f402145dec36c04
 SHA512:
-  metadata.gz: 7a059a91051aee0fa59beb62aa7bd952b1c8db15a75d66c47a66fdbda96a60cd9285094524e1d3c619ec215fa47dc5f9ee44e4dd7524f6c2bd60a4d0dfcf25e3
-  data.tar.gz: 9748ad5293f1e3cc902d9b74bbb40997d0c9588e43e78ab4299eb4ddbb9bfd030a7f3bf717d58a3207ac51e348cc090b1a726d7f63780d705807e04db7d9201d
+  metadata.gz: 2bbbce43d9ed8495f513b5cbd9688f0187f3fd64cdd932730c3938ba8d5e43d4c8e3b15118082742bb1692d95aa66537ccc501930cd778144d7639460d98c32e
+  data.tar.gz: 2a2276871754b37296e2dff2c4b0d3f1cc3822ecb4b5c55e61c2eba4996951072af69e990742463fa282cf57a5f956439a70304402cc4a208be8cd1a43309bb1

data/.gitignore

@@ -8,3 +8,7 @@
 /tmp/
 vendor
 todo.local.md
+*.log
+.setting_yaml_digest
+pbm_pid
+setting.yml

data/.rubocop.yml

@@ -22,3 +22,5 @@ Lint/UselessAssignment:
     Enabled: false
 Lint/EmptyBlock:
     Enabled: false
+Lint/ReturnInVoidContext:
+    Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.1.10] - 202
+- ボタンを無効化するdisableを設定できるようになりました
+- pvmenvで生成する初期ファイルにprocon_bypass_man-webを同梱しました
+- PBM自体の設定の構文を変更しました
+
 ## [0.1.9] - 2021-10-20
 - 左スティックを傾けた時に設定した最大値内に丸めることができるようになりました
     - 関連メソッド: set_neutral_position, left_analog_stick_cap

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.9)
+    procon_bypass_man (0.1.10)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -59,13 +59,7 @@ Switch <-- (PBM): ZR連打
 * 設定ファイル マクロの引数に、ボタンを取れるようにする
 
 ## 開発系
-```ruby
-ProconBypassMan.tap do |pbm|
-  pbm.root = File.expand_path(__dir__)
-  pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
-  pbm.logger.level = :debug
-end
-```
+* pbmenvで生成するapp.rbに開発用ブランチを参照してください
 
 ### プロコンとの接続を維持したまま、現在の設定ファイルをPBMに反映する
 ```shell
@@ -82,7 +76,7 @@ sudo kill -USR2 `cat ./pbm_pid`
   * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::Reporter.report(body: message.to_hash)"`
 
 ### リリース手順
-* project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
+* project_template/web.rb, project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
 * be rake release
 
 ## License

data/lib/procon_bypass_man/analog_stick_position.rb

@@ -1,14 +1,8 @@
 class AnalogStickPosition
+  attr_accessor :x, :y
+
   def initialize(x: , y: )
     @x = x
     @y = y
   end
-
-  def y
-    @y
-  end
-
-  def x
-    @x
-  end
 end

data/lib/procon_bypass_man/boot_message.rb

@@ -6,7 +6,7 @@ class ProconBypassMan::BootMessage
     @table[:pid] = $$
     @table[:root_path] = ProconBypassMan.root
     @table[:pid_path] = ProconBypassMan.pid_path
-    @table[:setting_path] = ProconBypassMan::Configuration.instance.setting_path
+    @table[:setting_path] = ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path
     @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
 
     build_version = `git rev-parse --short HEAD`.chomp

data/lib/procon_bypass_man/buttons_setting_configuration.rb

@@ -0,0 +1,100 @@
+require "procon_bypass_man/configuration/validator"
+require "procon_bypass_man/configuration/loader"
+require "procon_bypass_man/configuration/layer"
+
+module ProconBypassMan
+  class ButtonsSettingConfiguration
+    attr_accessor :layers,
+      :setting_path,
+      :mode_plugins,
+      :macro_plugins,
+      :context,
+      :current_context_key,
+      :neutral_position
+
+    def self.instance
+      @@current_context_key ||= :main
+      @@context ||= {}
+      @@context[@@current_context_key] ||= new
+    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
+    end
+
+    def initialize
+      reset!
+    end
+
+    module ManualMode
+      def self.name
+        'manual'
+      end
+    end
+    MODES = [:manual]
+    def layer(direction, mode: ManualMode, &block)
+      mode_name = case mode
+                  when String
+                    mode.to_sym
+                  when Symbol
+                    mode
+                  else
+                    mode.name.to_sym
+                  end
+      unless (MODES + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
+        raise("#{mode_name} mode is unknown")
+      end
+
+      layer = Layer.new(mode: mode_name)
+      layer.instance_eval(&block) if block_given?
+      self.layers[direction] = layer
+      self
+    end
+
+    def install_mode_plugin(klass)
+      ProconBypassMan::Procon::ModeRegistry.install_plugin(klass)
+      self
+    end
+
+    def install_macro_plugin(klass)
+      ProconBypassMan::Procon::MacroRegistry.install_plugin(klass)
+      self
+    end
+
+    def prefix_keys_for_changing_layer(buttons)
+      @prefix_keys_for_changing_layer = buttons
+      self
+    end
+
+    def set_neutral_position(x, y)
+      self.neutral_position = AnalogStickPosition.new(x: x, y: y)
+      self
+    end
+
+    def prefix_keys
+      @prefix_keys_for_changing_layer
+    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,
+      }
+      @neutral_position = AnalogStickPosition.new(x: 2124, y: 1808)
+    end
+  end
+end

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,15 @@
+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
@@ -11,22 +21,27 @@ class ProconBypassMan::Bypass
   def send_gadget_to_procon!
     monitor.record(:start_function)
     input = nil
-    begin
-      return if $will_terminate_token
-      # TODO blocking readにしたい
-      input = self.gadget.read_nonblock(64)
-      ProconBypassMan.logger.debug { ">>> #{input.unpack("H*")}" }
-    rescue IO::EAGAINWaitReadable
-      monitor.record(:eagain_wait_readable_on_read)
-      sleep(0.001)
-      retry
-    end
+    self.bypass_status = BypassStatus.new(input, sent = false)
 
-    begin
-      self.procon.write_nonblock(input)
-    rescue IO::EAGAINWaitReadable
-      monitor.record(:eagain_wait_readable_on_write)
-      return
+    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)
+        self.bypass_status.sent = true
+      rescue IO::EAGAINWaitReadable
+        monitor.record(:eagain_wait_readable_on_write)
+        return
+      end
     end
 
     monitor.record(:end_function)
@@ -35,31 +50,35 @@ class ProconBypassMan::Bypass
   def send_procon_to_gadget!
     monitor.record(:start_function)
     output = nil
+    self.bypass_status = BypassStatus.new(output, sent = false)
 
-    begin
-      return if $will_terminate_token
-      Timeout.timeout(1) do
-        output = self.procon.read(64)
-        ProconBypassMan.logger.debug { "<<< #{output.unpack("H*")}" }
+    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
-    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
-      # ProconBypassMan::Procon::DebugDumper.new(binary: output).dump_analog_sticks
-      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,7 +1,7 @@
 module ProconBypassMan
-  class Configuration
+  class ButtonsSettingConfiguration
     class Layer
-      attr_accessor :mode, :flips, :macros, :remaps, :left_analog_stick_caps
+      attr_accessor :mode, :flips, :macros, :remaps, :left_analog_stick_caps, :disables
 
       def initialize(mode: :manual)
         self.mode = mode
@@ -9,6 +9,7 @@ module ProconBypassMan
         self.macros = {}
         self.remaps = {}
         self.left_analog_stick_caps = {}
+        self.disables = []
         instance_eval(&block) if block_given?
       end
 
@@ -102,6 +103,21 @@ module ProconBypassMan
         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,100 +1,90 @@
-require "procon_bypass_man/configuration/validator"
-require "procon_bypass_man/configuration/loader"
-require "procon_bypass_man/configuration/layer"
-
-module ProconBypassMan
-  class Configuration
-    attr_accessor :layers,
-      :setting_path,
-      :mode_plugins,
-      :macro_plugins,
-      :context,
-      :current_context_key,
-      :neutral_position
-
-    def self.instance
-      @@current_context_key ||= :main
-      @@context ||= {}
-      @@context[@@current_context_key] ||= new
+class ProconBypassMan::Configuration
+  module ClassAttributes
+    def root
+      config.root
     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 logger
+      config.logger
     end
 
-    def initialize
-      reset!
+    def error_logger
+      config.error_logger
     end
 
-    module ManualMode
-      def self.name
-        'manual'
-      end
+    def pid_path
+      @@pid_path ||= File.expand_path("#{root}/pbm_pid", __dir__).freeze
     end
-    MODES = [:manual]
-    def layer(direction, mode: ManualMode, &block)
-      mode_name = case mode
-                  when String
-                    mode.to_sym
-                  when Symbol
-                    mode
-                  else
-                    mode.name.to_sym
-                  end
-      unless (MODES + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
-        raise("#{mode_name} mode is unknown")
-      end
 
-      layer = Layer.new(mode: mode_name)
-      layer.instance_eval(&block) if block_given?
-      self.layers[direction] = layer
-      self
+    def digest_path
+      config.digest_path
     end
 
-    def install_mode_plugin(klass)
-      ProconBypassMan::Procon::ModeRegistry.install_plugin(klass)
-      self
+    def cache
+      @@cache_table ||= ProconBypassMan::OnMemoryCache.new
     end
+  end
+
+  attr_reader :api_server
+  attr_accessor :enable_critical_error_logging
 
-    def install_macro_plugin(klass)
-      ProconBypassMan::Procon::MacroRegistry.install_plugin(klass)
-      self
+  def root=(path)
+    @root = path
+    return self
+  end
+
+  def root
+    if defined?(@root)
+      @root
+    else
+      File.expand_path('..', __dir__ || ".").freeze
     end
+  end
 
-    def prefix_keys_for_changing_layer(buttons)
-      @prefix_keys_for_changing_layer = buttons
-      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 set_neutral_position(x, y)
-      self.neutral_position = AnalogStickPosition.new(x: x, y: y)
-      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,
-      }
-      @neutral_position = AnalogStickPosition.new(x: 2124, y: 1808)
+  # @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