Skip to content

Commit

Permalink
Merge pull request #164 from maimux2x/add_positional_args
Browse files Browse the repository at this point in the history
add positional args to rbs
  • Loading branch information
hasumikin committed Mar 26, 2024
2 parents 5229a0a + 7d54f29 commit 89db2bf
Show file tree
Hide file tree
Showing 14 changed files with 61 additions and 65 deletions.
7 changes: 3 additions & 4 deletions mrbgems/picoruby-cyw43/sig/cyw43.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@
class CYW43
$_cyw43_country: String

def self.init: (?String, ?force: bool) -> void
def self.init: (?String country, ?force: bool) -> void
def self.initialized?: () -> bool
# @private
def self._init: (String, bool) -> bool
def self._init: (String country, bool force) -> bool

# @sidebar hardware_device
class GPIO
LED_PIN: Integer
@pin: Integer
def initialize: (Integer) -> void
def initialize: (Integer pin) -> void
def write: (Integer) -> 0
def read: () -> GPIO::gpio_logic_t
end
end

10 changes: 5 additions & 5 deletions mrbgems/picoruby-gpio/sig/gpio.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class IOError
ERROR_INVALID_ARG: -5
ERROR_IO: -6

def self.peripheral_error: (Integer, ?String) -> Integer
def self.peripheral_error: (Integer code, ?String name) -> Integer
end

# @sidebar io_peripheral
Expand Down Expand Up @@ -44,10 +44,10 @@ class GPIO
def high?: () -> bool
def low?: () -> bool

private def set_function: (Integer, Integer) -> 0
private def set_dir: (Integer) -> 0
private def set_pull: (Integer) -> 0
private def open_drain: (Integer) -> 0
private def set_function: (Integer flags, Integer alt_function) -> 0
private def set_dir: (Integer flags) -> 0
private def set_pull: (Integer flags) -> 0
private def open_drain: (Integer flags) -> 0
private def on_initialize?: () -> bool
# @private
def self._init: (gpio_pin_t) -> 0
Expand Down
8 changes: 4 additions & 4 deletions mrbgems/picoruby-music-macro-language/sig/mml.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ class MML

def self.new: () -> instance
# @private
def self.number_str: (String, Integer) -> [String, Integer]
def self.number_str: (String str, Integer i) -> [String, Integer]
# @private
def self.count_punto: (String, Integer) -> [Integer, Integer]
def self.count_punto: (String str, Integer i) -> [Integer, Integer]
# @private
def self.coef: (Integer) -> Float
def self.coef: (Integer punti) -> Float

def compile: (String) { (Float, Integer) -> bool } -> Integer
def compile: (String str) { (Float, Integer) -> bool } -> Integer
end
6 changes: 3 additions & 3 deletions mrbgems/picoruby-prk-consumer_key/sig/consumer_key.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class ConsumerKey
VIACODE: Hash[Integer, Symbol]
MAP_OFFSET: Integer

def self.keycode: (Symbol) -> Integer?
def self.keycode_from_mapcode: (Integer) -> Integer
def self.viacode_from_mapcode: (Integer) -> Integer?
def self.keycode: (Symbol sym) -> Integer?
def self.keycode_from_mapcode: (Integer mapcode) -> Integer
def self.viacode_from_mapcode: (Integer mapcode) -> Integer?
end
22 changes: 11 additions & 11 deletions mrbgems/picoruby-prk-keyboard/sig/keyboard.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ class Keyboard
def self.reload_keymap: () -> void
def self.wait_keymap: () -> void

def set_debounce: (debounce_type) -> void
def set_debounce_threshold: (Integer) -> void
def set_debounce: (debounce_type type) -> void
def set_debounce_threshold: (Integer val) -> void
def append: (append_type feature) -> void
def start_features: -> void
def mutual_uart_at_my_own_risk= : (bool) -> void
Expand All @@ -149,18 +149,18 @@ class Keyboard

def self.new: -> instance
def anchor?: -> bool
def via=: (bool) -> void
def via_layer_count=: (Integer) -> void
def via=: (bool val) -> void
def via_layer_count=: (Integer count) -> void
def bootsel!: -> void
def set_anchor: (anchor_type val) -> void
def set_scan_mode: (scan_mode_type val) -> void
def set_scan_mode: (scan_mode_type mode) -> void
def split_style=: (Symbol style) -> void
def init_matrix_pins: (Array[Array[Array[Integer] | nil]] matrix) -> void
def init_uart: () -> void
def init_pins: (Array[Integer] rows, Array[Integer] cols) -> void
def init_direct_pins: (Array[Integer] pins) -> void
def calculate_col_position: (Integer col_index) -> Integer
def convert_composite_keys: (Array[Symbol]) -> Array[Integer]
def convert_composite_keys: (Array[Symbol] keys) -> Array[Integer]
def add_layer: (Symbol name, Array[ Symbol | Array[Symbol] ] map) -> void
def find_keycode_index: (Symbol key) -> (Integer | Symbol)
def define_composite_key: (Symbol key_name, Array[Symbol] keys) -> void
Expand All @@ -169,8 +169,8 @@ class Keyboard
def before_report: () { (Keyboard) -> void } -> void
def on_start: () { (Keyboard) -> void } -> void
def signal_partner: (Symbol key) { (Keyboard) -> void } -> void
def keys_include?: (Symbol) -> bool
def action_on_release: (Integer | Array[Integer] | Proc | nil) -> void
def keys_include?: (Symbol key) -> bool
def action_on_release: (Integer | Array[Integer] | Proc | nil mode_key) -> void
def send_key: (*untyped) -> void # 気持ちとしては *(Symbol | Array) だけど書き方わからんかった
def start!: -> void
def raise_layer: -> void
Expand All @@ -184,9 +184,9 @@ class Keyboard
def scan_direct!: () -> void
def entire_cols_size: () -> Integer
def skip_position?: (Integer row_index, Integer col_index) -> bool
def resolve_key_alias: (Symbol) -> Symbol
def get_layer: (Symbol | nil, Integer) -> ( Array[Array[Integer | Symbol | Proc]] | nil )
def delete_mode_keys: (Symbol) -> void
def resolve_key_alias: (Symbol sym) -> Symbol
def get_layer: (Symbol | nil name, Integer num) -> ( Array[Array[Integer | Symbol | Proc]] | nil )
def delete_mode_keys: (Symbol layer_name) -> void
def inject_switch: (Integer col, Integer row) -> void
def key_pressed?: () -> bool
def output_report_changed: () { (Integer) -> void} -> void
Expand Down
16 changes: 8 additions & 8 deletions mrbgems/picoruby-prk-rgb/sig/rgb.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,18 @@ class RGB
def turn_off: () -> void
def turn_on: () -> void
def toggle: () -> void
def effect=: (rgb_effect_t) -> void
def hue=: (Integer) -> void
def saturation=: (Integer) -> void
def value=: (Integer | Float) -> void
def speed=: (Integer) -> void
def effect=: (rgb_effect_t name) -> void
def hue=: (Integer val) -> void
def saturation=: (Integer val) -> void
def value=: (Integer | Float val) -> void
def speed=: (Integer val) -> void
def reset_pixel: () -> void
def invoke_anchor: (Symbol | nil) -> Integer
def invoke_partner: (Integer) -> void
def invoke_anchor: (Symbol | nil key) -> Integer
def invoke_partner: (Integer message) -> void
def show: -> void
def fifo_push: (true data) -> void
def thunder: -> void
def ping?: () -> bool
def add_pixel: (Integer, Integer) -> void
def add_pixel: (Integer x, Integer y) -> void
def resume: () -> void
end
2 changes: 1 addition & 1 deletion mrbgems/picoruby-prk-rotary_encoder/sig/rotary_encoder.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class RotaryEncoder
def self.new: (Integer pin_a, Integer pin_b) -> instance
def init_pins: () -> void
def create_keycodes: (Integer) -> void
def call_proc_if: (Integer) -> void
def call_proc_if: (Integer keycode) -> void
def configure: (Symbol symbol) -> void
def left?: () -> bool
def right?: () -> bool
Expand Down
6 changes: 3 additions & 3 deletions mrbgems/picoruby-prk-sounder/sig/sounder.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ class Sounder
@last_compiled_song: nil | Symbol
@locked: bool

def self.new: (Integer) -> instance
def self.new: (Integer pin) -> instance

private def sounder_init: (Integer) -> void
private def sounder_replay: () -> void

def lock: () -> void
def unlock: () -> void
def replay: () -> void
def play: (*String | Symbol) -> void
def compile: (*String | Symbol) -> void
def play: (*String | Symbol measures) -> void
def compile: (*String | Symbol measures) -> void
def add_song: (Symbol name, *String measures) -> void
def add_note: (Float frequency, Integer duration) -> bool
def clear_song: () -> void
Expand Down
28 changes: 14 additions & 14 deletions mrbgems/picoruby-prk-via/sig/via.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,22 @@ class VIA
def rows_size: -> Integer
def task: -> void
def start!: -> void
def raw_hid_receive : (Array[Integer]) -> Array[Integer]
def raw_hid_receive_kb : (Array[Integer]) -> Array[Integer]
def dynamic_keymap_get_buffer : (Array[Integer]) -> Array[Integer]
def dynamic_keymap_set_buffer : (Array[Integer]) -> void
def dynamic_keymap_get_keycode : (Integer, Integer, Integer) -> Integer
def dynamic_keymap_set_keycode : (Integer, Integer, Integer, Integer) -> void
def via_get_layer_name : (Integer) -> Symbol
def check_for_keycode_shift : (Integer) -> ( Symbol | nil )
def via_keycode_into_keysymbol : (Integer) -> Symbol
def prk_keycode_into_via_keycode : (Integer | Symbol | Proc) -> Integer
def expand_composite_key : (Symbol) -> Array[Symbol]
def get_via_composite_keycode : (Symbol) -> Integer
def get_modifier_name : (Integer) -> String
def raw_hid_receive : (Array[Integer] data) -> Array[Integer]
def raw_hid_receive_kb : (Array[Integer] data) -> Array[Integer]
def dynamic_keymap_get_buffer : (Array[Integer] data) -> Array[Integer]
def dynamic_keymap_set_buffer : (Array[Integer] data) -> void
def dynamic_keymap_get_keycode : (Integer layer, Integer row, Integer col) -> Integer
def dynamic_keymap_set_keycode : (Integer layer, Integer row, Integer col, Integer keycode) -> void
def via_get_layer_name : (Integer i) -> Symbol
def check_for_keycode_shift : (Integer keycode) -> ( Symbol | nil )
def via_keycode_into_keysymbol : (Integer keycode) -> Symbol
def prk_keycode_into_via_keycode : (Integer | Symbol | Proc key) -> Integer
def expand_composite_key : (Symbol name) -> Array[Symbol]
def get_via_composite_keycode : (Symbol keyname) -> Integer
def get_modifier_name : (Integer bits) -> String
def load_mode_keys: -> void
def define_mode_key : (Symbol key_name, [Symbol | Array[Symbol] | Proc | nil, Symbol | Proc | nil, Integer?, Integer?] param) -> void
def sync_keymap : (?bool)-> void
def sync_keymap : (?bool init)-> void
def init_keymap: -> void
def save_on_keyboard: -> void
def save_on_flash: -> void
Expand Down
11 changes: 5 additions & 6 deletions mrbgems/picoruby-require/sig/require.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ end
# @sidebar builtin
# @added_by picoruby-require
class Object
def require: (String) -> bool
def load: (String) -> bool
private def required?: (String) -> bool
private def load_file: (String) -> bool
private def require_file: (String) -> bool
def require: (String name) -> bool
def load: (String path) -> bool
private def required?: (String name) -> bool
private def load_file: (String path) -> bool
private def require_file: (String name) -> bool
private def extern: (String path, ?bool force) -> (bool|nil)

# @ignore
# for CRuby
def require_relative: (String) -> bool
end

3 changes: 1 addition & 2 deletions mrbgems/picoruby-sandbox/sig/sandbox.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,5 @@ class Sandbox
def wait: (?timeout: (Integer|nil), ?signal: bool) -> bool
def execute: () -> bool
def exec_mrb: (String) -> bool
def load_file: (String, ?signal: bool) -> void
def load_file: (String path, ?signal: bool) -> void
end

3 changes: 1 addition & 2 deletions mrbgems/picoruby-sqlite3/sig/resultset.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ class SQLite3
@db: SQLite3::Database
@stmt: SQLite3::Statement
@eof: bool
def self.new: (SQLite3::Database, SQLite3::Statement) -> instance
def self.new: (SQLite3::Database db, SQLite3::Statement stmt) -> instance
def each: () { (Array[sqlite3_var_t] | Hash[String, sqlite3_var_t]) -> void } -> nil
def to_a: () -> Array[Array[sqlite3_var_t]]
def next: () -> (Array[sqlite3_var_t] | Hash[String, sqlite3_var_t] | nil)
end
end

2 changes: 1 addition & 1 deletion mrbgems/picoruby-task-ext/sig/task.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class Task
def self.list: () -> Array[Task]

def self.new: (*untyped) { (*untyped) -> void } -> instance
def name=: (String) -> String
def name=: (String name) -> String
def suspend: () -> self
def terminate: () -> self
def join: (?Integer|nil) -> (self | nil)
Expand Down
2 changes: 1 addition & 1 deletion mrbgems/picoruby-uart/sig/uart.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class UART
def readpartial: (Integer maxlen) -> String
def bytes_available: () -> Integer
def line_ending=: (("\n"|"\r\n"|"\r") line_ending) -> void
def puts: (String) -> nil
def puts: (String str) -> nil
def gets: () -> String
def write: (String str) -> Integer
def flush: () -> self
Expand Down

0 comments on commit 89db2bf

Please sign in to comment.