aboutsummaryrefslogtreecommitdiffstats
path: root/src/termhooks.h
diff options
context:
space:
mode:
authorDaniel Colascione2012-10-07 14:31:58 -0800
committerDaniel Colascione2012-10-07 14:31:58 -0800
commit36a305a723c63fd345be65c536c52fe9765c14be (patch)
treefb89d9e103552863214c60297a65320917109357 /src/termhooks.h
parent2ab329f3b5d52a39f0a45c3d9c129f1c19560142 (diff)
parent795b1482a9e314cda32d62ac2988f573d359366e (diff)
downloademacs-36a305a723c63fd345be65c536c52fe9765c14be.tar.gz
emacs-36a305a723c63fd345be65c536c52fe9765c14be.zip
Merge from trunk
Diffstat (limited to 'src/termhooks.h')
-rw-r--r--src/termhooks.h16
1 files changed, 3 insertions, 13 deletions
diff --git a/src/termhooks.h b/src/termhooks.h
index 0864b80da84..42f2e16e577 100644
--- a/src/termhooks.h
+++ b/src/termhooks.h
@@ -591,24 +591,14 @@ struct terminal
591 /* Called to read input events. 591 /* Called to read input events.
592 592
593 TERMINAL indicates which terminal device to read from. Input 593 TERMINAL indicates which terminal device to read from. Input
594 events should be read into BUF, the size of which is given in 594 events should be read into HOLD_QUIT.
595 SIZE. EXPECTED is non-zero if the caller suspects that new input
596 is available.
597 595
598 A positive return value indicates that that many input events 596 A positive return value indicates that that many input events
599 where read into BUF. 597 were read into BUF.
600 Zero means no events were immediately available. 598 Zero means no events were immediately available.
601 A value of -1 means a transient read error, while -2 indicates 599 A value of -1 means a transient read error, while -2 indicates
602 that the device was closed (hangup), and it should be deleted. 600 that the device was closed (hangup), and it should be deleted. */
603
604 XXX Please note that a non-zero value of EXPECTED only means that
605 there is available input on at least one of the currently opened
606 terminal devices -- but not necessarily on this device.
607 Therefore, in most cases EXPECTED should be simply ignored.
608
609 XXX This documentation needs to be updated. */
610 int (*read_socket_hook) (struct terminal *terminal, 601 int (*read_socket_hook) (struct terminal *terminal,
611 int expected,
612 struct input_event *hold_quit); 602 struct input_event *hold_quit);
613 603
614 /* Called when a frame's display becomes entirely up to date. */ 604 /* Called when a frame's display becomes entirely up to date. */