on master help sign in
commentary update
8abf7f9Corey O'Connor
src/Graphics/Vty/Input.hs+6−7
@@ -19,14 +19,10 @@
19--
19--
20-- vty assumes 7 bit mode. Which is the default AFAIK.
20-- vty assumes 7 bit mode. Which is the default AFAIK.
21--
21--
22−-- 1. ESC individually: ESC byte, no bytes for control-seq-period,
22+-- 1. ESC individually: ESC byte, no bytes for 'singleEscPeriod'.
23−-- no bytes for meta-combo-period.
24--
23--
25−-- 2. control keys that contain ESC in their byte sequence: ESC byte, bytes read within
24+-- 2. control keys that contain ESC in their byte sequence: ESC byte. Bytes read within
26−-- control-seq-period are part of the sequence. Up until the next valid input block.
25+-- 'singleEscPeriod' are part of the sequence up until the next valid input block.
27−--
28−-- 3. ESC used as meta in a key combination: ESC byte, no other bytes read within
29−-- control-seq-period. Bytes up until next valid input block are the input events plus meta.
30--
26--
31-- If the current runtime is the threaded runtime then the terminal's VMIN and VTIME parameters can
27-- If the current runtime is the threaded runtime then the terminal's VMIN and VTIME parameters can
32-- be applied to implement the above rules.
28-- be applied to implement the above rules.
@@ -66,6 +62,9 @@ inputForCurrentTerminal config = do
66
62
67-- | Set up the terminal attached to the given Fd for input. Returns a 'Input'.
63-- | Set up the terminal attached to the given Fd for input. Returns a 'Input'.
68--
64--
65+-- The table used to determine the 'Events' to produce for the input bytes comes from
66+-- 'classifyTableForTerm'.
67+--
69-- The terminal is modified as follows:
68-- The terminal is modified as follows:
70--
69--
71-- * IXON disabled
70-- * IXON disabled
test/interactive_terminal_test.hs+3−4
@@ -66,11 +66,10 @@ All the tests assume the following about the terminal display:
66Thanks for the help! :-D
66Thanks for the help! :-D
67To exit the test early enter "q" anytime at the following menu screen.
67To exit the test early enter "q" anytime at the following menu screen.
68
68
69−If any test failed then please post an issue to
69+If any test fails then please post an issue to
70 https://github.com/coreyoconnor/vty/issues
70 https://github.com/coreyoconnor/vty/issues
71−with the test_results.list file pasted into the issue. The issue summary can
71+with the test_results.list file pasted into the issue. A suitable summary is:
72−mention the specific tests that failed or just say "interactive terminal test
72+"interactive terminal test failure".
73−failure".
74|]
73|]
75 waitForReturn
74 waitForReturn
76 results <- doTestMenu 1
75 results <- doTestMenu 1