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 enum {
 115     TOPMOST_FLOAT_INACTIVE_NONE,
 116     TOPMOST_FLOAT_INACTIVE_NONFULLSCREEN,
 117     TOPMOST_FLOAT_INACTIVE_ALL,
 118 };
 119
 120 enum {
 121     GL_SURFACE_IN_FRONT_OPAQUE,
 122     GL_SURFACE_IN_FRONT_TRANSPARENT,
 123     GL_SURFACE_BEHIND,
 124 };
 125
 126 enum {
 127     MACDRV_HOTKEY_SUCCESS,
 128     MACDRV_HOTKEY_ALREADY_REGISTERED,
 129     MACDRV_HOTKEY_FAILURE,
 130 };
 131
 132 typedef struct __TISInputSource *TISInputSourceRef;
 133
 134 typedef struct macdrv_opaque_window* macdrv_window;
 135 typedef struct macdrv_opaque_event_queue* macdrv_event_queue;
 136 typedef struct macdrv_opaque_view* macdrv_view;
 137 typedef struct macdrv_opaque_opengl_context* macdrv_opengl_context;
 138 typedef struct macdrv_opaque_status_item* macdrv_status_item;
 139 struct macdrv_event;
 140 struct macdrv_query;
 141
 142 struct macdrv_display {
 143     CGDirectDisplayID displayID;
 144     CGRect frame;
 145     CGRect work_frame;
 146 };
 147
 148
 149 /* main */
 150 extern int macdrv_err_on;
 151 extern int topmost_float_inactive DECLSPEC_HIDDEN;
 152 extern int capture_displays_for_fullscreen DECLSPEC_HIDDEN;
 153 extern int left_option_is_alt DECLSPEC_HIDDEN;
 154 extern int right_option_is_alt DECLSPEC_HIDDEN;
 155 extern int allow_immovable_windows DECLSPEC_HIDDEN;
 156 extern int cursor_clipping_locks_windows DECLSPEC_HIDDEN;
 157 extern int use_precise_scrolling DECLSPEC_HIDDEN;
 158 extern int gl_surface_mode DECLSPEC_HIDDEN;
 159
 160 extern int macdrv_start_cocoa_app(unsigned long long tickcount) DECLSPEC_HIDDEN;
 161 extern void macdrv_window_rejected_focus(const struct macdrv_event *event) DECLSPEC_HIDDEN;
 162 extern void macdrv_beep(void) DECLSPEC_HIDDEN;
 163 extern void macdrv_set_application_icon(CFArrayRef images) DECLSPEC_HIDDEN;
 164 extern void macdrv_quit_reply(int reply) DECLSPEC_HIDDEN;
 165 extern int macdrv_using_input_method(void) DECLSPEC_HIDDEN;
 166 extern void macdrv_set_mouse_capture_window(macdrv_window window) DECLSPEC_HIDDEN;
 167
 168
 169 /* cursor */
 170 extern void macdrv_set_cursor(CFStringRef name, CFArrayRef frames) DECLSPEC_HIDDEN;
 171 extern int macdrv_get_cursor_position(CGPoint *pos) DECLSPEC_HIDDEN;
 172 extern int macdrv_set_cursor_position(CGPoint pos) DECLSPEC_HIDDEN;
 173 extern int macdrv_clip_cursor(CGRect rect) DECLSPEC_HIDDEN;
 174
 175
 176 /* display */
 177 extern int macdrv_get_displays(struct macdrv_display** displays, int* count) DECLSPEC_HIDDEN;
 178 extern void macdrv_free_displays(struct macdrv_display* displays) DECLSPEC_HIDDEN;
 179 extern int macdrv_set_display_mode(const struct macdrv_display* display,
 180                                    CGDisplayModeRef display_mode) DECLSPEC_HIDDEN;
 181
 182
 183 /* event */
 184 enum {
 185     APP_DEACTIVATED,
 186     APP_QUIT_REQUESTED,
 187     DISPLAYS_CHANGED,
 188     HOTKEY_PRESS,
 189     IM_SET_TEXT,
 190     KEY_PRESS,
 191     KEY_RELEASE,
 192     KEYBOARD_CHANGED,
 193     MOUSE_BUTTON,
 194     MOUSE_MOVED,
 195     MOUSE_MOVED_ABSOLUTE,
 196     MOUSE_SCROLL,
 197     QUERY_EVENT,
 198     RELEASE_CAPTURE,
 199     STATUS_ITEM_MOUSE_BUTTON,
 200     STATUS_ITEM_MOUSE_MOVE,
 201     WINDOW_BROUGHT_FORWARD,
 202     WINDOW_CLOSE_REQUESTED,
 203     WINDOW_DID_UNMINIMIZE,
 204     WINDOW_DRAG_BEGIN,
 205     WINDOW_DRAG_END,
 206     WINDOW_FRAME_CHANGED,
 207     WINDOW_GOT_FOCUS,
 208     WINDOW_LOST_FOCUS,
 209     WINDOW_MAXIMIZE_REQUESTED,
 210     WINDOW_MINIMIZE_REQUESTED,
 211     WINDOW_RESIZE_ENDED,
 212     WINDOW_RESTORE_REQUESTED,
 213     NUM_EVENT_TYPES
 214 };
 215
 216 enum {
 217     QUIT_REASON_NONE,
 218     QUIT_REASON_LOGOUT,
 219     QUIT_REASON_RESTART,
 220     QUIT_REASON_SHUTDOWN,
 221 };
 222
 223 typedef uint32_t macdrv_event_mask;
 224
 225 typedef struct macdrv_event {
 226     int                 refs;
 227     int                 deliver;
 228     int                 type;
 229     macdrv_window       window;
 230     union {
 231         struct {
 232             int reason;
 233         }                                           app_quit_requested;
 234         struct {
 235             int activating;
 236         }                                           displays_changed;
 237         struct {
 238             unsigned int    vkey;
 239             unsigned int    mod_flags;
 240             unsigned int    keycode;
 241             unsigned long   time_ms;
 242         }                                           hotkey_press;
 243         struct {
 244             void           *data;
 245             CFStringRef     text;       /* new text or NULL if just completing existing text */
 246             unsigned int    cursor_pos;
 247             unsigned int    complete;   /* is completing text? */
 248         }                                           im_set_text;
 249         struct {
 250             CGKeyCode                   keycode;
 251             CGEventFlags                modifiers;
 252             unsigned long               time_ms;
 253         }                                           key;
 254         struct {
 255             CFDataRef                   uchr;
 256             CGEventSourceKeyboardType   keyboard_type;
 257             int                         iso_keyboard;
 258             TISInputSourceRef           input_source;
 259         }                                           keyboard_changed;
 260         struct {
 261             int             button;
 262             int             pressed;
 263             int             x;
 264             int             y;
 265             unsigned long   time_ms;
 266         }                                           mouse_button;
 267         struct {
 268             int             x;
 269             int             y;
 270             int             drag;
 271             unsigned long   time_ms;
 272         }                                           mouse_moved;
 273         struct {
 274             int             x_scroll;
 275             int             y_scroll;
 276             int             x;
 277             int             y;
 278             unsigned long   time_ms;
 279         }                                           mouse_scroll;
 280         struct {
 281             struct macdrv_query *query;
 282         }                                           query_event;
 283         struct {
 284             macdrv_status_item  item;
 285             int                 button;
 286             int                 down;
 287             int                 count;
 288         }                                           status_item_mouse_button;
 289         struct {
 290             macdrv_status_item  item;
 291         }                                           status_item_mouse_move;
 292         struct {
 293             CGRect  frame;
 294             int     fullscreen;
 295             int     in_resize;
 296         }                                           window_frame_changed;
 297         struct {
 298             unsigned long   serial;
 299             void           *tried_windows;
 300         }                                           window_got_focus;
 301         struct {
 302             int     keep_frame;
 303             CGRect  frame;
 304         }                                           window_restore_requested;
 305     };
 306 } macdrv_event;
 307
 308 enum {
 309     QUERY_DRAG_DROP,
 310     QUERY_DRAG_EXITED,
 311     QUERY_DRAG_OPERATION,
 312     QUERY_IME_CHAR_RECT,
 313     QUERY_PASTEBOARD_DATA,
 314     QUERY_RESIZE_SIZE,
 315     QUERY_RESIZE_START,
 316     QUERY_MIN_MAX_INFO,
 317     NUM_QUERY_TYPES
 318 };
 319
 320 typedef struct macdrv_query {
 321     int                 refs;
 322     int                 type;
 323     macdrv_window       window;
 324     int                 status;
 325     int                 done;
 326     union {
 327         struct {
 328             int                 x;
 329             int                 y;
 330             uint32_t            op;
 331             CFTypeRef           pasteboard;
 332         }                                           drag_drop;
 333         struct {
 334             int                 x;
 335             int                 y;
 336             uint32_t            offered_ops;
 337             uint32_t            accepted_op;
 338             CFTypeRef           pasteboard;
 339         }                                           drag_operation;
 340         struct {
 341             void   *data;
 342             CFRange range;
 343             CGRect  rect;
 344         }                                           ime_char_rect;
 345         struct {
 346             CFStringRef type;
 347         }                                           pasteboard_data;
 348         struct {
 349             CGRect          rect;
 350             unsigned int    from_left : 1;
 351             unsigned int    from_top : 1;
 352         }                                           resize_size;
 353     };
 354 } macdrv_query;
 355
 356 static inline macdrv_event_mask event_mask_for_type(int type)
 357 {
 358     return ((macdrv_event_mask)1 << type);
 359 }
 360
 361 typedef void (*macdrv_event_handler)(const macdrv_event *event);
 362
 363 extern macdrv_event_queue macdrv_create_event_queue(macdrv_event_handler handler) DECLSPEC_HIDDEN;
 364 extern void macdrv_destroy_event_queue(macdrv_event_queue queue) DECLSPEC_HIDDEN;
 365 extern int macdrv_get_event_queue_fd(macdrv_event_queue queue) DECLSPEC_HIDDEN;
 366
 367 extern int macdrv_copy_event_from_queue(macdrv_event_queue queue,
 368         macdrv_event_mask mask, macdrv_event **event) DECLSPEC_HIDDEN;
 369 extern void macdrv_release_event(macdrv_event *event) DECLSPEC_HIDDEN;
 370
 371 extern macdrv_query* macdrv_create_query(void) DECLSPEC_HIDDEN;
 372 extern macdrv_query* macdrv_retain_query(macdrv_query *query) DECLSPEC_HIDDEN;
 373 extern void macdrv_release_query(macdrv_query *query) DECLSPEC_HIDDEN;
 374 extern void macdrv_set_query_done(macdrv_query *query) DECLSPEC_HIDDEN;
 375 extern int macdrv_register_hot_key(macdrv_event_queue q, unsigned int vkey, unsigned int mod_flags,
 376                                    unsigned int keycode, unsigned int modifiers) DECLSPEC_HIDDEN;
 377 extern void macdrv_unregister_hot_key(macdrv_event_queue q, unsigned int vkey, unsigned int mod_flags) DECLSPEC_HIDDEN;
 378
 379
 380 /* window */
 381 struct macdrv_window_features {
 382     unsigned int    title_bar:1;
 383     unsigned int    close_button:1;
 384     unsigned int    minimize_button:1;
 385     unsigned int    resizable:1;
 386     unsigned int    maximize_button:1;
 387     unsigned int    utility:1;
 388     unsigned int    shadow:1;
 389 };
 390
 391 struct macdrv_window_state {
 392     unsigned int    disabled:1;
 393     unsigned int    no_activate:1;
 394     unsigned int    floating:1;
 395     unsigned int    excluded_by_expose:1;
 396     unsigned int    excluded_by_cycle:1;
 397     unsigned int    minimized:1;
 398     unsigned int    minimized_valid:1;
 399     unsigned int    maximized:1;
 400 };
 401
 402 extern macdrv_window macdrv_create_cocoa_window(const struct macdrv_window_features* wf,
 403         CGRect frame, void* hwnd, macdrv_event_queue queue) DECLSPEC_HIDDEN;
 404 extern void macdrv_destroy_cocoa_window(macdrv_window w) DECLSPEC_HIDDEN;
 405 extern void* macdrv_get_window_hwnd(macdrv_window w) DECLSPEC_HIDDEN;
 406 extern void macdrv_set_cocoa_window_features(macdrv_window w,
 407         const struct macdrv_window_features* wf) DECLSPEC_HIDDEN;
 408 extern void macdrv_set_cocoa_window_state(macdrv_window w,
 409         const struct macdrv_window_state* state) DECLSPEC_HIDDEN;
 410 extern void macdrv_set_cocoa_window_title(macdrv_window w, const UniChar* title,
 411         size_t length) DECLSPEC_HIDDEN;
 412 extern void macdrv_order_cocoa_window(macdrv_window w, macdrv_window prev,
 413         macdrv_window next, int activate) DECLSPEC_HIDDEN;
 414 extern void macdrv_hide_cocoa_window(macdrv_window w) DECLSPEC_HIDDEN;
 415 extern void macdrv_set_cocoa_window_frame(macdrv_window w, const CGRect* new_frame) DECLSPEC_HIDDEN;
 416 extern void macdrv_get_cocoa_window_frame(macdrv_window w, CGRect* out_frame) DECLSPEC_HIDDEN;
 417 extern void macdrv_set_cocoa_parent_window(macdrv_window w, macdrv_window parent) DECLSPEC_HIDDEN;
 418 extern void macdrv_set_window_surface(macdrv_window w, void *surface, pthread_mutex_t *mutex) DECLSPEC_HIDDEN;
 419 extern CGImageRef create_surface_image(void *window_surface, CGRect *rect, int copy_data) DECLSPEC_HIDDEN;
 420 extern int get_surface_blit_rects(void *window_surface, const CGRect **rects, int *count) DECLSPEC_HIDDEN;
 421 extern void macdrv_window_needs_display(macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
 422 extern void macdrv_set_window_shape(macdrv_window w, const CGRect *rects, int count) DECLSPEC_HIDDEN;
 423 extern void macdrv_set_window_alpha(macdrv_window w, CGFloat alpha) DECLSPEC_HIDDEN;
 424 extern void macdrv_set_window_color_key(macdrv_window w, CGFloat keyRed, CGFloat keyGreen,
 425                                         CGFloat keyBlue) DECLSPEC_HIDDEN;
 426 extern void macdrv_clear_window_color_key(macdrv_window w) DECLSPEC_HIDDEN;
 427 extern void macdrv_window_use_per_pixel_alpha(macdrv_window w, int use_per_pixel_alpha) DECLSPEC_HIDDEN;
 428 extern void macdrv_give_cocoa_window_focus(macdrv_window w, int activate) DECLSPEC_HIDDEN;
 429 extern void macdrv_set_window_min_max_sizes(macdrv_window w, CGSize min_size, CGSize max_size) DECLSPEC_HIDDEN;
 430 extern macdrv_view macdrv_create_view(macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
 431 extern void macdrv_dispose_view(macdrv_view v) DECLSPEC_HIDDEN;
 432 extern void macdrv_set_view_window_and_frame(macdrv_view v, macdrv_window w, CGRect rect) DECLSPEC_HIDDEN;
 433 extern void macdrv_add_view_opengl_context(macdrv_view v, macdrv_opengl_context c) DECLSPEC_HIDDEN;
 434 extern void macdrv_remove_view_opengl_context(macdrv_view v, macdrv_opengl_context c) DECLSPEC_HIDDEN;
 435 extern uint32_t macdrv_window_background_color(void) DECLSPEC_HIDDEN;
 436 extern int macdrv_send_text_input_event(int pressed, unsigned int flags, int repeat, int keyc,
 437                                         void* data) DECLSPEC_HIDDEN;
 438
 439
 440 /* keyboard */
 441 extern void macdrv_get_input_source_info(CFDataRef* uchr,CGEventSourceKeyboardType* keyboard_type, int* is_iso,
 442                                          TISInputSourceRef* input_source) DECLSPEC_HIDDEN;
 443 extern CFArrayRef macdrv_create_input_source_list(void) DECLSPEC_HIDDEN;
 444 extern int macdrv_select_input_source(TISInputSourceRef input_source) DECLSPEC_HIDDEN;
 445 extern const CFStringRef macdrv_input_source_input_key DECLSPEC_HIDDEN;
 446 extern const CFStringRef macdrv_input_source_type_key DECLSPEC_HIDDEN;
 447 extern const CFStringRef macdrv_input_source_lang_key DECLSPEC_HIDDEN;
 448 extern int macdrv_layout_list_needs_update DECLSPEC_HIDDEN;
 449
 450
 451 /* clipboard */
 452 extern CFArrayRef macdrv_copy_pasteboard_types(CFTypeRef pasteboard) DECLSPEC_HIDDEN;
 453 extern CFDataRef macdrv_copy_pasteboard_data(CFTypeRef pasteboard, CFStringRef type) DECLSPEC_HIDDEN;
 454 extern int macdrv_is_pasteboard_owner(void) DECLSPEC_HIDDEN;
 455 extern void macdrv_clear_pasteboard(void) DECLSPEC_HIDDEN;
 456 extern int macdrv_set_pasteboard_data(CFStringRef type, CFDataRef data, macdrv_window w) DECLSPEC_HIDDEN;
 457
 458
 459 /* opengl */
 460 extern macdrv_opengl_context macdrv_create_opengl_context(void* cglctx) DECLSPEC_HIDDEN;
 461 extern void macdrv_dispose_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
 462 extern void macdrv_make_context_current(macdrv_opengl_context c, macdrv_view v) DECLSPEC_HIDDEN;
 463 extern void macdrv_update_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
 464 extern void macdrv_flush_opengl_context(macdrv_opengl_context c) DECLSPEC_HIDDEN;
 465
 466
 467 /* systray / status item */
 468 extern macdrv_status_item macdrv_create_status_item(macdrv_event_queue q) DECLSPEC_HIDDEN;
 469 extern void macdrv_destroy_status_item(macdrv_status_item s) DECLSPEC_HIDDEN;
 470 extern void macdrv_set_status_item_image(macdrv_status_item s, CGImageRef cgimage) DECLSPEC_HIDDEN;
 471 extern void macdrv_set_status_item_tooltip(macdrv_status_item s, CFStringRef cftip) DECLSPEC_HIDDEN;
 472
 473 #endif  /* __WINE_MACDRV_COCOA_H */