server/user.h

   1 /*
   2  * Wine server USER definitions
   3  *
   4  * Copyright (C) 2001 Alexandre Julliard
   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 #ifndef __WINE_SERVER_USER_H
  22 #define __WINE_SERVER_USER_H
  23
  24 #include "wine/server_protocol.h"
  25 #include "unicode.h"
  26
  27 struct thread;
  28 struct region;
  29 struct window;
  30 struct msg_queue;
  31 struct hook_table;
  32 struct window_class;
  33 struct atom_table;
  34 struct clipboard;
  35
  36 enum user_object
  37 {
  38     USER_WINDOW = 1,
  39     USER_HOOK,
  40     USER_CLIENT  /* arbitrary client handle */
  41 };
  42
  43 #define DESKTOP_ATOM  ((atom_t)32769)
  44
  45 struct winstation
  46 {
  47     struct object      obj;                /* object header */
  48     unsigned int       flags;              /* winstation flags */
  49     struct list        entry;              /* entry in global winstation list */
  50     struct list        desktops;           /* list of desktops of this winstation */
  51     struct desktop    *input_desktop;      /* desktop receiving user input */
  52     struct clipboard  *clipboard;          /* clipboard information */
  53     struct atom_table *atom_table;         /* global atom table */
  54     struct namespace  *desktop_names;      /* namespace for desktops of this winstation */
  55 };
  56
  57 struct global_cursor
  58 {
  59     rectangle_t          clip;             /* cursor clip rectangle */
  60     unsigned int         clip_flags;       /* last cursor clip flags */
  61     user_handle_t        win;              /* window that contains the cursor */
  62 };
  63
  64 struct key_repeat
  65 {
  66     int                  enable;           /* enable auto-repeat */
  67     timeout_t            delay;            /* auto-repeat delay */
  68     timeout_t            period;           /* auto-repeat period */
  69     hw_input_t           input;            /* the input to repeat */
  70     user_handle_t        win;              /* target window for input event */
  71     struct timeout_user *timeout;          /* timeout for repeat */
  72 };
  73
  74 struct desktop
  75 {
  76     struct object        obj;              /* object header */
  77     unsigned int         flags;            /* desktop flags */
  78     struct winstation   *winstation;       /* winstation this desktop belongs to */
  79     timeout_t            input_time;       /* last time this desktop had the input */
  80     struct list          entry;            /* entry in winstation list of desktops */
  81     struct list          threads;          /* list of threads connected to this desktop */
  82     struct window       *top_window;       /* desktop window for this desktop */
  83     struct window       *msg_window;       /* HWND_MESSAGE top window */
  84     struct hook_table   *global_hooks;     /* table of global hooks on this desktop */
  85     struct list          hotkeys;          /* list of registered hotkeys */
  86     struct list          pointers;         /* list of active pointers */
  87     struct timeout_user *close_timeout;    /* timeout before closing the desktop */
  88     struct thread_input *foreground_input; /* thread input of foreground thread */
  89     unsigned int         users;            /* processes and threads using this desktop */
  90     struct global_cursor cursor;           /* global cursor information */
  91     unsigned char        keystate[256];    /* asynchronous key state */
  92     struct key_repeat    key_repeat;       /* key auto-repeat */
  93     const desktop_shm_t *shared;           /* desktop session shared memory */
  94 };
  95
  96 /* user handles functions */
  97
  98 extern user_handle_t alloc_user_handle( void *ptr, enum user_object type );
  99 extern void *get_user_object( user_handle_t handle, enum user_object type );
 100 extern void *get_user_object_handle( user_handle_t *handle, enum user_object type );
 101 extern user_handle_t get_user_full_handle( user_handle_t handle );
 102 extern void *free_user_handle( user_handle_t handle );
 103 extern void *next_user_handle( user_handle_t *handle, enum user_object type );
 104 extern void free_process_user_handles( struct process *process );
 105
 106 /* clipboard functions */
 107
 108 extern void cleanup_clipboard_window( struct desktop *desktop, user_handle_t window );
 109 extern void cleanup_clipboard_thread( struct thread *thread );
 110
 111 /* hook functions */
 112
 113 extern void remove_thread_hooks( struct thread *thread );
 114 extern unsigned int get_active_hooks(void);
 115 extern struct thread *get_first_global_hook( struct desktop *desktop, int id );
 116
 117 /* queue functions */
 118
 119 extern void free_msg_queue( struct thread *thread );
 120 extern struct hook_table *get_queue_hooks( struct thread *thread );
 121 extern void set_queue_hooks( struct thread *thread, struct hook_table *hooks );
 122 extern void inc_queue_paint_count( struct thread *thread, int incr );
 123 extern void queue_cleanup_window( struct thread *thread, user_handle_t win );
 124 extern int init_thread_queue( struct thread *thread );
 125 extern void check_thread_queue_idle( struct thread *thread );
 126 extern int attach_thread_input( struct thread *thread_from, struct thread *thread_to );
 127 extern void detach_thread_input( struct thread *thread_from );
 128 extern void set_clip_rectangle( struct desktop *desktop, const rectangle_t *rect,
 129                                 unsigned int flags, int reset );
 130 extern void post_message( user_handle_t win, unsigned int message,
 131                           lparam_t wparam, lparam_t lparam );
 132 extern void send_notify_message( user_handle_t win, unsigned int message,
 133                                  lparam_t wparam, lparam_t lparam );
 134 extern void post_win_event( struct thread *thread, unsigned int event,
 135                             user_handle_t win, unsigned int object_id,
 136                             unsigned int child_id, client_ptr_t proc,
 137                             const WCHAR *module, data_size_t module_size,
 138                             user_handle_t handle );
 139 extern void free_hotkeys( struct desktop *desktop, user_handle_t window );
 140 extern void free_pointers( struct desktop *desktop );
 141 extern void set_rawinput_process( struct process *process, int enable );
 142
 143 /* region functions */
 144
 145 extern struct region *create_empty_region(void);
 146 extern struct region *create_region_from_req_data( const void *data, data_size_t size );
 147 extern void free_region( struct region *region );
 148 extern void set_region_rect( struct region *region, const rectangle_t *rect );
 149 extern rectangle_t *get_region_data( const struct region *region, data_size_t max_size,
 150                                      data_size_t *total_size );
 151 extern rectangle_t *get_region_data_and_free( struct region *region, data_size_t max_size,
 152                                               data_size_t *total_size );
 153 extern int is_region_empty( const struct region *region );
 154 extern int is_region_equal( const struct region *region1, const struct region *region2 );
 155 extern void get_region_extents( const struct region *region, rectangle_t *rect );
 156 extern void offset_region( struct region *region, int x, int y );
 157 extern void mirror_region( const rectangle_t *client_rect, struct region *region );
 158 extern void scale_region( struct region *region, unsigned int dpi_from, unsigned int dpi_to );
 159 extern struct region *copy_region( struct region *dst, const struct region *src );
 160 extern struct region *intersect_region( struct region *dst, const struct region *src1,
 161                                         const struct region *src2 );
 162 extern struct region *subtract_region( struct region *dst, const struct region *src1,
 163                                        const struct region *src2 );
 164 extern struct region *union_region( struct region *dst, const struct region *src1,
 165                                     const struct region *src2 );
 166 extern struct region *xor_region( struct region *dst, const struct region *src1,
 167                                   const struct region *src2 );
 168 extern int point_in_region( struct region *region, int x, int y );
 169 extern int rect_in_region( struct region *region, const rectangle_t *rect );
 170
 171 /* window functions */
 172
 173 extern struct process *get_top_window_owner( struct desktop *desktop );
 174 extern void get_top_window_rectangle( struct desktop *desktop, rectangle_t *rect );
 175 extern void post_desktop_message( struct desktop *desktop, unsigned int message,
 176                                   lparam_t wparam, lparam_t lparam );
 177 extern void free_window_handle( struct window *win );
 178 extern void destroy_thread_windows( struct thread *thread );
 179 extern int is_child_window( user_handle_t parent, user_handle_t child );
 180 extern int is_valid_foreground_window( user_handle_t window );
 181 extern int is_window_visible( user_handle_t window );
 182 extern int is_window_transparent( user_handle_t window );
 183 extern int make_window_active( user_handle_t window );
 184 extern struct thread *get_window_thread( user_handle_t handle );
 185 extern user_handle_t shallow_window_from_point( struct desktop *desktop, int x, int y );
 186 extern struct thread *window_thread_from_point( user_handle_t scope, int x, int y );
 187 extern user_handle_t find_window_to_repaint( user_handle_t parent, struct thread *thread );
 188 extern struct window_class *get_window_class( user_handle_t window );
 189
 190 /* window class functions */
 191
 192 extern void destroy_process_classes( struct process *process );
 193 extern struct window_class *grab_class( struct process *process, atom_t atom,
 194                                         mod_handle_t instance, int *extra_bytes );
 195 extern void release_class( struct window_class *class );
 196 extern int is_desktop_class( struct window_class *class );
 197 extern int is_hwnd_message_class( struct window_class *class );
 198 extern int get_class_style( struct window_class *class );
 199 extern atom_t get_class_atom( struct window_class *class );
 200 extern client_ptr_t get_class_client_ptr( struct window_class *class );
 201
 202 /* windows station functions */
 203
 204 extern struct winstation *get_visible_winstation(void);
 205 extern struct desktop *get_input_desktop( struct winstation *winstation );
 206 extern int set_input_desktop( struct winstation *winstation, struct desktop *new_desktop );
 207 extern struct desktop *get_desktop_obj( struct process *process, obj_handle_t handle, unsigned int access );
 208 extern struct winstation *get_process_winstation( struct process *process, unsigned int access );
 209 extern struct desktop *get_thread_desktop( struct thread *thread, unsigned int access );
 210 extern void connect_process_winstation( struct process *process, struct unicode_str *desktop_path,
 211                                         struct thread *parent_thread, struct process *parent_process );
 212 extern void set_process_default_desktop( struct process *process, struct desktop *desktop,
 213                                          obj_handle_t handle );
 214 extern void close_process_desktop( struct process *process );
 215 extern void set_thread_default_desktop( struct thread *thread, struct desktop *desktop, obj_handle_t handle );
 216 extern void release_thread_desktop( struct thread *thread, int close );
 217
 218 /* checks if two rectangles are identical */
 219 static inline int is_rect_equal( const rectangle_t *rect1, const rectangle_t *rect2 )
 220 {
 221     return (rect1->left == rect2->left && rect1->right == rect2->right &&
 222             rect1->top == rect2->top && rect1->bottom == rect2->bottom);
 223 }
 224
 225 static inline int is_rect_empty( const rectangle_t *rect )
 226 {
 227     return (rect->left >= rect->right || rect->top >= rect->bottom);
 228 }
 229
 230 static inline int point_in_rect( const rectangle_t *rect, int x, int y )
 231 {
 232     return (x >= rect->left && x < rect->right && y >= rect->top && y < rect->bottom);
 233 }
 234
 235 static inline int scale_dpi( int val, unsigned int dpi_from, unsigned int dpi_to )
 236 {
 237     if (val >= 0) return (val * dpi_to + (dpi_from / 2)) / dpi_from;
 238     return (val * dpi_to - (dpi_from / 2)) / dpi_from;
 239 }
 240
 241 static inline void scale_dpi_rect( rectangle_t *rect, unsigned int dpi_from, unsigned int dpi_to )
 242 {
 243     rect->left   = scale_dpi( rect->left, dpi_from, dpi_to );
 244     rect->top    = scale_dpi( rect->top, dpi_from, dpi_to );
 245     rect->right  = scale_dpi( rect->right, dpi_from, dpi_to );
 246     rect->bottom = scale_dpi( rect->bottom, dpi_from, dpi_to );
 247 }
 248
 249 /* offset the coordinates of a rectangle */
 250 static inline void offset_rect( rectangle_t *rect, int offset_x, int offset_y )
 251 {
 252     rect->left   += offset_x;
 253     rect->top    += offset_y;
 254     rect->right  += offset_x;
 255     rect->bottom += offset_y;
 256 }
 257
 258 /* mirror a rectangle respective to the window client area */
 259 static inline void mirror_rect( const rectangle_t *client_rect, rectangle_t *rect )
 260 {
 261     int width = client_rect->right - client_rect->left;
 262     int tmp = rect->left;
 263     rect->left = width - rect->right;
 264     rect->right = width - tmp;
 265 }
 266
 267 /* compute the intersection of two rectangles; return 0 if the result is empty */
 268 static inline int intersect_rect( rectangle_t *dst, const rectangle_t *src1, const rectangle_t *src2 )
 269 {
 270     dst->left   = max( src1->left, src2->left );
 271     dst->top    = max( src1->top, src2->top );
 272     dst->right  = min( src1->right, src2->right );
 273     dst->bottom = min( src1->bottom, src2->bottom );
 274     return !is_rect_empty( dst );
 275 }
 276
 277 /* validate a window handle and return the full handle */
 278 static inline user_handle_t get_valid_window_handle( user_handle_t win )
 279 {
 280     if (get_user_object_handle( &win, USER_WINDOW )) return win;
 281     set_win32_error( ERROR_INVALID_WINDOW_HANDLE );
 282     return 0;
 283 }
 284
 285 #endif  /* __WINE_SERVER_USER_H */