eacfbf51e165011518fb72f0083ef0fe2924be6b
[chise/xemacs-chise.git.1] / src / console-msw.h
1 /* Define mswindows-specific console, device, and frame object for XEmacs.
2    Copyright (C) 1989, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
3    Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
4
5 This file is part of XEmacs.
6
7 XEmacs is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
10 later version.
11
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with XEmacs; see the file COPYING.  If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.  */
21
22 /* Synched up with: Not in FSF. */
23
24
25 /* Authorship:
26
27    Ultimately based on FSF, then later on JWZ work for Lemacs.
28    Rewritten over time by Ben Wing and Chuck Thompson.
29    Rewritten for mswindows by Jonathan Harris, November 1997 for 21.0.
30  */
31
32 #ifndef INCLUDED_console_msw_h_
33 #define INCLUDED_console_msw_h_
34
35 #include "console.h"
36 #include "syswindows.h"
37 #include "syscommctrl.h"
38
39 #ifdef HAVE_XPM
40 #include <X11/xpm.h>
41 #endif
42
43 /* The name of the main window class */
44 #define XEMACS_CLASS "XEmacs"
45
46 #define XEMACS_CONTROL_CLASS "XEmacsControl"
47
48 /*
49  * Console
50  */
51
52 DECLARE_CONSOLE_TYPE (mswindows);
53
54 struct mswindows_console
55 {
56   int infd, outfd;
57 };
58
59 DECLARE_CONSOLE_TYPE (msprinter);
60
61 /*
62  * Device
63  */
64
65 #define MSW_FONTSIZE (LF_FACESIZE*4+12)
66
67 struct mswindows_device
68 {
69   int logpixelsx, logpixelsy;
70   int planes, cells;
71   int horzres, vertres;         /* Size in pixels */
72   int horzsize, vertsize;       /* Size in mm */
73   int bitspixel;
74   Lisp_Object fontlist;         /* List of strings, device fonts */
75   HDC hcdc;                     /* Compatible DC */
76 };
77
78 #define DEVICE_MSWINDOWS_DATA(d) DEVICE_TYPE_DATA (d, mswindows)
79 #define DEVICE_MSWINDOWS_LOGPIXELSX(d)  (DEVICE_MSWINDOWS_DATA (d)->logpixelsx)
80 #define DEVICE_MSWINDOWS_LOGPIXELSY(d)  (DEVICE_MSWINDOWS_DATA (d)->logpixelsy)
81 #define DEVICE_MSWINDOWS_PLANES(d)      (DEVICE_MSWINDOWS_DATA (d)->planes)
82 #define DEVICE_MSWINDOWS_CELLS(d)       (DEVICE_MSWINDOWS_DATA (d)->cells)
83 #define DEVICE_MSWINDOWS_HORZRES(d)     (DEVICE_MSWINDOWS_DATA (d)->horzres)
84 #define DEVICE_MSWINDOWS_VERTRES(d)     (DEVICE_MSWINDOWS_DATA (d)->vertres)
85 #define DEVICE_MSWINDOWS_HORZSIZE(d)    (DEVICE_MSWINDOWS_DATA (d)->horzsize)
86 #define DEVICE_MSWINDOWS_VERTSIZE(d)    (DEVICE_MSWINDOWS_DATA (d)->vertsize)
87 #define DEVICE_MSWINDOWS_BITSPIXEL(d)   (DEVICE_MSWINDOWS_DATA (d)->bitspixel)
88 #define DEVICE_MSWINDOWS_FONTLIST(d)    (DEVICE_MSWINDOWS_DATA (d)->fontlist)
89 #define DEVICE_MSWINDOWS_HCDC(d)        (DEVICE_MSWINDOWS_DATA (d)->hcdc)
90
91 struct msprinter_device
92 {
93   HDC hdc, hcdc;                /* Printer and the comp. DCs */
94   HANDLE hprinter;
95   Lisp_Object fontlist;
96   char* name;
97   DEVMODE *devmode, *devmode_mirror;
98   size_t devmode_size;
99 };
100
101 #define DEVICE_MSPRINTER_DATA(d) DEVICE_TYPE_DATA (d, msprinter)
102 #define DEVICE_MSPRINTER_HDC(d)         (DEVICE_MSPRINTER_DATA (d)->hdc)
103 #define DEVICE_MSPRINTER_HCDC(d)        (DEVICE_MSPRINTER_DATA (d)->hcdc)
104 #define DEVICE_MSPRINTER_HPRINTER(d)    (DEVICE_MSPRINTER_DATA (d)->hprinter)
105 #define DEVICE_MSPRINTER_FONTLIST(d)    (DEVICE_MSPRINTER_DATA (d)->fontlist)
106 #define DEVICE_MSPRINTER_NAME(d)        (DEVICE_MSPRINTER_DATA (d)->name)
107 #define DEVICE_MSPRINTER_DEVMODE(d)     (DEVICE_MSPRINTER_DATA (d)->devmode)
108 #define DEVICE_MSPRINTER_DEVMODE_MIRROR(d) \
109         (DEVICE_MSPRINTER_DATA (d)->devmode_mirror)
110 #define DEVICE_MSPRINTER_DEVMODE_SIZE(d) \
111         (DEVICE_MSPRINTER_DATA (d)->devmode_size)
112
113 #define CONSOLE_TYPESYM_MSPRINTER_P(typesym) EQ (typesym, Qmsprinter)
114 #define DEVICE_MSPRINTER_P(dev) CONSOLE_TYPESYM_MSPRINTER_P (DEVICE_TYPE (dev))
115 #define CHECK_MSPRINTER_DEVICE(z) CHECK_DEVICE_TYPE (z, msprinter)
116 #define CONCHECK_MSPRINTER_DEVICE(z) CONCHECK_DEVICE_TYPE (z, msprinter)
117
118 /* Printer functions in device-msw.c */
119 DEVMODE* msprinter_get_devmode_copy (struct device *d);
120 void msprinter_apply_devmode (struct device *d, DEVMODE *devmode);
121
122 /* Printer functions in frame-msw.c */
123 void msprinter_start_page (struct frame *f);
124
125 /* Common checks */
126
127 #define DEVICE_MSGDI_P(dev) (DEVICE_MSWINDOWS_P(dev) || DEVICE_MSPRINTER_P(dev))
128 #define CHECK_MSGDI_DEVICE(d)                           \
129   do {                                                  \
130     CHECK_DEVICE (d);                                   \
131     if (!(DEVICEP (d) && DEVICE_MSGDI_P(XDEVICE(d))))   \
132       dead_wrong_type_argument                          \
133         (list3 (Qor, Qmswindows, Qmsprinter), d);       \
134   } while (0)
135 #define CONCHECK_MSGDI_DEVICE(d)                        \
136   do {                                                  \
137     CHECK_DEVICE (d);                                   \
138     if (!(DEVICEP (d) && DEVICE_MSGDI_P(XDEVICE(d))))   \
139       wrong_type_argument                               \
140         (list3 (Qor, Qmswindows, Qmsprinter), d);       \
141   } while (0)
142
143 /*
144  * Frame
145  */
146 typedef struct
147 {
148   int left;
149   int top;
150   int width;
151   int height;
152 } XEMACS_RECT_WH;
153
154 struct mswindows_frame
155 {
156   /* win32 window handle */
157   HWND hwnd;
158
159   /* DC for this win32 window */
160   HDC hdc;
161
162   /* Used with DeferWindowPos */
163   HDWP hdwp;
164
165   /* Time of last click event, for button 2 emul */
166   DWORD last_click_time;
167
168   /* Coordinates of last click event, screen-relative */
169   POINTS last_click_point;
170 #ifdef HAVE_TOOLBARS
171   /* Toolbar hash table. See toolbar-msw.c */
172   Lisp_Object toolbar_hash_table;
173   unsigned int toolbar_checksum[4];
174 #endif
175
176   /* Menu hash table. See menubar-msw.c */
177   Lisp_Object menu_hash_table;
178
179   /* Menu checksum. See menubar-msw.c */
180   unsigned int menu_checksum;
181
182   /* Widget glyphs attached to this frame. See glyphs-msw.c */
183   Lisp_Object widget_hash_table1, widget_hash_table2, widget_hash_table3;
184
185   /* Frame title hash value. See frame-msw.c */
186   unsigned int title_checksum;
187
188   /* Real character width and height of the frame.
189      FRAME_{HEIGHT,WIDTH} do not work for pixel geometry! */
190   int charheight, charwidth;
191
192   /* Misc flags */
193   int button2_need_lbutton : 1;
194   int button2_need_rbutton : 1;
195   int button2_is_down : 1;
196   int ignore_next_lbutton_up : 1;
197   int ignore_next_rbutton_up : 1;
198   int sizing : 1;
199   int paint_pending : 1; /* Whether a WM_PAINT magic event has been queued */
200
201   /* Geometry, in characters, as specified by proplist during frame
202      creation. Memebers are set to -1 for unspecified */
203   XEMACS_RECT_WH* target_rect;
204 };
205
206 #define FRAME_MSWINDOWS_DATA(f) FRAME_TYPE_DATA (f, mswindows)
207
208 #define FRAME_MSWINDOWS_HANDLE(f)          (FRAME_MSWINDOWS_DATA (f)->hwnd)
209 #define FRAME_MSWINDOWS_DC(f)              (FRAME_MSWINDOWS_DATA (f)->hdc)
210 #define FRAME_MSWINDOWS_MENU_HASH_TABLE(f) (FRAME_MSWINDOWS_DATA (f)->menu_hash_table)
211 #define FRAME_MSWINDOWS_TOOLBAR_HASH_TABLE(f) \
212  (FRAME_MSWINDOWS_DATA (f)->toolbar_hash_table)
213 #define FRAME_MSWINDOWS_WIDGET_HASH_TABLE1(f) \
214  (FRAME_MSWINDOWS_DATA (f)->widget_hash_table1)
215 #define FRAME_MSWINDOWS_WIDGET_HASH_TABLE2(f) \
216  (FRAME_MSWINDOWS_DATA (f)->widget_hash_table2)
217 #define FRAME_MSWINDOWS_WIDGET_HASH_TABLE3(f) \
218  (FRAME_MSWINDOWS_DATA (f)->widget_hash_table3)
219 #define FRAME_MSWINDOWS_TOOLBAR_CHECKSUM(f,pos) \
220  (FRAME_MSWINDOWS_DATA (f)->toolbar_checksum[pos])
221 #define FRAME_MSWINDOWS_MENU_CHECKSUM(f)  (FRAME_MSWINDOWS_DATA (f)->menu_checksum)
222 #define FRAME_MSWINDOWS_TITLE_CHECKSUM(f) (FRAME_MSWINDOWS_DATA (f)->title_checksum)
223 #define FRAME_MSWINDOWS_CHARWIDTH(f)      (FRAME_MSWINDOWS_DATA (f)->charwidth)
224 #define FRAME_MSWINDOWS_CHARHEIGHT(f)     (FRAME_MSWINDOWS_DATA (f)->charheight)
225 #define FRAME_MSWINDOWS_TARGET_RECT(f)    (FRAME_MSWINDOWS_DATA (f)->target_rect)
226
227 /* Frame check and validation macros */
228 #define FRAME_MSWINDOWS_P(frm) CONSOLE_TYPESYM_MSWINDOWS_P (FRAME_TYPE (frm))
229 #define CHECK_MSWINDOWS_FRAME(z) CHECK_FRAME_TYPE (z, mswindows)
230 #define CONCHECK_MSWINDOWS_FRAME(z) CONCHECK_FRAME_TYPE (z, mswindows)
231
232 /* win32 window LONG indices */
233 #define XWL_FRAMEOBJ    0
234 #define XWL_COUNT       1       /* Number of LONGs that we use */
235 #define MSWINDOWS_WINDOW_EXTRA_BYTES    (XWL_COUNT*4)
236
237 /*
238  * Printer frame, aka printer job
239  */
240
241 struct msprinter_frame
242 {
243   int left_margin, top_margin,          /* All in twips */
244     right_margin, bottom_margin;
245   int charheight, charwidth;            /* As per proplist or -1 if not gven */
246   Lisp_Object orientation, duplex;      /* nil for printer's default */
247   int job_started : 1;
248   int page_started : 1;
249 };
250
251 #define FRAME_MSPRINTER_DATA(f) FRAME_TYPE_DATA (f, msprinter)
252 #define FRAME_MSPRINTER_LEFT_MARGIN(f)   (FRAME_MSPRINTER_DATA (f)->left_margin)
253 #define FRAME_MSPRINTER_RIGHT_MARGIN(f)  (FRAME_MSPRINTER_DATA (f)->top_margin)
254 #define FRAME_MSPRINTER_TOP_MARGIN(f)    (FRAME_MSPRINTER_DATA (f)->right_margin)
255 #define FRAME_MSPRINTER_BOTTOM_MARGIN(f) (FRAME_MSPRINTER_DATA (f)->bottom_margin)
256 #define FRAME_MSPRINTER_JOB_STARTED(f)   (FRAME_MSPRINTER_DATA (f)->job_started)
257 #define FRAME_MSPRINTER_PAGE_STARTED(f)  (FRAME_MSPRINTER_DATA (f)->page_started)
258 #define FRAME_MSPRINTER_ORIENTATION(f)   (FRAME_MSPRINTER_DATA (f)->orientation)
259 #define FRAME_MSPRINTER_DUPLEX(f)        (FRAME_MSPRINTER_DATA (f)->duplex)
260 #define FRAME_MSPRINTER_CHARWIDTH(f)     (FRAME_MSPRINTER_DATA (f)->charheight)
261 #define FRAME_MSPRINTER_CHARHEIGHT(f)    (FRAME_MSPRINTER_DATA (f)->charwidth)
262
263 /*
264  * Events
265  */
266
267 /* win32 messages / magic event types */
268 #define EVENT_MSWINDOWS_MAGIC_TYPE(e)   \
269         ((e)->event.magic.underlying_mswindows_event)
270 #define XM_BUMPQUEUE    (WM_USER + 101)
271 #define XM_MAPFRAME     (WM_USER + 102)
272 #define XM_UNMAPFRAME   (WM_USER + 103)
273
274
275 /*
276  * Random globals
277  */
278
279 /* win32 "Windows" procedure */
280 LRESULT WINAPI mswindows_wnd_proc (HWND hwnd, UINT msg, WPARAM wParam,
281                                    LPARAM lParam);
282 LRESULT WINAPI mswindows_control_wnd_proc (HWND hwnd,
283                                            UINT msg, WPARAM wParam,
284                                            LPARAM lParam);
285
286 void mswindows_redraw_exposed_area (struct frame *f, int x, int y, 
287                                     int width, int height);
288 void mswindows_size_frame_internal (struct frame* f, XEMACS_RECT_WH* dest);
289 void mswindows_enqueue_magic_event (HWND hwnd, UINT msg);
290
291 /* win32 DDE management library */
292 #define MSWINDOWS_DDE_ITEM_OPEN "Open"
293 extern DWORD mswindows_dde_mlid;
294 extern HSZ mswindows_dde_service;
295 extern HSZ mswindows_dde_topic_system;
296 extern HSZ mswindows_dde_item_open;
297 HDDEDATA CALLBACK mswindows_dde_callback (UINT uType, UINT uFmt, HCONV hconv,
298                                           HSZ hszTopic, HSZ hszItem,
299                                           HDDEDATA hdata,
300                                           DWORD dwData1, DWORD dwData2);
301
302 void mswindows_enqueue_dispatch_event (Lisp_Object event);
303 void mswindows_enqueue_misc_user_event (Lisp_Object channel,
304                                         Lisp_Object function,
305                                         Lisp_Object object);
306 Lisp_Object mswindows_cancel_dispatch_event (Lisp_Event* event);
307 Lisp_Object mswindows_pump_outstanding_events (void);
308 Lisp_Object mswindows_protect_modal_loop (Lisp_Object (*bfun)
309                                           (Lisp_Object barg),
310                                           Lisp_Object barg);
311 void mswindows_unmodalize_signal_maybe (void);
312
313 COLORREF mswindows_string_to_color (const char *name);
314 USID emacs_mswindows_create_stream_pair (void* inhandle, void* outhandle,
315                                          Lisp_Object* instream,
316                                          Lisp_Object* outstream,
317                                          int flags);
318 USID emacs_mswindows_delete_stream_pair (Lisp_Object instream,
319                                          Lisp_Object outstream);
320
321 #ifdef HAVE_WIN32_PROCESSES
322 HANDLE get_nt_process_handle (Lisp_Process *p);
323 #endif
324
325 extern Lisp_Object Vmswindows_frame_being_created;
326 extern Lisp_Object mswindows_frame_being_created;
327
328 void msw_get_workspace_coords (RECT *rc);
329
330 HWND msw_get_console_hwnd (void);
331 void msw_hide_console (void);
332 void msw_show_console (void);
333 int msw_output_console_string (CONST Extbyte *str, Extcount len);
334
335 Lisp_Object mswindows_enumerate_fonts (HDC hdc);
336
337 int msw_char_is_accelerator (struct frame *f, Emchar ch);
338 Bytecount msw_translate_menu_or_dialog_item (Bufbyte *item, Bytecount len,
339                                              Bytecount maxlen, Emchar *accel,
340                                              Lisp_Object error_name);
341
342 #ifdef HAVE_TOOLBARS
343 Lisp_Object mswindows_get_toolbar_button_text (struct frame* f,
344                                                int command_id);
345 Lisp_Object mswindows_handle_toolbar_wm_command (struct frame* f,
346                                                  HWND ctrl, WORD id);
347 #endif
348 Lisp_Object mswindows_handle_gui_wm_command (struct frame* f,
349                                              HWND ctrl, LPARAM id);
350
351 int msw_windows9x_p (void);
352
353
354 void mswindows_output_last_error (char *frob);
355
356 #endif /* INCLUDED_console_msw_h_ */