/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set ts=2 et sw=2 tw=80: */ /* 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/. */ #ifndef mozilla_a11y_AccessibleWrap_h_ #define mozilla_a11y_AccessibleWrap_h_ #include "nsCOMPtr.h" #include "Accessible.h" #include "ia2Accessible.h" #include "ia2AccessibleComponent.h" #include "ia2AccessibleHyperlink.h" #include "ia2AccessibleValue.h" #include "mozilla/a11y/AccessibleHandler.h" #include "mozilla/a11y/MsaaIdGenerator.h" #include "mozilla/a11y/ProxyAccessible.h" #include "mozilla/Attributes.h" #include "mozilla/mscom/Utils.h" #include "mozilla/StaticPtr.h" #include "nsXULAppAPI.h" #include "Units.h" #if defined(__GNUC__) || defined(__clang__) // Inheriting from both XPCOM and MSCOM interfaces causes a lot of warnings // about virtual functions being hidden by each other. This is done by // design, so silence the warning. # pragma GCC diagnostic ignored "-Woverloaded-virtual" #endif namespace mozilla { namespace a11y { class DocProxyAccessibleWrap; class AccessibleWrap : public Accessible, public ia2Accessible, public ia2AccessibleComponent, public ia2AccessibleHyperlink, public ia2AccessibleValue { public: // construction, destruction AccessibleWrap(nsIContent* aContent, DocAccessible* aDoc); // nsISupports NS_DECL_ISUPPORTS_INHERITED public: // IUnknown methods - see iunknown.h for documentation STDMETHODIMP QueryInterface(REFIID, void**) override; // Return the registered OLE class ID of this object's CfDataObj. CLSID GetClassID() const; public: // COM interface IAccessible virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accParent( /* [retval][out] */ IDispatch __RPC_FAR* __RPC_FAR* ppdispParent) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accChildCount( /* [retval][out] */ long __RPC_FAR* pcountChildren) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accChild( /* [in] */ VARIANT varChild, /* [retval][out] */ IDispatch __RPC_FAR* __RPC_FAR* ppdispChild) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accName( /* [optional][in] */ VARIANT varChild, /* [retval][out] */ BSTR __RPC_FAR* pszName) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accValue( /* [optional][in] */ VARIANT varChild, /* [retval][out] */ BSTR __RPC_FAR* pszValue) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accDescription( /* [optional][in] */ VARIANT varChild, /* [retval][out] */ BSTR __RPC_FAR* pszDescription) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accRole( /* [optional][in] */ VARIANT varChild, /* [retval][out] */ VARIANT __RPC_FAR* pvarRole) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accState( /* [optional][in] */ VARIANT varChild, /* [retval][out] */ VARIANT __RPC_FAR* pvarState) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accHelp( /* [optional][in] */ VARIANT varChild, /* [retval][out] */ BSTR __RPC_FAR* pszHelp) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accHelpTopic( /* [out] */ BSTR __RPC_FAR* pszHelpFile, /* [optional][in] */ VARIANT varChild, /* [retval][out] */ long __RPC_FAR* pidTopic) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accKeyboardShortcut( /* [optional][in] */ VARIANT varChild, /* [retval][out] */ BSTR __RPC_FAR* pszKeyboardShortcut) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accFocus( /* [retval][out] */ VARIANT __RPC_FAR* pvarChild) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accSelection( /* [retval][out] */ VARIANT __RPC_FAR* pvarChildren) override; virtual /* [id][propget] */ HRESULT STDMETHODCALLTYPE get_accDefaultAction( /* [optional][in] */ VARIANT varChild, /* [retval][out] */ BSTR __RPC_FAR* pszDefaultAction) override; virtual /* [id] */ HRESULT STDMETHODCALLTYPE accSelect( /* [in] */ long flagsSelect, /* [optional][in] */ VARIANT varChild) override; virtual /* [id] */ HRESULT STDMETHODCALLTYPE accLocation( /* [out] */ long __RPC_FAR* pxLeft, /* [out] */ long __RPC_FAR* pyTop, /* [out] */ long __RPC_FAR* pcxWidth, /* [out] */ long __RPC_FAR* pcyHeight, /* [optional][in] */ VARIANT varChild) override; virtual /* [id] */ HRESULT STDMETHODCALLTYPE accNavigate( /* [in] */ long navDir, /* [optional][in] */ VARIANT varStart, /* [retval][out] */ VARIANT __RPC_FAR* pvarEndUpAt) override; virtual /* [id] */ HRESULT STDMETHODCALLTYPE accHitTest( /* [in] */ long xLeft, /* [in] */ long yTop, /* [retval][out] */ VARIANT __RPC_FAR* pvarChild) override; virtual /* [id] */ HRESULT STDMETHODCALLTYPE accDoDefaultAction( /* [optional][in] */ VARIANT varChild) override; virtual /* [id][propput] */ HRESULT STDMETHODCALLTYPE put_accName( /* [optional][in] */ VARIANT varChild, /* [in] */ BSTR szName) override; virtual /* [id][propput] */ HRESULT STDMETHODCALLTYPE put_accValue( /* [optional][in] */ VARIANT varChild, /* [in] */ BSTR szValue) override; // IDispatch (support of scripting languages like VB) virtual HRESULT STDMETHODCALLTYPE GetTypeInfoCount(UINT* pctinfo) override; virtual HRESULT STDMETHODCALLTYPE GetTypeInfo(UINT iTInfo, LCID lcid, ITypeInfo** ppTInfo) override; virtual HRESULT STDMETHODCALLTYPE GetIDsOfNames(REFIID riid, LPOLESTR* rgszNames, UINT cNames, LCID lcid, DISPID* rgDispId) override; virtual HRESULT STDMETHODCALLTYPE Invoke(DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS* pDispParams, VARIANT* pVarResult, EXCEPINFO* pExcepInfo, UINT* puArgErr) override; // Accessible virtual nsresult HandleAccEvent(AccEvent* aEvent) override; virtual void Shutdown() override; // Helper methods static int32_t GetChildIDFor(Accessible* aAccessible); static HWND GetHWNDFor(Accessible* aAccessible); static void FireWinEvent(Accessible* aTarget, uint32_t aEventType); /** * System caret support: update the Windows caret position. * The system caret works more universally than the MSAA caret * For example, Window-Eyes, JAWS, ZoomText and Windows Tablet Edition use it * We will use an invisible system caret. * Gecko is still responsible for drawing its own caret */ void UpdateSystemCaretFor(Accessible* aAccessible); static void UpdateSystemCaretFor(ProxyAccessible* aProxy, const LayoutDeviceIntRect& aCaretRect); /** * Associate a COM object with this Accessible so it will be disconnected * from remote clients when this Accessible shuts down. * This should only be called with separate COM objects with a different * IUnknown to this AccessibleWrap; e.g. IAccessibleRelation. */ void AssociateCOMObjectForDisconnection(IUnknown* aObject) { // We only need to track these for content processes because COM garbage // collection is disabled there. if (XRE_IsContentProcess()) { mAssociatedCOMObjectsForDisconnection.AppendElement(aObject); } } private: static void UpdateSystemCaretFor(HWND aCaretWnd, const LayoutDeviceIntRect& aCaretRect); public: /** * Determine whether this is the root accessible for its HWND. */ bool IsRootForHWND(); /** * Find an accessible by the given child ID in cached documents. */ [[nodiscard]] already_AddRefed GetIAccessibleFor( const VARIANT& aVarChild, bool* aIsDefunct); virtual void GetNativeInterface(void** aOutAccessible) override; static IDispatch* NativeAccessible(Accessible* aAccessible); uint32_t GetExistingID() const { return mID; } static const uint32_t kNoID = 0; void SetID(uint32_t aID); static uint32_t GetContentProcessIdFor(dom::ContentParentId aIPCContentId); static void ReleaseContentProcessIdFor(dom::ContentParentId aIPCContentId); static void SetHandlerControl(DWORD aPid, RefPtr aCtrl); static void InvalidateHandlers(); bool DispatchTextChangeToHandler(bool aIsInsert, const nsString& aText, int32_t aStart, uint32_t aLen); static void AssignChildIDTo(NotNull aSdnAcc); static void ReleaseChildID(NotNull aSdnAcc); protected: virtual ~AccessibleWrap(); uint32_t mID; HRESULT ResolveChild(const VARIANT& aVarChild, IAccessible** aOutInterface); /** * Find a remote accessible by the given child ID. */ [[nodiscard]] already_AddRefed GetRemoteIAccessibleFor( const VARIANT& aVarChild); /** * Return the wrapper for the document's proxy. */ DocProxyAccessibleWrap* DocProxyWrapper() const; /** * Creates ITypeInfo for LIBID_Accessibility if it's needed and returns it. */ static ITypeInfo* GetTI(LCID lcid); static ITypeInfo* gTypeInfo; static MsaaIdGenerator sIDGen; enum navRelations { NAVRELATION_CONTROLLED_BY = 0x1000, NAVRELATION_CONTROLLER_FOR = 0x1001, NAVRELATION_LABEL_FOR = 0x1002, NAVRELATION_LABELLED_BY = 0x1003, NAVRELATION_MEMBER_OF = 0x1004, NAVRELATION_NODE_CHILD_OF = 0x1005, NAVRELATION_FLOWS_TO = 0x1006, NAVRELATION_FLOWS_FROM = 0x1007, NAVRELATION_SUBWINDOW_OF = 0x1008, NAVRELATION_EMBEDS = 0x1009, NAVRELATION_EMBEDDED_BY = 0x100a, NAVRELATION_POPUP_FOR = 0x100b, NAVRELATION_PARENT_WINDOW_OF = 0x100c, NAVRELATION_DEFAULT_BUTTON = 0x100d, NAVRELATION_DESCRIBED_BY = 0x100e, NAVRELATION_DESCRIPTION_FOR = 0x100f, NAVRELATION_NODE_PARENT_OF = 0x1010, NAVRELATION_CONTAINING_DOCUMENT = 0x1011, NAVRELATION_CONTAINING_TAB_PANE = 0x1012, NAVRELATION_CONTAINING_WINDOW = 0x1013, NAVRELATION_CONTAINING_APPLICATION = 0x1014, NAVRELATION_DETAILS = 0x1015, NAVRELATION_DETAILS_FOR = 0x1016, NAVRELATION_ERROR = 0x1017, NAVRELATION_ERROR_FOR = 0x1018 }; struct HandlerControllerData final { HandlerControllerData(DWORD aPid, RefPtr&& aCtrl) : mPid(aPid), mCtrl(std::move(aCtrl)) { mIsProxy = mozilla::mscom::IsProxy(mCtrl); } HandlerControllerData(HandlerControllerData&& aOther) : mPid(aOther.mPid), mIsProxy(aOther.mIsProxy), mCtrl(std::move(aOther.mCtrl)) {} bool operator==(const HandlerControllerData& aOther) const { return mPid == aOther.mPid; } bool operator==(const DWORD& aPid) const { return mPid == aPid; } DWORD mPid; bool mIsProxy; RefPtr mCtrl; }; static StaticAutoPtr> sHandlerControllers; nsTArray> mAssociatedCOMObjectsForDisconnection; }; static inline AccessibleWrap* WrapperFor(const ProxyAccessible* aProxy) { return reinterpret_cast(aProxy->GetWrapper()); } } // namespace a11y } // namespace mozilla #ifdef XP_WIN // Undo the windows.h damage # undef GetMessage # undef CreateEvent # undef GetClassName # undef GetBinaryType # undef RemoveDirectory #endif #endif