Mercurial > hg > xemacs-beta
annotate lisp/term/README @ 4981:4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
-------------------- ChangeLog entries follow: --------------------
modules/ChangeLog addition:
2010-02-05 Ben Wing <ben@xemacs.org>
* postgresql/postgresql.c:
* postgresql/postgresql.c (CHECK_LIVE_CONNECTION):
* postgresql/postgresql.c (Fpq_connectdb):
* postgresql/postgresql.c (Fpq_connect_start):
* postgresql/postgresql.c (Fpq_lo_import):
* postgresql/postgresql.c (Fpq_lo_export):
* ldap/eldap.c (Fldap_open):
* ldap/eldap.c (Fldap_search_basic):
* ldap/eldap.c (Fldap_add):
* ldap/eldap.c (Fldap_modify):
* ldap/eldap.c (Fldap_delete):
* canna/canna_api.c (Fcanna_initialize):
* canna/canna_api.c (Fcanna_store_yomi):
* canna/canna_api.c (Fcanna_parse):
* canna/canna_api.c (Fcanna_henkan_begin):
EXTERNAL_TO_C_STRING returns its argument instead of storing it
in a parameter, and is renamed to EXTERNAL_TO_ITEXT. Similar
things happen to related macros. See entry in src/ChangeLog.
More Mule-izing of postgresql.c. Extract out common code
between `pq-connectdb' and `pq-connect-start'. Fix places
that signal an error string using a formatted string to instead
follow the standard and have a fixed reason followed by the
particular error message stored as one of the frobs.
src/ChangeLog addition:
2010-02-05 Ben Wing <ben@xemacs.org>
* console-msw.c (write_string_to_mswindows_debugging_output):
* console-msw.c (Fmswindows_message_box):
* console-x.c (x_perhaps_init_unseen_key_defaults):
* console.c:
* database.c (dbm_get):
* database.c (dbm_put):
* database.c (dbm_remove):
* database.c (berkdb_get):
* database.c (berkdb_put):
* database.c (berkdb_remove):
* database.c (Fopen_database):
* device-gtk.c (gtk_init_device):
* device-msw.c (msprinter_init_device_internal):
* device-msw.c (msprinter_default_printer):
* device-msw.c (msprinter_init_device):
* device-msw.c (sync_printer_with_devmode):
* device-msw.c (Fmsprinter_select_settings):
* device-x.c (sanity_check_geometry_resource):
* device-x.c (Dynarr_add_validified_lisp_string):
* device-x.c (x_init_device):
* device-x.c (Fx_put_resource):
* device-x.c (Fx_valid_keysym_name_p):
* device-x.c (Fx_set_font_path):
* dialog-msw.c (push_lisp_string_as_unicode):
* dialog-msw.c (handle_directory_dialog_box):
* dialog-msw.c (handle_file_dialog_box):
* dialog-x.c (dbox_descriptor_to_widget_value):
* editfns.c (Fformat_time_string):
* editfns.c (Fencode_time):
* editfns.c (Fset_time_zone_rule):
* emacs.c (make_argc_argv):
* emacs.c (Fdump_emacs):
* emodules.c (emodules_load):
* eval.c:
* eval.c (maybe_signal_error_1):
* event-msw.c (Fdde_alloc_advise_item):
* event-msw.c (mswindows_dde_callback):
* event-msw.c (mswindows_wnd_proc):
* fileio.c (report_error_with_errno):
* fileio.c (Fsysnetunam):
* fileio.c (Fdo_auto_save):
* font-mgr.c (extract_fcapi_string):
* font-mgr.c (Ffc_config_app_font_add_file):
* font-mgr.c (Ffc_config_app_font_add_dir):
* font-mgr.c (Ffc_config_filename):
* frame-gtk.c (gtk_set_frame_text_value):
* frame-gtk.c (gtk_create_widgets):
* frame-msw.c (mswindows_init_frame_1):
* frame-msw.c (mswindows_set_title_from_ibyte):
* frame-msw.c (msprinter_init_frame_3):
* frame-x.c (x_set_frame_text_value):
* frame-x.c (x_set_frame_properties):
* frame-x.c (start_drag_internal_1):
* frame-x.c (x_cde_transfer_callback):
* frame-x.c (x_create_widgets):
* glyphs-eimage.c (my_jpeg_output_message):
* glyphs-eimage.c (jpeg_instantiate):
* glyphs-eimage.c (gif_instantiate):
* glyphs-eimage.c (png_instantiate):
* glyphs-eimage.c (tiff_instantiate):
* glyphs-gtk.c (xbm_instantiate_1):
* glyphs-gtk.c (gtk_xbm_instantiate):
* glyphs-gtk.c (gtk_xpm_instantiate):
* glyphs-gtk.c (gtk_xface_instantiate):
* glyphs-gtk.c (cursor_font_instantiate):
* glyphs-gtk.c (gtk_redisplay_widget):
* glyphs-gtk.c (gtk_widget_instantiate_1):
* glyphs-gtk.c (gtk_add_tab_item):
* glyphs-msw.c (mswindows_xpm_instantiate):
* glyphs-msw.c (bmp_instantiate):
* glyphs-msw.c (mswindows_resource_instantiate):
* glyphs-msw.c (xbm_instantiate_1):
* glyphs-msw.c (mswindows_xbm_instantiate):
* glyphs-msw.c (mswindows_xface_instantiate):
* glyphs-msw.c (mswindows_redisplay_widget):
* glyphs-msw.c (mswindows_widget_instantiate):
* glyphs-msw.c (add_tree_item):
* glyphs-msw.c (add_tab_item):
* glyphs-msw.c (mswindows_combo_box_instantiate):
* glyphs-msw.c (mswindows_widget_query_string_geometry):
* glyphs-x.c (x_locate_pixmap_file):
* glyphs-x.c (xbm_instantiate_1):
* glyphs-x.c (x_xbm_instantiate):
* glyphs-x.c (extract_xpm_color_names):
* glyphs-x.c (x_xpm_instantiate):
* glyphs-x.c (x_xface_instantiate):
* glyphs-x.c (autodetect_instantiate):
* glyphs-x.c (safe_XLoadFont):
* glyphs-x.c (cursor_font_instantiate):
* glyphs-x.c (x_redisplay_widget):
* glyphs-x.c (Fchange_subwindow_property):
* glyphs-x.c (x_widget_instantiate):
* glyphs-x.c (x_tab_control_redisplay):
* glyphs.c (pixmap_to_lisp_data):
* gui-x.c (menu_separator_style_and_to_external):
* gui-x.c (add_accel_and_to_external):
* gui-x.c (button_item_to_widget_value):
* hpplay.c (player_error_internal):
* hpplay.c (play_sound_file):
* hpplay.c (play_sound_data):
* intl.c (Fset_current_locale):
* lisp.h:
* menubar-gtk.c (gtk_xemacs_set_accel_keys):
* menubar-msw.c (populate_menu_add_item):
* menubar-msw.c (populate_or_checksum_helper):
* menubar-x.c (menu_item_descriptor_to_widget_value_1):
* nt.c (init_user_info):
* nt.c (get_long_basename):
* nt.c (nt_get_resource):
* nt.c (init_mswindows_environment):
* nt.c (get_cached_volume_information):
* nt.c (mswindows_readdir):
* nt.c (read_unc_volume):
* nt.c (mswindows_stat):
* nt.c (mswindows_getdcwd):
* nt.c (mswindows_executable_type):
* nt.c (Fmswindows_short_file_name):
* ntplay.c (nt_play_sound_file):
* objects-gtk.c:
* objects-gtk.c (gtk_valid_color_name_p):
* objects-gtk.c (gtk_initialize_font_instance):
* objects-gtk.c (gtk_font_list):
* objects-msw.c (font_enum_callback_2):
* objects-msw.c (parse_font_spec):
* objects-x.c (x_parse_nearest_color):
* objects-x.c (x_valid_color_name_p):
* objects-x.c (x_initialize_font_instance):
* objects-x.c (x_font_instance_truename):
* objects-x.c (x_font_list):
* objects-xlike-inc.c (XFUN):
* objects-xlike-inc.c (xft_find_charset_font):
* process-nt.c (mswindows_report_winsock_error):
* process-nt.c (nt_create_process):
* process-nt.c (get_internet_address):
* process-nt.c (nt_open_network_stream):
* process-unix.c:
* process-unix.c (allocate_pty):
* process-unix.c (get_internet_address):
* process-unix.c (unix_canonicalize_host_name):
* process-unix.c (unix_open_network_stream):
* realpath.c:
* select-common.h (lisp_data_to_selection_data):
* select-gtk.c (symbol_to_gtk_atom):
* select-gtk.c (atom_to_symbol):
* select-msw.c (symbol_to_ms_cf):
* select-msw.c (mswindows_register_selection_data_type):
* select-x.c (symbol_to_x_atom):
* select-x.c (x_atom_to_symbol):
* select-x.c (hack_motif_clipboard_selection):
* select-x.c (Fx_store_cutbuffer_internal):
* sound.c (Fplay_sound_file):
* sound.c (Fplay_sound):
* sound.h (sound_perror):
* sysdep.c:
* sysdep.c (qxe_allocating_getcwd):
* sysdep.c (qxe_execve):
* sysdep.c (copy_in_passwd):
* sysdep.c (qxe_getpwnam):
* sysdep.c (qxe_ctime):
* sysdll.c (dll_open):
* sysdll.c (dll_function):
* sysdll.c (dll_variable):
* sysdll.c (search_linked_libs):
* sysdll.c (dll_error):
* sysfile.h:
* sysfile.h (PATHNAME_CONVERT_OUT_TSTR):
* sysfile.h (PATHNAME_CONVERT_OUT_UTF_8):
* sysfile.h (PATHNAME_CONVERT_OUT):
* sysfile.h (LISP_PATHNAME_CONVERT_OUT):
* syswindows.h (ITEXT_TO_TSTR):
* syswindows.h (LOCAL_FILE_FORMAT_TO_TSTR):
* syswindows.h (TSTR_TO_LOCAL_FILE_FORMAT):
* syswindows.h (LOCAL_FILE_FORMAT_TO_INTERNAL_MSWIN):
* syswindows.h (LISP_LOCAL_FILE_FORMAT_MAYBE_URL_TO_TSTR):
* text.h:
* text.h (eicpy_ext_len):
* text.h (enum new_dfc_src_type):
* text.h (EXTERNAL_TO_ITEXT):
* text.h (GET_STRERROR):
* tooltalk.c (check_status):
* tooltalk.c (Fadd_tooltalk_message_arg):
* tooltalk.c (Fadd_tooltalk_pattern_attribute):
* tooltalk.c (Fadd_tooltalk_pattern_arg):
* win32.c (tstr_to_local_file_format):
* win32.c (mswindows_lisp_error_1):
* win32.c (mswindows_report_process_error):
* win32.c (Fmswindows_shell_execute):
* win32.c (mswindows_read_link_1):
Changes involving external/internal format conversion,
mostly code cleanup and renaming.
1. Eliminate the previous macros like LISP_STRING_TO_EXTERNAL
that stored its result in a parameter. The new version of
LISP_STRING_TO_EXTERNAL returns its result through the
return value, same as the previous NEW_LISP_STRING_TO_EXTERNAL.
Use the new-style macros throughout the code.
2. Rename C_STRING_TO_EXTERNAL and friends to ITEXT_TO_EXTERNAL,
in keeping with overall naming rationalization involving
Itext and related types.
Macros involved in previous two:
EXTERNAL_TO_C_STRING -> EXTERNAL_TO_ITEXT
EXTERNAL_TO_C_STRING_MALLOC -> EXTERNAL_TO_ITEXT_MALLOC
SIZED_EXTERNAL_TO_C_STRING -> SIZED_EXTERNAL_TO_ITEXT
SIZED_EXTERNAL_TO_C_STRING_MALLOC -> SIZED_EXTERNAL_TO_ITEXT_MALLOC
C_STRING_TO_EXTERNAL -> ITEXT_TO_EXTERNAL
C_STRING_TO_EXTERNAL_MALLOC -> ITEXT_TO_EXTERNAL_MALLOC
LISP_STRING_TO_EXTERNAL
LISP_STRING_TO_EXTERNAL_MALLOC
LISP_STRING_TO_TSTR
C_STRING_TO_TSTR -> ITEXT_TO_TSTR
TSTR_TO_C_STRING -> TSTR_TO_ITEXT
The following four still return their values through parameters,
since they have more than one value to return:
C_STRING_TO_SIZED_EXTERNAL -> ITEXT_TO_SIZED_EXTERNAL
LISP_STRING_TO_SIZED_EXTERNAL
C_STRING_TO_SIZED_EXTERNAL_MALLOC -> ITEXT_TO_SIZED_EXTERNAL_MALLOC
LISP_STRING_TO_SIZED_EXTERNAL_MALLOC
Sometimes additional casts had to be inserted, since the old
macros played strange games and completely defeated the type system
of the store params.
3. Rewrite many places where direct calls to TO_EXTERNAL_FORMAT
occurred with calls to one of the convenience macros listed above,
or to make_extstring().
4. Eliminate SIZED_C_STRING macros (they were hardly used, anyway)
and use a direct call to TO_EXTERNAL_FORMAT or TO_INTERNAL_FORMAT.
4. Use LISP_PATHNAME_CONVERT_OUT in many places instead of something
like LISP_STRING_TO_EXTERNAL(..., Qfile_name).
5. Eliminate some temporary variables that are no longer necessary
now that we return a value rather than storing it into a variable.
6. Some Mule-izing in database.c.
7. Error functions:
-- A bit of code cleanup in maybe_signal_error_1.
-- Eliminate report_file_type_error; it's just an alias for
signal_error_2 with params in a different order.
-- Fix some places in the hostname-handling code that directly
inserted externally-retrieved error strings into the
supposed ASCII "reason" param instead of doing the right thing
and sticking text descriptive of what was going on in "reason"
and putting the external message in a frob.
8. Use Ascbyte instead of CIbyte in process-unix.c and maybe one
or two other places.
9. Some code cleanup in copy_in_passwd() in sysdep.c.
10. Fix a real bug due to accidental variable shadowing in
tstr_to_local_file_format() in win32.c.
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Fri, 05 Feb 2010 11:02:24 -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. |