michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #ifndef mozilla_IMEStateManager_h_
michael@0: #define mozilla_IMEStateManager_h_
michael@0: 
michael@0: #include "mozilla/EventForwards.h"
michael@0: #include "nsIWidget.h"
michael@0: 
michael@0: class nsIContent;
michael@0: class nsIDOMMouseEvent;
michael@0: class nsINode;
michael@0: class nsPIDOMWindow;
michael@0: class nsPresContext;
michael@0: class nsISelection;
michael@0: 
michael@0: namespace mozilla {
michael@0: 
michael@0: class EventDispatchingCallback;
michael@0: class IMEContentObserver;
michael@0: class TextCompositionArray;
michael@0: class TextComposition;
michael@0: 
michael@0: /**
michael@0:  * IMEStateManager manages InputContext (e.g., active editor type, IME enabled
michael@0:  * state and IME open state) of nsIWidget instances, manages IMEContentObserver
michael@0:  * and provides useful API for IME.
michael@0:  */
michael@0: 
michael@0: class IMEStateManager
michael@0: {
michael@0:   typedef widget::IMEMessage IMEMessage;
michael@0:   typedef widget::IMEState IMEState;
michael@0:   typedef widget::InputContext InputContext;
michael@0:   typedef widget::InputContextAction InputContextAction;
michael@0: 
michael@0: public:
michael@0:   static void Shutdown();
michael@0: 
michael@0:   static nsresult OnDestroyPresContext(nsPresContext* aPresContext);
michael@0:   static nsresult OnRemoveContent(nsPresContext* aPresContext,
michael@0:                                   nsIContent* aContent);
michael@0:   /**
michael@0:    * OnChangeFocus() should be called when focused content is changed or
michael@0:    * IME enabled state is changed.  If nobody has focus, set both aPresContext
michael@0:    * and aContent nullptr.  E.g., all windows are deactivated.
michael@0:    */
michael@0:   static nsresult OnChangeFocus(nsPresContext* aPresContext,
michael@0:                                 nsIContent* aContent,
michael@0:                                 InputContextAction::Cause aCause);
michael@0:   static void OnInstalledMenuKeyboardListener(bool aInstalling);
michael@0: 
michael@0:   // These two methods manage focus and selection/text observers.
michael@0:   // They are separate from OnChangeFocus above because this offers finer
michael@0:   // control compared to having the two methods incorporated into OnChangeFocus
michael@0: 
michael@0:   // Get the focused editor's selection and root
michael@0:   static nsresult GetFocusSelectionAndRoot(nsISelection** aSel,
michael@0:                                            nsIContent** aRoot);
michael@0:   // This method updates the current IME state.  However, if the enabled state
michael@0:   // isn't changed by the new state, this method does nothing.
michael@0:   // Note that this method changes the IME state of the active element in the
michael@0:   // widget.  So, the caller must have focus.
michael@0:   static void UpdateIMEState(const IMEState &aNewIMEState,
michael@0:                              nsIContent* aContent);
michael@0: 
michael@0:   // This method is called when user clicked in an editor.
michael@0:   // aContent must be:
michael@0:   //   If the editor is for <input> or <textarea>, the element.
michael@0:   //   If the editor is for contenteditable, the active editinghost.
michael@0:   //   If the editor is for designMode, nullptr.
michael@0:   static void OnClickInEditor(nsPresContext* aPresContext,
michael@0:                               nsIContent* aContent,
michael@0:                               nsIDOMMouseEvent* aMouseEvent);
michael@0: 
michael@0:   // This method is called when editor actually gets focus.
michael@0:   // aContent must be:
michael@0:   //   If the editor is for <input> or <textarea>, the element.
michael@0:   //   If the editor is for contenteditable, the active editinghost.
michael@0:   //   If the editor is for designMode, nullptr.
michael@0:   static void OnFocusInEditor(nsPresContext* aPresContext,
michael@0:                               nsIContent* aContent);
michael@0: 
michael@0:   /**
michael@0:    * All DOM composition events and DOM text events must be dispatched via
michael@0:    * DispatchCompositionEvent() for storing the composition target
michael@0:    * and ensuring a set of composition events must be fired the stored target.
michael@0:    * If the stored composition event target is destroying, this removes the
michael@0:    * stored composition automatically.
michael@0:    */
michael@0:   static void DispatchCompositionEvent(nsINode* aEventTargetNode,
michael@0:                                        nsPresContext* aPresContext,
michael@0:                                        WidgetEvent* aEvent,
michael@0:                                        nsEventStatus* aStatus,
michael@0:                                        EventDispatchingCallback* aCallBack);
michael@0: 
michael@0:   /**
michael@0:    * Get TextComposition from widget.
michael@0:    */
michael@0:   static already_AddRefed<TextComposition>
michael@0:     GetTextCompositionFor(nsIWidget* aWidget);
michael@0: 
michael@0:   /**
michael@0:    * Returns TextComposition instance for the event.
michael@0:    *
michael@0:    * @param aEvent      Should be a composition event or a text event which is
michael@0:    *                    being dispatched.
michael@0:    */
michael@0:   static already_AddRefed<TextComposition>
michael@0:     GetTextCompositionFor(WidgetGUIEvent* aEvent);
michael@0: 
michael@0:   /**
michael@0:    * Send a notification to IME.  It depends on the IME or platform spec what
michael@0:    * will occur (or not occur).
michael@0:    */
michael@0:   static nsresult NotifyIME(IMEMessage aMessage, nsIWidget* aWidget);
michael@0:   static nsresult NotifyIME(IMEMessage aMessage, nsPresContext* aPresContext);
michael@0: 
michael@0:   static nsINode* GetRootEditableNode(nsPresContext* aPresContext,
michael@0:                                       nsIContent* aContent);
michael@0:   static bool IsTestingIME() { return sIsTestingIME; }
michael@0: 
michael@0: protected:
michael@0:   static nsresult OnChangeFocusInternal(nsPresContext* aPresContext,
michael@0:                                         nsIContent* aContent,
michael@0:                                         InputContextAction aAction);
michael@0:   static void SetIMEState(const IMEState &aState,
michael@0:                           nsIContent* aContent,
michael@0:                           nsIWidget* aWidget,
michael@0:                           InputContextAction aAction);
michael@0:   static IMEState GetNewIMEState(nsPresContext* aPresContext,
michael@0:                                  nsIContent* aContent);
michael@0: 
michael@0:   static void EnsureTextCompositionArray();
michael@0:   static void CreateIMEContentObserver();
michael@0:   static void DestroyTextStateManager();
michael@0: 
michael@0:   static bool IsEditable(nsINode* node);
michael@0: 
michael@0:   static bool IsEditableIMEState(nsIWidget* aWidget);
michael@0: 
michael@0:   static nsIContent*    sContent;
michael@0:   static nsPresContext* sPresContext;
michael@0:   static bool           sInstalledMenuKeyboardListener;
michael@0:   static bool           sIsTestingIME;
michael@0: 
michael@0:   static IMEContentObserver* sActiveIMEContentObserver;
michael@0: 
michael@0:   // All active compositions in the process are stored by this array.
michael@0:   // When you get an item of this array and use it, please be careful.
michael@0:   // The instances in this array can be destroyed automatically if you do
michael@0:   // something to cause committing or canceling the composition.
michael@0:   static TextCompositionArray* sTextCompositions;
michael@0: };
michael@0: 
michael@0: } // namespace mozilla
michael@0: 
michael@0: #endif // mozilla_IMEStateManager_h_