(checkdoc-this-string-valid-engine):
[emacs.git] / src / msdos.h
blobb7c045612d273e6e19b003b6684f9d955b3bb4b9
1 /* MS-DOS specific C utilities, interface.
2 Copyright (C) 1993, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #ifndef EMACS_MSDOS_H
21 #define EMACS_MSDOS_H
23 #include <dpmi.h>
25 int dos_ttraw ();
26 int dos_ttcooked ();
27 int dos_get_saved_screen (char **, int *, int *);
28 int dos_set_keyboard (int, int);
29 void dos_set_window_size (int *, int *);
31 int getdefdir (int, char*);
32 void unixtodos_filename (char *);
33 void dostounix_filename (char *);
34 char *rootrelativepath (char *);
35 void init_environment ();
36 void internal_terminal_init ();
37 void ctrl_break_func (_go32_dpmi_registers *);
38 void install_ctrl_break_check ();
40 extern int have_mouse;
41 void mouse_init ();
42 void mouse_on ();
43 void mouse_off ();
44 void mouse_moveto (int, int);
46 #ifndef HAVE_X_WINDOWS
47 /* Dummy types. */
48 typedef int XFontStruct;
49 typedef int GC;
50 typedef int Pixmap;
51 typedef int Display;
52 typedef int Window;
53 typedef int XRectangle;
54 #define PIX_TYPE unsigned long
55 #define XDISPLAY
57 /* A stripped version of struct x_display_info in xterm.h, which see. */
58 struct display_info
60 /* These variables describe the range of text currently shown in its
61 mouse-face, together with the window they apply to. As long as
62 the mouse stays within this range, we need not redraw anything on
63 its account. Rows and columns are glyph matrix positions in
64 MOUSE_FACE_WINDOW. */
65 int mouse_face_beg_row, mouse_face_beg_col;
66 int mouse_face_end_row, mouse_face_end_col;
67 int mouse_face_past_end;
68 Lisp_Object mouse_face_window;
69 int mouse_face_face_id;
71 /* 1 if a mouse motion event came and we didn't handle it right away because
72 gc was in progress. */
73 int mouse_face_deferred_gc;
75 /* FRAME and X, Y position of mouse when last checked for
76 highlighting. X and Y can be negative or out of range for the frame. */
77 struct frame *mouse_face_mouse_frame;
78 int mouse_face_mouse_x, mouse_face_mouse_y;
80 /* Nonzero means defer mouse-motion highlighting. */
81 int mouse_face_defer;
83 /* Nonzero means that the mouse highlight should not be shown. */
84 int mouse_face_hidden;
87 typedef struct display_info Display_Info;
89 /* This is a cut-down version of the one in xterm.h, which see. */
90 struct x_output
92 PIX_TYPE background_pixel; /* used in xfaces.c and lots of other places */
93 PIX_TYPE foreground_pixel; /* ditto */
94 XFontStruct *font; /* used in x-popup-menu (xmenu.c) */
95 Window hourglass_window; /* currently unused (but maybe some day) */
96 unsigned hourglass_p : 1; /* ditto */
97 struct display_info display_info; /* used for drawing mouse highlight */
100 extern struct x_output the_only_x_display;
102 #define FRAME_X_DISPLAY(f) ((Display *) 0)
103 #define FRAME_FOREGROUND_PIXEL(f) (the_only_x_display.foreground_pixel)
104 #define FRAME_BACKGROUND_PIXEL(f) (the_only_x_display.background_pixel)
105 #define FRAME_FONT(f) (the_only_x_display.font)
106 #define FRAME_X_DISPLAY_INFO(f) (&the_only_x_display.display_info)
108 /* Prototypes. */
110 /* Forward declarations for prototypes. */
111 struct frame;
112 struct window;
114 /* Defined in xfns.c; emulated on msdos.c */
116 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
117 extern int x_pixel_width P_ ((struct frame *));
118 extern int x_pixel_height P_ ((struct frame *));
120 #define XFreeGC (void)
121 #define x_destroy_bitmap(p1,p2)
122 #define load_pixmap(p1,p2,p3,p4) (0)
123 #define XGetGeometry(p1,p2,p3,p4,p5,p6,p7,p8,p9)
124 #define DisplayWidth(p1,p2) (SELECTED_FRAME()->text_cols)
125 #define DisplayHeight(p1,p2) (SELECTED_FRAME()->text_lines)
126 #define XMenuSetAEQ (void)
127 #define XMenuSetFreeze (void)
128 #define XMenuRecompute (void)
129 #define FONT_WIDTH(foo) 1
130 #define XM_FAILURE -1
131 #define XM_SUCCESS 1
132 #define XM_NO_SELECT 2
133 #define XM_IA_SELECT 3
134 #define ButtonReleaseMask 0
136 typedef struct x_menu_struct
138 int count;
139 char **text;
140 struct x_menu_struct **submenu;
141 int *panenumber; /* Also used as enable. */
142 int allocated;
143 int panecount;
144 int width;
145 char **help_text;
146 } XMenu;
148 XMenu *XMenuCreate (Display *, Window, char *);
149 int XMenuAddPane (Display *, XMenu *, char *, int);
150 int XMenuAddSelection (Display *, XMenu *, int, int, char *, int, char *);
151 void XMenuLocate (Display *, XMenu *, int, int, int, int,
152 int *, int *, int *, int *);
153 int XMenuActivate (Display *, XMenu *, int *, int *, int, int, unsigned,
154 char **, void (*callback)(char *, int, int));
155 void XMenuDestroy (Display *, XMenu *);
157 #endif /* not HAVE_X_WINDOWS */
159 #endif /* not EMACS_MSDOS_H */
161 /* arch-tag: ad21eeed-8fdb-4357-8007-36368a6bdbf3
162 (do not change this comment) */