Fix for bug 72578 -- add ability to retrieve controllers by ID from an nsIControllers. r=kin, sr=hyatt

content/xul/document/public/nsIControllers.idl

@@ -22,10 +22,12 @@
 
 #include "nsISecurityCheckedComponent.idl"
 #include "nsIController.idl"
+
 interface nsIDOMXULCommandDispatcher;
 
 [scriptable, uuid(A5ED3A01-7CC7-11d3-BF87-00105A1B0627)]
-interface nsIControllers : nsISecurityCheckedComponent {
+interface nsIControllers : nsISecurityCheckedComponent
+{
 	attribute nsIDOMXULCommandDispatcher commandDispatcher;
 
 	nsIController getControllerForCommand(in wstring command);
@@ -37,5 +39,15 @@ interface nsIControllers : nsISecurityCheckedComponent {
     void appendController(in nsIController controller);
 	void removeController(in nsIController controller);
 
+    /*
+        Return an ID for this controller which is unique to this
+        nsIControllers.
+    */
+    unsigned long getControllerId(in nsIController controller);
+    /*
+        Get the controller specified by the given ID.
+    */
+    nsIController getControlleryById(in unsigned long controllerID);
+    
 	unsigned long getControllerCount();
 };

content/xul/document/src/nsXULControllers.cpp

@@ -31,6 +31,8 @@
 
 */
 
+#include "nsString.h"
+
 #include "nsIControllers.h"
 #include "nsIDOMElement.h"
 #include "nsIDOMXULCommandDispatcher.h"
@@ -39,12 +41,28 @@
 //----------------------------------------------------------------------
 
 nsXULControllers::nsXULControllers()
+: mCurControllerID(0)
 {
 	NS_INIT_REFCNT();
 }
 
 nsXULControllers::~nsXULControllers(void)
 {
+  DeleteControllers();
+}
+
+void
+nsXULControllers::DeleteControllers()
+{
+  PRUint32 count = mControllers.Count();
+  for (PRUint32 i = 0; i < count; i++)
+  {
+    nsXULControllerData*  controllerData = NS_STATIC_CAST(nsXULControllerData*, mControllers.ElementAt(i));
+    if (controllerData)
+      delete controllerData;    // releases the nsIController
+  }
+  
+  mControllers.Clear();
 }
 
 
@@ -87,20 +105,23 @@ nsXULControllers::SetCommandDispatcher(nsIDOMXULCommandDispatcher* aCommandDispa
 }
 
 NS_IMETHODIMP
-nsXULControllers::GetControllerForCommand(const PRUnichar *command, nsIController** _retval)
+nsXULControllers::GetControllerForCommand(const PRUnichar *aCommand, nsIController** _retval)
 {
+  NS_ENSURE_ARG_POINTER(_retval);
     *_retval = nsnull;
-    if(!mControllers) 
-        return NS_OK;
 
-    PRUint32 count;
+  PRUint32 count = mControllers.Count();
-    mControllers->Count(&count);
+  for (PRUint32 i=0; i < count; i++)
-    for(PRUint32 i=0; i < count; i++) {
+  {
+    nsXULControllerData*  controllerData = NS_STATIC_CAST(nsXULControllerData*, mControllers.ElementAt(i));
+    if (controllerData)
+    {
         nsCOMPtr<nsIController> controller;
-        mControllers->QueryElementAt(i, NS_GET_IID(nsIController), getter_AddRefs(controller));
+      controllerData->GetController(getter_AddRefs(controller));
-        if( controller ) {
+      if (controller)
+      {
             PRBool supportsCommand;
-            controller->SupportsCommand(command, &supportsCommand);
+        controller->SupportsCommand(aCommand, &supportsCommand);
         if (supportsCommand) {
                 *_retval = controller;
                 NS_ADDREF(*_retval);
@@ -108,31 +129,34 @@ nsXULControllers::GetControllerForCommand(const PRUnichar *command, nsIControlle
             }
         }
     }
+  }
+  
     return NS_OK;
 }
 
 NS_IMETHODIMP
 nsXULControllers::InsertControllerAt(PRUint32 index, nsIController *controller)
 {
-    if(! mControllers ) {
+  nsXULControllerData*  controllerData = new nsXULControllerData(mCurControllerID++, controller);
-        nsresult rv;
+  if (!controllerData) return NS_ERROR_OUT_OF_MEMORY;
-        rv = NS_NewISupportsArray(getter_AddRefs(mControllers));
+  PRBool  inserted = mControllers.InsertElementAt((void *)controllerData, index);
-        if (NS_FAILED(rv)) return rv;
+  NS_ASSERTION(inserted, "Insertion of controller failed");
-    }
-
-    mControllers->InsertElementAt(controller, index);
     return NS_OK;
 }
 
 NS_IMETHODIMP
 nsXULControllers::RemoveControllerAt(PRUint32 index, nsIController **_retval)
 {
-    if(mControllers) {
+  NS_ENSURE_ARG_POINTER(_retval);
-        nsresult rv = mControllers->QueryElementAt(index, NS_GET_IID(nsIController), (void**)_retval);
-        if (NS_SUCCEEDED(rv) && *_retval)
-           mControllers->RemoveElementAt(index);  
-    } else
         *_retval = nsnull;
+  nsXULControllerData*  controllerData = NS_STATIC_CAST(nsXULControllerData*, mControllers.ElementAt(index));
+  if (!controllerData) return NS_ERROR_FAILURE;
+  
+  PRBool removed = mControllers.RemoveElementAt(index);
+  NS_ASSERTION(removed, "Removal of controller failed");
+    
+  controllerData->GetController(getter_AddRefs(_retval));
+  delete controllerData;
   
     return NS_OK;
 }
@@ -141,44 +165,95 @@ nsXULControllers::RemoveControllerAt(PRUint32 index, nsIController **_retval)
 NS_IMETHODIMP
 nsXULControllers::GetControllerAt(PRUint32 index, nsIController **_retval)
 {
-    if(mControllers)
+  NS_ENSURE_ARG_POINTER(_retval);
-        mControllers->QueryElementAt(index, NS_GET_IID(nsIController), (void**)_retval);
-    else 
         *_retval = nsnull;
-    return NS_OK;
+
+  nsXULControllerData*  controllerData = NS_STATIC_CAST(nsXULControllerData*, mControllers.ElementAt(index));
+  if (!controllerData) return NS_ERROR_FAILURE;
+
+  return controllerData->GetController(_retval);   // does the addref  
 }
 
 NS_IMETHODIMP
 nsXULControllers::AppendController(nsIController *controller)
 {
-    if(! mControllers ) {
+  nsXULControllerData*  controllerData = new nsXULControllerData(mCurControllerID++, controller);
-        nsresult rv;
+  if (!controllerData) return NS_ERROR_OUT_OF_MEMORY;
-        rv = NS_NewISupportsArray(getter_AddRefs(mControllers));
+  PRBool  appended = mControllers.AppendElement((void *)controllerData);
-        if (NS_FAILED(rv)) return rv;
+  NS_ASSERTION(appended, "Appending controller failed");
-    }
-     
-    mControllers->AppendElement(controller);
     return NS_OK;
 }
 
 NS_IMETHODIMP
 nsXULControllers::RemoveController(nsIController *controller)
 {
-    if(mControllers) {
+  // first find it
-        nsCOMPtr<nsISupports> supports = do_QueryInterface(controller);
+  PRUint32 count = mControllers.Count();
-        mControllers->RemoveElement(supports);  
+  for (PRUint32 i = 0; i < count; i++)
+  {
+    nsXULControllerData*  controllerData = NS_STATIC_CAST(nsXULControllerData*, mControllers.ElementAt(i));
+    if (controllerData)
+    {
+      nsCOMPtr<nsIController> thisController;
+      controllerData->GetController(getter_AddRefs(thisController));
+      if (thisController.get() == controller)
+      {
+        mControllers.RemoveElementAt(i);
+        delete controllerData;
+        return NS_OK;
+      }
+    }
+  }
+  return NS_ERROR_FAILURE;      // right thing to return if no controller found?
 }
     
+/* unsigned long getControllerId (in nsIController controller); */
+NS_IMETHODIMP
+nsXULControllers::GetControllerId(nsIController *controller, PRUint32 *_retval)
+{
+  NS_ENSURE_ARG_POINTER(_retval);
+
+  PRUint32 count = mControllers.Count();
+  for (PRUint32 i = 0; i < count; i++)
+  {
+    nsXULControllerData*  controllerData = NS_STATIC_CAST(nsXULControllerData*, mControllers.ElementAt(i));
+    if (controllerData)
+    {
+      nsCOMPtr<nsIController> thisController;
+      controllerData->GetController(getter_AddRefs(thisController));
+      if (thisController.get() == controller)
+      {
+        *_retval = controllerData->GetControllerID();
     return NS_OK;
       }
+    }
+  }
+  return NS_ERROR_FAILURE;  // none found
+}
+
+/* nsIController getControlleryById (in unsigned long controllerID); */
+NS_IMETHODIMP
+nsXULControllers::GetControlleryById(PRUint32 controllerID, nsIController **_retval)
+{
+  NS_ENSURE_ARG_POINTER(_retval);
+    
+  PRUint32 count = mControllers.Count();
+  for (PRUint32 i = 0; i < count; i++)
+  {
+    nsXULControllerData*  controllerData = NS_STATIC_CAST(nsXULControllerData*, mControllers.ElementAt(i));
+    if (controllerData && controllerData->GetControllerID() == controllerID)
+    {
+      return controllerData->GetController(_retval);
+    }
+  }
+  return NS_ERROR_FAILURE;  // none found
+}
 
 NS_IMETHODIMP
 nsXULControllers::GetControllerCount(PRUint32 *_retval)
 {
-    *_retval = 0;
+  NS_ENSURE_ARG_POINTER(_retval);
-    if(mControllers) 
+  *_retval = mControllers.Count();
-        mControllers->Count(_retval);
-    
     return NS_OK;
 }
 

content/xul/document/src/nsXULControllers.h

@@ -33,12 +33,41 @@
 #define nsXULControllers_h__
 
 #include "nsCOMPtr.h"
+#include "nsVoidArray.h"
 #include "nsWeakPtr.h"
 #include "nsIControllers.h"
 #include "nsISupportsArray.h"
 
 class nsIDOMXULCommandDispatcher;
 
+
+/* non-XPCOM class for holding controllers and their IDs */
+class nsXULControllerData
+{
+public:
+                            nsXULControllerData(PRUint32 inControllerID, nsIController* inController)
+                            : mControllerID(inControllerID)
+                            , mController(inController)
+                            {                            
+                            }
+
+                            ~nsXULControllerData() {}
+
+    PRUint32                GetControllerID()   { return mControllerID; }
+
+    nsresult                GetController(nsIController **outController)
+                            {
+                              NS_IF_ADDREF(*outController = mController);
+                              return NS_OK;
+                            }
+    
+protected:
+
+    PRUint32                mControllerID;
+    nsCOMPtr<nsIController> mController;
+};
+
+
 class nsXULControllers : public nsIControllers
 {
 public:
@@ -53,8 +82,11 @@ protected:
     nsXULControllers();
     virtual ~nsXULControllers(void);
 
-    nsCOMPtr<nsISupportsArray> mControllers;
+    void        DeleteControllers();
+
+    nsVoidArray mControllers;
     nsWeakPtr mCommandDispatcher;
+    PRUint32    mCurControllerID;
 };