dispextern.h 4.08 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, 1993 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 21 22 23 24
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 last display completed and cursor is really at
   cursX, cursY.  Zero means it was preempted. */
extern int display_completed;

#ifdef HAVE_X_WINDOWS
25 26 27 28 29
#include <X11/Xlib.h>

struct face
  {
    /* If this is non-zero, it is a GC we can use without modification
30
       to represent this face.  */
31
    GC gc;
32 33 34 35 36 37 38

    /* If we have ever called get_cached_face on this face structure,
       here is the index in face_vector of the face it returned.  It
       might not be valid any more, but it's a good place to start
       looking; get_cached_face tries to use this to avoid searching
       all of face_vector.  */
    int cached_index;
39
  
40
    /* Pixel value for foreground color.  */
41 42
    int foreground;
  
43
    /* Pixel value for background color.  */
44 45
    int background;
  
46 47
    /* Font used for this face.  */
    XFontStruct *font;
48
  
49
    /* Background stipple or bitmap used for this face.  */
50
    Pixmap stipple;
51 52 53

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

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

62
#define NORMAL_FACE ((struct face *) 0)
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

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

Jim Blandy's avatar
Jim Blandy committed
86
/* This structure is used for the actual display of text on a frame.
Jim Blandy's avatar
Jim Blandy committed
87 88 89

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

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

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

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

122
    /* Buffer offset of this line's first char.  */
Jim Blandy's avatar
Jim Blandy committed
123 124 125
    int   *bufp;

#ifdef HAVE_X_WINDOWS
126
    /* Pixel position of top left corner of line.  */
127
    short *top_left_x;
Jim Blandy's avatar
Jim Blandy committed
128 129
    short *top_left_y;

130
    /* Pixel width of line.  */
131 132
    short *pix_width;

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

136
    /* Largest font ascent on this line.  */
137 138 139
    short *max_ascent;
#endif	/* HAVE_X_WINDOWS */
  };
Jim Blandy's avatar
Jim Blandy committed
140 141

extern void get_display_line ();
142
extern Lisp_Object sit_for ();