History log of /openbsd-current/usr.bin/tmux/cmd-bind-key.c
Revision (<<< Hide revision tags) (Show revision tags >>>) Date Author Comments
# 1.46 27-Aug-2021 nicm

Replace %% in command lists (by copying them) for template arguments ,
this means they can be used with {} as well. Also make argument
processing from an existing vector preserve commands. GitHub issue 2858.


# 1.45 25-Aug-2021 nicm

bind-key needs to allow commands for any argument for the moment.


# 1.44 25-Aug-2021 nicm

Validate command argument types (string or command list) and give more
useful error messages.


# 1.43 23-Aug-2021 nicm

Key bindings steal a reference to the command instead of adding their
own, it was correct not to add a reference when parsing, but the
bind-key then needs to add one.


# 1.42 21-Aug-2021 nicm

Preserve argument type in command and convert to string on demand.


# 1.41 21-Aug-2021 nicm

Stop caring about empty commands, just treat as a null command.


# 1.40 21-Aug-2021 nicm

Add args parsing callback for some future work, currently unused.


# 1.39 20-Aug-2021 nicm

Hide struct args behind a couple of accessor functions.


Revision tags: OPENBSD_6_8_BASE OPENBSD_6_9_BASE
# 1.38 08-Sep-2020 nicm

Allow -N without a command to change or add a note to an existing key.


Revision tags: OPENBSD_6_7_BASE
# 1.37 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.36 30-Jan-2020 nicm

Remove bind-key -c which doesn't do anything and is undocumented.


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.45 25-Aug-2021 nicm

bind-key needs to allow commands for any argument for the moment.


# 1.44 25-Aug-2021 nicm

Validate command argument types (string or command list) and give more
useful error messages.


# 1.43 23-Aug-2021 nicm

Key bindings steal a reference to the command instead of adding their
own, it was correct not to add a reference when parsing, but the
bind-key then needs to add one.


# 1.42 21-Aug-2021 nicm

Preserve argument type in command and convert to string on demand.


# 1.41 21-Aug-2021 nicm

Stop caring about empty commands, just treat as a null command.


# 1.40 21-Aug-2021 nicm

Add args parsing callback for some future work, currently unused.


# 1.39 20-Aug-2021 nicm

Hide struct args behind a couple of accessor functions.


Revision tags: OPENBSD_6_8_BASE OPENBSD_6_9_BASE
# 1.38 08-Sep-2020 nicm

Allow -N without a command to change or add a note to an existing key.


Revision tags: OPENBSD_6_7_BASE
# 1.37 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.36 30-Jan-2020 nicm

Remove bind-key -c which doesn't do anything and is undocumented.


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.43 23-Aug-2021 nicm

Key bindings steal a reference to the command instead of adding their
own, it was correct not to add a reference when parsing, but the
bind-key then needs to add one.


# 1.42 21-Aug-2021 nicm

Preserve argument type in command and convert to string on demand.


# 1.41 21-Aug-2021 nicm

Stop caring about empty commands, just treat as a null command.


# 1.40 21-Aug-2021 nicm

Add args parsing callback for some future work, currently unused.


# 1.39 20-Aug-2021 nicm

Hide struct args behind a couple of accessor functions.


Revision tags: OPENBSD_6_8_BASE OPENBSD_6_9_BASE
# 1.38 08-Sep-2020 nicm

Allow -N without a command to change or add a note to an existing key.


Revision tags: OPENBSD_6_7_BASE
# 1.37 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.36 30-Jan-2020 nicm

Remove bind-key -c which doesn't do anything and is undocumented.


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.42 21-Aug-2021 nicm

Preserve argument type in command and convert to string on demand.


# 1.41 21-Aug-2021 nicm

Stop caring about empty commands, just treat as a null command.


# 1.40 21-Aug-2021 nicm

Add args parsing callback for some future work, currently unused.


# 1.39 20-Aug-2021 nicm

Hide struct args behind a couple of accessor functions.


Revision tags: OPENBSD_6_8_BASE OPENBSD_6_9_BASE
# 1.38 08-Sep-2020 nicm

Allow -N without a command to change or add a note to an existing key.


Revision tags: OPENBSD_6_7_BASE
# 1.37 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.36 30-Jan-2020 nicm

Remove bind-key -c which doesn't do anything and is undocumented.


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.40 21-Aug-2021 nicm

Add args parsing callback for some future work, currently unused.


# 1.39 20-Aug-2021 nicm

Hide struct args behind a couple of accessor functions.


Revision tags: OPENBSD_6_8_BASE OPENBSD_6_9_BASE
# 1.38 08-Sep-2020 nicm

Allow -N without a command to change or add a note to an existing key.


Revision tags: OPENBSD_6_7_BASE
# 1.37 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.36 30-Jan-2020 nicm

Remove bind-key -c which doesn't do anything and is undocumented.


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.38 08-Sep-2020 nicm

Allow -N without a command to change or add a note to an existing key.


Revision tags: OPENBSD_6_7_BASE
# 1.37 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.36 30-Jan-2020 nicm

Remove bind-key -c which doesn't do anything and is undocumented.


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.37 13-Apr-2020 nicm

Make struct cmd local to cmd.c and move it out of tmux.h.


# 1.36 30-Jan-2020 nicm

Remove bind-key -c which doesn't do anything and is undocumented.


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.36 30-Jan-2020 nicm

Remove bind-key -c which doesn't do anything and is undocumented.


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.35 27-Jan-2020 nicm

Add support for adding a note to a key binding (with bind-key -N) and
use this to add descriptions to the default key bindings. A new -N flag
to list-keys shows key bindings with notes rather than the default
bind-key command used to create them. Change the default ? binding to
use this to show a readable summary of keys.

Also extend command-prompt to return the name of the key pressed and add
a default binding (/) to show the note for the next key pressed

Suggested by Alex Tremblay in GitHub issue 2000.


Revision tags: OPENBSD_6_6_BASE
# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.34 27-May-2019 nicm

Add an additional {} syntax for defining strings in the configuration
file, making it much tidier to define commands that contain other tmux
or shell commands (like if-shell). Also tweak bind-key to expect a
string if it is only given one argument, so {} can be used with it as
well. From Avi Halachmi.


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


# 1.33 25-May-2019 nicm

Merge cmd_list_parse into cmd-parse.y so it can use the new alias
processing code.


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE OPENBSD_6_3_BASE OPENBSD_6_4_BASE OPENBSD_6_5_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti


Revision tags: OPENBSD_6_1_BASE OPENBSD_6_2_BASE
# 1.32 24-Jan-2017 nicm

Fixed keys for choose mode, and remove the last mode keys bits.


# 1.31 16-Oct-2016 nicm

Mass rename struct cmd_q to struct cmdq_item and related.


# 1.30 14-Oct-2016 nicm

Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.


# 1.29 12-Oct-2016 nicm

Drop the edit mode key tables and just use fixed key bindings for the
command prompt.


# 1.28 11-Oct-2016 nicm

Fundamental change to how copy mode key bindings work:

The vi-copy and emacs-copy mode key tables are gone, and instead copy
mode commands are bound in one of two normal key tables ("copy-mode" or
"copy-mode-vi"). Keys are bound to "send-keys -X copy-mode-command". So:

bind -temacs-copy C-Up scroll-up
bind -temacs-copy -R5 WheelUpPane scroll-up

Becomes:

bind -Tcopy-mode C-Up send -X scroll-up
bind -Tcopy-mode WheelUpPane send -N5 -X scroll-up

This allows the full command parser and command set to be used - for
example, we can use the normal command prompt for searching, jumping,
and so on instead of a custom one:

bind -Tcopy-mode C-r command-prompt -p'search up' "send -X search-backward '%%'"

command-prompt also gets a -1 option to only require on key press, which
is needed for jumping.

The plan is to get rid of mode keys entirely, so more to come eventually.


# 1.27 10-Oct-2016 nicm

Add static in cmd-* and fix a few other nits.


# 1.26 12-Sep-2016 nicm

Allow repeat count to be specified in mode key tables with bind-key -R,
and set the default repeat count to 5 for WheelUp and WheelDown in
copy-mode.


Revision tags: OPENBSD_5_9_BASE OPENBSD_6_0_BASE
# 1.25 19-Jan-2016 nicm

I no longer use my SourceForge address so replace it.


# 1.24 13-Dec-2015 nicm

Use member names in cmd_entry definitions so I stop getting confused
about the order.


# 1.23 12-Dec-2015 nicm

Allow prefix and prefix2 to be set to None to disable (useful if you
would rather bind the prefix in the root table).


# 1.22 12-Nov-2015 nicm

Support UTF-8 key bindings by expanding the key type from int to
uint64_t and converting UTF-8 to Unicode on input and the reverse on
output. (This allows key bindings, there are still omissions - the
largest being that the various prompts do not accept UTF-8.)


Revision tags: OPENBSD_5_8_BASE
# 1.21 20-Apr-2015 nicm

Support for multiple key tables to commands to be bound to sequences of
keys. The default key bindings become the "prefix" table and -n the
"root" table. Keys may be bound in new tables with bind -T and
switch-client -T used to specify the table in which the next key should
be looked up. Based on a diff from Keith Amling.


# 1.20 10-Apr-2015 nicm

Add a -x flag to copy-selection, append-selection and start-named-buffer
to prevent it exiting copy mode after copying. From J Raynor with a few
tweaks by me.


Revision tags: OPENBSD_5_7_BASE
# 1.19 20-Oct-2014 nicm

Instead of setting up the default keys by building the key struct
directly with a helper function in the cmd_entry, include a table of
bind-key commands and pass them through the command parser and a
temporary cmd_q.

As well as being smaller, this will allow default bindings to be command
sequences which will probably be needed soon.


Revision tags: OPENBSD_5_6_BASE
# 1.18 14-May-2014 nicm

Change key-table to mode-table to allow for some future work. From Keith
Amling.


Revision tags: OPENBSD_5_5_BASE
# 1.17 10-Oct-2013 nicm

Remove the barely-used and unnecessary command check() function.


Revision tags: OPENBSD_5_4_BASE
# 1.16 24-Mar-2013 nicm

Add a command queue to standardize and simplify commands that call other
commands and allow a command to block execution of subsequent
commands. This allows run-shell and if-shell to be synchronous which has
been much requested.

Each client has a default command queue and commands are consumed one at
a time from it. A command may suspend execution from the queue by
returning CMD_RETURN_WAIT and then resume it by calling cmd_continue() -
for example run-shell does this from the callback that is fired after
the job is freed.

When the command queue becomes empty, command clients are automatically
exited (unless attaching). A callback is also fired - this is used for
nested commands in, for example, if-shell which can block execution of
the client's cmdq until a new cmdq becomes empty.

Also merge all the old error/info/print functions together and lose the
old curclient/cmdclient distinction - a cmdq is bound to one client (or
none if in the configuration file), this is a command client if
c->session is NULL otherwise an attached client.


# 1.15 22-Mar-2013 nicm

Add copy-pipe mode command to copy selection and also pipe to a command.


Revision tags: OPENBSD_5_2_BASE OPENBSD_5_3_BASE
# 1.14 11-Jul-2012 nicm

Make command exec functions return an enum rather than -1/0/1 values and
add a new value to mean "leave client running but don't attach" to fix
problems with using some commands in a command sequence. Most of the
work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.


# 1.13 10-Jul-2012 nicm

xfree is not particularly helpful, remove it. From Thomas Adam.


Revision tags: OPENBSD_5_1_BASE
# 1.12 21-Jan-2012 nicm

Use RB trees not SPLAY.


Revision tags: OPENBSD_4_9_BASE OPENBSD_5_0_BASE
# 1.11 15-Jan-2011 nicm

Fix bind-key -t.


# 1.10 04-Jan-2011 nicm

Clean up and simplify tmux command argument parsing.

Originally, tmux commands were parsed in the client process into a
struct with the command data which was then serialised and sent to the
server to be executed. The parsing was later moved into the server (an
argv was sent from the client), but the parse step and intermediate
struct was kept.

This change removes that struct and the separate parse step. Argument
parsing and printing is now common to all commands (in arguments.c) with
each command left with just an optional check function (to validate the
arguments at parse time), the exec function and a function to set up any
key bindings (renamed from the old init function).

This is overall more simple and consistent.

There should be no changes to any commands behaviour or syntax although
as this touches every command please watch for any unexpected changes.


Revision tags: OPENBSD_4_8_BASE
# 1.9 26-Jun-2010 nicm

Setting the cmdlist pointer in the bind-key to NULL to prevent it being freed
after the command is executing is bogus because it may still be needed if the
same command is going to be executed again (for example if you "bind-key a
bind-key b ..."). Making a copy is hard, so instead add a reference count to
the cmd_list.

While here, also print bind-key -n and the rest of the flags properly.

Fixes problem reported by mcbride@.


Revision tags: OPENBSD_4_7_BASE
# 1.8 23-Jan-2010 nicm

Don't leak if arguments appear multiple times, from Tiago Cunha.


# 1.7 03-Dec-2009 nicm

Massive spaces->tabs and trailing whitespace cleanup, hopefully for the last
time now I've configured emacs to make them displayed in really annoying
colours...


# 1.6 13-Nov-2009 nicm

Get rid of the ugly CMD_CHFLAG macro and use a const string (eg "dDU") in the
command entry structs and a couple of functions to check/set the flags.


# 1.5 28-Jul-2009 nicm

Final pieces of mode key rebinding: bind-key and unbind-key now accept a -t
argument to modify a table.


# 1.4 26-Jul-2009 nicm

Make all messages sent between the client and server fixed size.

This is the first of two changes to make the protocol more resilient and less
sensitive to other changes in the code, particularly with commands. The client
now packs argv into a buffer and sends it to the server for parsing, rather
than doing it itself and sending the parsed command data.

As a side-effect this also removes a lot of now-unused command marshalling
code.

Mixing a server without this change and a client with or vice versa will cause
tmux to hang or crash, please ensure that tmux is entirely killed before
upgrading.


# 1.3 24-Jul-2009 nicm

Permit commands to be bound to key presses without the prefix key first. The
new -n flag to bind-key and unbind-key sets or removes these bindings, and
list-key shows them in []s.


# 1.2 13-Jul-2009 nicm

Having fixed flags for single-character getopt options is a bit hard to
maintain and is only going to get worse as more are used. So instead, add a new
uint64_t member to cmd_entry which is a bitmask of upper and lowercase options
accepted by the command.

This means new single character options can be used without the need to add it
explicitly to the list.


Revision tags: OPENBSD_4_6_BASE
# 1.1 01-Jun-2009 nicm

Import tmux, a terminal multiplexor allowing (among other things) a single
terminal to be switched between several different windows and programs
displayed on one terminal be detached from one terminal and moved to another.

ok deraadt pirofti