Mercurial > hg > xemacs-beta
annotate lisp/term/README @ 5127:a9c41067dd88 ben-lisp-object
more cleanups, terminology clarification, lots of doc work
-------------------- ChangeLog entries follow: --------------------
man/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* internals/internals.texi (Introduction to Allocation):
* internals/internals.texi (Integers and Characters):
* internals/internals.texi (Allocation from Frob Blocks):
* internals/internals.texi (lrecords):
* internals/internals.texi (Low-level allocation):
Rewrite section on allocation of Lisp objects to reflect the new
reality. Remove references to nonexistent XSETINT and XSETCHAR.
modules/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* postgresql/postgresql.c (allocate_pgconn):
* postgresql/postgresql.c (allocate_pgresult):
* postgresql/postgresql.h (struct Lisp_PGconn):
* postgresql/postgresql.h (struct Lisp_PGresult):
* ldap/eldap.c (allocate_ldap):
* ldap/eldap.h (struct Lisp_LDAP):
Same changes as in src/ dir. See large log there in ChangeLog,
but basically:
ALLOC_LISP_OBJECT -> ALLOC_NORMAL_LISP_OBJECT
LISP_OBJECT_HEADER -> NORMAL_LISP_OBJECT_HEADER
../hlo/src/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* alloc.c:
* alloc.c (old_alloc_sized_lcrecord):
* alloc.c (very_old_free_lcrecord):
* alloc.c (copy_lisp_object):
* alloc.c (zero_sized_lisp_object):
* alloc.c (zero_nonsized_lisp_object):
* alloc.c (lisp_object_storage_size):
* alloc.c (free_normal_lisp_object):
* alloc.c (FREE_FIXED_TYPE_WHEN_NOT_IN_GC):
* alloc.c (ALLOC_FROB_BLOCK_LISP_OBJECT):
* alloc.c (Fcons):
* alloc.c (noseeum_cons):
* alloc.c (make_float):
* alloc.c (make_bignum):
* alloc.c (make_bignum_bg):
* alloc.c (make_ratio):
* alloc.c (make_ratio_bg):
* alloc.c (make_ratio_rt):
* alloc.c (make_bigfloat):
* alloc.c (make_bigfloat_bf):
* alloc.c (size_vector):
* alloc.c (make_compiled_function):
* alloc.c (Fmake_symbol):
* alloc.c (allocate_extent):
* alloc.c (allocate_event):
* alloc.c (make_key_data):
* alloc.c (make_button_data):
* alloc.c (make_motion_data):
* alloc.c (make_process_data):
* alloc.c (make_timeout_data):
* alloc.c (make_magic_data):
* alloc.c (make_magic_eval_data):
* alloc.c (make_eval_data):
* alloc.c (make_misc_user_data):
* alloc.c (Fmake_marker):
* alloc.c (noseeum_make_marker):
* alloc.c (size_string_direct_data):
* alloc.c (make_uninit_string):
* alloc.c (make_string_nocopy):
* alloc.c (mark_lcrecord_list):
* alloc.c (alloc_managed_lcrecord):
* alloc.c (free_managed_lcrecord):
* alloc.c (sweep_lcrecords_1):
* alloc.c (malloced_storage_size):
* buffer.c (allocate_buffer):
* buffer.c (compute_buffer_usage):
* buffer.c (DEFVAR_BUFFER_LOCAL_1):
* buffer.c (nuke_all_buffer_slots):
* buffer.c (common_init_complex_vars_of_buffer):
* buffer.h (struct buffer_text):
* buffer.h (struct buffer):
* bytecode.c:
* bytecode.c (make_compiled_function_args):
* bytecode.c (size_compiled_function_args):
* bytecode.h (struct compiled_function_args):
* casetab.c (allocate_case_table):
* casetab.h (struct Lisp_Case_Table):
* charset.h (struct Lisp_Charset):
* chartab.c (fill_char_table):
* chartab.c (Fmake_char_table):
* chartab.c (make_char_table_entry):
* chartab.c (copy_char_table_entry):
* chartab.c (Fcopy_char_table):
* chartab.c (put_char_table):
* chartab.h (struct Lisp_Char_Table_Entry):
* chartab.h (struct Lisp_Char_Table):
* console-gtk-impl.h (struct gtk_device):
* console-gtk-impl.h (struct gtk_frame):
* console-impl.h (struct console):
* console-msw-impl.h (struct Lisp_Devmode):
* console-msw-impl.h (struct mswindows_device):
* console-msw-impl.h (struct msprinter_device):
* console-msw-impl.h (struct mswindows_frame):
* console-msw-impl.h (struct mswindows_dialog_id):
* console-stream-impl.h (struct stream_console):
* console-stream.c (stream_init_console):
* console-tty-impl.h (struct tty_console):
* console-tty-impl.h (struct tty_device):
* console-tty.c (allocate_tty_console_struct):
* console-x-impl.h (struct x_device):
* console-x-impl.h (struct x_frame):
* console.c (allocate_console):
* console.c (nuke_all_console_slots):
* console.c (DEFVAR_CONSOLE_LOCAL_1):
* console.c (common_init_complex_vars_of_console):
* data.c (make_weak_list):
* data.c (make_weak_box):
* data.c (make_ephemeron):
* database.c:
* database.c (struct Lisp_Database):
* database.c (allocate_database):
* database.c (finalize_database):
* device-gtk.c (allocate_gtk_device_struct):
* device-impl.h (struct device):
* device-msw.c:
* device-msw.c (mswindows_init_device):
* device-msw.c (msprinter_init_device):
* device-msw.c (finalize_devmode):
* device-msw.c (allocate_devmode):
* device-tty.c (allocate_tty_device_struct):
* device-x.c (allocate_x_device_struct):
* device.c:
* device.c (nuke_all_device_slots):
* device.c (allocate_device):
* dialog-msw.c (handle_question_dialog_box):
* elhash.c:
* elhash.c (struct Lisp_Hash_Table):
* elhash.c (finalize_hash_table):
* elhash.c (make_general_lisp_hash_table):
* elhash.c (Fcopy_hash_table):
* elhash.h (htentry):
* emacs.c (main_1):
* eval.c:
* eval.c (size_multiple_value):
* event-stream.c (finalize_command_builder):
* event-stream.c (allocate_command_builder):
* event-stream.c (free_command_builder):
* event-stream.c (event_stream_generate_wakeup):
* event-stream.c (event_stream_resignal_wakeup):
* event-stream.c (event_stream_disable_wakeup):
* event-stream.c (event_stream_wakeup_pending_p):
* events.h (struct Lisp_Timeout):
* events.h (struct command_builder):
* extents-impl.h:
* extents-impl.h (struct extent_auxiliary):
* extents-impl.h (struct extent_info):
* extents-impl.h (set_extent_no_chase_aux_field):
* extents-impl.h (set_extent_no_chase_normal_field):
* extents.c:
* extents.c (gap_array_marker):
* extents.c (gap_array):
* extents.c (extent_list_marker):
* extents.c (extent_list):
* extents.c (stack_of_extents):
* extents.c (gap_array_make_marker):
* extents.c (extent_list_make_marker):
* extents.c (allocate_extent_list):
* extents.c (SLOT):
* extents.c (mark_extent_auxiliary):
* extents.c (allocate_extent_auxiliary):
* extents.c (attach_extent_auxiliary):
* extents.c (size_gap_array):
* extents.c (finalize_extent_info):
* extents.c (allocate_extent_info):
* extents.c (uninit_buffer_extents):
* extents.c (allocate_soe):
* extents.c (copy_extent):
* extents.c (vars_of_extents):
* extents.h:
* faces.c (allocate_face):
* faces.h (struct Lisp_Face):
* faces.h (struct face_cachel):
* file-coding.c:
* file-coding.c (finalize_coding_system):
* file-coding.c (sizeof_coding_system):
* file-coding.c (Fcopy_coding_system):
* file-coding.h (struct Lisp_Coding_System):
* file-coding.h (MARKED_SLOT):
* fns.c (size_bit_vector):
* font-mgr.c:
* font-mgr.c (finalize_fc_pattern):
* font-mgr.c (print_fc_pattern):
* font-mgr.c (Ffc_pattern_p):
* font-mgr.c (Ffc_pattern_create):
* font-mgr.c (Ffc_name_parse):
* font-mgr.c (Ffc_name_unparse):
* font-mgr.c (Ffc_pattern_duplicate):
* font-mgr.c (Ffc_pattern_add):
* font-mgr.c (Ffc_pattern_del):
* font-mgr.c (Ffc_pattern_get):
* font-mgr.c (fc_config_create_using):
* font-mgr.c (fc_strlist_to_lisp_using):
* font-mgr.c (fontset_to_list):
* font-mgr.c (Ffc_config_p):
* font-mgr.c (Ffc_config_up_to_date):
* font-mgr.c (Ffc_config_build_fonts):
* font-mgr.c (Ffc_config_get_cache):
* font-mgr.c (Ffc_config_get_fonts):
* font-mgr.c (Ffc_config_set_current):
* font-mgr.c (Ffc_config_get_blanks):
* font-mgr.c (Ffc_config_get_rescan_interval):
* font-mgr.c (Ffc_config_set_rescan_interval):
* font-mgr.c (Ffc_config_app_font_add_file):
* font-mgr.c (Ffc_config_app_font_add_dir):
* font-mgr.c (Ffc_config_app_font_clear):
* font-mgr.c (size):
* font-mgr.c (Ffc_config_substitute):
* font-mgr.c (Ffc_font_render_prepare):
* font-mgr.c (Ffc_font_match):
* font-mgr.c (Ffc_font_sort):
* font-mgr.c (finalize_fc_config):
* font-mgr.c (print_fc_config):
* font-mgr.h:
* font-mgr.h (struct fc_pattern):
* font-mgr.h (XFC_PATTERN):
* font-mgr.h (struct fc_config):
* font-mgr.h (XFC_CONFIG):
* frame-gtk.c (allocate_gtk_frame_struct):
* frame-impl.h (struct frame):
* frame-msw.c (mswindows_init_frame_1):
* frame-x.c (allocate_x_frame_struct):
* frame.c (nuke_all_frame_slots):
* frame.c (allocate_frame_core):
* gc.c:
* gc.c (GC_CHECK_NOT_FREE):
* glyphs.c (finalize_image_instance):
* glyphs.c (allocate_image_instance):
* glyphs.c (Fcolorize_image_instance):
* glyphs.c (allocate_glyph):
* glyphs.c (unmap_subwindow_instance_cache_mapper):
* glyphs.c (register_ignored_expose):
* glyphs.h (struct Lisp_Image_Instance):
* glyphs.h (struct Lisp_Glyph):
* glyphs.h (struct glyph_cachel):
* glyphs.h (struct expose_ignore):
* gui.c (allocate_gui_item):
* gui.h (struct Lisp_Gui_Item):
* keymap.c (struct Lisp_Keymap):
* keymap.c (make_keymap):
* lisp.h:
* lisp.h (struct Lisp_String_Direct_Data):
* lisp.h (struct Lisp_String_Indirect_Data):
* lisp.h (struct Lisp_Vector):
* lisp.h (struct Lisp_Bit_Vector):
* lisp.h (DECLARE_INLINE_LISP_BIT_VECTOR):
* lisp.h (struct weak_box):
* lisp.h (struct ephemeron):
* lisp.h (struct weak_list):
* lrecord.h:
* lrecord.h (struct lrecord_implementation):
* lrecord.h (MC_ALLOC_CALL_FINALIZER):
* lrecord.h (struct lcrecord_list):
* lstream.c (finalize_lstream):
* lstream.c (sizeof_lstream):
* lstream.c (Lstream_new):
* lstream.c (Lstream_delete):
* lstream.h (struct lstream):
* marker.c:
* marker.c (finalize_marker):
* marker.c (compute_buffer_marker_usage):
* mule-charset.c:
* mule-charset.c (make_charset):
* mule-charset.c (compute_charset_usage):
* objects-impl.h (struct Lisp_Color_Instance):
* objects-impl.h (struct Lisp_Font_Instance):
* objects-tty-impl.h (struct tty_color_instance_data):
* objects-tty-impl.h (struct tty_font_instance_data):
* objects-tty.c (tty_initialize_color_instance):
* objects-tty.c (tty_initialize_font_instance):
* objects.c (finalize_color_instance):
* objects.c (Fmake_color_instance):
* objects.c (finalize_font_instance):
* objects.c (Fmake_font_instance):
* objects.c (reinit_vars_of_objects):
* opaque.c:
* opaque.c (sizeof_opaque):
* opaque.c (make_opaque_ptr):
* opaque.c (free_opaque_ptr):
* opaque.h:
* opaque.h (Lisp_Opaque):
* opaque.h (Lisp_Opaque_Ptr):
* print.c (printing_unreadable_lcrecord):
* print.c (external_object_printer):
* print.c (debug_p4):
* process.c (finalize_process):
* process.c (make_process_internal):
* procimpl.h (struct Lisp_Process):
* rangetab.c (Fmake_range_table):
* rangetab.c (Fcopy_range_table):
* rangetab.h (struct Lisp_Range_Table):
* scrollbar.c:
* scrollbar.c (create_scrollbar_instance):
* scrollbar.c (compute_scrollbar_instance_usage):
* scrollbar.h (struct scrollbar_instance):
* specifier.c (finalize_specifier):
* specifier.c (sizeof_specifier):
* specifier.c (set_specifier_caching):
* specifier.h (struct Lisp_Specifier):
* specifier.h (struct specifier_caching):
* symeval.h:
* symeval.h (SYMBOL_VALUE_MAGIC_P):
* symeval.h (DEFVAR_SYMVAL_FWD):
* symsinit.h:
* syntax.c (init_buffer_syntax_cache):
* syntax.h (struct syntax_cache):
* toolbar.c:
* toolbar.c (allocate_toolbar_button):
* toolbar.c (update_toolbar_button):
* toolbar.h (struct toolbar_button):
* tooltalk.c (struct Lisp_Tooltalk_Message):
* tooltalk.c (make_tooltalk_message):
* tooltalk.c (struct Lisp_Tooltalk_Pattern):
* tooltalk.c (make_tooltalk_pattern):
* ui-gtk.c:
* ui-gtk.c (allocate_ffi_data):
* ui-gtk.c (emacs_gtk_object_finalizer):
* ui-gtk.c (allocate_emacs_gtk_object_data):
* ui-gtk.c (allocate_emacs_gtk_boxed_data):
* ui-gtk.h:
* window-impl.h (struct window):
* window-impl.h (struct window_mirror):
* window.c (finalize_window):
* window.c (allocate_window):
* window.c (new_window_mirror):
* window.c (mark_window_as_deleted):
* window.c (make_dummy_parent):
* window.c (compute_window_mirror_usage):
* window.c (compute_window_usage):
Overall point of this change and previous ones in this repository:
(1) Introduce new, clearer terminology: everything other than int
or char is a "record" object, which comes in two types: "normal
objects" and "frob-block objects". Fix up all places that
referred to frob-block objects as "simple", "basic", etc.
(2) Provide an advertised interface for doing operations on Lisp
objects, including creating new types, that is clean and
consistent in its naming, uses the above-referenced terms and
avoids referencing "lrecords", "old lcrecords", etc., which should
hide under the surface.
(3) Make the size_in_bytes and finalizer methods take a
Lisp_Object rather than a void * for consistency with other methods.
(4) Separate finalizer method into finalizer and disksaver, so
that normal finalize methods don't have to worry about disksaving.
Other specifics:
(1) Renaming:
LISP_OBJECT_HEADER -> NORMAL_LISP_OBJECT_HEADER
ALLOC_LISP_OBJECT -> ALLOC_NORMAL_LISP_OBJECT
implementation->basic_p -> implementation->frob_block_p
ALLOCATE_FIXED_TYPE_AND_SET_IMPL -> ALLOC_FROB_BLOCK_LISP_OBJECT
*FCCONFIG*, wrap_fcconfig -> *FC_CONFIG*, wrap_fc_config
*FCPATTERN*, wrap_fcpattern -> *FC_PATTERN*, wrap_fc_pattern
(the last two changes make the naming of these macros consistent
with the naming of all other macros, since the objects are named
fc-config and fc-pattern with a hyphen)
(2) Lots of documentation fixes in lrecord.h.
(3) Eliminate macros for copying, freeing, zeroing objects, getting
their storage size. Instead, new functions:
zero_sized_lisp_object()
zero_nonsized_lisp_object()
lisp_object_storage_size()
free_normal_lisp_object()
(copy_lisp_object() already exists)
LISP_OBJECT_FROB_BLOCK_P() (actually a macro)
Eliminated:
free_lrecord()
zero_lrecord()
copy_lrecord()
copy_sized_lrecord()
old_copy_lcrecord()
old_copy_sized_lcrecord()
old_zero_lcrecord()
old_zero_sized_lcrecord()
LISP_OBJECT_STORAGE_SIZE()
COPY_SIZED_LISP_OBJECT()
COPY_SIZED_LCRECORD()
COPY_LISP_OBJECT()
ZERO_LISP_OBJECT()
FREE_LISP_OBJECT()
(4) Catch the remaining places where lrecord stuff was used directly
and use the advertised interface, e.g. alloc_sized_lrecord() ->
ALLOC_SIZED_LISP_OBJECT().
(5) Make certain statically-declared pseudo-objects
(buffer_local_flags, console_local_flags) have their lheader
initialized correctly, so things like copy_lisp_object() can work
on them. Make extent_auxiliary_defaults a proper heap object
Vextent_auxiliary_defaults, and make extent auxiliaries dumpable
so that this object can be dumped. allocate_extent_auxiliary()
now just creates the object, and attach_extent_auxiliary()
creates an extent auxiliary and attaches to an extent, like the
old allocate_extent_auxiliary().
(6) Create EXTENT_AUXILIARY_SLOTS macro, similar to the foo-slots.h
files but in a macro instead of a file. The purpose is to avoid
duplication when iterating over all the slots in an extent auxiliary.
Use it.
(7) In lstream.c, don't zero out object after allocation because
allocation routines take care of this.
(8) In marker.c, fix a mistake in computing marker overhead.
(9) In print.c, clean up printing_unreadable_lcrecord(),
external_object_printer() to avoid lots of ifdef NEW_GC's.
(10) Separate toolbar-button allocation into a separate
allocate_toolbar_button() function for use in the example code
in lrecord.h.
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Fri, 05 Mar 2010 04:08:17 -0600 |
| parents | 376386a54a3c |
| children | 6e27daf7cbc9 |
| rev | line source |
|---|---|
| 0 | 1 This directory contains files of elisp that customize Emacs for certain |
| 2 terminal types. | |
| 3 | |
| 4 When Emacs starts, it checks the TERM environment variable to see what type | |
| 5 of terminal the user is running on, checks for an elisp file named | |
| 6 "term/${TERM}.el", and if one exists, loads it. If that doesn't yield a file | |
| 7 that exists, the last hyphen and what follows it is stripped. If that doesn't | |
| 8 yield a file that exists, the previous hyphen is stripped, and so on until all | |
| 9 hyphens are gone. For example, if the terminal type is `aaa-48-foo', Emacs | |
| 10 will try first `term/aaa-48-foo.el', then `term/aaa-48.el' and finally | |
| 11 `term/aaa.el'. | |
| 12 | |
| 13 When writing terminal packages, there are some things it is good to keep in | |
| 14 mind. | |
| 15 | |
| 16 First, about keycap names. Your terminal package can create any keycap | |
| 17 cookies it likes, but there are good reasons to stick to the set recognized by | |
| 18 the X-windows code whenever possible. The key symbols recognized by Emacs | |
| 19 are listed in src/term.c; look for the string `keys' in that file. | |
| 20 | |
| 21 For one thing, it means that you'll have the same Emacs key bindings on in | |
| 22 terminal mode as on an X console. If there are differences, you can bet | |
| 23 they'll frustrate you after you've forgotten about them. | |
| 24 | |
| 25 For another, the X keysms provide a standard set of names that Emacs knows | |
| 26 about. It tries to bind many of them to useful things at startup, before your | |
| 27 .emacs is read (so you can override them). In some ways, the X keysym standard | |
| 28 is a admittedly poor one; it's incomplete, and not well matched to the set of | |
| 29 `virtual keys' that UNIX terminfo(3) provides. But, trust us, the alternatives | |
| 30 were worse. | |
| 31 | |
| 32 This doesn't mean that if your terminal has a "Cokebottle" key you shouldn't | |
| 33 define a [cokebottle] keycap. But if you must define cookies that aren't in | |
| 34 that set, try to pattern them on the standard terminfo variable names for | |
| 35 clarity; also, for a fighting chance that your binding may be useful to someone | |
| 36 else someday. | |
| 37 | |
| 38 For example, if your terminal has a `find' key, observe that terminfo | |
| 39 supports a key_find capability and call your cookie [key-find]. | |
| 40 | |
| 41 Here is a complete list, with corresponding X keysyms. | |
| 42 | |
| 43 ----------------------------------------------------------------------------- | |
| 44 Variable name cap X Keysym Description | |
| 45 -------------- --- ------------ ------------------------------------- | |
| 46 key_down kd down Sent by terminal down arrow key | |
| 47 key_up ku up Sent by terminal up arrow key | |
| 48 key_left kl left Sent by terminal left arrow key | |
| 49 key_right kr right Sent by terminal right arrow key | |
| 50 key_home kh home Sent by home key. | |
| 51 key_backspace kb Sent by backspace key | |
| 52 key_dl kd deleteline Sent by delete line key. | |
| 53 key_il kA insertline Sent by insert line. | |
| 54 key_dc kD Sent by delete character key. | |
| 55 key_ic kI insertchar (1) Sent by ins char/enter ins mode key. | |
| 56 key_eic KM Sent by rmir or smir in insert mode. | |
| 57 key_clear kC Sent by clear screen or erase key. | |
| 58 key_eos kS Sent by clear-to-end-of-screen key. | |
| 59 key_eol kE Sent by clear-to-end-of-line key. | |
| 60 key_sf kF Sent by scroll-forward/down key | |
| 61 key_sr kR Sent by scroll-backward/up key | |
| 62 key_npage kN next (2) Sent by next-page key | |
| 63 key_ppage kP prior (2) Sent by previous-page key | |
| 64 key_stab kT Sent by set-tab key | |
| 65 key_ctab kt Sent by clear-tab key | |
| 66 key_catab ka Sent by clear-all-tabs key. | |
| 67 key_enter @8 kp-enter Enter/send (unreliable) | |
| 68 key_print %9 print print or copy | |
| 69 key_ll kH Sent by home-down key | |
| 70 key_a1 K1 kp-1 Upper left of keypad | |
| 71 key_a3 K3 kp-3 Upper right of keypad | |
| 72 key_b2 K2 kp-5 Center of keypad | |
| 73 key_c1 K4 kp-7 Lower left of keypad | |
| 74 key_c3 K5 kp-9 Lower right of keypad | |
| 75 key_btab kB backtab Back tab key | |
| 76 key_beg @1 begin beg(inning) key | |
| 77 key_cancel @2 cancel cancel key | |
| 78 key_close @3 close key | |
| 79 key_command @4 execute (3) cmd (command) key | |
| 80 key_copy @5 copy key | |
| 81 key_create @6 create key | |
| 82 key_end @7 end end key | |
| 83 key_exit @9 exit key | |
| 84 key_find @0 find key | |
| 85 key_help %1 help key | |
| 86 key_mark %2 mark key | |
| 87 key_message %3 message key | |
| 88 key_move %4 move key | |
| 89 key_next %5 next (2) next object key | |
| 90 key_open %6 open key | |
| 91 key_options %7 menu (3) options key | |
| 92 key_previous %8 previous (2) previous object key | |
| 93 key_redo %0 redo redo key | |
| 94 key_reference &1 ref(erence) key | |
| 95 key_refresh &2 refresh key | |
| 96 key_replace &3 replace key | |
| 97 key_restart &4 reset (3) restart key | |
| 98 key_resume &5 resume key | |
| 99 key_save &6 save key | |
| 100 key_sbeg &9 shifted beginning key | |
| 101 key_select *6 select select key | |
| 102 key_suspend &7 suspend key | |
| 103 key_undo &8 undo undo key | |
| 104 | |
| 105 key_scancel &0 shifted cancel key | |
| 106 key_scommand *1 shifted command key | |
| 107 key_scopy *2 shifted copy key | |
| 108 key_screate *3 shifted create key | |
| 109 key_sdc *4 shifted delete char key | |
| 110 key_sdl *5 shifted delete line key | |
| 111 key_send *7 shifted end key | |
| 112 key_seol *8 shifted clear line key | |
| 113 key_sexit *9 shifted exit key | |
| 114 key_sf kF shifted find key | |
| 115 key_shelp #1 shifted help key | |
| 116 key_shome #2 shifted home key | |
| 117 key_sic #3 shifted input key | |
| 118 key_sleft #4 shifted left arrow key | |
| 119 key_smessage %a shifted message key | |
| 120 key_smove %b shifted move key | |
| 121 key_snext %c shifted next key | |
| 122 key_soptions %d shifted options key | |
| 123 key_sprevious %e shifted prev key | |
| 124 key_sprint %f shifted print key | |
| 125 key_sredo %g shifted redo key | |
| 126 key_sreplace %h shifted replace key | |
| 127 key_sright %i shifted right arrow | |
| 128 key_sresume %j shifted resume key | |
| 129 key_ssave !1 shifted save key | |
| 130 key_suspend !2 shifted suspend key | |
| 131 key_sundo !3 shifted undo key | |
| 132 | |
| 133 key_f0 k0 f0 (4) function key 0 | |
| 134 key_f1 k1 f1 function key 1 | |
| 135 key_f2 k2 f2 function key 2 | |
| 136 key_f3 k3 f3 function key 3 | |
| 137 key_f4 k4 f4 function key 4 | |
| 138 key_f5 k5 f5 function key 5 | |
| 139 key_f6 k6 f6 function key 6 | |
| 140 key_f7 k7 f7 function key 7 | |
| 141 key_f8 k8 f8 function key 8 | |
| 142 key_f9 k9 f9 function key 9 | |
| 143 key_f10 k; f10 (4) function key 10 | |
| 144 key_f11 F1 f11 function key 11 | |
| 145 : : : : | |
| 146 key_f35 FP f35 function key 35 | |
| 147 key_f36 FQ function key 36 | |
| 148 : : : : | |
| 149 key_f64 k1 function key 64 | |
| 150 | |
| 151 (1) The terminfo documentation says this may be the 'insert character' or | |
| 152 `enter insert mode' key. Accordingly, key_ic is mapped to the `insertchar' | |
| 153 keysym if there is also a key_dc key; otherwise it's mapped to `insert'. | |
| 154 The presumption is that keyboards with `insert character' keys usually | |
| 155 have `delete character' keys paired with them. | |
| 156 | |
| 157 (2) If there is no key_next key but there is a key_npage key, key_npage | |
| 158 will be bound to the `next' keysym. If there is no key_previous key but | |
| 159 there is a key_ppage key, key_ppage will be bound to the `previous' keysym. | |
| 160 | |
| 161 (3) Sorry, these are not exact but they're the best we can do. | |
| 162 | |
| 163 (4) The uses of the "k0" capability are inconsistent; sometimes it | |
| 164 describes F10, whereas othertimes it describes F0 and "k;" describes F10. | |
| 165 Emacs attempts to politely accommodate both systems by testing for | |
| 166 "k;", and if it is present, assuming that "k0" denotes F0, otherwise F10. | |
| 167 ----------------------------------------------------------------------------- | |
| 168 | |
| 169 The following X keysyms do *not* have terminfo equivalents. These are | |
| 170 the cookies your terminal package will have to set up itself, if you want them: | |
| 171 | |
| 172 break | |
| 173 system | |
| 174 user | |
| 175 kp-backtab | |
| 176 kp-space | |
| 177 kp-tab | |
| 178 kp-f1 | |
| 179 kp-f2 | |
| 180 kp-f3 | |
| 181 kp-f4 | |
| 182 kp-multiply | |
| 183 kp-add | |
| 184 kp-separator | |
| 185 kp-subtract | |
| 186 kp-decimal | |
| 187 kp-divide | |
| 188 kp-0 | |
| 189 kp-2 | |
| 190 kp-4 | |
| 191 kp-6 | |
| 192 kp-8 | |
| 193 kp-equal | |
| 194 | |
| 195 In general, you should not bind any of the standard keysym names to | |
| 196 functions in a terminal package. There's code in loaddefs.el that does that; | |
| 197 the less people make exceptions to that, the more consistent an interface Emacs | |
| 198 will have across different keyboards. Those exceptions should go in your | |
| 199 .emacs file. | |
| 200 | |
| 201 Finally, if you're using a USL UNIX or a Sun box or anything else with the | |
| 202 USL version of curses(3) on it, bear in mind that the original curses(3) had | |
| 203 (and still has) a very much smaller set of keycaps. In fact, the reliable | |
| 204 ones were just the arrow keys and the first ten function keys. If you care | |
| 205 about making your package portable to older Berkeley machines, don't count on | |
| 206 the setup code to bind anything else. | |
| 207 | |
| 208 If your terminal's arrow key sequences are so funky that they conflict with | |
| 209 normal Emacs key bindings, the package should set up a function called | |
| 210 (enable-foo-arrow-keys), where `foo' becomes the terminal name, and leave | |
| 211 it up to the user's .emacs file whether to call it. | |
| 212 | |
| 213 Before writing a terminal-support package, it's a good idea to read the | |
| 214 existing ones and learn the common conventions. |