/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- * vim: sw=2 ts=8 et : */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ /** * This "puppet widget" isn't really a platform widget. It's intended * to be used in widgetless rendering contexts, such as sandboxed * content processes. If any "real" widgetry is needed, the request * is forwarded to and/or data received from elsewhere. */ #ifndef mozilla_widget_PuppetWidget_h__ #define mozilla_widget_PuppetWidget_h__ #include "nsBaseScreen.h" #include "nsBaseWidget.h" #include "nsIScreenManager.h" #include "nsThreadUtils.h" #include "nsWeakReference.h" #include "mozilla/Attributes.h" class gfxASurface; namespace mozilla { namespace dom { class TabChild; } namespace widget { class PuppetWidget : public nsBaseWidget, public nsSupportsWeakReference { typedef mozilla::dom::TabChild TabChild; typedef nsBaseWidget Base; // The width and height of the "widget" are clamped to this. static const size_t kMaxDimension; public: PuppetWidget(TabChild* aTabChild); virtual ~PuppetWidget(); NS_DECL_ISUPPORTS_INHERITED NS_IMETHOD Create(nsIWidget* aParent, nsNativeWidget aNativeParent, const nsIntRect& aRect, nsDeviceContext* aContext, nsWidgetInitData* aInitData = nullptr); void InitIMEState(); virtual already_AddRefed CreateChild(const nsIntRect &aRect, nsDeviceContext *aContext, nsWidgetInitData *aInitData = nullptr, bool aForceUseIWidgetParent = false); NS_IMETHOD Destroy(); NS_IMETHOD Show(bool aState); virtual bool IsVisible() const { return mVisible; } NS_IMETHOD ConstrainPosition(bool /*ignored aAllowSlop*/, int32_t* aX, int32_t* aY) { *aX = kMaxDimension; *aY = kMaxDimension; return NS_OK; } // We're always at <0, 0>, and so ignore move requests. NS_IMETHOD Move(double aX, double aY) { return NS_OK; } NS_IMETHOD Resize(double aWidth, double aHeight, bool aRepaint); NS_IMETHOD Resize(double aX, double aY, double aWidth, double aHeight, bool aRepaint) // (we're always at <0, 0>) { return Resize(aWidth, aHeight, aRepaint); } // XXX/cjones: copying gtk behavior here; unclear what disabling a // widget is supposed to entail NS_IMETHOD Enable(bool aState) { mEnabled = aState; return NS_OK; } virtual bool IsEnabled() const { return mEnabled; } NS_IMETHOD SetFocus(bool aRaise = false); // PuppetWidgets don't care about children. virtual nsresult ConfigureChildren(const nsTArray& aConfigurations) { return NS_OK; } NS_IMETHOD Invalidate(const nsIntRect& aRect); // This API is going away, steer clear. virtual void Scroll(const nsIntPoint& aDelta, const nsTArray& aDestRects, const nsTArray& aReconfigureChildren) { /* dead man walking */ } // PuppetWidgets don't have native data, as they're purely nonnative. virtual void* GetNativeData(uint32_t aDataType); NS_IMETHOD ReparentNativeWidget(nsIWidget* aNewParent) { return NS_ERROR_UNEXPECTED; } // PuppetWidgets don't have any concept of titles. NS_IMETHOD SetTitle(const nsAString& aTitle) { return NS_ERROR_UNEXPECTED; } // PuppetWidgets are always at <0, 0>. virtual nsIntPoint WidgetToScreenOffset() { return nsIntPoint(0, 0); } void InitEvent(WidgetGUIEvent& aEvent, nsIntPoint* aPoint = nullptr); NS_IMETHOD DispatchEvent(WidgetGUIEvent* aEvent, nsEventStatus& aStatus); NS_IMETHOD CaptureRollupEvents(nsIRollupListener* aListener, bool aDoCapture) { return NS_ERROR_UNEXPECTED; } // // nsBaseWidget methods we override // // Documents loaded in child processes are always subdocuments of // other docs in an ancestor process. To ensure that the // backgrounds of those documents are painted like those of // same-process subdocuments, we force the widget here to be // transparent, which in turn will cause layout to use a transparent // backstop background color. virtual nsTransparencyMode GetTransparencyMode() MOZ_OVERRIDE { return eTransparencyTransparent; } virtual LayerManager* GetLayerManager(PLayerTransactionChild* aShadowManager = nullptr, LayersBackend aBackendHint = mozilla::layers::LAYERS_NONE, LayerManagerPersistence aPersistence = LAYER_MANAGER_CURRENT, bool* aAllowRetaining = nullptr); virtual gfxASurface* GetThebesSurface(); NS_IMETHOD NotifyIME(NotificationToIME aNotification) MOZ_OVERRIDE; NS_IMETHOD_(void) SetInputContext(const InputContext& aContext, const InputContextAction& aAction); NS_IMETHOD_(InputContext) GetInputContext(); NS_IMETHOD NotifyIMEOfTextChange(uint32_t aOffset, uint32_t aEnd, uint32_t aNewEnd) MOZ_OVERRIDE; virtual nsIMEUpdatePreference GetIMEUpdatePreference(); NS_IMETHOD SetCursor(nsCursor aCursor); NS_IMETHOD SetCursor(imgIContainer* aCursor, uint32_t aHotspotX, uint32_t aHotspotY) { return nsBaseWidget::SetCursor(aCursor, aHotspotX, aHotspotY); } // Gets the DPI of the screen corresponding to this widget. // Contacts the parent process which gets the DPI from the // proper widget there. TODO: Handle DPI changes that happen // later on. virtual float GetDPI(); virtual double GetDefaultScaleInternal(); virtual bool NeedsPaint() MOZ_OVERRIDE; virtual TabChild* GetOwningTabChild() MOZ_OVERRIDE { return mTabChild; } private: nsresult Paint(); void SetChild(PuppetWidget* aChild); nsresult IMEEndComposition(bool aCancel); nsresult NotifyIMEOfFocusChange(bool aFocus); nsresult NotifyIMEOfSelectionChange(); class PaintTask : public nsRunnable { public: NS_DECL_NSIRUNNABLE PaintTask(PuppetWidget* widget) : mWidget(widget) {} void Revoke() { mWidget = nullptr; } private: PuppetWidget* mWidget; }; // TabChild normally holds a strong reference to this PuppetWidget // or its root ancestor, but each PuppetWidget also needs a // reference back to TabChild (e.g. to delegate nsIWidget IME calls // to chrome) So we hold a weak reference to TabChild here. Since // it's possible for TabChild to outlive the PuppetWidget, we clear // this weak reference in Destroy() TabChild* mTabChild; // The "widget" to which we delegate events if we don't have an // event handler. nsRefPtr mChild; nsIntRegion mDirtyRegion; nsRevocableEventPtr mPaintTask; bool mEnabled; bool mVisible; // XXX/cjones: keeping this around until we teach LayerManager to do // retained-content-only transactions nsRefPtr mSurface; // IME nsIMEUpdatePreference mIMEPreference; bool mIMEComposing; // Latest seqno received through events uint32_t mIMELastReceivedSeqno; // Chrome's seqno value when last blur occurred // arriving events with seqno up to this should be discarded // Note that if seqno overflows (~50 days at 1 ms increment rate), // events will be discarded until new focus/blur occurs uint32_t mIMELastBlurSeqno; bool mNeedIMEStateInit; // The DPI of the screen corresponding to this widget float mDPI; double mDefaultScale; }; class PuppetScreen : public nsBaseScreen { public: PuppetScreen(void* nativeScreen); ~PuppetScreen(); NS_IMETHOD GetRect(int32_t* aLeft, int32_t* aTop, int32_t* aWidth, int32_t* aHeight) MOZ_OVERRIDE; NS_IMETHOD GetAvailRect(int32_t* aLeft, int32_t* aTop, int32_t* aWidth, int32_t* aHeight) MOZ_OVERRIDE; NS_IMETHOD GetPixelDepth(int32_t* aPixelDepth) MOZ_OVERRIDE; NS_IMETHOD GetColorDepth(int32_t* aColorDepth) MOZ_OVERRIDE; NS_IMETHOD GetRotation(uint32_t* aRotation) MOZ_OVERRIDE; NS_IMETHOD SetRotation(uint32_t aRotation) MOZ_OVERRIDE; }; class PuppetScreenManager MOZ_FINAL : public nsIScreenManager { public: PuppetScreenManager(); ~PuppetScreenManager(); NS_DECL_ISUPPORTS NS_DECL_NSISCREENMANAGER protected: nsCOMPtr mOneScreen; }; } // namespace widget } // namespace mozilla #endif // mozilla_widget_PuppetWidget_h__