winemac: Synthesize additional bitmap pasteboard types from any that Cocoa can convert.
[wine] / dlls / winemac.drv / macdrv_cocoa.h
1 /*
2  * MACDRV Cocoa interface declarations
3  *
4  * Copyright 2011, 2012, 2013 Ken Thomases for CodeWeavers Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 /* This header serves as a C interface between the Wine parts of MACDRV
22  * and the Objective-C parts.  It should restrict itself to C and the C-based
23  * Mac APIs, avoiding both Wine and Objective-C/Cocoa features, so that it can
24  * be included by both sides without contaminating either.
25  */
26
27 #ifndef __WINE_MACDRV_COCOA_H
28 #define __WINE_MACDRV_COCOA_H
29
30
31 #define GetCurrentProcess MacGetCurrentProcess
32 #define GetCurrentThread MacGetCurrentThread
33 #define LoadResource MacLoadResource
34 #define AnimatePalette MacAnimatePalette
35 #define EqualRgn MacEqualRgn
36 #define FillRgn MacFillRgn
37 #define FrameRgn MacFrameRgn
38 #define GetPixel MacGetPixel
39 #define InvertRgn MacInvertRgn
40 #define LineTo MacLineTo
41 #define OffsetRgn MacOffsetRgn
42 #define PaintRgn MacPaintRgn
43 #define Polygon MacPolygon
44 #define ResizePalette MacResizePalette
45 #define SetRectRgn MacSetRectRgn
46 #define EqualRect MacEqualRect
47 #define FillRect MacFillRect
48 #define FrameRect MacFrameRect
49 #define GetCursor MacGetCursor
50 #define InvertRect MacInvertRect
51 #define OffsetRect MacOffsetRect
52 #define PtInRect MacPtInRect
53 #define SetCursor MacSetCursor
54 #define SetRect MacSetRect
55 #define ShowCursor MacShowCursor
56 #define UnionRect MacUnionRect
57
58 #include <ApplicationServices/ApplicationServices.h>
59
60 #undef GetCurrentProcess
61 #undef GetCurrentThread
62 #undef LoadResource
63 #undef AnimatePalette
64 #undef EqualRgn
65 #undef FillRgn
66 #undef FrameRgn
67 #undef GetPixel
68 #undef InvertRgn
69 #undef LineTo
70 #undef OffsetRgn
71 #undef PaintRgn
72 #undef Polygon
73 #undef ResizePalette
74 #undef SetRectRgn
75 #undef EqualRect
76 #undef FillRect
77 #undef FrameRect
78 #undef GetCursor
79 #undef InvertRect
80 #undef OffsetRect
81 #undef PtInRect
82 #undef SetCursor
83 #undef SetRect
84 #undef ShowCursor
85 #undef UnionRect
86 #undef DPRINTF
87
88 #include <pthread.h>
89
90
91 #ifndef DECLSPEC_HIDDEN
92 # if defined(__MSC_VER) || defined(__MINGW32__) || defined(__CYGWIN__)
93 #  define DECLSPEC_HIDDEN
94 # elif defined(__GNUC__) && ((__GNUC__ > 3) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 3)))
95 #  define DECLSPEC_HIDDEN __attribute__((visibility ("hidden")))
96 # else
97 #  define DECLSPEC_HIDDEN
98 # endif
99 #endif
100
101
102 typedef struct macdrv_opaque_window* macdrv_window;
103 typedef struct macdrv_opaque_event_queue* macdrv_event_queue;
104 typedef struct macdrv_opaque_view* macdrv_view;
105 typedef struct macdrv_opaque_opengl_context* macdrv_opengl_context;
106 struct macdrv_event;
107 struct macdrv_query;
108
109 struct macdrv_display {
110     CGDirectDisplayID displayID;
111     CGRect frame;
112     CGRect work_frame;
113 };
114
115
116 /* main */
117 extern int macdrv_err_on;
118
119 extern int macdrv_start_cocoa_app(unsigned long long tickcount) DECLSPEC_HIDDEN;
120 extern void macdrv_window_rejected_focus(const struct macdrv_event *event) DECLSPEC_HIDDEN;
121 extern void macdrv_beep(void) DECLSPEC_HIDDEN;
122
123
124 /* cursor */
125 extern void macdrv_set_cursor(CFStringRef name, CFArrayRef frames) DECLSPEC_HIDDEN;
126 extern int macdrv_get_cursor_position(CGPoint *pos) DECLSPEC_HIDDEN;
127 extern int macdrv_set_cursor_position(CGPoint pos) DECLSPEC_HIDDEN;
128 extern int macdrv_clip_cursor(CGRect rect) DECLSPEC_HIDDEN;
129
130
131 /* display */
132 extern int macdrv_get_displays(struct macdrv_display** displays, int* count) DECLSPEC_HIDDEN;
133 extern void macdrv_free_displays(struct macdrv_display* displays) DECLSPEC_HIDDEN;
134 extern int macdrv_set_display_mode(const struct macdrv_display* display,
135                                    CGDisplayModeRef display_mode) DECLSPEC_HIDDEN;
136
137
138 /* event */
139 enum {
140     APP_DEACTIVATED,
141     DISPLAYS_CHANGED,
142     KEY_PRESS,
143     KEY_RELEASE,
144     KEYBOARD_CHANGED,
145     MOUSE_BUTTON,
146     MOUSE_MOVED,
147     MOUSE_MOVED_ABSOLUTE,
148     MOUSE_SCROLL,
149     QUERY_EVENT,
150     WINDOW_CLOSE_REQUESTED,
151     WINDOW_DID_MINIMIZE,
152     WINDOW_DID_UNMINIMIZE,
153     WINDOW_FRAME_CHANGED,
154     WINDOW_GOT_FOCUS,
155     WINDOW_LOST_FOCUS,
156     NUM_EVENT_TYPES
157 };
158
159 typedef uint32_t macdrv_event_mask;
160
161 typedef struct macdrv_event {
162     int                 type;
163     macdrv_window       window;
164     union {
165         struct {
166             int activating;
167         }                                           displays_changed;
168         struct {
169             CGKeyCode                   keycode;
170             CGEventFlags                modifiers;
171             unsigned long               time_ms;
172         }                                           key;
173         struct {
174             CFDataRef                   uchr;
175             CGEventSourceKeyboardType   keyboard_type;
176             int                         iso_keyboard;
177         }                                           keyboard_changed;
178         struct {
179             int             button;
180             int             pressed;
181             int             x;
182             int             y;
183             unsigned long   time_ms;
184         }                                           mouse_button;
185         struct {
186             int             x;
187             int             y;
188             unsigned long   time_ms;
189         }                                           mouse_moved;
190         struct {
191             int             x_scroll;
192             int             y_scroll;
193             int             x;
194             int             y;
195             unsigned long   time_ms;
196         }                                           mouse_scroll;
197         struct {
198             struct macdrv_query *query;
199         }                                           query_event;
200         struct {
201             CGRect frame;
202         }                                           window_frame_changed;
203         struct {
204             unsigned long   serial;
205             void           *tried_windows;
206         }                                           window_got_focus;
207     };
208 } macdrv_event;
209
210 enum {
211     QUERY_PASTEBOARD_DATA,
212     NUM_QUERY_TYPES
213 };
214
215 typedef struct macdrv_query {
216     int                 refs;
217     int                 type;
218     macdrv_window       window;
219     int                 status;
220     int                 done;
221     union {
222         struct {
223             CFStringRef type;
224         }                                           pasteboard_data;
225     };
226 } macdrv_query;
227
228 static inline macdrv_event_mask event_mask_for_type(int type)
229 {
230     return ((macdrv_event_mask)1 << type);
231 }
232
233 typedef void (*macdrv_event_handler)(macdrv_event *event);
234
235 extern macdrv_event_queue macdrv_create_event_queue(macdrv_event_handler handler) DECLSPEC_HIDDEN;
236 extern void macdrv_destroy_event_queue(macdrv_event_queue queue) DECLSPEC_HIDDEN;
237 extern int macdrv_get_event_queue_fd(macdrv_event_queue queue) DECLSPEC_HIDDEN;
238
239 extern int macdrv_get_event_from_queue(macdrv_event_queue queue,
240         macdrv_event_mask mask, macdrv_event *event) DECLSPEC_HIDDEN;
241 extern void macdrv_cleanup_event(macdrv_event *event) DECLSPEC_HIDDEN;
242
243 extern macdrv_query* macdrv_create_query(void) DECLSPEC_HIDDEN;
244 extern macdrv_query* macdrv_retain_query(macdrv_query *query) DECLSPEC_HIDDEN;
245 extern void macdrv_release_query(macdrv_query *query) DECLSPEC_HIDDEN;
246 extern void macdrv_set_query_done(macdrv_query *query) DECLSPEC_HIDDEN;
247
248
249 /* window */
250 struct macdrv_window_features {
251     unsigned int    title_bar:1;
252     unsigned int    close_button:1;
253     unsigned int    minimize_button:1;
254     unsigned int    resizable:1;
255     unsigned int    utility:1;
256     unsigned int    shadow:1;
257 };
258
259 struct macdrv_window_state {
260     unsigned int    disabled:1;
261     unsigned int    no_activate:1;
262     unsigned int    floating:1;
263     unsigned int    excluded_by_expose:1;
264     unsigned int    excluded_by_cycle:1;
265     unsigned int    minimized:1;
266 };
267
268 extern macdrv_window macdrv_create_cocoa_window(const struct macdrv_window_features* wf,
269         CGRect frame, void* hwnd, macdrv_event_queue queue) DECLSPEC_HIDDEN;
270 extern void macdrv_destroy_cocoa_window(macdrv_window w) DECLSPEC_HIDDEN;
271 extern void* macdrv_get_window_hwnd(macdrv_window w) DECLSPEC_HIDDEN;
272 extern void macdrv_set_cocoa_window_features(macdrv_window w,
273         const struct macdrv_window_features* wf) DECLSPEC_HIDDEN;
274 extern void macdrv_set_cocoa_window_state(macdrv_window w,
275         const struct macdrv_window_state* state) DECLSPEC_HIDDEN;
276 extern void macdrv_set_cocoa_window_title(macdrv_window w, const UniChar* title,
277         size_t length) DECLSPEC_HIDDEN;
278 extern int macdrv_order_cocoa_window(macdrv_window w, macdrv_window prev,
279         macdrv_window next) DECLSPEC_HIDDEN;
280 extern void macdrv_hide_cocoa_window(macdrv_window w) DECLSPEC_HIDDEN;
281 extern int macdrv_set_cocoa_window_frame(macdrv_window w, const CGRect* new_frame) DECLSPEC_HIDDEN;
282 extern void macdrv_get_cocoa_window_frame(macdrv_window w, CGRect* out_frame) DECLSPEC_HIDDEN;
283 extern void macdrv_set_cocoa_parent_window(macdrv_window w, macdrv_window parent) DECLSPEC_HIDDEN;
284 extern void macdrv_set_window_surface(macdrv_window w, void *surface, pthread_mutex_t *mutex) DECLSPEC_HIDDEN;
285 extern CGImageRef create_surface_image(void *window_surface, CGRect *rect, int copy_data) DECLSPEC_HIDDEN;
286 extern int get_surface_region_rects(void *window_surface, const CGRect **rects, int *count) DECLSPEC_HIDDEN;
287 extern void macdrv_window_needs_display(macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
288 extern void macdrv_set_window_shape(macdrv_window w, const CGRect *rects, int count) DECLSPEC_HIDDEN;
289 extern void macdrv_set_window_alpha(macdrv_window w, CGFloat alpha) DECLSPEC_HIDDEN;
290 extern void macdrv_set_window_color_key(macdrv_window w, CGFloat keyRed, CGFloat keyGreen,
291                                         CGFloat keyBlue) DECLSPEC_HIDDEN;
292 extern void macdrv_clear_window_color_key(macdrv_window w) DECLSPEC_HIDDEN;
293 extern void macdrv_window_use_per_pixel_alpha(macdrv_window w, int use_per_pixel_alpha) DECLSPEC_HIDDEN;
294 extern void macdrv_give_cocoa_window_focus(macdrv_window w) DECLSPEC_HIDDEN;
295 extern macdrv_view macdrv_create_view(macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
296 extern void macdrv_dispose_view(macdrv_view v) DECLSPEC_HIDDEN;
297 extern void macdrv_set_view_window_and_frame(macdrv_view v, macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
298 extern void macdrv_add_view_opengl_context(macdrv_view v, macdrv_opengl_context c) DECLSPEC_HIDDEN;
299 extern void macdrv_remove_view_opengl_context(macdrv_view v, macdrv_opengl_context c) DECLSPEC_HIDDEN;
300
301
302 /* keyboard */
303 extern CFDataRef macdrv_copy_keyboard_layout(CGEventSourceKeyboardType* keyboard_type, int* is_iso) DECLSPEC_HIDDEN;
304
305
306 /* clipboard */
307 extern CFArrayRef macdrv_copy_pasteboard_types(void) DECLSPEC_HIDDEN;
308 extern CFDataRef macdrv_copy_pasteboard_data(CFStringRef type) DECLSPEC_HIDDEN;
309 extern int macdrv_is_pasteboard_owner(void) DECLSPEC_HIDDEN;
310 extern void macdrv_clear_pasteboard(void) DECLSPEC_HIDDEN;
311 extern int macdrv_set_pasteboard_data(CFStringRef type, CFDataRef data, macdrv_window w) DECLSPEC_HIDDEN;
312
313
314 /* opengl */
315 extern macdrv_opengl_context macdrv_create_opengl_context(void* cglctx) DECLSPEC_HIDDEN;
316 extern void macdrv_dispose_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
317 extern void macdrv_make_context_current(macdrv_opengl_context c, macdrv_view v) DECLSPEC_HIDDEN;
318 extern void macdrv_update_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
319 extern void macdrv_flush_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
320
321 #endif  /* __WINE_MACDRV_COCOA_H */