src/dispextern.h

   1 /* Interface definitions for display code.
   2    Copyright (C) 1985, 1992 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 /* Nonzero means last display completed and cursor is really at
  21    cursX, cursY.  Zero means it was preempted. */
  22 extern int display_completed;
  23
  24 #ifdef HAVE_X_WINDOWS
  25 #include <X11/Xlib.h>
  26
  27 struct face
  28   {
  29     /* If this is non-zero, it is a GC we can use without modification
  30        to represent this face.  */
  31     GC gc;
  32
  33     /* Pixel value for foreground color.  */
  34     int foreground;
  35
  36     /* Pixel value for background color.  */
  37     int background;
  38
  39     /* Font used for this face.  */
  40     XFontStruct *font;
  41
  42     /* Background stipple or bitmap used for this face.  */
  43     Pixmap stipple;
  44
  45     /* Pixmap_depth.  */
  46     unsigned int pixmap_w, pixmap_h;
  47
  48     /* Whether or not to underline text in this face.  */
  49     char underline;
  50   };
  51
  52 /* Let's stop using this and get rid of it.  */
  53 typedef struct face *FACE;
  54
  55 #define NORMAL_FACE ((struct face *) 0)
  56
  57 #define FACE_HAS_GC(f) ((f)->gc)
  58 #define FACE_GC(f) ((f)->gc)
  59 #define FACE_FOREGROUND(f) ((f)->foreground)
  60 #define FACE_BACKGROUND(f) ((f)->background)
  61 #define FACE_FONT(f) ((f)->font)
  62 #define FACE_STIPPLE(f) ((f)->stipple)
  63 #define FACE_UNDERLINE_P(f) ((f)->underline)
  64
  65 #else  /* Not X */
  66
  67 typedef int FACE;
  68
  69 #define NORMAL_FACE 0x0
  70 #define HIGHLIGHT_FACE 0x1
  71 #define UNDERLINE_FACE 0x2
  72 #define HIGHLIGHT_UNDERLINE_FACE 0x3
  73
  74 #define FACE_HIGHLIGHT(f) ((f) & 0x1)
  75 #define FACE_UNDERLINE(f) ((f) & 0x2)
  76 #endif /* Not X */
  77
  78
  79 /* This structure is used for the actual display of text on a frame.
  80
  81    There are two instantiations of it:  the glyphs currently displayed,
  82    and the glyphs we desire to display.  The latter object is generated
  83    from buffers being displayed.  */
  84
  85 struct frame_glyphs
  86   {
  87 #ifdef MULTI_FRAME
  88     struct  frame *frame;       /* Frame these glyphs belong to.  */
  89 #endif /* MULTI_FRAME */
  90     int height;
  91     int width;
  92
  93     /* Contents of the frame.
  94        glyphs[V][H] is the glyph at position V, H.
  95        Note that glyphs[V][-1],
  96                  glyphs[V][used[V]],
  97              and glyphs[V][frame_width] are always '\0'.  */
  98     GLYPH **glyphs;
  99     /* long vector from which the strings in `glyphs' are taken.  */
 100     GLYPH *total_contents;
 101
 102     /* When representing a desired frame,
 103          enable[n] == 0 means that line n is same as current frame.
 104          Between updates, all lines should be disabled.
 105        When representing current frame contents,
 106          enable[n] == 0 means that line n is blank.  */
 107     char *enable;
 108
 109     /* Everything on line n after column used[n] is considered blank.  */
 110     int *used;
 111
 112     /* highlight[n] != 0 iff line n is highlighted.  */
 113     char *highlight;
 114
 115     /* Buffer offset of this line's first char.  */
 116     int   *bufp;
 117
 118 #ifdef HAVE_X_WINDOWS
 119     /* Pixel position of top left corner of line.  */
 120     short *top_left_x;
 121     short *top_left_y;
 122
 123     /* Pixel width of line.  */
 124     short *pix_width;
 125
 126     /* Pixel height of line.  */
 127     short *pix_height;
 128
 129     /* Largest font ascent on this line.  */
 130     short *max_ascent;
 131 #endif  /* HAVE_X_WINDOWS */
 132   };
 133
 134 extern void get_display_line ();
 135 extern Lisp_Object sit_for ();