dispextern.h 3.67 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Interface definitions for display code.
Jim Blandy's avatar
Jim Blandy committed
2
   Copyright (C) 1985, 1992 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 20
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.  */

/* Nonzero means don't assume anything about current
Jim Blandy's avatar
Jim Blandy committed
21 22
   contents of actual terminal frame */
extern int frame_garbaged;
Jim Blandy's avatar
Jim Blandy committed
23 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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
#include <X11/Xlib.h>

struct face
  {
    /* If this is non-zero, it is a GC we can use without modification
       to represent this face. */
    GC gc;
  
    /* Pixel value for foreground color. */
    int foreground;
  
    /* Pixel value for background color. */
    int background;
  
    /* Font used for this face */
    XFontStruct font;
  
    /* Background stipple or bitmap used for this face. */
    Pixmap stipple;
  
    /* Whether or not to underline text in this face. */
    char underline;
  };

typedef struct face *FACE;

#define NORMAL_FACE ((FACE *) 0)

#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)

#else  /* Not X */

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)
#endif /* Not X */

Jim Blandy's avatar
Jim Blandy committed
78

Jim Blandy's avatar
Jim Blandy committed
79
/* This structure is used for the actual display of text on a frame.
Jim Blandy's avatar
Jim Blandy committed
80 81 82 83 84

   There are two instantiations of it:  the glyphs currently displayed,
   and the glyphs we desire to display.  The latter object is generated
   from buffers being displayed. */

Jim Blandy's avatar
Jim Blandy committed
85
struct frame_glyphs
Jim Blandy's avatar
Jim Blandy committed
86
  {
Jim Blandy's avatar
Jim Blandy committed
87 88 89
#ifdef MULTI_FRAME
    struct  frame *frame;	/* Frame these glyphs belong to. */
#endif /* MULTI_FRAME */
Jim Blandy's avatar
Jim Blandy committed
90 91 92
    int height;
    int width;

Jim Blandy's avatar
Jim Blandy committed
93
    /* Contents of the frame.
Jim Blandy's avatar
Jim Blandy committed
94 95 96
       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
97
	     and glyphs[V][frame_width] are always '\0'.  */
Jim Blandy's avatar
Jim Blandy committed
98 99 100 101
    GLYPH **glyphs;
    /* long vector from which the strings in `glyphs' are taken.  */
    GLYPH *total_contents;

Jim Blandy's avatar
Jim Blandy committed
102 103 104
    /* When representing a desired frame,
         enable[n] == 0 means that line n is same as current frame.
       When representing current frame contents,
Jim Blandy's avatar
Jim Blandy committed
105 106 107 108 109 110
         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
111 112 113 114 115 116 117
    /* highlight[n] != 0 iff line n is highlighted.  */
    char *highlight;

    /* Buffer offset of this line's first char. */
    int   *bufp;

#ifdef HAVE_X_WINDOWS
118 119
    /* Pixel position of top left corner of line. */
    short *top_left_x;
Jim Blandy's avatar
Jim Blandy committed
120 121
    short *top_left_y;

122 123 124 125 126
    /* Pixel width of line. */
    short *pix_width;

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

128 129 130 131
    /* Largest font ascent on this line. */
    short *max_ascent;
#endif	/* HAVE_X_WINDOWS */
  };
Jim Blandy's avatar
Jim Blandy committed
132 133

extern void get_display_line ();