code.delx.au - gnu-emacs/blob - src/dispextern.h

   1 /* Interface definitions for display code.
   2    Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #ifndef _DISPEXTERN_H_
  21 #define _DISPEXTERN_H_
  22
  23 /* Nonzero means last display completed and cursor is really at
  24    cursX, cursY.  Zero means it was preempted. */
  25 extern int display_completed;
  26
  27 #ifdef HAVE_X_WINDOWS
  28 #include <X11/Xlib.h>
  29 #endif
  30
  31 #ifdef MSDOS
  32 #include "msdos.h"
  33 #endif
  34
  35 #ifdef HAVE_NTGUI
  36 #include "win32.h"
  37 #endif
  38
  39 #ifdef HAVE_FACES
  40 struct face
  41   {
  42     /* If this is non-zero, it is a GC we can use without modification
  43        to represent this face.  */
  44     GC gc;
  45
  46     /* Pixel value for foreground color.  */
  47     EMACS_UINT foreground;
  48
  49     /* Pixel value for background color.  */
  50     EMACS_UINT background;
  51
  52     /* Font used for this face.  */
  53     XFontStruct *font;
  54
  55     /* Background stipple or bitmap used for this face.  */
  56     Pixmap stipple;
  57
  58     /* Pixmap_depth.  */
  59     unsigned int pixmap_w, pixmap_h;
  60
  61     /* Whether or not to underline text in this face.  */
  62     char underline;
  63   };
  64
  65 /* Let's stop using this and get rid of it.  */
  66 typedef struct face *FACE;
  67
  68 #define NORMAL_FACE ((struct face *) 0)
  69
  70 #define FACE_HAS_GC(f) ((f)->gc)
  71 #define FACE_GC(f) ((f)->gc)
  72 #define FACE_FOREGROUND(f) ((f)->foreground)
  73 #define FACE_BACKGROUND(f) ((f)->background)
  74 #define FACE_FONT(f) ((f)->font)
  75 #define FACE_STIPPLE(f) ((f)->stipple)
  76 #define FACE_UNDERLINE_P(f) ((f)->underline)
  77
  78 #else /* not HAVE_FACES */
  79
  80 typedef int FACE;
  81
  82 #define NORMAL_FACE 0x0
  83 #define HIGHLIGHT_FACE 0x1
  84 #define UNDERLINE_FACE 0x2
  85 #define HIGHLIGHT_UNDERLINE_FACE 0x3
  86
  87 #define FACE_HIGHLIGHT(f) ((f) & 0x1)
  88 #define FACE_UNDERLINE(f) ((f) & 0x2)
  89
  90 #endif /* not HAVE_FACES */
  91
  92
  93 /* This structure is used for the actual display of text on a frame.
  94
  95    There are two instantiations of it:  the glyphs currently displayed,
  96    and the glyphs we desire to display.  The latter object is generated
  97    from buffers being displayed.  */
  98
  99 struct frame_glyphs
 100   {
 101 #ifdef MULTI_FRAME
 102     struct  frame *frame;       /* Frame these glyphs belong to.  */
 103 #endif /* MULTI_FRAME */
 104     int height;
 105     int width;
 106
 107     /* Contents of the frame.
 108        glyphs[V][H] is the glyph at position V, H.
 109        Note that glyphs[V][-1],
 110                  glyphs[V][used[V]],
 111              and glyphs[V][frame_width] are always '\0'.  */
 112     GLYPH **glyphs;
 113     /* long vector from which the strings in `glyphs' are taken.  */
 114     GLYPH *total_contents;
 115
 116     /* When representing a desired frame,
 117          enable[n] == 0 means that line n is same as current frame.
 118          Between updates, all lines should be disabled.
 119        When representing current frame contents,
 120          enable[n] == 0 means that line n is blank.  */
 121     char *enable;
 122
 123     /* Everything on line n after column used[n] is considered blank.  */
 124     int *used;
 125
 126     /* highlight[n] != 0 iff line n is highlighted.  */
 127     char *highlight;
 128
 129     /* Buffer offset of this line's first char.
 130        This is not really implemented, and cannot be,
 131        and should be deleted.  */
 132     int   *bufp;
 133
 134 #ifdef HAVE_WINDOW_SYSTEM
 135     /* Pixel position of top left corner of line.  */
 136     short *top_left_x;
 137     short *top_left_y;
 138
 139     /* Pixel width of line.  */
 140     short *pix_width;
 141
 142     /* Pixel height of line.  */
 143     short *pix_height;
 144
 145     /* Largest font ascent on this line.  */
 146     short *max_ascent;
 147 #endif  /* HAVE_WINDOW_SYSTEM */
 148
 149     /* Mapping of coordinate pairs to buffer positions.
 150        This field holds a vector indexed by row number.
 151        Its elements are vectors indexed by column number.
 152        Each element of these vectors is a buffer position, 0, or -1.
 153
 154        For a column where the image of a text character starts,
 155        the element value is the buffer position of that character.
 156        When a window's screen line starts in mid character,
 157        the element for the line's first column (at the window's left margin)
 158        is that character's position.
 159        For successive columns within a multicolumn character,
 160        the element is -1.
 161        For the column just beyond the last glyph on a line,
 162        the element is the buffer position of the end of the line.
 163        For following columns within the same window, the element is 0.
 164        For rows past the end of the accessible buffer text,
 165        the window's first column has ZV and other columns have 0.
 166
 167        Mode lines and vertical separator lines have 0.
 168
 169        The column of a window's left margin
 170        always has a positive value (a buffer position), not 0 or -1,
 171        for each line in that window's interior.  */
 172
 173     int **charstarts;
 174
 175     /* This holds all the space in the subvectors of the charstarts field.  */
 176     int *total_charstarts;
 177   };
 178
 179 extern void get_display_line ();
 180 extern Lisp_Object sit_for ();
 181
 182 #endif /* not _DISPEXTERN_H_ */