Update FSF's address in the preamble.
[bpt/emacs.git] / src / dispextern.h
index be6c2fb..500221d 100644 (file)
@@ -1,5 +1,5 @@
 /* Interface definitions for display code.
-   Copyright (C) 1985, 1992 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -15,11 +15,11 @@ 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.  */
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
 
-/* Nonzero means don't assume anything about current
-   contents of actual terminal frame */
-extern int frame_garbaged;
+#ifndef _DISPEXTERN_H_
+#define _DISPEXTERN_H_
 
 /* Nonzero means last display completed and cursor is really at
    cursX, cursY.  Zero means it was preempted. */
@@ -27,32 +27,46 @@ extern int display_completed;
 
 #ifdef HAVE_X_WINDOWS
 #include <X11/Xlib.h>
+#endif
 
+#ifdef MSDOS
+#include "msdos.h"
+#endif
+
+#ifdef HAVE_NTGUI
+#include "win32.h"
+#endif
+
+#ifdef HAVE_FACES
 struct face
   {
     /* If this is non-zero, it is a GC we can use without modification
-       to represent this face. */
+       to represent this face.  */
     GC gc;
   
-    /* Pixel value for foreground color. */
-    int foreground;
+    /* Pixel value for foreground color.  */
+    EMACS_UINT foreground;
   
-    /* Pixel value for background color. */
-    int background;
+    /* Pixel value for background color.  */
+    EMACS_UINT background;
   
-    /* Font used for this face */
-    XFontStruct font;
+    /* Font used for this face */
+    XFontStruct *font;
   
-    /* Background stipple or bitmap used for this face. */
+    /* Background stipple or bitmap used for this face.  */
     Pixmap stipple;
+
+    /* Pixmap_depth.  */
+    unsigned int pixmap_w, pixmap_h;
   
-    /* Whether or not to underline text in this face. */
+    /* Whether or not to underline text in this face.  */
     char underline;
   };
 
+/* Let's stop using this and get rid of it.  */
 typedef struct face *FACE;
 
-#define NORMAL_FACE ((FACE *) 0)
+#define NORMAL_FACE ((struct face *) 0)
 
 #define FACE_HAS_GC(f) ((f)->gc)
 #define FACE_GC(f) ((f)->gc)
@@ -62,7 +76,7 @@ typedef struct face *FACE;
 #define FACE_STIPPLE(f) ((f)->stipple)
 #define FACE_UNDERLINE_P(f) ((f)->underline)
 
-#else  /* Not X */
+#else /* not HAVE_FACES */
 
 typedef int FACE;
 
@@ -73,19 +87,20 @@ typedef int FACE;
 
 #define FACE_HIGHLIGHT(f) ((f) & 0x1)
 #define FACE_UNDERLINE(f) ((f) & 0x2)
-#endif /* Not X */
+
+#endif /* not HAVE_FACES */
 
 
 /* This structure is used for the actual display of text on a frame.
 
    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. */
+   from buffers being displayed.  */
 
 struct frame_glyphs
   {
 #ifdef MULTI_FRAME
-    struct  frame *frame;      /* Frame these glyphs belong to. */
+    struct  frame *frame;      /* Frame these glyphs belong to.  */
 #endif /* MULTI_FRAME */
     int height;
     int width;
@@ -101,6 +116,7 @@ struct frame_glyphs
 
     /* When representing a desired frame,
          enable[n] == 0 means that line n is same as current frame.
+        Between updates, all lines should be disabled.
        When representing current frame contents,
          enable[n] == 0 means that line n is blank.  */
     char *enable;
@@ -111,24 +127,57 @@ struct frame_glyphs
     /* highlight[n] != 0 iff line n is highlighted.  */
     char *highlight;
 
-    /* Buffer offset of this line's first char. */
+    /* Buffer offset of this line's first char.
+       This is not really implemented, and cannot be,
+       and should be deleted.  */
     int   *bufp;
 
-#ifdef HAVE_X_WINDOWS
-    /* Pixel position of top left corner of line. */
+#ifdef HAVE_WINDOW_SYSTEM
+    /* Pixel position of top left corner of line.  */
     short *top_left_x;
     short *top_left_y;
 
-    /* Pixel width of line. */
+    /* Pixel width of line.  */
     short *pix_width;
 
-    /* Pixel height of line. */
+    /* Pixel height of line.  */
     short *pix_height;
 
-    /* Largest font ascent on this line. */
+    /* Largest font ascent on this line.  */
     short *max_ascent;
-#endif /* HAVE_X_WINDOWS */
+#endif /* HAVE_WINDOW_SYSTEM */
+
+    /* 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.  */
+
+    int **charstarts;
+
+    /* This holds all the space in the subvectors of the charstarts field.  */
+    int *total_charstarts;
   };
 
 extern void get_display_line ();
 extern Lisp_Object sit_for ();
+
+#endif /* not _DISPEXTERN_H_ */