accessible/src/base/nsApplicationAccessible.cpp

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* vim:expandtab:shiftwidth=4:tabstop=4:
   3  */
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is mozilla.org code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Mozilla Foundation.
  21  * Portions created by the Initial Developer are Copyright (C) 2007
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Bolian Yin <bolian.yin@sun.com>
  26  *   Ginn Chen <ginn.chen@sun.com>
  27  *   Alexander Surkov <surkov.alexander@gmail.com>
  28  *
  29  * Alternatively, the contents of this file may be used under the terms of
  30  * either the GNU General Public License Version 2 or later (the "GPL"), or
  31  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  32  * in which case the provisions of the GPL or the LGPL are applicable instead
  33  * of those above. If you wish to allow use of your version of this file only
  34  * under the terms of either the GPL or the LGPL, and not to allow others to
  35  * use your version of this file under the terms of the MPL, indicate your
  36  * decision by deleting the provisions above and replace them with the notice
  37  * and other provisions required by the GPL or the LGPL. If you do not delete
  38  * the provisions above, a recipient may use your version of this file under
  39  * the terms of any one of the MPL, the GPL or the LGPL.
  40  *
  41  * ***** END LICENSE BLOCK ***** */
  42
  43 #include "nsApplicationAccessible.h"
  44
  45 #include "nsIComponentManager.h"
  46 #include "nsServiceManagerUtils.h"
  47
  48 nsApplicationAccessible::nsApplicationAccessible():
  49     nsAccessibleWrap(nsnull, nsnull), mChildren(nsnull)
  50 {
  51 }
  52
  53 ////////////////////////////////////////////////////////////////////////////////
  54 // nsISupports
  55
  56 NS_IMPL_CYCLE_COLLECTION_CLASS(nsApplicationAccessible)
  57
  58 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(nsApplicationAccessible,
  59                                                   nsAccessible)
  60
  61   nsCOMPtr<nsISimpleEnumerator> enumerator;
  62   tmp->mChildren->Enumerate(getter_AddRefs(enumerator));
  63
  64   nsCOMPtr<nsIWeakReference> childWeakRef;
  65   nsCOMPtr<nsIAccessible> accessible;
  66
  67   PRBool hasMoreElements;
  68   while(NS_SUCCEEDED(enumerator->HasMoreElements(&hasMoreElements))
  69         && hasMoreElements) {
  70
  71     enumerator->GetNext(getter_AddRefs(childWeakRef));
  72     accessible = do_QueryReferent(childWeakRef);
  73     if (accessible) {
  74       NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(cb, "nsApplicationAccessible child");
  75       cb.NoteXPCOMChild(accessible);
  76     }
  77   }
  78
  79 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
  80
  81 NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(nsApplicationAccessible,
  82                                                 nsAccessible)
  83   tmp->mChildren->Clear();
  84 NS_IMPL_CYCLE_COLLECTION_UNLINK_END
  85
  86 NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION_INHERITED(nsApplicationAccessible)
  87 NS_INTERFACE_MAP_END_INHERITING(nsAccessible)
  88
  89 NS_IMPL_ADDREF_INHERITED(nsApplicationAccessible, nsAccessible)
  90 NS_IMPL_RELEASE_INHERITED(nsApplicationAccessible, nsAccessible)
  91
  92 ////////////////////////////////////////////////////////////////////////////////
  93 // nsIAccessNode
  94
  95 nsresult
  96 nsApplicationAccessible::Init()
  97 {
  98   nsresult rv;
  99   mChildren = do_CreateInstance(NS_ARRAY_CONTRACTID, &rv);
 100   return rv;
 101 }
 102
 103 // nsIAccessible
 104
 105 NS_IMETHODIMP
 106 nsApplicationAccessible::GetName(nsAString& aName)
 107 {
 108   aName.Truncate();
 109
 110   nsCOMPtr<nsIStringBundleService> bundleService =
 111     do_GetService(NS_STRINGBUNDLE_CONTRACTID);
 112
 113   NS_ASSERTION(bundleService, "String bundle service must be present!");
 114   NS_ENSURE_STATE(bundleService);
 115
 116   nsCOMPtr<nsIStringBundle> bundle;
 117   nsresult rv = bundleService->CreateBundle("chrome://branding/locale/brand.properties",
 118                                             getter_AddRefs(bundle));
 119   NS_ENSURE_SUCCESS(rv, rv);
 120
 121   nsXPIDLString appName;
 122   rv = bundle->GetStringFromName(NS_LITERAL_STRING("brandShortName").get(),
 123                                  getter_Copies(appName));
 124   if (NS_FAILED(rv) || appName.IsEmpty()) {
 125     NS_WARNING("brandShortName not found, using default app name");
 126     appName.AssignLiteral("Gecko based application");
 127   }
 128
 129   aName.Assign(appName);
 130   return NS_OK;
 131 }
 132
 133 NS_IMETHODIMP
 134 nsApplicationAccessible::GetRole(PRUint32 *aRole)
 135 {
 136   *aRole = nsIAccessibleRole::ROLE_APP_ROOT;
 137   return NS_OK;
 138 }
 139
 140 NS_IMETHODIMP
 141 nsApplicationAccessible::GetFinalRole(PRUint32 *aFinalRole)
 142 {
 143   return GetRole(aFinalRole);
 144 }
 145
 146 nsresult
 147 nsApplicationAccessible::GetStateInternal(PRUint32 *aState,
 148                                           PRUint32 *aExtraState)
 149 {
 150   *aState = 0;
 151   if (aExtraState)
 152     *aExtraState = 0;
 153
 154   return NS_OK;
 155 }
 156
 157 NS_IMETHODIMP
 158 nsApplicationAccessible::GetParent(nsIAccessible **aParent)
 159 {
 160   *aParent = nsnull;
 161   return NS_OK;
 162 }
 163
 164 NS_IMETHODIMP
 165 nsApplicationAccessible::GetChildAt(PRInt32 aChildNum, nsIAccessible **aChild)
 166 {
 167   NS_ENSURE_ARG_POINTER(aChild);
 168   *aChild = nsnull;
 169
 170   PRUint32 count = 0;
 171   nsresult rv = NS_OK;
 172
 173   if (mChildren) {
 174     rv = mChildren->GetLength(&count);
 175     NS_ENSURE_SUCCESS(rv, rv);
 176   }
 177
 178   if (aChildNum >= static_cast<PRInt32>(count) || count == 0)
 179     return NS_ERROR_INVALID_ARG;
 180
 181   if (aChildNum < 0)
 182     aChildNum = count - 1;
 183
 184   nsCOMPtr<nsIWeakReference> childWeakRef;
 185   rv = mChildren->QueryElementAt(aChildNum, NS_GET_IID(nsIWeakReference),
 186                                  getter_AddRefs(childWeakRef));
 187   NS_ENSURE_SUCCESS(rv, rv);
 188
 189   if (childWeakRef) {
 190     nsCOMPtr<nsIAccessible> childAcc(do_QueryReferent(childWeakRef));
 191     NS_IF_ADDREF(*aChild = childAcc);
 192   }
 193
 194   return NS_OK;
 195 }
 196
 197 NS_IMETHODIMP
 198 nsApplicationAccessible::GetNextSibling(nsIAccessible **aNextSibling)
 199 {
 200   NS_ENSURE_ARG_POINTER(aNextSibling);
 201
 202   *aNextSibling = nsnull;
 203   return NS_OK;
 204 }
 205
 206 NS_IMETHODIMP
 207 nsApplicationAccessible::GetPreviousSibling(nsIAccessible **aPreviousSibling)
 208 {
 209   NS_ENSURE_ARG_POINTER(aPreviousSibling);
 210
 211   *aPreviousSibling = nsnull;
 212   return NS_OK;
 213 }
 214
 215 NS_IMETHODIMP
 216 nsApplicationAccessible::GetIndexInParent(PRInt32 *aIndexInParent)
 217 {
 218   NS_ENSURE_ARG_POINTER(aIndexInParent);
 219
 220   *aIndexInParent = -1;
 221   return NS_OK;
 222 }
 223
 224 void
 225 nsApplicationAccessible::CacheChildren()
 226 {
 227   if (!mChildren) {
 228     mAccChildCount = eChildCountUninitialized;
 229     return;
 230   }
 231
 232   if (mAccChildCount == eChildCountUninitialized) {
 233     mAccChildCount = 0;// Prevent reentry
 234     nsCOMPtr<nsISimpleEnumerator> enumerator;
 235     mChildren->Enumerate(getter_AddRefs(enumerator));
 236
 237     nsCOMPtr<nsIWeakReference> childWeakRef;
 238     nsCOMPtr<nsIAccessible> accessible;
 239     nsCOMPtr<nsPIAccessible> previousAccessible;
 240     PRBool hasMoreElements;
 241     while(NS_SUCCEEDED(enumerator->HasMoreElements(&hasMoreElements))
 242           && hasMoreElements) {
 243       enumerator->GetNext(getter_AddRefs(childWeakRef));
 244       accessible = do_QueryReferent(childWeakRef);
 245       if (accessible) {
 246         if (previousAccessible)
 247           previousAccessible->SetNextSibling(accessible);
 248         else
 249           SetFirstChild(accessible);
 250
 251         previousAccessible = do_QueryInterface(accessible);
 252         previousAccessible->SetParent(this);
 253       }
 254     }
 255
 256     PRUint32 count = 0;
 257     mChildren->GetLength(&count);
 258     mAccChildCount = static_cast<PRInt32>(count);
 259   }
 260 }
 261
 262 // nsApplicationAccessible
 263
 264 nsresult
 265 nsApplicationAccessible::AddRootAccessible(nsIAccessible *aRootAccessible)
 266 {
 267   NS_ENSURE_ARG_POINTER(aRootAccessible);
 268
 269   // add by weak reference
 270   nsresult rv = mChildren->AppendElement(aRootAccessible, PR_TRUE);
 271   NS_ENSURE_SUCCESS(rv, rv);
 272
 273   InvalidateChildren();
 274   return NS_OK;
 275 }
 276
 277 nsresult
 278 nsApplicationAccessible::RemoveRootAccessible(nsIAccessible *aRootAccessible)
 279 {
 280   NS_ENSURE_ARG_POINTER(aRootAccessible);
 281
 282   PRUint32 index = 0;
 283
 284   // we must use weak ref to get the index
 285   nsCOMPtr<nsIWeakReference> weakPtr = do_GetWeakReference(aRootAccessible);
 286   nsresult rv = mChildren->IndexOf(0, weakPtr, &index);
 287   NS_ENSURE_SUCCESS(rv, rv);
 288
 289   rv = mChildren->RemoveElementAt(index);
 290   NS_ENSURE_SUCCESS(rv, rv);
 291
 292   InvalidateChildren();
 293   return NS_OK;
 294 }
 295