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