Mercurial > hg > xemacs-beta
annotate src/console.h @ 5258:1ed4cefddd12
Add a couple of extra docstring backslashes, #'format-time-string
2010-09-05 Aidan Kehoe <kehoea@parhasard.net>
* editfns.c (Fformat_time_string):
Use two backslashes so that there is at least one present in the
output of describe function, when describing the Roman month
number syntax in this function's docstring. Thanks for provoking
me to look at this, Stephen Turnbull.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sun, 05 Sep 2010 19:22:37 +0100 |
| parents | e0db3c197671 |
| children | 308d34e9f07d |
| rev | line source |
|---|---|
| 428 | 1 /* Define console object for XEmacs. |
| 872 | 2 Copyright (C) 1996, 2002 Ben Wing |
| 428 | 3 |
| 4 This file is part of XEmacs. | |
| 5 | |
| 6 XEmacs is free software; you can redistribute it and/or modify it | |
| 7 under the terms of the GNU General Public License as published by the | |
| 8 Free Software Foundation; either version 2, or (at your option) any | |
| 9 later version. | |
| 10 | |
| 11 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 for more details. | |
| 15 | |
| 16 You should have received a copy of the GNU General Public License | |
| 17 along with XEmacs; see the file COPYING. If not, write to | |
| 18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 19 Boston, MA 02111-1307, USA. */ | |
| 20 | |
| 21 /* Synched up with: Not in FSF. */ | |
| 22 | |
| 23 /* Written by Ben Wing. */ | |
| 24 | |
| 440 | 25 #ifndef INCLUDED_console_h_ |
| 26 #define INCLUDED_console_h_ | |
| 428 | 27 |
| 28 /* Devices and consoles are similar entities. The idea is that | |
| 29 a console represents a physical keyboard/mouse/other-input-source | |
| 30 while a device represents a display where frames appear on. | |
| 3360 | 31 Nowadays "multi-headed" displays with multiple physical screens |
| 32 are becoming familiar; in the XEmacs nomenclature, this maps to a | |
| 33 "console" supporting multiple "devices". | |
| 34 | |
| 428 | 35 In the X world, a console is a "Display" while a device is a |
| 36 "Screen". Implementationally, it can sometimes get confusing: | |
| 37 under X, multiple devices on a single console are different | |
| 38 "Display" connections to what is in reality the same Display on | |
| 3360 | 39 the same server. Furthermore, in the X model input comes from the |
| 40 device and not from the console. This causes no confusion because | |
| 41 events are basically always tagged to a particular X window (i.e. | |
| 42 frame), which exists on only one screen; therefore the event won't | |
| 43 be reported multiple times even if there are multiple devices on | |
| 44 the same physical display. | |
| 45 | |
| 46 This is an implementation detail specific to X consoles (e.g. under | |
|
4759
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
3360
diff
changeset
|
47 Windows, this could be different, and input would come directly from |
|
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
3360
diff
changeset
|
48 the console). |
| 428 | 49 */ |
| 50 | |
| 51 /* GCC does not like forward enum declaration. This needs to be | |
| 52 defined here. What a disgust! */ | |
| 53 | |
| 934 | 54 enum console_variant |
| 55 { | |
| 56 dead_console, | |
| 57 tty_console, | |
| 58 gtk_console, | |
| 59 x_console, | |
| 60 mswindows_console, | |
| 1346 | 61 msprinter_console, |
| 934 | 62 stream_console |
| 63 }; | |
| 64 | |
| 428 | 65 enum device_metrics |
| 66 { | |
| 67 DM_color_default, DM_color_select, DM_color_balloon, DM_color_3d_face, | |
| 68 DM_color_3d_light, DM_color_3d_dark, DM_color_menu, DM_color_menu_highlight, | |
| 69 DM_color_menu_button, DM_color_menu_disabled, DM_color_toolbar, | |
| 70 DM_color_scrollbar, DM_color_desktop, DM_color_workspace, DM_font_default, | |
| 71 DM_font_menubar, DM_font_dialog, DM_size_cursor, DM_size_scrollbar, | |
| 72 DM_size_menu, DM_size_toolbar, DM_size_toolbar_button, | |
| 73 DM_size_toolbar_border, DM_size_icon, DM_size_icon_small, DM_size_device, | |
| 440 | 74 DM_size_workspace, DM_offset_workspace, DM_size_device_mm, DM_device_dpi, |
| 1942 | 75 DM_num_bit_planes, DM_num_color_cells, DM_num_screens, DM_mouse_buttons, |
| 76 DM_swap_buttons, DM_show_sounds, DM_slow_device, DM_security, | |
| 77 DM_backing_store, DM_save_under | |
| 428 | 78 }; |
| 79 | |
| 872 | 80 struct console; |
| 428 | 81 |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents:
4759
diff
changeset
|
82 DECLARE_LISP_OBJECT (console, struct console); |
| 428 | 83 #define XCONSOLE(x) XRECORD (x, console, struct console) |
| 617 | 84 #define wrap_console(p) wrap_record (p, console) |
| 428 | 85 #define CONSOLEP(x) RECORDP (x, console) |
| 86 #define CHECK_CONSOLE(x) CHECK_RECORD (x, console) | |
| 87 #define CONCHECK_CONSOLE(x) CONCHECK_RECORD (x, console) | |
| 88 | |
| 872 | 89 /* Basic properties available to non-privileged users; redefined in |
| 90 console-impl.h */ | |
| 91 | |
| 874 | 92 struct console_methods; |
| 93 | |
| 872 | 94 int console_live_p (struct console *c); |
| 95 Lisp_Object console_device_list (struct console *c); | |
| 96 | |
| 97 #define CONSOLE_LIVE_P(c) console_live_p (c) | |
| 98 #define CONSOLE_DEVICE_LIST(c) console_device_list (c) | |
| 99 | |
| 428 | 100 #define CHECK_LIVE_CONSOLE(x) do { \ |
| 101 CHECK_CONSOLE (x); \ | |
| 102 if (! CONSOLE_LIVE_P (XCONSOLE (x))) \ | |
| 103 dead_wrong_type_argument (Qconsole_live_p, (x)); \ | |
| 104 } while (0) | |
| 105 #define CONCHECK_LIVE_CONSOLE(x) do { \ | |
| 106 CONCHECK_CONSOLE (x); \ | |
| 107 if (! CONSOLE_LIVE_P (XCONSOLE (x))) \ | |
| 108 x = wrong_type_argument (Qconsole_live_p, (x)); \ | |
| 109 } while (0) | |
| 110 | |
| 111 #define CDFW_CONSOLE(obj) \ | |
| 1204 | 112 ((WINDOWP (obj) && WINDOW_LIVE_P (XWINDOW(obj))) ? WINDOW_CONSOLE (XWINDOW (obj)) \ |
| 113 : ((FRAMEP (obj) && FRAME_LIVE_P (XFRAME (obj))) ? FRAME_CONSOLE (XFRAME (obj)) \ | |
| 114 : ((DEVICEP (obj) && DEVICE_LIVE_P (XDEVICE (obj))) ? DEVICE_CONSOLE (XDEVICE (obj)) \ | |
| 115 : ((CONSOLEP (obj) && CONSOLE_LIVE_P (XCONSOLE (obj))) ? obj \ | |
| 428 | 116 : Qnil)))) |
| 117 | |
| 118 #define CONSOLE_LOOP(concons) LIST_LOOP (concons, Vconsole_list) | |
| 119 #define CONSOLE_DEVICE_LOOP(devcons, con) \ | |
| 120 LIST_LOOP (devcons, CONSOLE_DEVICE_LIST (con)) | |
| 121 | |
| 872 | 122 EXFUN (Fconsole_disable_input, 1); |
| 123 EXFUN (Fdelete_console, 2); | |
| 124 EXFUN (Fselect_console, 1); | |
| 125 EXFUN (Fselected_console, 0); | |
| 126 | |
| 127 extern Lisp_Object Qcreate_console_hook, Qdelete_console_hook; | |
| 128 extern Lisp_Object Vconsole_defaults, Vconsole_type_list, Vselected_console; | |
| 129 | |
| 130 int valid_console_type_p (Lisp_Object type); | |
| 428 | 131 |
| 132 Lisp_Object create_console (Lisp_Object name, Lisp_Object type, | |
| 133 Lisp_Object connection, Lisp_Object props); | |
| 134 void select_console_1 (Lisp_Object); | |
| 135 struct console *decode_console (Lisp_Object); | |
| 136 void add_entry_to_console_type_list (Lisp_Object symbol, | |
| 137 struct console_methods *type); | |
| 138 struct console_methods *decode_console_type (Lisp_Object type, | |
| 578 | 139 Error_Behavior errb); |
| 934 | 140 |
| 141 enum console_variant get_console_variant (Lisp_Object type); | |
| 142 | |
| 428 | 143 void delete_console_internal (struct console *con, int force, |
| 144 int from_kill_emacs, int from_io_error); | |
| 145 void io_error_delete_console (Lisp_Object console); | |
| 146 void set_console_last_nonminibuf_frame (struct console *con, | |
| 147 Lisp_Object frame); | |
| 872 | 148 void stuff_buffered_input (Lisp_Object); |
| 428 | 149 |
| 440 | 150 #endif /* INCLUDED_console_h_ */ |