dispextern.h 5.29 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 18 19
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

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

Jim Blandy's avatar
Jim Blandy committed
23 24 25 26 27
/* 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
28
#include <X11/Xlib.h>
Morten Welinder's avatar
Morten Welinder committed
29 30 31 32 33
#endif

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

Morten Welinder's avatar
Morten Welinder committed
35
#ifdef HAVE_FACES
36 37 38
struct face
  {
    /* If this is non-zero, it is a GC we can use without modification
39
       to represent this face.  */
40 41
    GC gc;
  
42
    /* Pixel value for foreground color.  */
43
    EMACS_UINT foreground;
44
  
45
    /* Pixel value for background color.  */
46
    EMACS_UINT background;
47
  
48 49
    /* Font used for this face.  */
    XFontStruct *font;
50
  
51
    /* Background stipple or bitmap used for this face.  */
52
    Pixmap stipple;
53 54 55

    /* Pixmap_depth.  */
    unsigned int pixmap_w, pixmap_h;
56
  
57
    /* Whether or not to underline text in this face.  */
58 59 60
    char underline;
  };

61
/* Let's stop using this and get rid of it.  */
62 63
typedef struct face *FACE;

64
#define NORMAL_FACE ((struct face *) 0)
65 66 67 68 69 70 71 72 73

#define FACE_HAS_GC(f) ((f)->gc)
#define FACE_GC(f) ((f)->gc)
#define FACE_FOREGROUND(f) ((f)->foreground)
#define FACE_BACKGROUND(f) ((f)->background)
#define FACE_FONT(f) ((f)->font)
#define FACE_STIPPLE(f) ((f)->stipple)
#define FACE_UNDERLINE_P(f) ((f)->underline)

Morten Welinder's avatar
Morten Welinder committed
74
#else /* not HAVE_FACES */
75 76 77 78 79 80 81 82 83 84

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
85 86

#endif /* not HAVE_FACES */
87

Jim Blandy's avatar
Jim Blandy committed
88

Jim Blandy's avatar
Jim Blandy committed
89
/* This structure is used for the actual display of text on a frame.
Jim Blandy's avatar
Jim Blandy committed
90 91 92

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

Jim Blandy's avatar
Jim Blandy committed
95
struct frame_glyphs
Jim Blandy's avatar
Jim Blandy committed
96
  {
Jim Blandy's avatar
Jim Blandy committed
97
#ifdef MULTI_FRAME
98
    struct  frame *frame;	/* Frame these glyphs belong to.  */
Jim Blandy's avatar
Jim Blandy committed
99
#endif /* MULTI_FRAME */
Jim Blandy's avatar
Jim Blandy committed
100 101 102
    int height;
    int width;

Jim Blandy's avatar
Jim Blandy committed
103
    /* Contents of the frame.
Jim Blandy's avatar
Jim Blandy committed
104 105 106
       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
107
	     and glyphs[V][frame_width] are always '\0'.  */
Jim Blandy's avatar
Jim Blandy committed
108 109 110 111
    GLYPH **glyphs;
    /* long vector from which the strings in `glyphs' are taken.  */
    GLYPH *total_contents;

Jim Blandy's avatar
Jim Blandy committed
112 113
    /* When representing a desired frame,
         enable[n] == 0 means that line n is same as current frame.
114
	 Between updates, all lines should be disabled.
Jim Blandy's avatar
Jim Blandy committed
115
       When representing current frame contents,
Jim Blandy's avatar
Jim Blandy committed
116 117 118 119 120 121
         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
122 123 124
    /* highlight[n] != 0 iff line n is highlighted.  */
    char *highlight;

Richard M. Stallman's avatar
Richard M. Stallman committed
125 126 127
    /* 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
128 129 130
    int   *bufp;

#ifdef HAVE_X_WINDOWS
131
    /* Pixel position of top left corner of line.  */
132
    short *top_left_x;
Jim Blandy's avatar
Jim Blandy committed
133 134
    short *top_left_y;

135
    /* Pixel width of line.  */
136 137
    short *pix_width;

138
    /* Pixel height of line.  */
139
    short *pix_height;
Jim Blandy's avatar
Jim Blandy committed
140

141
    /* Largest font ascent on this line.  */
142 143
    short *max_ascent;
#endif	/* HAVE_X_WINDOWS */
144

Richard M. Stallman's avatar
Richard M. Stallman committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
    /* 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.  */

169 170 171 172
    int **charstarts;

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

extern void get_display_line ();
176
extern Lisp_Object sit_for ();
Morten Welinder's avatar
Morten Welinder committed
177 178

#endif /* not _DISPEXTERN_H_ */