programs/explorer/appbar.c

   1 /*
   2  * SHAppBarMessage implementation
   3  *
   4  * Copyright 2008 Vincent Povirk for CodeWeavers
   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  * TODO: freedesktop _NET_WM_STRUT integration
  21  *
  22  * TODO: find when a fullscreen app is in the foreground and send FULLSCREENAPP
  23  *  notifications
  24  *
  25  * TODO: detect changes in the screen size and send ABN_POSCHANGED ?
  26  *
  27  * TODO: multiple monitor support
  28  */
  29
  30 #include "windows.h"
  31 #include "shellapi.h"
  32 #include "wine/debug.h"
  33 #include "explorer_private.h"
  34
  35 #include "wine/list.h"
  36
  37 WINE_DEFAULT_DEBUG_CHANNEL(appbar);
  38
  39 struct appbar_data_msg  /* platform-independent data */
  40 {
  41     LONG      hWnd;
  42     UINT      uCallbackMessage;
  43     UINT      uEdge;
  44     RECT      rc;
  45     ULONGLONG lParam;
  46 };
  47
  48 struct appbar_cmd
  49 {
  50     ULONG  return_map;
  51     DWORD  return_process;
  52     struct appbar_data_msg abd;
  53 };
  54
  55 struct appbar_response
  56 {
  57     ULONGLONG result;
  58     struct appbar_data_msg abd;
  59 };
  60
  61 static HWND appbarmsg_window = NULL;
  62
  63 struct appbar_data
  64 {
  65     struct list entry;
  66     HWND hwnd;
  67     UINT callback_msg;
  68     UINT edge;
  69     RECT rc;
  70     BOOL space_reserved;
  71     /* BOOL autohide; */
  72 };
  73
  74 static struct list appbars = LIST_INIT(appbars);
  75
  76 static struct appbar_data* get_appbar(HWND hwnd)
  77 {
  78     struct appbar_data* data;
  79
  80     LIST_FOR_EACH_ENTRY(data, &appbars, struct appbar_data, entry)
  81     {
  82         if (data->hwnd == hwnd)
  83             return data;
  84     }
  85
  86     return NULL;
  87 }
  88
  89 /* send_poschanged: send ABN_POSCHANGED to every appbar except one */
  90 static void send_poschanged(HWND hwnd)
  91 {
  92     struct appbar_data* data;
  93     LIST_FOR_EACH_ENTRY(data, &appbars, struct appbar_data, entry)
  94     {
  95         if (data->hwnd != hwnd)
  96         {
  97             PostMessageW(data->hwnd, data->callback_msg, ABN_POSCHANGED, 0);
  98         }
  99     }
 100 }
 101
 102 /* appbar_cliprect: cut out parts of the rectangle that interfere with existing appbars */
 103 static void appbar_cliprect( HWND hwnd, RECT *rect )
 104 {
 105     struct appbar_data* data;
 106     LIST_FOR_EACH_ENTRY(data, &appbars, struct appbar_data, entry)
 107     {
 108         if (data->hwnd == hwnd)
 109         {
 110             /* we only care about appbars that were added before this one */
 111             return;
 112         }
 113         if (data->space_reserved)
 114         {
 115             /* move in the side that corresponds to the other appbar's edge */
 116             switch (data->edge)
 117             {
 118             case ABE_BOTTOM:
 119                 rect->bottom = min(rect->bottom, data->rc.top);
 120                 break;
 121             case ABE_LEFT:
 122                 rect->left = max(rect->left, data->rc.right);
 123                 break;
 124             case ABE_RIGHT:
 125                 rect->right = min(rect->right, data->rc.left);
 126                 break;
 127             case ABE_TOP:
 128                 rect->top = max(rect->top, data->rc.bottom);
 129                 break;
 130             }
 131         }
 132     }
 133 }
 134
 135 static UINT_PTR handle_appbarmessage(DWORD msg, struct appbar_data_msg *abd)
 136 {
 137     struct appbar_data* data;
 138     HWND hwnd = LongToHandle( abd->hWnd );
 139
 140     switch (msg)
 141     {
 142     case ABM_NEW:
 143         if (get_appbar(hwnd))
 144         {
 145             /* fail when adding an hwnd the second time */
 146             return FALSE;
 147         }
 148
 149         data = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct appbar_data));
 150         if (!data)
 151         {
 152             WINE_ERR("out of memory\n");
 153             return FALSE;
 154         }
 155         data->hwnd = hwnd;
 156         data->callback_msg = abd->uCallbackMessage;
 157
 158         list_add_tail(&appbars, &data->entry);
 159
 160         return TRUE;
 161     case ABM_REMOVE:
 162         if ((data = get_appbar(hwnd)))
 163         {
 164             list_remove(&data->entry);
 165
 166             send_poschanged(hwnd);
 167
 168             HeapFree(GetProcessHeap(), 0, data);
 169         }
 170         else
 171             WINE_WARN("removing hwnd %p not on the list\n", hwnd);
 172         return TRUE;
 173     case ABM_QUERYPOS:
 174         if (abd->uEdge > ABE_BOTTOM)
 175             WINE_WARN("invalid edge %i for %p\n", abd->uEdge, hwnd);
 176         appbar_cliprect( hwnd, &abd->rc );
 177         return TRUE;
 178     case ABM_SETPOS:
 179         if (abd->uEdge > ABE_BOTTOM)
 180         {
 181             WINE_WARN("invalid edge %i for %p\n", abd->uEdge, hwnd);
 182             return TRUE;
 183         }
 184         if ((data = get_appbar(hwnd)))
 185         {
 186             /* calculate acceptable space */
 187             appbar_cliprect( hwnd, &abd->rc );
 188
 189             if (!EqualRect(&abd->rc, &data->rc))
 190                 send_poschanged(hwnd);
 191
 192             /* reserve that space for this appbar */
 193             data->edge = abd->uEdge;
 194             data->rc = abd->rc;
 195             data->space_reserved = TRUE;
 196         }
 197         else
 198         {
 199             WINE_WARN("app sent ABM_SETPOS message for %p without ABM_ADD\n", hwnd);
 200         }
 201         return TRUE;
 202     case ABM_GETSTATE:
 203         WINE_FIXME("SHAppBarMessage(ABM_GETSTATE): stub\n");
 204         return ABS_ALWAYSONTOP | ABS_AUTOHIDE;
 205     case ABM_GETTASKBARPOS:
 206         WINE_FIXME("SHAppBarMessage(ABM_GETTASKBARPOS, hwnd=%p): stub\n", hwnd);
 207         /* Report the taskbar is at the bottom of the screen. */
 208         abd->rc.left = 0;
 209         abd->rc.right = GetSystemMetrics(SM_CXSCREEN);
 210         abd->rc.bottom = GetSystemMetrics(SM_CYSCREEN);
 211         abd->rc.top = abd->rc.bottom-1;
 212         abd->uEdge = ABE_BOTTOM;
 213         return TRUE;
 214     case ABM_ACTIVATE:
 215         return TRUE;
 216     case ABM_GETAUTOHIDEBAR:
 217         WINE_FIXME("SHAppBarMessage(ABM_GETAUTOHIDEBAR, hwnd=%p, edge=%x): stub\n", hwnd, abd->uEdge);
 218         return 0;
 219     case ABM_SETAUTOHIDEBAR:
 220         WINE_FIXME("SHAppBarMessage(ABM_SETAUTOHIDEBAR, hwnd=%p, edge=%x, lparam=%s): stub\n",
 221                    hwnd, abd->uEdge, wine_dbgstr_longlong(abd->lParam));
 222         return TRUE;
 223     case ABM_WINDOWPOSCHANGED:
 224         return TRUE;
 225     default:
 226         WINE_FIXME("SHAppBarMessage(%lx) unimplemented\n", msg);
 227         return FALSE;
 228     }
 229 }
 230
 231 static LRESULT CALLBACK appbar_wndproc(HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam)
 232 {
 233     switch (msg)
 234     {
 235     case WM_COPYDATA:
 236         {
 237             COPYDATASTRUCT* cds;
 238             struct appbar_cmd cmd;
 239             UINT_PTR result;
 240             HANDLE return_hproc;
 241             HANDLE return_map;
 242             LPVOID return_view;
 243             struct appbar_response* response;
 244
 245             cds = (COPYDATASTRUCT*)lparam;
 246             if (cds->cbData != sizeof(struct appbar_cmd))
 247                 return TRUE;
 248             CopyMemory(&cmd, cds->lpData, cds->cbData);
 249
 250             result = handle_appbarmessage(cds->dwData, &cmd.abd);
 251
 252             return_hproc = OpenProcess(PROCESS_DUP_HANDLE, FALSE, cmd.return_process);
 253             if (return_hproc == NULL)
 254             {
 255                 WINE_ERR("couldn't open calling process\n");
 256                 return TRUE;
 257             }
 258
 259             if (!DuplicateHandle(return_hproc, UlongToHandle(cmd.return_map),
 260                                  GetCurrentProcess(), &return_map, 0, FALSE, DUPLICATE_SAME_ACCESS))
 261             {
 262                 WINE_ERR("couldn't duplicate handle\n");
 263                 CloseHandle(return_hproc);
 264                 return TRUE;
 265             }
 266             CloseHandle(return_hproc);
 267
 268             return_view = MapViewOfFile(return_map, FILE_MAP_WRITE, 0, 0, sizeof(struct appbar_response));
 269
 270             if (return_view)
 271             {
 272                 response = (struct appbar_response*)return_view;
 273                 response->result = result;
 274                 response->abd = cmd.abd;
 275
 276                 UnmapViewOfFile(return_view);
 277             }
 278             else
 279                 WINE_ERR("couldn't map view of file\n");
 280
 281             CloseHandle(return_map);
 282             return TRUE;
 283         }
 284     default:
 285         break;
 286     }
 287
 288     return DefWindowProcW(hwnd, msg, wparam, lparam);
 289 }
 290
 291 void initialize_appbar(void)
 292 {
 293     WNDCLASSEXW class;
 294     static const WCHAR classname[] = {'W','i','n','e','A','p','p','B','a','r',0};
 295
 296     /* register the appbar window class */
 297     ZeroMemory(&class, sizeof(class));
 298     class.cbSize = sizeof(class);
 299     class.lpfnWndProc = appbar_wndproc;
 300     class.hInstance = NULL;
 301     class.lpszClassName = classname;
 302
 303     if (!RegisterClassExW(&class))
 304     {
 305         WINE_ERR("Could not register appbar message window class\n");
 306         return;
 307     }
 308
 309     appbarmsg_window = CreateWindowW(classname, classname, 0, 0, 0, 0, 0, HWND_MESSAGE, NULL, NULL, NULL);
 310     if (!appbarmsg_window)
 311     {
 312         WINE_ERR("Could not create appbar message window\n");
 313         return;
 314     }
 315 }