dom/xul/nsXULControllers.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /*
   7
   8   This file provides the implementation for the XUL "controllers"
   9   object.
  10
  11 */
  12
  13 #include "nsString.h"
  14
  15 #include "nsIControllers.h"
  16 #include "nsIDOMElement.h"
  17 #include "nsXULControllers.h"
  18 #include "nsDOMClassInfoID.h"
  19 #include "nsIController.h"
  20
  21 //----------------------------------------------------------------------
  22
  23 nsXULControllers::nsXULControllers()
  24 : mCurControllerID(0)
  25 {
  26 }
  27
  28 nsXULControllers::~nsXULControllers(void)
  29 {
  30   DeleteControllers();
  31 }
  32
  33 void
  34 nsXULControllers::DeleteControllers()
  35 {
  36   uint32_t count = mControllers.Length();
  37   for (uint32_t i = 0; i < count; i++)
  38   {
  39     nsXULControllerData* controllerData = mControllers.ElementAt(i);
  40     delete controllerData;    // releases the nsIController
  41   }
  42
  43   mControllers.Clear();
  44 }
  45
  46
  47 nsresult
  48 NS_NewXULControllers(nsISupports* aOuter, REFNSIID aIID, void** aResult)
  49 {
  50   NS_PRECONDITION(aOuter == nullptr, "no aggregation");
  51   if (aOuter)
  52     return NS_ERROR_NO_AGGREGATION;
  53
  54   nsXULControllers* controllers = new nsXULControllers();
  55   if (! controllers)
  56     return NS_ERROR_OUT_OF_MEMORY;
  57
  58   nsresult rv;
  59   NS_ADDREF(controllers);
  60   rv = controllers->QueryInterface(aIID, aResult);
  61   NS_RELEASE(controllers);
  62   return rv;
  63 }
  64
  65 NS_IMPL_CYCLE_COLLECTION_CLASS(nsXULControllers)
  66
  67 NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(nsXULControllers)
  68   tmp->DeleteControllers();
  69 NS_IMPL_CYCLE_COLLECTION_UNLINK_END
  70 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(nsXULControllers)
  71   {
  72     uint32_t i, count = tmp->mControllers.Length();
  73     for (i = 0; i < count; ++i) {
  74       nsXULControllerData* controllerData = tmp->mControllers[i];
  75       if (controllerData) {
  76         cb.NoteXPCOMChild(controllerData->mController);
  77       }
  78     }
  79   }
  80 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
  81
  82 NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(nsXULControllers)
  83   NS_INTERFACE_MAP_ENTRY(nsIControllers)
  84   NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIControllers)
  85   NS_DOM_INTERFACE_MAP_ENTRY_CLASSINFO(XULControllers)
  86 NS_INTERFACE_MAP_END
  87
  88 NS_IMPL_CYCLE_COLLECTING_ADDREF(nsXULControllers)
  89 NS_IMPL_CYCLE_COLLECTING_RELEASE(nsXULControllers)
  90
  91 NS_IMETHODIMP
  92 nsXULControllers::GetControllerForCommand(const char *aCommand, nsIController** _retval)
  93 {
  94   NS_ENSURE_ARG_POINTER(_retval);
  95   *_retval = nullptr;
  96
  97   uint32_t count = mControllers.Length();
  98   for (uint32_t i=0; i < count; i++)
  99   {
 100     nsXULControllerData* controllerData = mControllers.ElementAt(i);
 101     if (controllerData)
 102     {
 103       nsCOMPtr<nsIController> controller;
 104       controllerData->GetController(getter_AddRefs(controller));
 105       if (controller)
 106       {
 107         bool supportsCommand;
 108         controller->SupportsCommand(aCommand, &supportsCommand);
 109         if (supportsCommand) {
 110           *_retval = controller;
 111           NS_ADDREF(*_retval);
 112           return NS_OK;
 113         }
 114       }
 115     }
 116   }
 117
 118   return NS_OK;
 119 }
 120
 121 NS_IMETHODIMP
 122 nsXULControllers::InsertControllerAt(uint32_t aIndex, nsIController *controller)
 123 {
 124   nsXULControllerData*  controllerData = new nsXULControllerData(++mCurControllerID, controller);
 125   if (!controllerData) return NS_ERROR_OUT_OF_MEMORY;
 126 #ifdef DEBUG
 127   nsXULControllerData** inserted =
 128 #endif
 129   mControllers.InsertElementAt(aIndex, controllerData);
 130   NS_ASSERTION(inserted != nullptr, "Insertion of controller failed");
 131   return NS_OK;
 132 }
 133
 134 NS_IMETHODIMP
 135 nsXULControllers::RemoveControllerAt(uint32_t aIndex, nsIController **_retval)
 136 {
 137   NS_ENSURE_ARG_POINTER(_retval);
 138   *_retval = nullptr;
 139
 140   nsXULControllerData* controllerData = mControllers.SafeElementAt(aIndex);
 141   if (!controllerData) return NS_ERROR_FAILURE;
 142
 143   mControllers.RemoveElementAt(aIndex);
 144
 145   controllerData->GetController(_retval);
 146   delete controllerData;
 147
 148   return NS_OK;
 149 }
 150
 151
 152 NS_IMETHODIMP
 153 nsXULControllers::GetControllerAt(uint32_t aIndex, nsIController **_retval)
 154 {
 155   NS_ENSURE_ARG_POINTER(_retval);
 156   *_retval = nullptr;
 157
 158   nsXULControllerData* controllerData = mControllers.SafeElementAt(aIndex);
 159   if (!controllerData) return NS_ERROR_FAILURE;
 160
 161   return controllerData->GetController(_retval);   // does the addref
 162 }
 163
 164 NS_IMETHODIMP
 165 nsXULControllers::AppendController(nsIController *controller)
 166 {
 167   // This assigns controller IDs starting at 1 so we can use 0 to test if an ID was obtained
 168   nsXULControllerData*  controllerData = new nsXULControllerData(++mCurControllerID, controller);
 169   if (!controllerData) return NS_ERROR_OUT_OF_MEMORY;
 170
 171 #ifdef DEBUG
 172   nsXULControllerData** appended =
 173 #endif
 174   mControllers.AppendElement(controllerData);
 175   NS_ASSERTION(appended != nullptr, "Appending controller failed");
 176   return NS_OK;
 177 }
 178
 179 NS_IMETHODIMP
 180 nsXULControllers::RemoveController(nsIController *controller)
 181 {
 182   // first get the identity pointer
 183   nsCOMPtr<nsISupports> controllerSup(do_QueryInterface(controller));
 184   // then find it
 185   uint32_t count = mControllers.Length();
 186   for (uint32_t i = 0; i < count; i++)
 187   {
 188     nsXULControllerData* controllerData = mControllers.ElementAt(i);
 189     if (controllerData)
 190     {
 191       nsCOMPtr<nsIController> thisController;
 192       controllerData->GetController(getter_AddRefs(thisController));
 193       nsCOMPtr<nsISupports> thisControllerSup(do_QueryInterface(thisController)); // get identity
 194       if (thisControllerSup == controllerSup)
 195       {
 196         mControllers.RemoveElementAt(i);
 197         delete controllerData;
 198         return NS_OK;
 199       }
 200     }
 201   }
 202   return NS_ERROR_FAILURE;      // right thing to return if no controller found?
 203 }
 204
 205 /* unsigned long getControllerId (in nsIController controller); */
 206 NS_IMETHODIMP
 207 nsXULControllers::GetControllerId(nsIController *controller, uint32_t *_retval)
 208 {
 209   NS_ENSURE_ARG_POINTER(_retval);
 210
 211   uint32_t count = mControllers.Length();
 212   for (uint32_t i = 0; i < count; i++)
 213   {
 214     nsXULControllerData* controllerData = mControllers.ElementAt(i);
 215     if (controllerData)
 216     {
 217       nsCOMPtr<nsIController> thisController;
 218       controllerData->GetController(getter_AddRefs(thisController));
 219       if (thisController.get() == controller)
 220       {
 221         *_retval = controllerData->GetControllerID();
 222         return NS_OK;
 223       }
 224     }
 225   }
 226   return NS_ERROR_FAILURE;  // none found
 227 }
 228
 229 /* nsIController getControllerById (in unsigned long controllerID); */
 230 NS_IMETHODIMP
 231 nsXULControllers::GetControllerById(uint32_t controllerID, nsIController **_retval)
 232 {
 233   NS_ENSURE_ARG_POINTER(_retval);
 234
 235   uint32_t count = mControllers.Length();
 236   for (uint32_t i = 0; i < count; i++)
 237   {
 238     nsXULControllerData* controllerData = mControllers.ElementAt(i);
 239     if (controllerData && controllerData->GetControllerID() == controllerID)
 240     {
 241       return controllerData->GetController(_retval);
 242     }
 243   }
 244   return NS_ERROR_FAILURE;  // none found
 245 }
 246
 247 NS_IMETHODIMP
 248 nsXULControllers::GetControllerCount(uint32_t *_retval)
 249 {
 250   NS_ENSURE_ARG_POINTER(_retval);
 251   *_retval = mControllers.Length();
 252   return NS_OK;
 253 }
 254