Mercurial > hg > xemacs-beta
view src/console.h @ 665:fdefd0186b75
[xemacs-hg @ 2001-09-20 06:28:42 by ben]
The great integral types renaming.
The purpose of this is to rationalize the names used for various
integral types, so that they match their intended uses and follow
consist conventions, and eliminate types that were not semantically
different from each other.
The conventions are:
-- All integral types that measure quantities of anything are
signed. Some people disagree vociferously with this, but their
arguments are mostly theoretical, and are vastly outweighed by
the practical headaches of mixing signed and unsigned values,
and more importantly by the far increased likelihood of
inadvertent bugs: Because of the broken "viral" nature of
unsigned quantities in C (operations involving mixed
signed/unsigned are done unsigned, when exactly the opposite is
nearly always wanted), even a single error in declaring a
quantity unsigned that should be signed, or even the even more
subtle error of comparing signed and unsigned values and
forgetting the necessary cast, can be catastrophic, as
comparisons will yield wrong results. -Wsign-compare is turned
on specifically to catch this, but this tends to result in a
great number of warnings when mixing signed and unsigned, and
the casts are annoying. More has been written on this
elsewhere.
-- All such quantity types just mentioned boil down to EMACS_INT,
which is 32 bits on 32-bit machines and 64 bits on 64-bit
machines. This is guaranteed to be the same size as Lisp
objects of type `int', and (as far as I can tell) of size_t
(unsigned!) and ssize_t. The only type below that is not an
EMACS_INT is Hashcode, which is an unsigned value of the same
size as EMACS_INT.
-- Type names should be relatively short (no more than 10
characters or so), with the first letter capitalized and no
underscores if they can at all be avoided.
-- "count" == a zero-based measurement of some quantity. Includes
sizes, offsets, and indexes.
-- "bpos" == a one-based measurement of a position in a buffer.
"Charbpos" and "Bytebpos" count text in the buffer, rather than
bytes in memory; thus Bytebpos does not directly correspond to
the memory representation. Use "Membpos" for this.
-- "Char" refers to internal-format characters, not to the C type
"char", which is really a byte.
-- For the actual name changes, see the script below.
I ran the following script to do the conversion. (NOTE: This script
is idempotent. You can safely run it multiple times and it will
not screw up previous results -- in fact, it will do nothing if
nothing has changed. Thus, it can be run repeatedly as necessary
to handle patches coming in from old workspaces, or old branches.)
There are two tags, just before and just after the change:
`pre-integral-type-rename' and `post-integral-type-rename'. When
merging code from the main trunk into a branch, the best thing to
do is first merge up to `pre-integral-type-rename', then apply the
script and associated changes, then merge from
`post-integral-type-change' to the present. (Alternatively, just do
the merging in one operation; but you may then have a lot of
conflicts needing to be resolved by hand.)
Script `fixtypes.sh' follows:
----------------------------------- cut ------------------------------------
files="*.[ch] s/*.h m/*.h config.h.in ../configure.in Makefile.in.in ../lib-src/*.[ch] ../lwlib/*.[ch]"
gr Memory_Count Bytecount $files
gr Lstream_Data_Count Bytecount $files
gr Element_Count Elemcount $files
gr Hash_Code Hashcode $files
gr extcount bytecount $files
gr bufpos charbpos $files
gr bytind bytebpos $files
gr memind membpos $files
gr bufbyte intbyte $files
gr Extcount Bytecount $files
gr Bufpos Charbpos $files
gr Bytind Bytebpos $files
gr Memind Membpos $files
gr Bufbyte Intbyte $files
gr EXTCOUNT BYTECOUNT $files
gr BUFPOS CHARBPOS $files
gr BYTIND BYTEBPOS $files
gr MEMIND MEMBPOS $files
gr BUFBYTE INTBYTE $files
gr MEMORY_COUNT BYTECOUNT $files
gr LSTREAM_DATA_COUNT BYTECOUNT $files
gr ELEMENT_COUNT ELEMCOUNT $files
gr HASH_CODE HASHCODE $files
----------------------------------- cut ------------------------------------
`fixtypes.sh' is a Bourne-shell script; it uses 'gr':
----------------------------------- cut ------------------------------------
#!/bin/sh
# Usage is like this:
# gr FROM TO FILES ...
# globally replace FROM with TO in FILES. FROM and TO are regular expressions.
# backup files are stored in the `backup' directory.
from="$1"
to="$2"
shift 2
echo ${1+"$@"} | xargs global-replace "s/$from/$to/g"
----------------------------------- cut ------------------------------------
`gr' in turn uses a Perl script to do its real work,
`global-replace', which follows:
----------------------------------- cut ------------------------------------
: #-*- Perl -*-
### global-modify --- modify the contents of a file by a Perl expression
## Copyright (C) 1999 Martin Buchholz.
## Copyright (C) 2001 Ben Wing.
## Authors: Martin Buchholz <martin@xemacs.org>, Ben Wing <ben@xemacs.org>
## Maintainer: Ben Wing <ben@xemacs.org>
## Current Version: 1.0, May 5, 2001
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with XEmacs; see the file COPYING. If not, write to the Free
# Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
eval 'exec perl -w -S $0 ${1+"$@"}'
if 0;
use strict;
use FileHandle;
use Carp;
use Getopt::Long;
use File::Basename;
(my $myName = $0) =~ s@.*/@@; my $usage="
Usage: $myName [--help] [--backup-dir=DIR] [--line-mode] [--hunk-mode]
PERLEXPR FILE ...
Globally modify a file, either line by line or in one big hunk.
Typical usage is like this:
[with GNU print, GNU xargs: guaranteed to handle spaces, quotes, etc.
in file names]
find . -name '*.[ch]' -print0 | xargs -0 $0 's/\bCONST\b/const/g'\n
[with non-GNU print, xargs]
find . -name '*.[ch]' -print | xargs $0 's/\bCONST\b/const/g'\n
The file is read in, either line by line (with --line-mode specified)
or in one big hunk (with --hunk-mode specified; it's the default), and
the Perl expression is then evalled with \$_ set to the line or hunk of
text, including the terminating newline if there is one. It should
destructively modify the value there, storing the changed result in \$_.
Files in which any modifications are made are backed up to the directory
specified using --backup-dir, or to `backup' by default. To disable this,
use --backup-dir= with no argument.
Hunk mode is the default because it is MUCH MUCH faster than line-by-line.
Use line-by-line only when it matters, e.g. you want to do a replacement
only once per line (the default without the `g' argument). Conversely,
when using hunk mode, *ALWAYS* use `g'; otherwise, you will only make one
replacement in the entire file!
";
my %options = ();
$Getopt::Long::ignorecase = 0;
&GetOptions (
\%options,
'help', 'backup-dir=s', 'line-mode', 'hunk-mode',
);
die $usage if $options{"help"} or @ARGV <= 1;
my $code = shift;
die $usage if grep (-d || ! -w, @ARGV);
sub SafeOpen {
open ((my $fh = new FileHandle), $_[0]);
confess "Can't open $_[0]: $!" if ! defined $fh;
return $fh;
}
sub SafeClose {
close $_[0] or confess "Can't close $_[0]: $!";
}
sub FileContents {
my $fh = SafeOpen ("< $_[0]");
my $olddollarslash = $/;
local $/ = undef;
my $contents = <$fh>;
$/ = $olddollarslash;
return $contents;
}
sub WriteStringToFile {
my $fh = SafeOpen ("> $_[0]");
binmode $fh;
print $fh $_[1] or confess "$_[0]: $!\n";
SafeClose $fh;
}
foreach my $file (@ARGV) {
my $changed_p = 0;
my $new_contents = "";
if ($options{"line-mode"}) {
my $fh = SafeOpen $file;
while (<$fh>) {
my $save_line = $_;
eval $code;
$changed_p = 1 if $save_line ne $_;
$new_contents .= $_;
}
} else {
my $orig_contents = $_ = FileContents $file;
eval $code;
if ($_ ne $orig_contents) {
$changed_p = 1;
$new_contents = $_;
}
}
if ($changed_p) {
my $backdir = $options{"backup-dir"};
$backdir = "backup" if !defined ($backdir);
if ($backdir) {
my ($name, $path, $suffix) = fileparse ($file, "");
my $backfulldir = $path . $backdir;
my $backfile = "$backfulldir/$name";
mkdir $backfulldir, 0755 unless -d $backfulldir;
print "modifying $file (original saved in $backfile)\n";
rename $file, $backfile;
}
WriteStringToFile ($file, $new_contents);
}
}
----------------------------------- cut ------------------------------------
In addition to those programs, I needed to fix up a few other
things, particularly relating to the duplicate definitions of
types, now that some types merged with others. Specifically:
1. in lisp.h, removed duplicate declarations of Bytecount. The
changed code should now look like this: (In each code snippet
below, the first and last lines are the same as the original, as
are all lines outside of those lines. That allows you to locate
the section to be replaced, and replace the stuff in that
section, verifying that there isn't anything new added that
would need to be kept.)
--------------------------------- snip -------------------------------------
/* Counts of bytes or chars */
typedef EMACS_INT Bytecount;
typedef EMACS_INT Charcount;
/* Counts of elements */
typedef EMACS_INT Elemcount;
/* Hash codes */
typedef unsigned long Hashcode;
/* ------------------------ dynamic arrays ------------------- */
--------------------------------- snip -------------------------------------
2. in lstream.h, removed duplicate declaration of Bytecount.
Rewrote the comment about this type. The changed code should
now look like this:
--------------------------------- snip -------------------------------------
#endif
/* The have been some arguments over the what the type should be that
specifies a count of bytes in a data block to be written out or read in,
using Lstream_read(), Lstream_write(), and related functions.
Originally it was long, which worked fine; Martin "corrected" these to
size_t and ssize_t on the grounds that this is theoretically cleaner and
is in keeping with the C standards. Unfortunately, this practice is
horribly error-prone due to design flaws in the way that mixed
signed/unsigned arithmetic happens. In fact, by doing this change,
Martin introduced a subtle but fatal error that caused the operation of
sending large mail messages to the SMTP server under Windows to fail.
By putting all values back to be signed, avoiding any signed/unsigned
mixing, the bug immediately went away. The type then in use was
Lstream_Data_Count, so that it be reverted cleanly if a vote came to
that. Now it is Bytecount.
Some earlier comments about why the type must be signed: This MUST BE
SIGNED, since it also is used in functions that return the number of
bytes actually read to or written from in an operation, and these
functions can return -1 to signal error.
Note that the standard Unix read() and write() functions define the
count going in as a size_t, which is UNSIGNED, and the count going
out as an ssize_t, which is SIGNED. This is a horrible design
flaw. Not only is it highly likely to lead to logic errors when a
-1 gets interpreted as a large positive number, but operations are
bound to fail in all sorts of horrible ways when a number in the
upper-half of the size_t range is passed in -- this number is
unrepresentable as an ssize_t, so code that checks to see how many
bytes are actually written (which is mandatory if you are dealing
with certain types of devices) will get completely screwed up.
--ben
*/
typedef enum lstream_buffering
--------------------------------- snip -------------------------------------
3. in dumper.c, there are four places, all inside of switch()
statements, where XD_BYTECOUNT appears twice as a case tag. In
each case, the two case blocks contain identical code, and you
should *REMOVE THE SECOND* and leave the first.
| author | ben |
|---|---|
| date | Thu, 20 Sep 2001 06:31:11 +0000 |
| parents | b39c14581166 |
| children | 943eaba38521 |
line wrap: on
line source
/* Define console object for XEmacs. Copyright (C) 1996 Ben Wing This file is part of XEmacs. XEmacs is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. XEmacs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with XEmacs; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /* Synched up with: Not in FSF. */ /* Written by Ben Wing. */ #ifndef INCLUDED_console_h_ #define INCLUDED_console_h_ /* Devices and consoles are similar entities. The idea is that a console represents a physical keyboard/mouse/other-input-source while a device represents a display where frames appear on. In the X world, a console is a "Display" while a device is a "Screen". Implementationally, it can sometimes get confusing: under X, multiple devices on a single console are different "Display" connections to what is in reality the same Display on the same server. Because of this, input comes from the device and not from the console. This is OK because events are basically always tagged to a particular X window (i.e. frame), which exists on only one screen; therefore the event won't be reported multiple times even if there are multiple devices on the same physical display. This is an implementation detail specific to X consoles (e.g. under NeXTstep or Windows, this could be different, and input would come directly from the console). */ /* GCC does not like forward enum declaration. This needs to be defined here. What a disgust! */ enum device_metrics { DM_color_default, DM_color_select, DM_color_balloon, DM_color_3d_face, DM_color_3d_light, DM_color_3d_dark, DM_color_menu, DM_color_menu_highlight, DM_color_menu_button, DM_color_menu_disabled, DM_color_toolbar, DM_color_scrollbar, DM_color_desktop, DM_color_workspace, DM_font_default, DM_font_menubar, DM_font_dialog, DM_size_cursor, DM_size_scrollbar, DM_size_menu, DM_size_toolbar, DM_size_toolbar_button, DM_size_toolbar_border, DM_size_icon, DM_size_icon_small, DM_size_device, DM_size_workspace, DM_offset_workspace, DM_size_device_mm, DM_device_dpi, DM_num_bit_planes, DM_num_color_cells, DM_mouse_buttons, DM_swap_buttons, DM_show_sounds, DM_slow_device, DM_security }; extern const struct struct_description cted_description; extern const struct struct_description console_methods_description; /* * Constants returned by device_implementation_flags_method */ /* Set when device uses pixel-based geometry */ #define XDEVIMPF_PIXEL_GEOMETRY 0x00000001L /* Indicates that the device is a printer */ #define XDEVIMPF_IS_A_PRINTER 0x00000002L /* Do not automatically redisplay this device */ #define XDEVIMPF_NO_AUTO_REDISPLAY 0x00000004L /* Do not delete the device when last frame's gone */ #define XDEVIMPF_FRAMELESS_OK 0x00000008L /* Do not preempt resiaply of frame or device once it starts */ #define XDEVIMPF_DONT_PREEMPT_REDISPLAY 0x00000010L struct console_methods { const char *name; /* Used by print_console, print_device, print_frame */ Lisp_Object symbol; Lisp_Object predicate_symbol; unsigned int flags; /* Read-only implementation flags, set once upon console type creation. INITIALIZE_CONSOLE_TYPE sets this member to 0. */ /* console methods */ void (*init_console_method) (struct console *, Lisp_Object props); void (*mark_console_method) (struct console *); int (*initially_selected_for_input_method) (struct console *); void (*delete_console_method) (struct console *); Lisp_Object (*semi_canonicalize_console_connection_method) (Lisp_Object connection, Error_Behavior errb); Lisp_Object (*semi_canonicalize_device_connection_method) (Lisp_Object connection, Error_Behavior errb); Lisp_Object (*canonicalize_console_connection_method) (Lisp_Object connection, Error_Behavior errb); Lisp_Object (*canonicalize_device_connection_method) (Lisp_Object connection, Error_Behavior errb); Lisp_Object (*device_to_console_connection_method) (Lisp_Object connection, Error_Behavior errb); /* device methods */ void (*init_device_method) (struct device *, Lisp_Object props); void (*finish_init_device_method) (struct device *, Lisp_Object props); void (*delete_device_method) (struct device *); void (*mark_device_method) (struct device *); void (*asynch_device_change_method) (void); Lisp_Object (*device_system_metrics_method) (struct device *, enum device_metrics); Lisp_Object (*own_selection_method)(Lisp_Object selection_name, Lisp_Object selection_value, Lisp_Object how_to_add, Lisp_Object selection_type, int owned_p); void (*disown_selection_method)(Lisp_Object selection_name, Lisp_Object timeval); Lisp_Object (*get_foreign_selection_method) (Lisp_Object selection_symbol, Lisp_Object target_type); Lisp_Object (*selection_exists_p_method)(Lisp_Object selection_name, Lisp_Object selection_type); Lisp_Object (*available_selection_types_method)(Lisp_Object selection_name); Lisp_Object (*register_selection_data_type_method)(Lisp_Object type_name); Lisp_Object (*selection_data_type_name_method)(Lisp_Object type); /* frame methods */ Lisp_Object *device_specific_frame_props; void (*init_frame_1_method) (struct frame *, Lisp_Object properties); void (*init_frame_2_method) (struct frame *, Lisp_Object properties); void (*init_frame_3_method) (struct frame *); void (*after_init_frame_method) (struct frame *, int first_on_device, int first_on_console); void (*mark_frame_method) (struct frame *); void (*delete_frame_method) (struct frame *); void (*focus_on_frame_method) (struct frame *); void (*raise_frame_method) (struct frame *); void (*lower_frame_method) (struct frame *); void (*enable_frame_method) (struct frame *); void (*disable_frame_method) (struct frame *); int (*get_mouse_position_method) (struct device *d, Lisp_Object *frame, int *x, int *y); void (*set_mouse_position_method) (struct window *w, int x, int y); void (*make_frame_visible_method) (struct frame *f); void (*make_frame_invisible_method) (struct frame *f); void (*iconify_frame_method) (struct frame *f); Lisp_Object (*frame_property_method) (struct frame *f, Lisp_Object prop); int (*internal_frame_property_p_method) (struct frame *f, Lisp_Object prop); Lisp_Object (*frame_properties_method) (struct frame *f); void (*set_frame_properties_method) (struct frame *f, Lisp_Object plist); void (*set_frame_size_method) (struct frame *f, int width, int height); void (*set_frame_position_method) (struct frame *f, int xoff, int yoff); int (*frame_visible_p_method) (struct frame *f); int (*frame_totally_visible_p_method) (struct frame *f); int (*frame_iconified_p_method) (struct frame *f); void (*set_title_from_intbyte_method) (struct frame *f, Intbyte *title); void (*set_icon_name_from_intbyte_method) (struct frame *f, Intbyte *title); void (*set_frame_pointer_method) (struct frame *f); void (*set_frame_icon_method) (struct frame *f); void (*popup_menu_method) (Lisp_Object menu, Lisp_Object event); Lisp_Object (*get_frame_parent_method) (struct frame *f); void (*update_frame_external_traits_method) (struct frame *f, Lisp_Object name); int (*frame_size_fixed_p_method) (struct frame *f); void (*eject_page_method) (struct frame *f); /* redisplay methods */ int (*left_margin_width_method) (struct window *); int (*right_margin_width_method) (struct window *); int (*text_width_method) (struct frame *f, struct face_cachel *cachel, const Emchar *str, Charcount len); void (*output_display_block_method) (struct window *, struct display_line *, int, int, int, int, int, int, int); int (*divider_height_method) (void); int (*eol_cursor_width_method) (void); void (*output_vertical_divider_method) (struct window *, int); void (*clear_to_window_end_method) (struct window *, int, int); void (*clear_region_method) (Lisp_Object, struct device*, struct frame*, face_index, int, int, int, int, Lisp_Object, Lisp_Object, Lisp_Object); void (*clear_frame_method) (struct frame *); void (*window_output_begin_method) (struct window *); void (*frame_output_begin_method) (struct frame *); void (*window_output_end_method) (struct window *); void (*frame_output_end_method) (struct frame *); int (*flash_method) (struct device *); void (*ring_bell_method) (struct device *, int volume, int pitch, int duration); void (*frame_redraw_cursor_method) (struct frame *f); void (*set_final_cursor_coords_method) (struct frame *, int, int); void (*bevel_area_method) (struct window *, face_index, int, int, int, int, int, int, enum edge_style); void (*output_pixmap_method) (struct window *w, Lisp_Object image_instance, struct display_box *db, struct display_glyph_area *dga, face_index findex, int cursor_start, int cursor_width, int cursor_height, int offset_bitmap); void (*output_string_method) (struct window *w, struct display_line *dl, Emchar_dynarr *buf, int xpos, int xoffset, int start_pixpos, int width, face_index findex, int cursor, int cursor_start, int cursor_width, int cursor_height); /* color methods */ int (*initialize_color_instance_method) (Lisp_Color_Instance *, Lisp_Object name, Lisp_Object device, Error_Behavior errb); void (*mark_color_instance_method) (Lisp_Color_Instance *); void (*print_color_instance_method) (Lisp_Color_Instance *, Lisp_Object printcharfun, int escapeflag); void (*finalize_color_instance_method) (Lisp_Color_Instance *); int (*color_instance_equal_method) (Lisp_Color_Instance *, Lisp_Color_Instance *, int depth); Hashcode (*color_instance_hash_method) (Lisp_Color_Instance *, int depth); Lisp_Object (*color_instance_rgb_components_method) (Lisp_Color_Instance *); int (*valid_color_name_p_method) (struct device *, Lisp_Object color); /* font methods */ int (*initialize_font_instance_method) (Lisp_Font_Instance *, Lisp_Object name, Lisp_Object device, Error_Behavior errb); void (*mark_font_instance_method) (Lisp_Font_Instance *); void (*print_font_instance_method) (Lisp_Font_Instance *, Lisp_Object printcharfun, int escapeflag); void (*finalize_font_instance_method) (Lisp_Font_Instance *); Lisp_Object (*font_instance_truename_method) (Lisp_Font_Instance *, Error_Behavior errb); Lisp_Object (*font_instance_properties_method) (Lisp_Font_Instance *); Lisp_Object (*list_fonts_method) (Lisp_Object pattern, Lisp_Object device); Lisp_Object (*find_charset_font_method) (Lisp_Object device, Lisp_Object font, Lisp_Object charset); int (*font_spec_matches_charset_method) (struct device *d, Lisp_Object charset, const Intbyte *nonreloc, Lisp_Object reloc, Bytecount offset, Bytecount length); /* image methods */ void (*mark_image_instance_method) (Lisp_Image_Instance *); void (*print_image_instance_method) (Lisp_Image_Instance *, Lisp_Object printcharfun, int escapeflag); void (*finalize_image_instance_method) (Lisp_Image_Instance *); void (*unmap_subwindow_method) (Lisp_Image_Instance *); void (*map_subwindow_method) (Lisp_Image_Instance *, int x, int y, struct display_glyph_area* dga); void (*resize_subwindow_method) (Lisp_Image_Instance *, int w, int h); void (*redisplay_subwindow_method) (Lisp_Image_Instance *); void (*redisplay_widget_method) (Lisp_Image_Instance *); int (*image_instance_equal_method) (Lisp_Image_Instance *, Lisp_Image_Instance *, int depth); Hashcode (*image_instance_hash_method) (Lisp_Image_Instance *, int depth); void (*init_image_instance_from_eimage_method) (Lisp_Image_Instance *ii, int width, int height, int slices, unsigned char *eimage, int dest_mask, Lisp_Object instantiator, Lisp_Object domain); Lisp_Object (*locate_pixmap_file_method) (Lisp_Object file_method); int (*colorize_image_instance_method) (Lisp_Object image_instance, Lisp_Object fg, Lisp_Object bg); Lisp_Object image_conversion_list; #ifdef HAVE_TOOLBARS /* toolbar methods */ void (*output_frame_toolbars_method) (struct frame *); void (*initialize_frame_toolbars_method) (struct frame *); void (*free_frame_toolbars_method) (struct frame *); void (*output_toolbar_button_method) (struct frame *, Lisp_Object); void (*redraw_frame_toolbars_method) (struct frame *); void (*redraw_exposed_toolbars_method) (struct frame *f, int x, int y, int width, int height); #endif #ifdef HAVE_SCROLLBARS /* scrollbar methods */ int (*inhibit_scrollbar_slider_size_change_method) (void); void (*free_scrollbar_instance_method) (struct scrollbar_instance *); void (*release_scrollbar_instance_method) (struct scrollbar_instance *); void (*create_scrollbar_instance_method) (struct frame *, int, struct scrollbar_instance *); void (*update_scrollbar_instance_values_method) (struct window *, struct scrollbar_instance *, int, int, int, int, int, int, int, int, int, int); void (*update_scrollbar_instance_status_method) (struct window *, int, int, struct scrollbar_instance *); void (*scrollbar_pointer_changed_in_window_method) (struct window *w); #ifdef MEMORY_USAGE_STATS int (*compute_scrollbar_instance_usage_method) (struct device *, struct scrollbar_instance *, struct overhead_stats *); #endif #endif /* HAVE_SCROLLBARS */ #ifdef HAVE_MENUBARS /* menubar methods */ void (*update_frame_menubars_method) (struct frame *); void (*free_frame_menubars_method) (struct frame *); #endif #ifdef HAVE_DIALOGS /* dialog methods */ Lisp_Object (*make_dialog_box_internal_method) (struct frame *, Lisp_Object type, Lisp_Object keys); #endif }; #define CONMETH_TYPE(meths) ((meths)->symbol) #define CONMETH_IMPL_FLAG(meths, f) ((meths)->flags & (f)) #define CONSOLE_TYPE_NAME(c) ((c)->conmeths->name) #define CONSOLE_TYPE(c) ((c)->conmeths->symbol) #define CONSOLE_IMPL_FLAG(c, f) CONMETH_IMPL_FLAG ((c)->conmeths, (f)) /******** Accessing / calling a console method *********/ #define HAS_CONTYPE_METH_P(meth, m) ((meth)->m##_method) #define CONTYPE_METH(meth, m, args) (((meth)->m##_method) args) /* Call a void-returning console method, if it exists */ #define MAYBE_CONTYPE_METH(meth, m, args) do { \ struct console_methods *maybe_contype_meth_meth = (meth); \ if (HAS_CONTYPE_METH_P (maybe_contype_meth_meth, m)) \ CONTYPE_METH (maybe_contype_meth_meth, m, args); \ } while (0) /* Call a console method, if it exists; otherwise return the specified value - meth is multiply evaluated. */ #define CONTYPE_METH_OR_GIVEN(meth, m, args, given) \ (HAS_CONTYPE_METH_P (meth, m) ? \ CONTYPE_METH (meth, m, args) : (given)) /* Call an int-returning console method, if it exists; otherwise return 0 */ #define MAYBE_INT_CONTYPE_METH(meth, m, args) \ CONTYPE_METH_OR_GIVEN (meth, m, args, 0) /* Call an Lisp-Object-returning console method, if it exists; otherwise return Qnil */ #define MAYBE_LISP_CONTYPE_METH(meth, m, args) \ CONTYPE_METH_OR_GIVEN (meth, m, args, Qnil) /******** Same functions, operating on a console instead of a struct console_methods ********/ #define HAS_CONMETH_P(c, m) HAS_CONTYPE_METH_P ((c)->conmeths, m) #define CONMETH(c, m, args) CONTYPE_METH ((c)->conmeths, m, args) #define MAYBE_CONMETH(c, m, args) MAYBE_CONTYPE_METH ((c)->conmeths, m, args) #define CONMETH_OR_GIVEN(c, m, args, given) \ CONTYPE_METH_OR_GIVEN((c)->conmeths, m, args, given) #define MAYBE_INT_CONMETH(c, m, args) \ MAYBE_INT_CONTYPE_METH ((c)->conmeths, m, args) #define MAYBE_LISP_CONMETH(c, m, args) \ MAYBE_LISP_CONTYPE_METH ((c)->conmeths, m, args) /******** Defining new console types ********/ typedef struct console_type_entry console_type_entry; struct console_type_entry { Lisp_Object symbol; struct console_methods *meths; }; #define DECLARE_CONSOLE_TYPE(type) \ extern struct console_methods * type##_console_methods #define DEFINE_CONSOLE_TYPE(type) \ struct console_methods * type##_console_methods #define INITIALIZE_CONSOLE_TYPE(type, obj_name, pred_sym) do { \ type##_console_methods = xnew_and_zero (struct console_methods); \ type##_console_methods->name = obj_name; \ type##_console_methods->symbol = Q##type; \ defsymbol_nodump (&type##_console_methods->predicate_symbol, pred_sym); \ add_entry_to_console_type_list (Q##type, type##_console_methods); \ type##_console_methods->image_conversion_list = Qnil; \ staticpro_nodump (&type##_console_methods->image_conversion_list); \ dump_add_root_struct_ptr (&type##_console_methods, &console_methods_description); \ } while (0) #define REINITIALIZE_CONSOLE_TYPE(type) do { \ staticpro_nodump (&type##_console_methods->predicate_symbol); \ staticpro_nodump (&type##_console_methods->image_conversion_list); \ } while (0) /* Declare that console-type TYPE has method M; used in initialization routines */ #define CONSOLE_HAS_METHOD(type, m) \ (type##_console_methods->m##_method = type##_##m) /* Declare that console-type TYPE inherits method M implementation from console-type FROMTYPE */ #define CONSOLE_INHERITS_METHOD(type, fromtype, m) \ (type##_console_methods->m##_method = fromtype##_##m) /* Define console type implementation flags */ #define CONSOLE_IMPLEMENTATION_FLAGS(type, flg) \ (type##_console_methods->flags = flg) struct console { struct lcrecord_header header; /* Description of this console's methods. */ struct console_methods *conmeths; /* A structure of auxiliary data specific to the console type. struct x_console is used for X window frames; defined in console-x.h struct tty_console is used to TTY's; defined in console-tty.h */ void *console_data; /* Character that causes a quit. Normally C-g. #### Should be possible for this not to be ASCII. (Currently works under Windows.) */ Emchar quit_char; /* ----- begin partially-completed console localization of event loop ---- */ int local_var_flags; #define MARKED_SLOT(x) Lisp_Object x #include "conslots.h" /* Where to store the next keystroke of the macro. Index into con->kbd_macro_builder. */ int kbd_macro_ptr; /* The finalized section of the macro starts at kbd_macro_buffer and ends before this. This is not the same as kbd_macro_pointer, because we advance this to kbd_macro_pointer when a key's command is complete. This way, the keystrokes for "end-kbd-macro" are not included in the macro. */ int kbd_macro_end; /* ----- end partially-completed console localization of event loop ---- */ unsigned int input_enabled :1; }; DECLARE_LRECORD (console, struct console); #define XCONSOLE(x) XRECORD (x, console, struct console) #define XSETCONSOLE(x, p) XSETRECORD (x, p, console) #define wrap_console(p) wrap_record (p, console) #define CONSOLEP(x) RECORDP (x, console) #define CHECK_CONSOLE(x) CHECK_RECORD (x, console) #define CONCHECK_CONSOLE(x) CONCHECK_RECORD (x, console) #define CHECK_LIVE_CONSOLE(x) do { \ CHECK_CONSOLE (x); \ if (! CONSOLE_LIVE_P (XCONSOLE (x))) \ dead_wrong_type_argument (Qconsole_live_p, (x)); \ } while (0) #define CONCHECK_LIVE_CONSOLE(x) do { \ CONCHECK_CONSOLE (x); \ if (! CONSOLE_LIVE_P (XCONSOLE (x))) \ x = wrong_type_argument (Qconsole_live_p, (x)); \ } while (0) #define CONSOLE_TYPE_P(con, type) EQ (CONSOLE_TYPE (con), Q##type) #ifdef ERROR_CHECK_TYPECHECK INLINE_HEADER struct console * error_check_console_type (struct console *con, Lisp_Object sym); INLINE_HEADER struct console * error_check_console_type (struct console *con, Lisp_Object sym) { assert (EQ (CONSOLE_TYPE (con), sym)); return con; } # define CONSOLE_TYPE_DATA(con, type) \ (*(struct type##_console **) \ &(error_check_console_type (con, Q##type))->console_data) #else # define CONSOLE_TYPE_DATA(con, type) \ (*(struct type##_console **) &((con)->console_data)) #endif #define CHECK_CONSOLE_TYPE(x, type) do { \ CHECK_CONSOLE (x); \ if (! CONSOLE_TYPE_P (XCONSOLE (x), type)) \ dead_wrong_type_argument \ (type##_console_methods->predicate_symbol, x); \ } while (0) #define CONCHECK_CONSOLE_TYPE(x, type) do { \ CONCHECK_CONSOLE (x); \ if (!(CONSOLEP (x) && \ CONSOLE_TYPE_P (XCONSOLE (x), type))) \ x = wrong_type_argument \ (type##_console_methods->predicate_symbol, x); \ } while (0) /* #### These should be in the console-*.h files but there are too many places where the abstraction is broken. Need to fix. */ #ifdef HAVE_GTK #define CONSOLE_TYPESYM_GTK_P(typesym) EQ (typesym, Qgtk) #else #define CONSOLE_TYPESYM_GTK_P(typesym) 0 #endif #ifdef HAVE_X_WINDOWS #define CONSOLE_TYPESYM_X_P(typesym) EQ (typesym, Qx) #else #define CONSOLE_TYPESYM_X_P(typesym) 0 #endif #ifdef HAVE_TTY #define CONSOLE_TYPESYM_TTY_P(typesym) EQ (typesym, Qtty) #else #define CONSOLE_TYPESYM_TTY_P(typesym) 0 #endif #ifdef HAVE_MS_WINDOWS #define CONSOLE_TYPESYM_MSWINDOWS_P(typesym) EQ (typesym, Qmswindows) #else #define CONSOLE_TYPESYM_MSWINDOWS_P(typesym) 0 #endif #define CONSOLE_TYPESYM_STREAM_P(typesym) EQ (typesym, Qstream) #define CONSOLE_TYPESYM_WIN_P(typesym) \ (CONSOLE_TYPESYM_GTK_P (typesym) || CONSOLE_TYPESYM_X_P (typesym) || CONSOLE_TYPESYM_MSWINDOWS_P (typesym)) #define CONSOLE_X_P(con) CONSOLE_TYPESYM_X_P (CONSOLE_TYPE (con)) #define CHECK_X_CONSOLE(z) CHECK_CONSOLE_TYPE (z, x) #define CONCHECK_X_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, x) #define CONSOLE_GTK_P(con) CONSOLE_TYPESYM_GTK_P (CONSOLE_TYPE (con)) #define CHECK_GTK_CONSOLE(z) CHECK_CONSOLE_TYPE (z, gtk) #define CONCHECK_GTK_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, gtk) #define CONSOLE_TTY_P(con) CONSOLE_TYPESYM_TTY_P (CONSOLE_TYPE (con)) #define CHECK_TTY_CONSOLE(z) CHECK_CONSOLE_TYPE (z, tty) #define CONCHECK_TTY_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, tty) #define CONSOLE_MSWINDOWS_P(con) CONSOLE_TYPESYM_MSWINDOWS_P (CONSOLE_TYPE (con)) #define CHECK_MSWINDOWS_CONSOLE(z) CHECK_CONSOLE_TYPE (z, mswindows) #define CONCHECK_MSWINDOWS_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, mswindows) #define CONSOLE_STREAM_P(con) CONSOLE_TYPESYM_STREAM_P (CONSOLE_TYPE (con)) #define CHECK_STREAM_CONSOLE(z) CHECK_CONSOLE_TYPE (z, stream) #define CONCHECK_STREAM_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, stream) #define CONSOLE_WIN_P(con) CONSOLE_TYPESYM_WIN_P (CONSOLE_TYPE (con)) EXFUN (Fconsole_disable_input, 1); EXFUN (Fdelete_console, 2); EXFUN (Fselect_console, 1); EXFUN (Fselected_console, 0); extern Lisp_Object Qcreate_console_hook, Qdelete_console_hook; extern Lisp_Object Vconsole_defaults, Vconsole_type_list, Vselected_console; /* This structure marks which slots in a console have corresponding default values in console_defaults. Each such slot has a nonzero value in this structure. The value has only one nonzero bit. When a console has its own local value for a slot, the bit for that slot (found in the same slot in this structure) is turned on in the console's local_var_flags slot. If a slot in this structure is zero, then even though there may be a DEFVAR_CONSOLE_LOCAL for the slot, there is no default value for it; and the corresponding slot in console_defaults is not used. */ extern struct console console_local_flags; int valid_console_type_p (Lisp_Object type); #define CONSOLE_LIVE_P(con) (!EQ (CONSOLE_TYPE (con), Qdead)) #define CONSOLE_NAME(con) ((con)->name) #define CONSOLE_CONNECTION(con) ((con)->connection) #define CONSOLE_CANON_CONNECTION(con) ((con)->canon_connection) #define CONSOLE_FUNCTION_KEY_MAP(con) ((con)->function_key_map) #define CONSOLE_DEVICE_LIST(con) ((con)->device_list) #define CONSOLE_SELECTED_DEVICE(con) ((con)->selected_device) #define CONSOLE_SELECTED_FRAME(con) \ DEVICE_SELECTED_FRAME (XDEVICE ((con)->selected_device)) #define CONSOLE_LAST_NONMINIBUF_FRAME(con) NON_LVALUE ((con)->last_nonminibuf_frame) #define CONSOLE_QUIT_CHAR(con) ((con)->quit_char) #define CDFW_CONSOLE(obj) \ (WINDOWP (obj) ? WINDOW_CONSOLE (XWINDOW (obj)) \ : (FRAMEP (obj) ? FRAME_CONSOLE (XFRAME (obj)) \ : (DEVICEP (obj) ? DEVICE_CONSOLE (XDEVICE (obj)) \ : (CONSOLEP (obj) ? obj \ : Qnil)))) #define CONSOLE_LOOP(concons) LIST_LOOP (concons, Vconsole_list) #define CONSOLE_DEVICE_LOOP(devcons, con) \ LIST_LOOP (devcons, CONSOLE_DEVICE_LIST (con)) DECLARE_CONSOLE_TYPE (dead); extern console_type_entry_dynarr *the_console_type_entry_dynarr; Lisp_Object create_console (Lisp_Object name, Lisp_Object type, Lisp_Object connection, Lisp_Object props); void select_console_1 (Lisp_Object); struct console *decode_console (Lisp_Object); Lisp_Object make_console (struct console *c); void add_entry_to_console_type_list (Lisp_Object symbol, struct console_methods *type); struct console_methods *decode_console_type (Lisp_Object type, Error_Behavior errb); void delete_console_internal (struct console *con, int force, int from_kill_emacs, int from_io_error); void io_error_delete_console (Lisp_Object console); void set_console_last_nonminibuf_frame (struct console *con, Lisp_Object frame); #endif /* INCLUDED_console_h_ */