widget/src/windows/WindowHook.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Mozilla Foundation
  20  * Portions created by the Initial Developer are Copyright (C) 2009
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Rob Arnold <tellrob@gmail.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef __mozilla_WindowHook_h__
  41 #define __mozilla_WindowHook_h__
  42
  43 #include <windows.h>
  44
  45 #include <nsHashKeys.h>
  46 #include <nsClassHashtable.h>
  47 #include <nsTArray.h>
  48
  49 #include "nsAppShell.h"
  50
  51 class nsWindow;
  52
  53 namespace mozilla {
  54 namespace widget {
  55
  56 class WindowHook {
  57 public:
  58
  59   // It is expected that most callbacks will return false
  60   typedef PRBool (*Callback)(void *aContext, HWND hWnd, UINT nMsg,
  61                              WPARAM wParam, LPARAM lParam, LRESULT *aResult);
  62
  63   nsresult AddHook(UINT nMsg, Callback callback, void *context);
  64   nsresult RemoveHook(UINT nMsg, Callback callback, void *context);
  65   nsresult AddMonitor(UINT nMsg, Callback callback, void *context);
  66   nsresult RemoveMonitor(UINT nMsg, Callback callback, void *context);
  67
  68 private:
  69   struct CallbackData {
  70     Callback cb;
  71     void *context;
  72
  73     CallbackData() : cb(nsnull), context(nsnull) {}
  74     CallbackData(Callback cb, void *ctx) : cb(cb), context(ctx) {}
  75     PRBool Invoke(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam,
  76                   LRESULT *aResult);
  77     PRBool operator== (const CallbackData &rhs) const {
  78       return cb == rhs.cb && context == rhs.context;
  79     }
  80     PRBool operator!= (const CallbackData &rhs) const {
  81       return !(*this == rhs);
  82     }
  83     operator PRBool () const {
  84       return !!cb;
  85     }
  86   };
  87
  88   typedef nsTArray<CallbackData> CallbackDataArray;
  89   struct MessageData {
  90     UINT nMsg;
  91     CallbackData hook;
  92     CallbackDataArray monitors;
  93   };
  94
  95   PRBool Notify(HWND hWnd, UINT nMsg, WPARAM wParam, LPARAM lParam,
  96                 LRESULT *aResult);
  97
  98   MessageData *Lookup(UINT nMsg);
  99   MessageData *LookupOrCreate(UINT nMsg);
 100   void DeleteIfEmpty(MessageData *data);
 101
 102   typedef nsTArray<MessageData> MessageDataArray;
 103   MessageDataArray mMessageData;
 104
 105   // For Notify
 106   friend class ::nsWindow;
 107 };
 108
 109 }
 110 }
 111
 112 #endif // __mozilla_WindowHook_h__