annotate lisp/term/README @ 4885:6772ce4d982b

Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums lisp/ChangeLog addition: 2010-01-24 Aidan Kehoe <kehoea@parhasard.net> Correct the semantics of #'member*, #'eql, #'assoc* in the presence of bignums; change the integerp byte code to fixnump semantics. * bytecomp.el (fixnump, integerp, byte-compile-integerp): Change the integerp byte code to fixnump; add a byte-compile method to integerp using fixnump and numberp and avoiding a funcall most of the time, since in the non-core contexts where integerp is used, it's mostly distinguishing between fixnums and things that are not numbers at all. * byte-optimize.el (side-effect-free-fns, byte-after-unbind-ops) (byte-compile-side-effect-and-error-free-ops): Replace the integerp bytecode with fixnump; add fixnump to the side-effect-free-fns. Add the other extended number type predicates to the list in passing. * obsolete.el (floatp-safe): Mark this as obsolete. * cl.el (eql): Go into more detail in the docstring here. Don't bother checking whether both arguments are numbers; one is enough, #'equal will fail correctly if they have distinct types. (subst): Replace a call to #'integerp (deciding whether to use #'memq or not) with one to #'fixnump. Delete most-positive-fixnum, most-negative-fixnum from this file; they're now always in C, so they can't be modified from Lisp. * cl-seq.el (member*, assoc*, rassoc*): Correct these functions in the presence of bignums. * cl-macs.el (cl-make-type-test): The type test for a fixnum is now fixnump. Ditch floatp-safe, use floatp instead. (eql): Correct this compiler macro in the presence of bignums. (assoc*): Correct this compiler macro in the presence of bignums. * simple.el (undo): Change #'integerp to #'fixnump here, since we use #'delq with the same value as ELT a few lines down. src/ChangeLog addition: 2010-01-24 Aidan Kehoe <kehoea@parhasard.net> Fix problems with #'eql, extended number types, and the hash table implementation; change the Bintegerp bytecode to fixnump semantics even on bignum builds, since #'integerp can have a fast implementation in terms of #'fixnump for most of its extant uses, but not vice-versa. * lisp.h: Always #include number.h; we want the macros provided in it, even if the various number types are not available. * number.h (NON_FIXNUM_NUMBER_P): New macro, giving 1 when its argument is of non-immediate number type. Equivalent to FLOATP if WITH_NUMBER_TYPES is not defined. * elhash.c (lisp_object_eql_equal, lisp_object_eql_hash): Use NON_FIXNUM_NUMBER_P in these functions, instead of FLOATP, giving more correct behaviour in the presence of the extended number types. * bytecode.c (Bfixnump, execute_optimized_program): Rename Bintegerp to Bfixnump; change its semantics to reflect the new name on builds with bignum support. * data.c (Ffixnump, Fintegerp, syms_of_data, vars_of_data): Always make #'fixnump available, even on non-BIGNUM builds; always implement #'integerp in this file, even on BIGNUM builds. Move most-positive-fixnum, most-negative-fixnum here from number.c, so they are Lisp constants even on builds without number types, and attempts to change or bind them error. Use the NUMBERP and INTEGERP macros even on builds without extended number types. * data.c (fixnum_char_or_marker_to_int): Rename this function from integer_char_or_marker_to_int, to better reflect the arguments it accepts. * number.c (Fevenp, Foddp, syms_of_number): Never provide #'integerp in this file. Remove #'oddp, #'evenp; their implementations are overridden by those in cl.el. * number.c (vars_of_number): most-positive-fixnum, most-negative-fixnum are no longer here. man/ChangeLog addition: 2010-01-23 Aidan Kehoe <kehoea@parhasard.net> Generally: be careful to say fixnum, not integer, when talking about fixed-precision integral types. I'm sure I've missed instances, both here and in the docstrings, but this is a decent start. * lispref/text.texi (Columns): Document where only fixnums, not integers generally, are accepted. (Registers): Remove some ancient char-int confoundance here. * lispref/strings.texi (Creating Strings, Creating Strings): Be more exact in describing where fixnums but not integers in general are accepted. (Creating Strings): Use a more contemporary example to illustrate how concat deals with lists including integers about #xFF. Delete some obsolete documentation on same. (Char Table Types): Document that only fixnums are accepted as values in syntax tables. * lispref/searching.texi (String Search, Search and Replace): Be exact in describing where fixnums but not integers in general are accepted. * lispref/range-tables.texi (Range Tables): Be exact in describing them; only fixnums are accepted to describe ranges. * lispref/os.texi (Killing XEmacs, User Identification) (Time of Day, Time Conversion): Be more exact about using fixnum where only fixed-precision integers are accepted. * lispref/objects.texi (Integer Type): Be more exact (and up-to-date) about the possible values for integers. Cross-reference to documentation of the bignum extension. (Equality Predicates): (Range Table Type): (Array Type): Use fixnum, not integer, to describe a fixed-precision integer. (Syntax Table Type): Correct some English syntax here. * lispref/numbers.texi (Numbers): Change the phrasing here to use fixnum to mean the fixed-precision integers normal in emacs. Document that our terminology deviates from that of Common Lisp, and that we're working on it. (Compatibility Issues): Reiterate the Common Lisp versus Emacs Lisp compatibility issues. (Comparison of Numbers, Arithmetic Operations): * lispref/commands.texi (Command Loop Info, Working With Events): * lispref/buffers.texi (Modification Time): Be more exact in describing where fixnums but not integers in general are accepted.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 24 Jan 2010 15:21:27 +0000
parents 376386a54a3c
children 6e27daf7cbc9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 This directory contains files of elisp that customize Emacs for certain
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 terminal types.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 When Emacs starts, it checks the TERM environment variable to see what type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 of terminal the user is running on, checks for an elisp file named
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 "term/${TERM}.el", and if one exists, loads it. If that doesn't yield a file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 that exists, the last hyphen and what follows it is stripped. If that doesn't
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 yield a file that exists, the previous hyphen is stripped, and so on until all
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 hyphens are gone. For example, if the terminal type is `aaa-48-foo', Emacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 will try first `term/aaa-48-foo.el', then `term/aaa-48.el' and finally
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 `term/aaa.el'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 When writing terminal packages, there are some things it is good to keep in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 mind.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 First, about keycap names. Your terminal package can create any keycap
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 cookies it likes, but there are good reasons to stick to the set recognized by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 the X-windows code whenever possible. The key symbols recognized by Emacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 are listed in src/term.c; look for the string `keys' in that file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 For one thing, it means that you'll have the same Emacs key bindings on in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 terminal mode as on an X console. If there are differences, you can bet
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 they'll frustrate you after you've forgotten about them.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 For another, the X keysms provide a standard set of names that Emacs knows
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 about. It tries to bind many of them to useful things at startup, before your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 .emacs is read (so you can override them). In some ways, the X keysym standard
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 is a admittedly poor one; it's incomplete, and not well matched to the set of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 `virtual keys' that UNIX terminfo(3) provides. But, trust us, the alternatives
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 were worse.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 This doesn't mean that if your terminal has a "Cokebottle" key you shouldn't
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 define a [cokebottle] keycap. But if you must define cookies that aren't in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 that set, try to pattern them on the standard terminfo variable names for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 clarity; also, for a fighting chance that your binding may be useful to someone
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 else someday.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 For example, if your terminal has a `find' key, observe that terminfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 supports a key_find capability and call your cookie [key-find].
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 Here is a complete list, with corresponding X keysyms.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 -----------------------------------------------------------------------------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 Variable name cap X Keysym Description
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 -------------- --- ------------ -------------------------------------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 key_down kd down Sent by terminal down arrow key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 key_up ku up Sent by terminal up arrow key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 key_left kl left Sent by terminal left arrow key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 key_right kr right Sent by terminal right arrow key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 key_home kh home Sent by home key.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 key_backspace kb Sent by backspace key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 key_dl kd deleteline Sent by delete line key.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 key_il kA insertline Sent by insert line.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 key_dc kD Sent by delete character key.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 key_ic kI insertchar (1) Sent by ins char/enter ins mode key.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 key_eic KM Sent by rmir or smir in insert mode.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 key_clear kC Sent by clear screen or erase key.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 key_eos kS Sent by clear-to-end-of-screen key.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 key_eol kE Sent by clear-to-end-of-line key.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 key_sf kF Sent by scroll-forward/down key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 key_sr kR Sent by scroll-backward/up key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 key_npage kN next (2) Sent by next-page key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 key_ppage kP prior (2) Sent by previous-page key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 key_stab kT Sent by set-tab key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 key_ctab kt Sent by clear-tab key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 key_catab ka Sent by clear-all-tabs key.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 key_enter @8 kp-enter Enter/send (unreliable)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 key_print %9 print print or copy
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 key_ll kH Sent by home-down key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 key_a1 K1 kp-1 Upper left of keypad
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 key_a3 K3 kp-3 Upper right of keypad
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 key_b2 K2 kp-5 Center of keypad
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 key_c1 K4 kp-7 Lower left of keypad
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 key_c3 K5 kp-9 Lower right of keypad
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 key_btab kB backtab Back tab key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 key_beg @1 begin beg(inning) key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 key_cancel @2 cancel cancel key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 key_close @3 close key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 key_command @4 execute (3) cmd (command) key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 key_copy @5 copy key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 key_create @6 create key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 key_end @7 end end key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 key_exit @9 exit key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 key_find @0 find key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85 key_help %1 help key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 key_mark %2 mark key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 key_message %3 message key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 key_move %4 move key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 key_next %5 next (2) next object key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 key_open %6 open key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91 key_options %7 menu (3) options key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 key_previous %8 previous (2) previous object key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 key_redo %0 redo redo key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 key_reference &1 ref(erence) key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 key_refresh &2 refresh key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 key_replace &3 replace key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 key_restart &4 reset (3) restart key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 key_resume &5 resume key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 key_save &6 save key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 key_sbeg &9 shifted beginning key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101 key_select *6 select select key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102 key_suspend &7 suspend key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103 key_undo &8 undo undo key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105 key_scancel &0 shifted cancel key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106 key_scommand *1 shifted command key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 key_scopy *2 shifted copy key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 key_screate *3 shifted create key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 key_sdc *4 shifted delete char key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110 key_sdl *5 shifted delete line key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 key_send *7 shifted end key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112 key_seol *8 shifted clear line key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 key_sexit *9 shifted exit key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 key_sf kF shifted find key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115 key_shelp #1 shifted help key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 key_shome #2 shifted home key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117 key_sic #3 shifted input key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118 key_sleft #4 shifted left arrow key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 key_smessage %a shifted message key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120 key_smove %b shifted move key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 key_snext %c shifted next key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122 key_soptions %d shifted options key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123 key_sprevious %e shifted prev key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124 key_sprint %f shifted print key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125 key_sredo %g shifted redo key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126 key_sreplace %h shifted replace key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127 key_sright %i shifted right arrow
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128 key_sresume %j shifted resume key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129 key_ssave !1 shifted save key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 key_suspend !2 shifted suspend key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
131 key_sundo !3 shifted undo key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133 key_f0 k0 f0 (4) function key 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134 key_f1 k1 f1 function key 1
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
135 key_f2 k2 f2 function key 2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136 key_f3 k3 f3 function key 3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137 key_f4 k4 f4 function key 4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138 key_f5 k5 f5 function key 5
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 key_f6 k6 f6 function key 6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 key_f7 k7 f7 function key 7
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141 key_f8 k8 f8 function key 8
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142 key_f9 k9 f9 function key 9
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 key_f10 k; f10 (4) function key 10
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144 key_f11 F1 f11 function key 11
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 : : : :
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 key_f35 FP f35 function key 35
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147 key_f36 FQ function key 36
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148 : : : :
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149 key_f64 k1 function key 64
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
150
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151 (1) The terminfo documentation says this may be the 'insert character' or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152 `enter insert mode' key. Accordingly, key_ic is mapped to the `insertchar'
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153 keysym if there is also a key_dc key; otherwise it's mapped to `insert'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154 The presumption is that keyboards with `insert character' keys usually
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155 have `delete character' keys paired with them.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
157 (2) If there is no key_next key but there is a key_npage key, key_npage
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
158 will be bound to the `next' keysym. If there is no key_previous key but
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
159 there is a key_ppage key, key_ppage will be bound to the `previous' keysym.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
160
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161 (3) Sorry, these are not exact but they're the best we can do.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
163 (4) The uses of the "k0" capability are inconsistent; sometimes it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
164 describes F10, whereas othertimes it describes F0 and "k;" describes F10.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165 Emacs attempts to politely accommodate both systems by testing for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166 "k;", and if it is present, assuming that "k0" denotes F0, otherwise F10.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167 -----------------------------------------------------------------------------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
168
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169 The following X keysyms do *not* have terminfo equivalents. These are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
170 the cookies your terminal package will have to set up itself, if you want them:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 break
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
173 system
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
174 user
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
175 kp-backtab
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
176 kp-space
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
177 kp-tab
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
178 kp-f1
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
179 kp-f2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
180 kp-f3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 kp-f4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182 kp-multiply
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183 kp-add
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
184 kp-separator
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185 kp-subtract
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
186 kp-decimal
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
187 kp-divide
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
188 kp-0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
189 kp-2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
190 kp-4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
191 kp-6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
192 kp-8
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
193 kp-equal
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
194
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
195 In general, you should not bind any of the standard keysym names to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
196 functions in a terminal package. There's code in loaddefs.el that does that;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
197 the less people make exceptions to that, the more consistent an interface Emacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
198 will have across different keyboards. Those exceptions should go in your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
199 .emacs file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
200
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
201 Finally, if you're using a USL UNIX or a Sun box or anything else with the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
202 USL version of curses(3) on it, bear in mind that the original curses(3) had
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
203 (and still has) a very much smaller set of keycaps. In fact, the reliable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
204 ones were just the arrow keys and the first ten function keys. If you care
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
205 about making your package portable to older Berkeley machines, don't count on
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
206 the setup code to bind anything else.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
207
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
208 If your terminal's arrow key sequences are so funky that they conflict with
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
209 normal Emacs key bindings, the package should set up a function called
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
210 (enable-foo-arrow-keys), where `foo' becomes the terminal name, and leave
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
211 it up to the user's .emacs file whether to call it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
212
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
213 Before writing a terminal-support package, it's a good idea to read the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
214 existing ones and learn the common conventions.