dispextern.h 8.37 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Interface definitions for display code.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
any later version.

GNU Emacs 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 GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20

Morten Welinder's avatar
Morten Welinder committed
21 22 23
#ifndef _DISPEXTERN_H_
#define _DISPEXTERN_H_

Jim Blandy's avatar
Jim Blandy committed
24 25 26 27 28
/* Nonzero means last display completed and cursor is really at
   cursX, cursY.  Zero means it was preempted. */
extern int display_completed;

#ifdef HAVE_X_WINDOWS
29
#include <X11/Xlib.h>
Morten Welinder's avatar
Morten Welinder committed
30 31 32 33 34
#endif

#ifdef MSDOS
#include "msdos.h"
#endif
35

Geoff Voelker's avatar
Geoff Voelker committed
36
#ifdef HAVE_NTGUI
Geoff Voelker's avatar
Geoff Voelker committed
37
#include "w32gui.h"
Geoff Voelker's avatar
Geoff Voelker committed
38 39
#endif

Morten Welinder's avatar
Morten Welinder committed
40
#ifdef HAVE_FACES
41 42 43
struct face
  {
    /* If this is non-zero, it is a GC we can use without modification
44
       to represent this face.  Used only for ASCII characters.  */
45
    GC gc;
46 47 48 49

    /* GC used for non-ASCII characters.  */
    GC non_ascii_gc;

50
    /* Pixel value for foreground color.  */
51
    EMACS_UINT foreground;
52
  
53
    /* Pixel value for background color.  */
54
    EMACS_UINT background;
55
  
56 57 58 59 60
    /* Font used for this face.  If any fontset is set for this face,
       this points to a `font' slot of the struct `font_info' for an
       ASCII font of the fontset.  In that case, we should not call
       XFreeFont on it because the font may still be used somewhere
       else.  */
61
    XFontStruct *font;
62 63 64

    /* Fontset ID if any fontset is set for this face, else -1.  */
    int fontset;
65
  
66
    /* Background stipple or bitmap used for this face.  */
67
    Pixmap stipple;
68 69 70

    /* Pixmap_depth.  */
    unsigned int pixmap_w, pixmap_h;
71
  
72
    /* Whether or not to underline text in this face.  */
73 74 75
    char underline;
  };

76
/* Let's stop using this and get rid of it.  */
77 78
typedef struct face *FACE;

79
#define NORMAL_FACE ((struct face *) 0)
80 81 82

#define FACE_HAS_GC(f) ((f)->gc)
#define FACE_GC(f) ((f)->gc)
83
#define FACE_NON_ASCII_GC(f) ((f)->non_ascii_gc)
84 85 86
#define FACE_FOREGROUND(f) ((f)->foreground)
#define FACE_BACKGROUND(f) ((f)->background)
#define FACE_FONT(f) ((f)->font)
87
#define FACE_FONTSET(f) ((f)->fontset)
88 89 90
#define FACE_STIPPLE(f) ((f)->stipple)
#define FACE_UNDERLINE_P(f) ((f)->underline)

Morten Welinder's avatar
Morten Welinder committed
91
#else /* not HAVE_FACES */
92 93 94 95 96 97 98 99 100 101

typedef int FACE;

#define NORMAL_FACE 0x0
#define HIGHLIGHT_FACE 0x1
#define UNDERLINE_FACE 0x2
#define HIGHLIGHT_UNDERLINE_FACE 0x3

#define FACE_HIGHLIGHT(f) ((f) & 0x1)
#define FACE_UNDERLINE(f) ((f) & 0x2)
Morten Welinder's avatar
Morten Welinder committed
102 103

#endif /* not HAVE_FACES */
104

Jim Blandy's avatar
Jim Blandy committed
105

Jim Blandy's avatar
Jim Blandy committed
106
/* This structure is used for the actual display of text on a frame.
Jim Blandy's avatar
Jim Blandy committed
107 108 109

   There are two instantiations of it:  the glyphs currently displayed,
   and the glyphs we desire to display.  The latter object is generated
110
   from buffers being displayed.  */
Jim Blandy's avatar
Jim Blandy committed
111

Jim Blandy's avatar
Jim Blandy committed
112
struct frame_glyphs
Jim Blandy's avatar
Jim Blandy committed
113
  {
114
    struct  frame *frame;	/* Frame these glyphs belong to.  */
Jim Blandy's avatar
Jim Blandy committed
115 116 117
    int height;
    int width;

Jim Blandy's avatar
Jim Blandy committed
118
    /* Contents of the frame.
Jim Blandy's avatar
Jim Blandy committed
119 120 121
       glyphs[V][H] is the glyph at position V, H.
       Note that glyphs[V][-1],
                 glyphs[V][used[V]],
Jim Blandy's avatar
Jim Blandy committed
122
	     and glyphs[V][frame_width] are always '\0'.  */
Jim Blandy's avatar
Jim Blandy committed
123 124 125 126
    GLYPH **glyphs;
    /* long vector from which the strings in `glyphs' are taken.  */
    GLYPH *total_contents;

Jim Blandy's avatar
Jim Blandy committed
127 128
    /* When representing a desired frame,
         enable[n] == 0 means that line n is same as current frame.
129
	 Between updates, all lines should be disabled.
Jim Blandy's avatar
Jim Blandy committed
130
       When representing current frame contents,
Jim Blandy's avatar
Jim Blandy committed
131 132 133 134 135 136
         enable[n] == 0 means that line n is blank.  */
    char *enable;

    /* Everything on line n after column used[n] is considered blank.  */
    int *used;

Jim Blandy's avatar
Jim Blandy committed
137 138 139
    /* highlight[n] != 0 iff line n is highlighted.  */
    char *highlight;

Richard M. Stallman's avatar
Richard M. Stallman committed
140 141 142
    /* Buffer offset of this line's first char.
       This is not really implemented, and cannot be,
       and should be deleted.  */
Jim Blandy's avatar
Jim Blandy committed
143 144
    int   *bufp;

Geoff Voelker's avatar
Geoff Voelker committed
145
#ifdef HAVE_WINDOW_SYSTEM
146
    /* Pixel position of top left corner of line.  */
147
    short *top_left_x;
Jim Blandy's avatar
Jim Blandy committed
148 149
    short *top_left_y;

150
    /* Pixel width of line.  */
151 152
    short *pix_width;

153
    /* Pixel height of line.  */
154
    short *pix_height;
Jim Blandy's avatar
Jim Blandy committed
155

156
    /* Largest font ascent on this line.  */
157
    short *max_ascent;
Geoff Voelker's avatar
Geoff Voelker committed
158
#endif	/* HAVE_WINDOW_SYSTEM */
159

Richard M. Stallman's avatar
Richard M. Stallman committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
    /* Mapping of coordinate pairs to buffer positions.
       This field holds a vector indexed by row number.
       Its elements are vectors indexed by column number.
       Each element of these vectors is a buffer position, 0, or -1.

       For a column where the image of a text character starts,
       the element value is the buffer position of that character.
       When a window's screen line starts in mid character,
       the element for the line's first column (at the window's left margin)
       is that character's position.
       For successive columns within a multicolumn character,
       the element is -1.
       For the column just beyond the last glyph on a line,
       the element is the buffer position of the end of the line.
       For following columns within the same window, the element is 0.
       For rows past the end of the accessible buffer text,
       the window's first column has ZV and other columns have 0.

       Mode lines and vertical separator lines have 0.

       The column of a window's left margin
       always has a positive value (a buffer position), not 0 or -1,
       for each line in that window's interior.  */

184 185 186 187
    int **charstarts;

    /* This holds all the space in the subvectors of the charstarts field.  */
    int *total_charstarts;
188
  };
Jim Blandy's avatar
Jim Blandy committed
189

Andreas Schwab's avatar
Andreas Schwab committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
extern void redraw_frame P_ ((struct frame *));
extern void redraw_garbaged_frames P_ ((void));
extern void free_frame_glyphs P_ ((struct frame *, struct frame_glyphs *));
extern void remake_frame_glyphs P_ ((struct frame *));
extern void cancel_line P_ ((int, struct frame *));
extern void clear_frame_records P_ ((struct frame *));
extern void init_desired_glyphs P_ ((struct frame *));
extern void get_display_line P_ ((struct frame *, int, int));
extern int scroll_frame_lines P_ ((struct frame *, int, int, int, int));
extern void preserve_other_columns P_ ((struct window *));
extern void adjust_window_charstarts P_ ((struct window *, int, int));
extern void verify_charstarts P_ ((struct window *));
extern void cancel_my_columns P_ ((struct window *));
extern int direct_output_for_insert P_ ((int));
extern int direct_output_forward_char P_ ((int));
extern int update_frame P_ ((struct frame *, int, int));
extern void quit_error_check P_ ((void));
extern int scrolling P_ ((struct frame *));
extern int buffer_posn_from_coords P_ ((struct window *, int, int));
extern void do_pending_window_change P_ ((void));
extern void change_frame_size P_ ((struct frame *, int, int, int, int));
extern void bitch_at_user P_ ((void));

/* Defined in term.c */
extern void ring_bell P_ ((void));
extern void set_terminal_modes P_ ((void));
extern void reset_terminal_modes P_ ((void));
extern void update_begin P_ ((struct frame *));
extern void update_end P_ ((struct frame *));
extern void set_terminal_window P_ ((int));
extern void set_scroll_region P_ ((int, int));
extern void turn_off_insert P_ ((void));
extern void turn_off_highlight P_ ((void));
extern void background_highlight P_ ((void));
extern void reassert_line_highlight P_ ((int, int));
extern void change_line_highlight P_ ((int, int, int));
extern void cursor_to P_ ((int, int));
extern void clear_frame P_ ((void));
extern void clear_end_of_line P_ ((int));
extern void clear_end_of_line_raw P_ ((int));
extern void write_glyphs P_ ((GLYPH *, int));
extern void insert_glyphs P_ ((GLYPH *, int));
extern void delete_glyphs P_ ((int));
extern void ins_del_lines P_ ((int, int));
extern int string_cost P_ ((char *));
extern int per_line_cost P_ ((char *));
extern void calculate_costs P_ ((struct frame *));
extern void term_init P_ ((char *));
extern void fatal P_ ((/* char *, ... */));

/* Defined in scroll.c */
extern int scrolling_max_lines_saved P_ ((int, int, int *, int *, int *));
extern int scroll_cost P_ ((struct frame *, int, int, int));
extern void do_line_insertion_deletion_costs P_ ((struct frame *, char *,
						  char *, char *, char *,
						  char *, char *, int));
Morten Welinder's avatar
Morten Welinder committed
246 247

#endif /* not _DISPEXTERN_H_ */