Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

command: make script-binding command scalable #15316

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

command: make script-binding command scalable #15316

wants to merge 8 commits into from
+69 −24

Conversation

na-na-hi
Copy link
Contributor

This makes script-binding command and key bindings added by mp.add_key_binding() scalable. The script-message command now has an extra argument with the scale of the key.

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 14, 2024 •
edited
Loading

Download the artifacts for this pull request:

Windows
macOS

@avih
Copy link
Member

avih commented Nov 15, 2024 •
edited
Loading

The script-message command now has an extra argument

Did you mean script-binding? I don't think I see at the changes anything specific to script-message, but I do see changes to script-binding.

If it's still script-message, then at which level is the extra argument added?

The script-message command itself - as clients use it, takes any number of arbitrarry arguments, and by convention the first is the message name.

So adding an argument at this level will surely break existing clients which expect the receiver to see exactly the arguments they send.

Or maybe it's only in how script-binding uses script-message?

Please clarify.

@na-na-hi
Copy link
Contributor Author

na-na-hi commented Nov 15, 2024 •
edited
Loading

Did you mean script-binding? I don't think I see at the changes anything specific to script-message, but I do see changes to script-binding.

It's noted in the changed script-binding documentation. Internally script-binding calls script-message command with several arguments. This makes script-binding calling script-message with an additional argument of scale.

I have updated the commit message to clarify this.

So adding an argument at this level will surely break existing clients which expect the receiver to see exactly the arguments they send.
Or maybe it's only in how script-binding uses script-message?

This only affects how script-binding uses script-message. The script-binding documentation explicitly notes: "Future versions can add more arguments and more key state characters to support more input peculiarities.", so it doesn't guarantee stability, but for this PR the extra argument is added to the end to avoid breaking existing clients.

@na-na-hi na-na-hi mentioned this pull request Nov 15, 2024
Open
@na-na-hi
command: make script-binding command scalable
87f06fd 
script-binding command is currently not scalable, so script
registered key bindings also cannot be scalable, unlink input.conf
bindings.

This makes script-binding command scalable so that it's possible to
define scalable key bindings in scripts. It now calls script-message
command with an extra argument with the scale of the key.
@na-na-hi
DOCS/man/input.rst: document the new argument of script-binding
2cbe364
@na-na-hi
defaults.lua: support scalable mp.add_key_binding()
f18a461 
For complex key bindings, the table now contains a new member
of the current key scale. mp.add_key_binding() now accepts the
scalable flag to make the binding scalable.
@na-na-hi
defaults.js: support scalable mp.add_key_binding()
e838a56
@na-na-hi
DOCS/man/lua.rst: document scale for mp.add_key_binding()
49284a7
@na-na-hi
input/cmd: add comment for scalable and is_ignore
3dd6627
@na-na-hi
DOCS/man/input.rst: document the scalable commands
43ab609 
This documents the commands which are scalable, and refer
to information on how it affects input processing.
@na-na-hi
Copy link
Contributor Author

Added some documentation for scalable keys and scalable commands to better clarify scalable stuffs as a whole.

@na-na-hi
DOCS/man/input.rst: document that WHEEL_* are scalable
e1d605a 
This documents the scalable keys (currently WHEEL_*) and notes
how the keys work with scalable commands. Mention touch pad
as a common source of scalable input source.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@na-na-hi @avih