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: /*
michael@0: 
michael@0:   This file provides the implementation for the XUL "controllers"
michael@0:   object.
michael@0: 
michael@0: */
michael@0: 
michael@0: #include "nsString.h"
michael@0: 
michael@0: #include "nsIControllers.h"
michael@0: #include "nsIDOMElement.h"
michael@0: #include "nsXULControllers.h"
michael@0: #include "nsDOMClassInfoID.h"
michael@0: #include "nsIController.h"
michael@0: 
michael@0: //----------------------------------------------------------------------
michael@0: 
michael@0: nsXULControllers::nsXULControllers()
michael@0: : mCurControllerID(0)
michael@0: {
michael@0: }
michael@0: 
michael@0: nsXULControllers::~nsXULControllers(void)
michael@0: {
michael@0:   DeleteControllers();
michael@0: }
michael@0: 
michael@0: void
michael@0: nsXULControllers::DeleteControllers()
michael@0: {
michael@0:   uint32_t count = mControllers.Length();
michael@0:   for (uint32_t i = 0; i < count; i++)
michael@0:   {
michael@0:     nsXULControllerData* controllerData = mControllers.ElementAt(i);
michael@0:     delete controllerData;    // releases the nsIController
michael@0:   }
michael@0:   
michael@0:   mControllers.Clear();
michael@0: }
michael@0: 
michael@0: 
michael@0: nsresult
michael@0: NS_NewXULControllers(nsISupports* aOuter, REFNSIID aIID, void** aResult)
michael@0: {
michael@0:   NS_PRECONDITION(aOuter == nullptr, "no aggregation");
michael@0:   if (aOuter)
michael@0:     return NS_ERROR_NO_AGGREGATION;
michael@0: 
michael@0:   nsXULControllers* controllers = new nsXULControllers();
michael@0:   if (! controllers)
michael@0:     return NS_ERROR_OUT_OF_MEMORY;
michael@0:   
michael@0:   nsresult rv;
michael@0:   NS_ADDREF(controllers);
michael@0:   rv = controllers->QueryInterface(aIID, aResult);
michael@0:   NS_RELEASE(controllers);
michael@0:   return rv;
michael@0: }
michael@0: 
michael@0: NS_IMPL_CYCLE_COLLECTION_CLASS(nsXULControllers)
michael@0: 
michael@0: NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(nsXULControllers)
michael@0:   tmp->DeleteControllers();
michael@0: NS_IMPL_CYCLE_COLLECTION_UNLINK_END
michael@0: NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(nsXULControllers)
michael@0:   {
michael@0:     uint32_t i, count = tmp->mControllers.Length();
michael@0:     for (i = 0; i < count; ++i) {
michael@0:       nsXULControllerData* controllerData = tmp->mControllers[i];
michael@0:       if (controllerData) {
michael@0:         cb.NoteXPCOMChild(controllerData->mController);
michael@0:       }
michael@0:     }
michael@0:   }
michael@0: NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
michael@0: 
michael@0: DOMCI_DATA(XULControllers, nsXULControllers)
michael@0: 
michael@0: NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(nsXULControllers)
michael@0:   NS_INTERFACE_MAP_ENTRY(nsIControllers)
michael@0:   NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIControllers)
michael@0:   NS_DOM_INTERFACE_MAP_ENTRY_CLASSINFO(XULControllers)
michael@0: NS_INTERFACE_MAP_END
michael@0: 
michael@0: NS_IMPL_CYCLE_COLLECTING_ADDREF(nsXULControllers)
michael@0: NS_IMPL_CYCLE_COLLECTING_RELEASE(nsXULControllers)
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::GetControllerForCommand(const char *aCommand, nsIController** _retval)
michael@0: {
michael@0:   NS_ENSURE_ARG_POINTER(_retval);
michael@0:   *_retval = nullptr;
michael@0: 
michael@0:   uint32_t count = mControllers.Length();
michael@0:   for (uint32_t i=0; i < count; i++)
michael@0:   {
michael@0:     nsXULControllerData* controllerData = mControllers.ElementAt(i);
michael@0:     if (controllerData)
michael@0:     {
michael@0:       nsCOMPtr<nsIController> controller;
michael@0:       controllerData->GetController(getter_AddRefs(controller));
michael@0:       if (controller)
michael@0:       {
michael@0:         bool supportsCommand;
michael@0:         controller->SupportsCommand(aCommand, &supportsCommand);
michael@0:         if (supportsCommand) {
michael@0:           *_retval = controller;
michael@0:           NS_ADDREF(*_retval);
michael@0:           return NS_OK;
michael@0:         }
michael@0:       }
michael@0:     }
michael@0:   }
michael@0:   
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::InsertControllerAt(uint32_t aIndex, nsIController *controller)
michael@0: {
michael@0:   nsXULControllerData*  controllerData = new nsXULControllerData(++mCurControllerID, controller);
michael@0:   if (!controllerData) return NS_ERROR_OUT_OF_MEMORY;
michael@0: #ifdef DEBUG
michael@0:   nsXULControllerData** inserted =
michael@0: #endif
michael@0:   mControllers.InsertElementAt(aIndex, controllerData);
michael@0:   NS_ASSERTION(inserted != nullptr, "Insertion of controller failed");
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::RemoveControllerAt(uint32_t aIndex, nsIController **_retval)
michael@0: {
michael@0:   NS_ENSURE_ARG_POINTER(_retval);
michael@0:   *_retval = nullptr;
michael@0: 
michael@0:   nsXULControllerData* controllerData = mControllers.SafeElementAt(aIndex);
michael@0:   if (!controllerData) return NS_ERROR_FAILURE;
michael@0: 
michael@0:   mControllers.RemoveElementAt(aIndex);
michael@0: 
michael@0:   controllerData->GetController(_retval);
michael@0:   delete controllerData;
michael@0:   
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::GetControllerAt(uint32_t aIndex, nsIController **_retval)
michael@0: {
michael@0:   NS_ENSURE_ARG_POINTER(_retval);
michael@0:   *_retval = nullptr;
michael@0: 
michael@0:   nsXULControllerData* controllerData = mControllers.SafeElementAt(aIndex);
michael@0:   if (!controllerData) return NS_ERROR_FAILURE;
michael@0: 
michael@0:   return controllerData->GetController(_retval);   // does the addref  
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::AppendController(nsIController *controller)
michael@0: {
michael@0:   // This assigns controller IDs starting at 1 so we can use 0 to test if an ID was obtained
michael@0:   nsXULControllerData*  controllerData = new nsXULControllerData(++mCurControllerID, controller);
michael@0:   if (!controllerData) return NS_ERROR_OUT_OF_MEMORY;
michael@0: 
michael@0: #ifdef DEBUG
michael@0:   nsXULControllerData** appended =
michael@0: #endif
michael@0:   mControllers.AppendElement(controllerData);
michael@0:   NS_ASSERTION(appended != nullptr, "Appending controller failed");
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::RemoveController(nsIController *controller)
michael@0: {
michael@0:   // first get the identity pointer
michael@0:   nsCOMPtr<nsISupports> controllerSup(do_QueryInterface(controller));
michael@0:   // then find it
michael@0:   uint32_t count = mControllers.Length();
michael@0:   for (uint32_t i = 0; i < count; i++)
michael@0:   {
michael@0:     nsXULControllerData* controllerData = mControllers.ElementAt(i);
michael@0:     if (controllerData)
michael@0:     {
michael@0:       nsCOMPtr<nsIController> thisController;
michael@0:       controllerData->GetController(getter_AddRefs(thisController));
michael@0:       nsCOMPtr<nsISupports> thisControllerSup(do_QueryInterface(thisController)); // get identity
michael@0:       if (thisControllerSup == controllerSup)
michael@0:       {
michael@0:         mControllers.RemoveElementAt(i);
michael@0:         delete controllerData;
michael@0:         return NS_OK;
michael@0:       }
michael@0:     }
michael@0:   }
michael@0:   return NS_ERROR_FAILURE;      // right thing to return if no controller found?
michael@0: }
michael@0:     
michael@0: /* unsigned long getControllerId (in nsIController controller); */
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::GetControllerId(nsIController *controller, uint32_t *_retval)
michael@0: {
michael@0:   NS_ENSURE_ARG_POINTER(_retval);
michael@0: 
michael@0:   uint32_t count = mControllers.Length();
michael@0:   for (uint32_t i = 0; i < count; i++)
michael@0:   {
michael@0:     nsXULControllerData* controllerData = mControllers.ElementAt(i);
michael@0:     if (controllerData)
michael@0:     {
michael@0:       nsCOMPtr<nsIController> thisController;
michael@0:       controllerData->GetController(getter_AddRefs(thisController));
michael@0:       if (thisController.get() == controller)
michael@0:       {
michael@0:         *_retval = controllerData->GetControllerID();
michael@0:         return NS_OK;
michael@0:       }
michael@0:     }
michael@0:   }
michael@0:   return NS_ERROR_FAILURE;  // none found
michael@0: }
michael@0: 
michael@0: /* nsIController getControllerById (in unsigned long controllerID); */
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::GetControllerById(uint32_t controllerID, nsIController **_retval)
michael@0: {
michael@0:   NS_ENSURE_ARG_POINTER(_retval);
michael@0:     
michael@0:   uint32_t count = mControllers.Length();
michael@0:   for (uint32_t i = 0; i < count; i++)
michael@0:   {
michael@0:     nsXULControllerData* controllerData = mControllers.ElementAt(i);
michael@0:     if (controllerData && controllerData->GetControllerID() == controllerID)
michael@0:     {
michael@0:       return controllerData->GetController(_retval);
michael@0:     }
michael@0:   }
michael@0:   return NS_ERROR_FAILURE;  // none found
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsXULControllers::GetControllerCount(uint32_t *_retval)
michael@0: {
michael@0:   NS_ENSURE_ARG_POINTER(_retval);
michael@0:   *_retval = mControllers.Length();
michael@0:   return NS_OK;
michael@0: }
michael@0: