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 /* Must match the values of Cocoa's NSDragOperation enum. */
 103 enum {
 104     DRAG_OP_NONE    = 0,
 105     DRAG_OP_COPY    = 1,
 106     DRAG_OP_LINK    = 2,
 107     DRAG_OP_GENERIC = 4,
 108     DRAG_OP_PRIVATE = 8,
 109     DRAG_OP_MOVE    = 16,
 110     DRAG_OP_DELETE  = 32,
 111     DRAG_OP_EVERY   = UINT32_MAX
 112 };
 113
 114
 115 typedef struct macdrv_opaque_window* macdrv_window;
 116 typedef struct macdrv_opaque_event_queue* macdrv_event_queue;
 117 typedef struct macdrv_opaque_view* macdrv_view;
 118 typedef struct macdrv_opaque_opengl_context* macdrv_opengl_context;
 119 struct macdrv_event;
 120 struct macdrv_query;
 121
 122 struct macdrv_display {
 123     CGDirectDisplayID displayID;
 124     CGRect frame;
 125     CGRect work_frame;
 126 };
 127
 128
 129 /* main */
 130 extern int macdrv_err_on;
 131
 132 extern int macdrv_start_cocoa_app(unsigned long long tickcount) DECLSPEC_HIDDEN;
 133 extern void macdrv_window_rejected_focus(const struct macdrv_event *event) DECLSPEC_HIDDEN;
 134 extern void macdrv_beep(void) DECLSPEC_HIDDEN;
 135 extern void macdrv_set_application_icon(CFArrayRef images) DECLSPEC_HIDDEN;
 136
 137
 138 /* cursor */
 139 extern void macdrv_set_cursor(CFStringRef name, CFArrayRef frames) DECLSPEC_HIDDEN;
 140 extern int macdrv_get_cursor_position(CGPoint *pos) DECLSPEC_HIDDEN;
 141 extern int macdrv_set_cursor_position(CGPoint pos) DECLSPEC_HIDDEN;
 142 extern int macdrv_clip_cursor(CGRect rect) DECLSPEC_HIDDEN;
 143
 144
 145 /* display */
 146 extern int macdrv_get_displays(struct macdrv_display** displays, int* count) DECLSPEC_HIDDEN;
 147 extern void macdrv_free_displays(struct macdrv_display* displays) DECLSPEC_HIDDEN;
 148 extern int macdrv_set_display_mode(const struct macdrv_display* display,
 149                                    CGDisplayModeRef display_mode) DECLSPEC_HIDDEN;
 150
 151
 152 /* event */
 153 enum {
 154     APP_DEACTIVATED,
 155     DISPLAYS_CHANGED,
 156     KEY_PRESS,
 157     KEY_RELEASE,
 158     KEYBOARD_CHANGED,
 159     MOUSE_BUTTON,
 160     MOUSE_MOVED,
 161     MOUSE_MOVED_ABSOLUTE,
 162     MOUSE_SCROLL,
 163     QUERY_EVENT,
 164     WINDOW_CLOSE_REQUESTED,
 165     WINDOW_DID_MINIMIZE,
 166     WINDOW_DID_UNMINIMIZE,
 167     WINDOW_FRAME_CHANGED,
 168     WINDOW_GOT_FOCUS,
 169     WINDOW_LOST_FOCUS,
 170     NUM_EVENT_TYPES
 171 };
 172
 173 typedef uint32_t macdrv_event_mask;
 174
 175 typedef struct macdrv_event {
 176     int                 type;
 177     macdrv_window       window;
 178     union {
 179         struct {
 180             int activating;
 181         }                                           displays_changed;
 182         struct {
 183             CGKeyCode                   keycode;
 184             CGEventFlags                modifiers;
 185             unsigned long               time_ms;
 186         }                                           key;
 187         struct {
 188             CFDataRef                   uchr;
 189             CGEventSourceKeyboardType   keyboard_type;
 190             int                         iso_keyboard;
 191         }                                           keyboard_changed;
 192         struct {
 193             int             button;
 194             int             pressed;
 195             int             x;
 196             int             y;
 197             unsigned long   time_ms;
 198         }                                           mouse_button;
 199         struct {
 200             int             x;
 201             int             y;
 202             unsigned long   time_ms;
 203         }                                           mouse_moved;
 204         struct {
 205             int             x_scroll;
 206             int             y_scroll;
 207             int             x;
 208             int             y;
 209             unsigned long   time_ms;
 210         }                                           mouse_scroll;
 211         struct {
 212             struct macdrv_query *query;
 213         }                                           query_event;
 214         struct {
 215             CGRect frame;
 216         }                                           window_frame_changed;
 217         struct {
 218             unsigned long   serial;
 219             void           *tried_windows;
 220         }                                           window_got_focus;
 221     };
 222 } macdrv_event;
 223
 224 enum {
 225     QUERY_DRAG_DROP,
 226     QUERY_DRAG_EXITED,
 227     QUERY_DRAG_OPERATION,
 228     QUERY_PASTEBOARD_DATA,
 229     NUM_QUERY_TYPES
 230 };
 231
 232 typedef struct macdrv_query {
 233     int                 refs;
 234     int                 type;
 235     macdrv_window       window;
 236     int                 status;
 237     int                 done;
 238     union {
 239         struct {
 240             int                 x;
 241             int                 y;
 242             uint32_t            op;
 243             CFTypeRef           pasteboard;
 244         }                                           drag_drop;
 245         struct {
 246             int                 x;
 247             int                 y;
 248             uint32_t            offered_ops;
 249             uint32_t            accepted_op;
 250             CFTypeRef           pasteboard;
 251         }                                           drag_operation;
 252         struct {
 253             CFStringRef type;
 254         }                                           pasteboard_data;
 255     };
 256 } macdrv_query;
 257
 258 static inline macdrv_event_mask event_mask_for_type(int type)
 259 {
 260     return ((macdrv_event_mask)1 << type);
 261 }
 262
 263 typedef void (*macdrv_event_handler)(macdrv_event *event);
 264
 265 extern macdrv_event_queue macdrv_create_event_queue(macdrv_event_handler handler) DECLSPEC_HIDDEN;
 266 extern void macdrv_destroy_event_queue(macdrv_event_queue queue) DECLSPEC_HIDDEN;
 267 extern int macdrv_get_event_queue_fd(macdrv_event_queue queue) DECLSPEC_HIDDEN;
 268
 269 extern int macdrv_get_event_from_queue(macdrv_event_queue queue,
 270         macdrv_event_mask mask, macdrv_event *event) DECLSPEC_HIDDEN;
 271 extern void macdrv_cleanup_event(macdrv_event *event) DECLSPEC_HIDDEN;
 272
 273 extern macdrv_query* macdrv_create_query(void) DECLSPEC_HIDDEN;
 274 extern macdrv_query* macdrv_retain_query(macdrv_query *query) DECLSPEC_HIDDEN;
 275 extern void macdrv_release_query(macdrv_query *query) DECLSPEC_HIDDEN;
 276 extern void macdrv_set_query_done(macdrv_query *query) DECLSPEC_HIDDEN;
 277
 278
 279 /* window */
 280 struct macdrv_window_features {
 281     unsigned int    title_bar:1;
 282     unsigned int    close_button:1;
 283     unsigned int    minimize_button:1;
 284     unsigned int    resizable:1;
 285     unsigned int    utility:1;
 286     unsigned int    shadow:1;
 287 };
 288
 289 struct macdrv_window_state {
 290     unsigned int    disabled:1;
 291     unsigned int    no_activate:1;
 292     unsigned int    floating:1;
 293     unsigned int    excluded_by_expose:1;
 294     unsigned int    excluded_by_cycle:1;
 295     unsigned int    minimized:1;
 296 };
 297
 298 extern macdrv_window macdrv_create_cocoa_window(const struct macdrv_window_features* wf,
 299         CGRect frame, void* hwnd, macdrv_event_queue queue) DECLSPEC_HIDDEN;
 300 extern void macdrv_destroy_cocoa_window(macdrv_window w) DECLSPEC_HIDDEN;
 301 extern void* macdrv_get_window_hwnd(macdrv_window w) DECLSPEC_HIDDEN;
 302 extern void macdrv_set_cocoa_window_features(macdrv_window w,
 303         const struct macdrv_window_features* wf) DECLSPEC_HIDDEN;
 304 extern void macdrv_set_cocoa_window_state(macdrv_window w,
 305         const struct macdrv_window_state* state) DECLSPEC_HIDDEN;
 306 extern void macdrv_set_cocoa_window_title(macdrv_window w, const UniChar* title,
 307         size_t length) DECLSPEC_HIDDEN;
 308 extern int macdrv_order_cocoa_window(macdrv_window w, macdrv_window prev,
 309         macdrv_window next) DECLSPEC_HIDDEN;
 310 extern void macdrv_hide_cocoa_window(macdrv_window w) DECLSPEC_HIDDEN;
 311 extern int macdrv_set_cocoa_window_frame(macdrv_window w, const CGRect* new_frame) DECLSPEC_HIDDEN;
 312 extern void macdrv_get_cocoa_window_frame(macdrv_window w, CGRect* out_frame) DECLSPEC_HIDDEN;
 313 extern void macdrv_set_cocoa_parent_window(macdrv_window w, macdrv_window parent) DECLSPEC_HIDDEN;
 314 extern void macdrv_set_window_surface(macdrv_window w, void *surface, pthread_mutex_t *mutex) DECLSPEC_HIDDEN;
 315 extern CGImageRef create_surface_image(void *window_surface, CGRect *rect, int copy_data) DECLSPEC_HIDDEN;
 316 extern int get_surface_region_rects(void *window_surface, const CGRect **rects, int *count) DECLSPEC_HIDDEN;
 317 extern void macdrv_window_needs_display(macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
 318 extern void macdrv_set_window_shape(macdrv_window w, const CGRect *rects, int count) DECLSPEC_HIDDEN;
 319 extern void macdrv_set_window_alpha(macdrv_window w, CGFloat alpha) DECLSPEC_HIDDEN;
 320 extern void macdrv_set_window_color_key(macdrv_window w, CGFloat keyRed, CGFloat keyGreen,
 321                                         CGFloat keyBlue) DECLSPEC_HIDDEN;
 322 extern void macdrv_clear_window_color_key(macdrv_window w) DECLSPEC_HIDDEN;
 323 extern void macdrv_window_use_per_pixel_alpha(macdrv_window w, int use_per_pixel_alpha) DECLSPEC_HIDDEN;
 324 extern void macdrv_give_cocoa_window_focus(macdrv_window w) DECLSPEC_HIDDEN;
 325 extern macdrv_view macdrv_create_view(macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
 326 extern void macdrv_dispose_view(macdrv_view v) DECLSPEC_HIDDEN;
 327 extern void macdrv_set_view_window_and_frame(macdrv_view v, macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
 328 extern void macdrv_add_view_opengl_context(macdrv_view v, macdrv_opengl_context c) DECLSPEC_HIDDEN;
 329 extern void macdrv_remove_view_opengl_context(macdrv_view v, macdrv_opengl_context c) DECLSPEC_HIDDEN;
 330
 331
 332 /* keyboard */
 333 extern CFDataRef macdrv_copy_keyboard_layout(CGEventSourceKeyboardType* keyboard_type, int* is_iso) DECLSPEC_HIDDEN;
 334
 335
 336 /* clipboard */
 337 extern CFArrayRef macdrv_copy_pasteboard_types(CFTypeRef pasteboard) DECLSPEC_HIDDEN;
 338 extern CFDataRef macdrv_copy_pasteboard_data(CFTypeRef pasteboard, CFStringRef type) DECLSPEC_HIDDEN;
 339 extern int macdrv_is_pasteboard_owner(void) DECLSPEC_HIDDEN;
 340 extern void macdrv_clear_pasteboard(void) DECLSPEC_HIDDEN;
 341 extern int macdrv_set_pasteboard_data(CFStringRef type, CFDataRef data, macdrv_window w) DECLSPEC_HIDDEN;
 342
 343
 344 /* opengl */
 345 extern macdrv_opengl_context macdrv_create_opengl_context(void* cglctx) DECLSPEC_HIDDEN;
 346 extern void macdrv_dispose_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
 347 extern void macdrv_make_context_current(macdrv_opengl_context c, macdrv_view v) DECLSPEC_HIDDEN;
 348 extern void macdrv_update_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
 349 extern void macdrv_flush_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
 350
 351 #endif  /* __WINE_MACDRV_COCOA_H */