changeset: 2577:8400c9042cbd
tag: tip
user: Kris Maglione <kris_AT_suckless.org>
date: Mon Oct 26 21:25:53 2009 -0400
files: cmd/menu/main.c man/wimenu.1 man/wimenu.man1 mk/gcc.mk mk/wmii.mk
description:
Update wimenu(1), add custom completion example.
diff -r bc6ff98f6b17 -r 8400c9042cbd cmd/menu/main.c
--- a/cmd/menu/main.c Mon Oct 26 16:35:43 2009 -0400
+++ b/cmd/menu/main.c Mon Oct 26 21:25:53 2009 -0400
@@ -149,8 +149,9 @@
update_input(void) {
if(alwaysprint) {
write(1, input.string, input.pos - input.string);
- write(1, "", 1);
- write(1, input.pos, input.end - input.pos + 1);
+ write(1, "\n", 1);
+ write(1, input.pos, input.end - input.pos);
+ write(1, "\n", 1);
}
}
diff -r bc6ff98f6b17 -r 8400c9042cbd man/wimenu.1
--- a/man/wimenu.1 Mon Oct 26 16:35:43 2009 -0400
+++ b/man/wimenu.1 Mon Oct 26 21:25:53 2009 -0400
@@ -6,7 +6,7 @@
.SH SYNOPSIS
.P
-wimenu \fI[\-a \fI<address>\fR]\fR \fI[\-c]\fR \fI[\-h \fI<history file>\fR]\fR \fI[\-i]\fR \fI[\-K]\fR \fI[\-k \fI<keys file>\fR]\fR \fI[\-n \fI<history count>\fR]\fR \fI[\-p \fI<prompt>\fR]\fR \fI[\-s \fI<screen>\fR]\fR
+wimenu \fI[\-i]\fR \fI[\-h \fI<history file>\fR]\fR \fI[\-n \fI<history count>\fR]\fR \fI[\-p \fI<prompt>\fR]\fR
.P
wimenu \-v
@@ -18,16 +18,11 @@
programs, select views, and perform standard actions. It
supports basic item completion and history searching.
-.SH ARGUMENTS
-.TP
-\-a
-The address at which to connect to \fBwmii\fR.
-.TP
-\-c
-Prints the contents of the input buffer each time the
-user inputs a character, as such:
+.SH BASIC ARGUMENTS
+.P
+Normal use of \fBwimenu\fR shouldn't require any arguments other than the
+following. More advanced options are documented below.
-\fI<text before caret>\fR\e0\fI<text after caret>\fR\e0
.TP
\-h \fI<history file>\fR
Causes \fBwimenu\fR to read its command history from
@@ -38,6 +33,22 @@
Causes matching of completion items to be performed in a
case insensitive manner.
.TP
+\-n \fI<count>\fR
+Write at most \fI<count>\fR items back to the history file.
+The file is never modified unless this option is
+provided. Duplicates are filtered out within a 20 item
+sliding window before this limit is imposed.
+.TP
+\-p \fI<prompt>\fR
+The string \fI<prompt>\fR will be show before the input field
+when the menu is opened.
+
+
+.SH ADVANCED ARGUMENTS
+.TP
+\-a
+The address at which to connect to \fBwmii\fR.
+.TP
\-K
Prevents \fBwimenu\fR from initializing its default key
bindings. WARNING: If you do this, be sure to bind a key
@@ -57,19 +68,119 @@
executable (this level of customization is reserved for the
determined).
.TP
-\-n \fI<count>\fR
-Write at most \fI<count>\fR items back to the history file.
-The file is never modified unless this option is
-provided. Duplicates are filtered out within a 20 item
-sliding window before this limit is imposed.
-.TP
-\-p \fI<prompt>\fR
-The string \fI<prompt>\fR will be show before the input field
-when the menu is opened.
-.TP
\-s \fI<screen>\fR
Suggests that the menu open on Xinerama screen \fI<screen>\fR.
+.TP
+\-S \fI<command separator>\fR
+.RS
+Causes each input item to be split at the first occurance of
+\fI<command sep>\fR. The text to the left of the separator is displayed
+as a menu option, and the text to the right is displayed when a
+selection is made.
+.RE
+
+.SH CUSTOM COMPLETION
+.P
+Custom, multipart completion data may be proveded by an
+external application. When the standard input is not a TTY,
+processing of a set of completions stops at every blank line.
+After the first new line or EOF, \fBwimenu\fR displays the first
+set of menu items, and waits for further input. The completion
+items may be replaced by writing out a new set, again followed
+by a new line. Every set following the first must begin with a
+line containing a single decimal number specifying where the
+new completion results are to be spliced into the input. When
+an item is selected, text from this position to the position
+of the caret is replaced.
+
+.SS ARGUMENTS
+.TP
+\-c
+Prints the contents of the input buffer each time the
+user inputs a character, as such:
+
+\fI<text before caret>\fR\en\fI<text after caret>\fR\en
+
+
+.SS EXAMPLE
+.P
+Let's assume that a script would like to provide a menu with
+completions first for a command name, then for arguments
+to that command. Given three commands and argument sets,
+
+.TP
+foo
+
+.RS
+1, 2, 3
+.RE
+.TP
+bar
+
+.RS
+4, 5, 6
+.RE
+.TP
+baz
+
+.RS
+7, 8, 9
+.RE
+
+.P
+the following script provides the appropriate completions:
+
+.nf
+ #!/bin/sh -f
+
+ rm fifo
+ mkfifo fifo
+
+ # Open wimenu with a fifo as its stdin
+ wimenu -c <fifo | awk '
+ BEGIN {
+ # Define the completion results
+ cmds = "foo\enbar\enbaz\en"
+ cmd\fI["foo"]\fR = "1\en2\en3\en"
+ cmd\fI["bar"]\fR = "4\en5\en6\en"
+ cmd\fI["baz"]\fR = "7\en8\en9\en"
+
+ # Print the first set of completions to wimenu’s fifo
+ fifo = "fifo"
+ print cmds >fifo; fflush(fifo)
+ }
+
+ # Store the last line we get and print it when done
+ { last = $0 }
+ END { print last }
+
+ # Push out a new set of completions
+ function update(str, opts) {
+ print length str >fifo # Print the length of the preceding string
+ print opts >fifo # and the options themself
+ fflush(fifo)
+ }
+
+ # Ensure correct argument count with trailing spaces
+ / $/ { $0 = $0 "#"; }
+
+ { # Process the input and provide the completions
+ if (NF == 1)
+ update("", cmds) # The first arg, command choices
+ else
+ update($1 " ", cmd\fI[$1]\fR) # The second arg, command arguments
+ # Skip the trailing part of the command
+ getline rest
+ }
+ \&'
+.fi
+
+
+.P
+In theory, this facility can be used for myriad purposes,
+including hijacking the programmable completion facilities of
+most shells.
.SH ENVIRONMENT
.TP
diff -r bc6ff98f6b17 -r 8400c9042cbd man/wimenu.man1
--- a/man/wimenu.man1 Mon Oct 26 16:35:43 2009 -0400
+++ b/man/wimenu.man1 Mon Oct 26 21:25:53 2009 -0400
@@ -10,7 +10,7 @@
= SYNOPSIS =
-wimenu [-a <address>] [-c] [-h <history file>] [-i] [-K] [-k <keys file>] [-n <history count>] [-p <prompt>] [-s <screen>] +
+wimenu [-i] [-h <history file>] [-n <history count>] [-p <prompt>] +
wimenu -v
= DESCRIPTION =
@@ -21,15 +21,11 @@
programs, select views, and perform standard actions. It
supports basic item completion and history searching.
-= ARGUMENTS =
+= BASIC ARGUMENTS =
-: -a
- The address at which to connect to `wmii`.
-: -c
- Prints the contents of the input buffer each time the
- user inputs a character, as such:
+Normal use of `wimenu` shouldn't require any arguments other than the
+following. More advanced options are documented below.
- <text before caret>\0<text after caret>\0
: -h <history file>
Causes `wimenu` to read its command history from
<history file> and to append its result to that file if
@@ -37,6 +33,20 @@
: -i
Causes matching of completion items to be performed in a
case insensitive manner.
+: -n <count>
+ Write at most <count> items back to the history file.
+ The file is never modified unless this option is
+ provided. Duplicates are filtered out within a 20 item
+ sliding window before this limit is imposed.
+: -p <prompt>
+ The string <prompt> will be show before the input field
+ when the menu is opened.
+:
+
+= ADVANCED ARGUMENTS =
+
+: -a
+ The address at which to connect to `wmii`.
: -K
Prevents `wimenu` from initializing its default key
bindings. WARNING: If you do this, be sure to bind a key
@@ -54,18 +64,101 @@
cmd/menu/keys.txt, or use strings(1) on the `wimenu`
executable (this level of customization is reserved for the
determined).
-: -n <count>
- Write at most <count> items back to the history file.
- The file is never modified unless this option is
- provided. Duplicates are filtered out within a 20 item
- sliding window before this limit is imposed.
-: -p <prompt>
- The string <prompt> will be show before the input field
- when the menu is opened.
: -s <screen>
Suggests that the menu open on Xinerama screen <screen>.
+: -S <command separator>
+ Causes each input item to be split at the first occurance of
+ <command sep>. The text to the left of the separator is displayed
+ as a menu option, and the text to the right is displayed when a
+ selection is made.
+
+= CUSTOM COMPLETION =
+
+Custom, multipart completion data may be proveded by an
+external application. When the standard input is not a TTY,
+processing of a set of completions stops at every blank line.
+After the first new line or EOF, `wimenu` displays the first
+set of menu items, and waits for further input. The completion
+items may be replaced by writing out a new set, again followed
+by a new line. Every set following the first must begin with a
+line containing a single decimal number specifying where the
+new completion results are to be spliced into the input. When
+an item is selected, text from this position to the position
+of the caret is replaced.
+
+== ARGUMENTS ==
+
+: -c
+ Prints the contents of the input buffer each time the
+ user inputs a character, as such:
+
+ <text before caret>\n<text after caret>\n
:
+== EXAMPLE ==
+
+Let's assume that a script would like to provide a menu with
+completions first for a command name, then for arguments
+to that command. Given three commands and argument sets,
+
+: foo
+ 1, 2, 3
+: bar
+ 4, 5, 6
+: baz
+ 7, 8, 9
+
+the following script provides the appropriate completions:
+
+```
+#!/bin/sh -f
+
+rm fifo
+mkfifo fifo
+
+# Open wimenu with a fifo as its stdin
+wimenu -c <fifo | awk '
+ BEGIN {
+ # Define the completion results
+ cmds = "foo\nbar\nbaz\n"
+ cmd["foo"] = "1\n2\n3\n"
+ cmd["bar"] = "4\n5\n6\n"
+ cmd["baz"] = "7\n8\n9\n"
+
+ # Print the first set of completions to wimenu’s fifo
+ fifo = "fifo"
+ print cmds >fifo; fflush(fifo)
+ }
+
+ # Store the last line we get and print it when done
+ { last = $0 }
+ END { print last }
+
+ # Push out a new set of completions
+ function update(str, opts) {
+ print length str >fifo # Print the length of the preceding string
+ print opts >fifo # and the options themself
+ fflush(fifo)
+ }
+
+ # Ensure correct argument count with trailing spaces
+ / $/ { $0 = $0 "#"; }
+
+ { # Process the input and provide the completions
+ if (NF == 1)
+ update("", cmds) # The first arg, command choices
+ else
+ update($1 " ", cmd[$1]) # The second arg, command arguments
+ # Skip the trailing part of the command
+ getline rest
+ }
+'
+```
+
+In theory, this facility can be used for myriad purposes,
+including hijacking the programmable completion facilities of
+most shells.
+
= ENVIRONMENT =
: $WMII_ADDRESS
diff -r bc6ff98f6b17 -r 8400c9042cbd mk/gcc.mk
--- a/mk/gcc.mk Mon Oct 26 16:35:43 2009 -0400
+++ b/mk/gcc.mk Mon Oct 26 21:25:53 2009 -0400
@@ -19,6 +19,7 @@
-Wno-parentheses \
-Wno-sign-compare \
-Wno-switch \
+ -Wno-unused-result \
-Wpointer-arith \
-Wreturn-type \
-Wstrict-prototypes \
diff -r bc6ff98f6b17 -r 8400c9042cbd mk/wmii.mk
--- a/mk/wmii.mk Mon Oct 26 16:35:43 2009 -0400
+++ b/mk/wmii.mk Mon Oct 26 21:25:53 2009 -0400
@@ -1,7 +1,7 @@
VERS = hg$$(hg identify -n)
VERS = $$(test -n "$$WMII_HGVERSION" && echo $$WMII_HGVERSION || \
- echo hg$$(hg log -r $$(hg id 2>/dev/null | awk -F'[+ ]' '{print $$1}') --template '{rev}' 2>/dev/null))
+ hg log -r $$(hg id 2>/dev/null | awk -F'[+ ]' '{print $$1}') --template 'hg{rev}' 2>/dev/null)
WMII_HGVERSION = $(VERS)
WMII_HGVERSION := $(shell echo $(VERS))
Received on Tue Oct 27 2009 - 01:26:06 UTC
This archive was generated by hypermail 2.2.0 : Tue Oct 27 2009 - 01:36:06 UTC