/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla Communicator client code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   - David W. Hyatt (hyatt@netscape.com)
 *   - Mike Pinkerton (pinkerton@netscape.com)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef nsXBLWindowHandler_h__
#define nsXBLWindowHandler_h__

#include "prtypes.h"
#include "nsError.h"
#include "nsString.h"
#include "nsCOMPtr.h"
#include "nsXBLPrototypeHandler.h"
#include "nsIBoxObject.h"


class nsIDOMEventReceiver;
class nsIDOMElement;
class nsIDOMEvent;
class nsIAtom;
class nsIXBLDocumentInfo;
class nsXBLSpecialDocInfo;


//
// class nsXBLWindowHandler
//
// A virtual base class that all window-level event handlers inherit
// from. Provides the code to parse and walk the XBL bindings.
//
class nsXBLWindowHandler 
{
public:

  nsXBLWindowHandler(nsIDOMElement* aElement, nsIDOMEventReceiver* aReceiver);
  virtual ~nsXBLWindowHandler();

protected:

  // are we working with editor or browser?
  PRBool IsEditor() ;

  // lazily load the handlers
  virtual nsresult EnsureHandlers(PRBool *aIsEditor);
  
  // walk the handlers, looking for one to handle the event
  virtual nsresult WalkHandlersInternal(nsIDOMEvent* aKeyEvent,
                                        nsIAtom* aEventType, 
                                        nsXBLPrototypeHandler* aHandler);

    // does the handler care about the particular event?
  virtual PRBool EventMatched(nsXBLPrototypeHandler* inHandler,
                              nsIAtom* inEventType,
                              nsIDOMEvent* inEvent) = 0;

  // Returns the element which was passed as a parameter to the constructor,
  // unless the element has been removed from the document.
  already_AddRefed<nsIDOMElement> GetElement();

  // Using nsIBoxObject as a weak reference to a DOM Element.
  nsCOMPtr<nsIBoxObject> mBoxObjectForElement;
  nsIDOMEventReceiver*   mReceiver;     // weak ref

  // these are not owning references; the prototype handlers are owned
  // by the prototype bindings which are owned by the docinfo.
  nsXBLPrototypeHandler* mHandler;            // platform bindings
  nsXBLPrototypeHandler* mUserHandler;        // user-specific bindings

  static nsXBLSpecialDocInfo* sXBLSpecialDocInfo;       // holds document info about bindings
    
private:

  static PRUint32 sRefCnt;

}; // class nsXBLWindowHandler


#endif