Extension to add builtin accessibility. In the future it will support text-to-speech and braille displays for visually impaired users. See README, bug=65158, r=jst, sr=vidur.

extensions/access-builtin/Makefile.in

@@ -31,7 +31,7 @@ VPATH		= .
 
 include $(DEPTH)/config/autoconf.mk
 
-DIRS		= accessproxy accessiblehandler speechout
+DIRS		= accessproxy
 
 include $(topsrcdir)/config/rules.mk
 

extensions/access-builtin/accessproxy/nsAccessProxy.cpp

@@ -0,0 +1,276 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Initial Developer of the Original Code is Aaron Leventhal.
+ * Portionsk  created by Aaron Leventhal are Copyright (C) 2001
+ * Aaron Leventhal. All Rights Reserved.
+ *
+ * Alternatively, the contents of this file may be used under the terms
+ * of the GNU General Public License (the "GPL"), in which case the
+ * provisions of the GPL are applicable instead of those above.  If you
+ * wish to allow use of your version of this file only under the terms of
+ * the GPL and not to allow others to use your version of this file under
+ * the MPL, indicate your decision by deleting the provisions above and
+ * replace them with the notice and other provisions required by the
+ * GPL. If you do not delete the provisions above, a recipient may use
+ * your version of this file under either the MPL or the GPL.
+ *
+ * Contributor(s):
+ */
+
+#include "nsCOMPtr.h"
+#include "nsMemory.h"
+#include "nsIServiceManager.h"
+#include "nsIGenericFactory.h"
+#include "nsIAppShellComponent.h"
+#include "nsIWebProgress.h"
+#include "nsIDocumentLoader.h"
+#include "nsCURILoader.h"
+#include "nsIDocShell.h"
+#include "nsIDOMWindow.h"
+#include "nsIDOMWindowInternal.h"
+#include "nsIDOMEventTarget.h"
+
+#include "nsIRegistry.h"
+#include "nsString.h"
+
+#include "nsIDOMNode.h"
+#include "nsIPresShell.h"
+#include "nsIDOMDocument.h"
+#include "nsIDocument.h"
+#include "nsISelection.h"
+#include "nsISelectionController.h"
+#include "nsIFrameSelection.h"
+#include "nsICaret.h"
+
+// Header for this class
+#include "nsAccessProxy.h"
+
+#define NS_DEBUG_ACCESS_BUILTIN 1
+
+
+////////////////////////////////////////////////////////////////////////
+
+
+NS_IMPL_ISUPPORTS4(nsAccessProxy, nsIAppShellComponent, nsISupportsWeakReference, nsIWebProgressListener, nsIDOMEventListener)
+
+nsAccessProxy* nsAccessProxy::mInstance = nsnull;
+
+nsAccessProxy::nsAccessProxy()
+{
+  NS_INIT_REFCNT();
+}
+
+nsAccessProxy::~nsAccessProxy()
+{
+  printf("%s","\n\n\n\nBYE BYE BYE BYE \n\n\n\n");
+}
+
+nsAccessProxy *nsAccessProxy::GetInstance()
+{
+  if (mInstance == nsnull) {
+    mInstance = new nsAccessProxy();
+    // Will be released in the module destructor
+    NS_IF_ADDREF(mInstance);
+  }
+
+  NS_IF_ADDREF(mInstance);
+  return mInstance;
+}
+
+void nsAccessProxy::ReleaseInstance()
+{
+  NS_IF_RELEASE(nsAccessProxy::mInstance);
+  //return NS_OK;
+}
+
+
+nsresult nsAccessProxy::HandleEvent(nsIDOMEvent* aEvent)
+{
+  nsresult rv;
+
+  //////// Get Type of Event into a string called eventName ///////
+  nsAutoString eventNameStr;
+  rv=aEvent->GetType(eventNameStr);
+  if (NS_FAILED(rv))
+    return rv;
+  // Print event name and styles debugging messages
+  #ifdef NS_DEBUG_ACCESS_BUILTIN
+  printf("\n==== %s event occurred ====\n",NS_ConvertUCS2toUTF8(eventNameStr).get());
+  #endif
+
+  ////////// Get Target Node - place in document where event was fired ////////////
+  nsCOMPtr<nsIDOMEventTarget> targetNode;
+  rv = aEvent->GetOriginalTarget(getter_AddRefs(targetNode));
+
+  if (NS_FAILED(rv))
+    return rv;
+  if (!targetNode)
+    return NS_ERROR_NULL_POINTER;
+  nsCOMPtr<nsIDOMNode> domNode = do_QueryInterface(targetNode);
+  if (!domNode)
+    return NS_OK;
+
+  // get the Document and PresShell
+  nsCOMPtr<nsIDOMDocument> domDoc;
+  nsCOMPtr<nsIPresShell> presShell;
+  nsCOMPtr<nsIDocument> doc;
+  domNode->GetOwnerDocument(getter_AddRefs(domDoc));
+  if (domDoc) {
+    doc = do_QueryInterface(domDoc);
+    if (doc && doc->GetNumberOfShells()>0)
+      presShell= dont_AddRef(doc->GetShellAt(0));
+    }
+  //return  NS_OK;
+  /*
+  if (presShell && eventNameStr.EqualsWithConversion("click")) {
+    nsCOMPtr<nsIFrameSelection> frameSelection;
+    presShell->GetFrameSelection(getter_AddRefs(frameSelection));
+    if (!frameSelection)
+      return NS_OK;
+    nsCOMPtr<nsISelection> domSelection;
+    frameSelection->GetSelection(nsISelectionController::SELECTION_NORMAL,
+                            getter_AddRefs(domSelection));
+    if (!domSelection)
+      return NS_OK;
+    nsCOMPtr<nsIDOMNode> focusDomNode;
+    domSelection->GetAnchorNode(getter_AddRefs(focusDomNode));
+    if (focusDomNode) domNode=focusDomNode;
+    // first, tell the caret which selection to use
+    nsCOMPtr<nsICaret> caret;
+    presShell->GetCaret(getter_AddRefs(caret));
+    if (!caret) return NS_OK;
+    caret->SetCaretDOMSelection(domSelection);
+    // tell the pres shell to enable the caret, rather than settings its visibility directly.
+    // this way the presShell's idea of caret visibility is maintained.
+    nsCOMPtr<nsISelectionController> selCon = do_QueryInterface(presShell);
+    if (!selCon) return NS_ERROR_NO_INTERFACE;
+    selCon->SetCaretEnabled(PR_TRUE);
+    caret->SetCaretVisible(PR_TRUE);
+  }
+  */
+
+  return NS_OK;
+}
+
+
+// This method gets called on application startup
+NS_IMETHODIMP nsAccessProxy::Initialize(nsIAppShellService *anAppShell,
+  nsICmdLineService  *aCmdLineService)
+{
+  nsCOMPtr<nsIWebProgress> progress(do_GetService(NS_DOCUMENTLOADER_SERVICE_CONTRACTID));
+  nsresult rv = NS_ERROR_FAILURE;
+  if (progress) {
+    rv = progress->AddProgressListener(NS_STATIC_CAST(nsIWebProgressListener*,this));
+    if (NS_SUCCEEDED(rv))
+      AddRef();
+  }
+
+  return rv;
+}
+
+// This method gets called on application shutdown
+NS_IMETHODIMP nsAccessProxy::Shutdown()
+{
+  Release();
+  return NS_OK;
+}
+
+
+NS_IMETHODIMP nsAccessProxy::OnStateChange(nsIWebProgress *aWebProgress,
+  nsIRequest *aRequest, PRInt32 aStateFlags, PRUint32 aStatus)
+{
+/* PRInt32 aStateFlags ...
+ *
+ * ===== What has happened =====	
+ * STATE_START, STATE_REDIRECTING, STATE_TRANSFERRING,
+ * STATE_NEGOTIATING, STATE_STOP
+
+ * ===== Where did it occur? =====
+ * STATE_IS_REQUEST, STATE_IS_DOCUMENT, STATE_IS_NETWORK, STATE_IS_WINDOW
+
+ * ===== Security info =====
+ * STATE_IS_INSECURE, STATE_IS_BROKEN, STATE_IS_SECURE, STATE_SECURE_HIGH
+ * STATE_SECURE_MED, STATE_SECURE_LOW
+ *
+ */
+
+  nsresult rv;
+  if ((aStateFlags & (STATE_STOP|STATE_START)) && (aStateFlags & STATE_IS_DOCUMENT)) {
+    nsCOMPtr<nsIDOMWindow> domWindow;
+    aWebProgress->GetDOMWindow(getter_AddRefs(domWindow));
+
+    if (domWindow) {
+      nsCOMPtr<nsIDOMEventTarget> eventTarget = do_QueryInterface(domWindow);
+      nsCOMPtr<nsIDOMWindowInternal> windowInternal = do_QueryInterface(domWindow);
+      nsCOMPtr<nsIDOMWindowInternal> opener;
+      if (windowInternal)
+        windowInternal->GetOpener(getter_AddRefs(opener));
+      if (eventTarget && opener) {
+        eventTarget->AddEventListener(NS_LITERAL_STRING("keyup"), this, PR_FALSE);
+        eventTarget->AddEventListener(NS_LITERAL_STRING("keypress"), this, PR_FALSE);
+        eventTarget->AddEventListener(NS_LITERAL_STRING("focus"), this, PR_FALSE);
+        eventTarget->AddEventListener(NS_LITERAL_STRING("load"), this, PR_FALSE);
+        eventTarget->AddEventListener(NS_LITERAL_STRING("click"), this, PR_FALSE); // for debugging
+        }
+      }
+    }
+
+  return NS_OK;
+}
+
+/* void onProgressChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in long aCurSelfProgress, in long aMaxSelfProgress, in long aCurTotalProgress, in long aMaxTotalProgress); */
+NS_IMETHODIMP nsAccessProxy::OnProgressChange(nsIWebProgress *aWebProgress,
+  nsIRequest *aRequest, PRInt32 aCurSelfProgress, PRInt32 aMaxSelfProgress,
+  PRInt32 aCurTotalProgress, PRInt32 aMaxTotalProgress)
+{
+  // We can use this to report the percentage done
+  #ifdef NS_DEBUG_ACCESS_BUILTIN
+  // printf ("** nsAccessProxy ** OnProgressChange ** \n");
+  #endif
+  return NS_OK;
+}
+
+/* void onLocationChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in nsIURI location); */
+NS_IMETHODIMP nsAccessProxy::OnLocationChange(nsIWebProgress *aWebProgress,
+  nsIRequest *aRequest, nsIURI *location)
+{
+  // Load has been verified, it will occur, about to commence
+  #ifdef NS_DEBUG_ACCESS_BUILTIN
+  // printf ("** nsAccessProxy ** OnLocationChange ** \n");
+  #endif
+  return NS_OK;
+}
+
+/* void onStatusChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in nsresult aStatus, in wstring aMessage); */
+NS_IMETHODIMP nsAccessProxy::OnStatusChange(nsIWebProgress *aWebProgress,
+  nsIRequest *aRequest, nsresult aStatus, const PRUnichar *aMessage)
+{
+  // Status bar has changed
+  #ifdef NS_DEBUG_ACCESS_BUILTIN
+  // printf ("** nsAccessProxy ** OnStatusChange ** \n");
+  #endif
+  return NS_OK;
+}
+
+/* void onSecurityChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in long state); */
+NS_IMETHODIMP nsAccessProxy::OnSecurityChange(nsIWebProgress *aWebProgress,
+  nsIRequest *aRequest, PRInt32 state)
+{
+  // Security setting has changed
+  #ifdef NS_DEBUG_ACCESS_BUILTIN
+  printf ("** nsAccessProxy ** OnSecurityChange ** \n");
+  #endif
+  return NS_OK;
+}
+
+

extensions/access-builtin/accessproxy/nsAccessProxy.h

@@ -0,0 +1,77 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * 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 Initial Developer of the Original Code is Aaron Leventhal.
+ * Portions created by Aaron Leventhal are Copyright (C) 2001
+ * Aaron Leventhal. All Rights Reserved.
+ *
+ * Alternatively, the contents of this file may be used under the terms
+ * of the GNU General Public License (the "GPL"), in which case the
+ * provisions of the GPL are applicable instead of those above.  If you
+ * wish to allow use of your version of this file only under the terms of
+ * the GPL and not to allow others to use your version of this file under
+ * the MPL, indicate your decision by deleting the provisions above and
+ * replace them with the notice and other provisions required by the
+ * GPL. If you do not delete the provisions above, a recipient may use
+ * your version of this file under either the MPL or the GPL.
+ *
+ * Contributor(s):
+ */
+
+/**
+ * This file is the header of an implementation
+ * nsAccessProxy of the nsIAccessProxy interface.
+ */
+
+#include "nsIAccessProxy.h"
+#include "nsIDOMEventListener.h"
+#include "nsIAppShellComponent.h"
+#include "nsIWebProgressListener.h"
+#include "nsWeakReference.h"
+
+
+/**
+ * AccessProxy is an implementation of the nsIAccessProxy interface.  In XPCOM,
+ * there can be more than one implementation of an given interface.  Class
+ * IDs (CIDs) uniquely identify a particular implementation of an interface.
+ * Interface IDs (IIDs) uniquely identify an interface.
+ *
+ * The CID is also a unique number that looks just like an IID
+ * and uniquely identifies an implementation
+ * {7CB5B7A0-07D7-11d3-BDE2-000064657374}
+ */
+
+
+class nsAccessProxy : public nsIDOMEventListener,
+                      public nsIAppShellComponent,
+                      public nsIWebProgressListener,
+                      public nsSupportsWeakReference
+{
+public:
+  nsAccessProxy();
+  virtual ~nsAccessProxy();
+
+  NS_DEFINE_STATIC_CID_ACCESSOR(NS_ACCESSPROXY_CID);
+
+  NS_DECL_ISUPPORTS  // This macro expands into declaration of nsISupports interface
+  NS_DECL_NSIAPPSHELLCOMPONENT
+  NS_DECL_NSIWEBPROGRESSLISTENER
+
+  //NS_DECL_NSIACCESSPROXY
+  virtual nsresult HandleEvent(nsIDOMEvent *event);  // This compiles on Windows
+
+  static nsAccessProxy *GetInstance();
+  static void ReleaseInstance(void);
+
+private:
+  static nsAccessProxy *mInstance;
+};

extensions/access-builtin/accessproxy/nsAccessProxyRegistration.cpp

@@ -0,0 +1,93 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * 
+ * 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 Initial Developer of the Original Code is Aaron Leventhal.
+ * Portionsk  created by Aaron Leventhal are Copyright (C) 2001
+ * Aaron Leventhal. All Rights Reserved.
+ *
+ * Alternatively, the contents of this file may be used under the terms
+ * of the GNU General Public License (the "GPL"), in which case the
+ * provisions of the GPL are applicable instead of those above.  If you
+ * wish to allow use of your version of this file only under the terms of
+ * the GPL and not to allow others to use your version of this file under
+ * the MPL, indicate your decision by deleting the provisions above and
+ * replace them with the notice and other provisions required by the
+ * GPL. If you do not delete the provisions above, a recipient may use
+ * your version of this file under either the MPL or the GPL.
+ *
+ * Contributor(s):
+ */
+
+#include "nsIGenericFactory.h"
+#include "nsAccessProxy.h"
+#include "nsIAppShellComponent.h"
+#include "nsIRegistry.h"
+#include "prprf.h"
+
+#define NS_ACESSPROXY_CONTRACTID NS_IAPPSHELLCOMPONENT_CONTRACTID "/accessproxy;1"
+
+////////////////////////////////////////////////////////////////////////
+// Define a table of CIDs implemented by this module along with other
+// information like the function to create an instance, contractid, and
+// class name.
+//
+// The Registration and Unregistration proc are optional in the structure.
+//
+
+
+// This function is called at component registration time
+static NS_METHOD nsAccessProxyRegistrationProc(nsIComponentManager *aCompMgr,
+  nsIFile *aPath, const char *registryLocation, const char *componentType)
+{
+  // This function performs the extra step of installing us as
+  // an application component. This makes sure that we're
+  // initialized on application startup.
+  // get the registry
+  nsIRegistry* registry;
+  nsresult rv = nsServiceManager::GetService(NS_REGISTRY_CONTRACTID,
+    NS_GET_IID(nsIRegistry), (nsISupports**)&registry);
+  if (NS_SUCCEEDED(rv)) {
+    registry->OpenWellKnownRegistry(nsIRegistry::ApplicationComponentRegistry);
+    char buffer[256];
+    char *cid = nsAccessProxy::GetCID().ToString();
+    PR_snprintf(buffer, sizeof buffer, "%s/%s", NS_IAPPSHELLCOMPONENT_KEY,
+      cid ? cid : "unknown" );
+    nsCRT::free(cid);
+
+    nsRegistryKey key;
+    rv = registry->AddSubtree(nsIRegistry::Common, buffer, &key);
+    nsServiceManager::ReleaseService(NS_REGISTRY_CONTRACTID, registry);
+  }
+  return rv;
+}
+
+
+NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR(nsAccessProxy,nsAccessProxy::GetInstance);
+
+static void PR_CALLBACK AccessProxyModuleDtor(nsIModule* self)
+{
+    nsAccessProxy::ReleaseInstance();
+}
+
+static nsModuleComponentInfo components[] =
+{
+  { "AccessProxy Component", NS_ACCESSPROXY_CID, NS_ACCESSPROXY_CONTRACTID,
+    nsAccessProxyConstructor, nsAccessProxyRegistrationProc,
+    nsnull  // Unregistration proc
+  }
+};
+
+NS_IMPL_NSGETMODULE_WITH_DTOR("nsAccessProxy", components, AccessProxyModuleDtor)
+
+
+
+

extensions/access-builtin/accessproxy/nsIAccessProxy.idl

@@ -0,0 +1,55 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * 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 Initial Developer of the Original Code is Aaron Leventhal.
+ * Portions created by Aaron Leventhal are Copyright (C) 2001
+ * Aaron Leventhal. All Rights Reserved.
+
+ * Alternatively, the contents of this file may be used under the terms
+ * of the GNU General Public License (the "GPL"), in which case the
+ * provisions of the GPL are applicable instead of those above.  If you
+ * wish to allow use of your version of this file only under the terms of
+ * the GPL and not to allow others to use your version of this file under
+ * the MPL, indicate your decision by deleting the provisions above and
+ * replace them with the notice and other provisions required by the
+ * GPL. If you do not delete the provisions above, a recipient may use
+ * your version of this file under either the MPL or the GPL.
+
+ * Contributor(s):
+ */
+
+/**
+ * A accessproxy of XPConnect. This file contains a accessproxy interface.
+ *
+ */
+
+#include "nsISupports.idl"
+#include "domstubs.idl"
+
+%{ C++
+  #include "nsIDOMEvent.h"
+
+  #define NS_ACCESSPROXY_CID \
+  { 0x7cb5b7a0, 0x7d7, 0x11d3, { 0xbd, 0xe2, 0x0, 0x0, 0x64, 0x65, 0x73, 0x74 } }
+
+  #define NS_ACCESSPROXY_CONTRACTID NS_IAPPSHELLCOMPONENT_CONTRACTID "/accessproxy;1"
+%}
+
+interface nsIDOMEvent;
+
+[uuid(57e45180-7b41-4815-beec-6cac25dfac57)]
+interface nsIAccessProxy : nsISupports
+{
+  void handleEvent(in nsIDOMEvent event);
+};
+
+
+

extensions/access-builtin/makefile.win

@@ -26,6 +26,6 @@
 
 DEPTH=..\..
 
-DIRS=accessproxy accessiblehandler speechout
+DIRS=accessproxy
 
 include <$(DEPTH)\config\rules.mak>