1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/accessible/src/base/AccIterator.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,320 @@
1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
1.5 +/* vim: set ts=2 et sw=2 tw=80: */
1.6 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.9 +
1.10 +#ifndef mozilla_a11y_AccIterator_h__
1.11 +#define mozilla_a11y_AccIterator_h__
1.12 +
1.13 +#include "DocAccessible.h"
1.14 +#include "Filters.h"
1.15 +
1.16 +class nsITreeView;
1.17 +
1.18 +namespace mozilla {
1.19 +namespace a11y {
1.20 +
1.21 +/**
1.22 + * AccIterable is a basic interface for iterators over accessibles.
1.23 + */
1.24 +class AccIterable
1.25 +{
1.26 +public:
1.27 + virtual ~AccIterable() { }
1.28 + virtual Accessible* Next() = 0;
1.29 +
1.30 +private:
1.31 + friend class Relation;
1.32 + nsAutoPtr<AccIterable> mNextIter;
1.33 +};
1.34 +
1.35 +/**
1.36 + * Allows to iterate through accessible children or subtree complying with
1.37 + * filter function.
1.38 + */
1.39 +class AccIterator : public AccIterable
1.40 +{
1.41 +public:
1.42 + AccIterator(Accessible* aRoot, filters::FilterFuncPtr aFilterFunc);
1.43 + virtual ~AccIterator();
1.44 +
1.45 + /**
1.46 + * Return next accessible complying with filter function. Return the first
1.47 + * accessible for the first time.
1.48 + */
1.49 + virtual Accessible* Next();
1.50 +
1.51 +private:
1.52 + AccIterator();
1.53 + AccIterator(const AccIterator&);
1.54 + AccIterator& operator =(const AccIterator&);
1.55 +
1.56 + struct IteratorState
1.57 + {
1.58 + IteratorState(Accessible* aParent, IteratorState* mParentState = nullptr);
1.59 +
1.60 + Accessible* mParent;
1.61 + int32_t mIndex;
1.62 + IteratorState* mParentState;
1.63 + };
1.64 +
1.65 + filters::FilterFuncPtr mFilterFunc;
1.66 + IteratorState* mState;
1.67 +};
1.68 +
1.69 +
1.70 +/**
1.71 + * Allows to traverse through related accessibles that are pointing to the given
1.72 + * dependent accessible by relation attribute.
1.73 + */
1.74 +class RelatedAccIterator : public AccIterable
1.75 +{
1.76 +public:
1.77 + /**
1.78 + * Constructor.
1.79 + *
1.80 + * @param aDocument [in] the document accessible the related
1.81 + * & accessibles belong to.
1.82 + * @param aDependentContent [in] the content of dependent accessible that
1.83 + * relations were requested for
1.84 + * @param aRelAttr [in] relation attribute that relations are
1.85 + * pointed by
1.86 + */
1.87 + RelatedAccIterator(DocAccessible* aDocument, nsIContent* aDependentContent,
1.88 + nsIAtom* aRelAttr);
1.89 +
1.90 + virtual ~RelatedAccIterator() { }
1.91 +
1.92 + /**
1.93 + * Return next related accessible for the given dependent accessible.
1.94 + */
1.95 + virtual Accessible* Next();
1.96 +
1.97 +private:
1.98 + RelatedAccIterator();
1.99 + RelatedAccIterator(const RelatedAccIterator&);
1.100 + RelatedAccIterator& operator = (const RelatedAccIterator&);
1.101 +
1.102 + DocAccessible* mDocument;
1.103 + nsIAtom* mRelAttr;
1.104 + DocAccessible::AttrRelProviderArray* mProviders;
1.105 + nsIContent* mBindingParent;
1.106 + uint32_t mIndex;
1.107 +};
1.108 +
1.109 +
1.110 +/**
1.111 + * Used to iterate through HTML labels associated with the given accessible.
1.112 + */
1.113 +class HTMLLabelIterator : public AccIterable
1.114 +{
1.115 +public:
1.116 + enum LabelFilter {
1.117 + eAllLabels,
1.118 + eSkipAncestorLabel
1.119 + };
1.120 +
1.121 + HTMLLabelIterator(DocAccessible* aDocument, const Accessible* aAccessible,
1.122 + LabelFilter aFilter = eAllLabels);
1.123 +
1.124 + virtual ~HTMLLabelIterator() { }
1.125 +
1.126 + /**
1.127 + * Return next label accessible associated with the given element.
1.128 + */
1.129 + virtual Accessible* Next();
1.130 +
1.131 +private:
1.132 + HTMLLabelIterator();
1.133 + HTMLLabelIterator(const HTMLLabelIterator&);
1.134 + HTMLLabelIterator& operator = (const HTMLLabelIterator&);
1.135 +
1.136 + RelatedAccIterator mRelIter;
1.137 + // XXX: replace it on weak reference (bug 678429), it's safe to use raw
1.138 + // pointer now because iterators life cycle is short.
1.139 + const Accessible* mAcc;
1.140 + LabelFilter mLabelFilter;
1.141 +};
1.142 +
1.143 +
1.144 +/**
1.145 + * Used to iterate through HTML outputs associated with the given element.
1.146 + */
1.147 +class HTMLOutputIterator : public AccIterable
1.148 +{
1.149 +public:
1.150 + HTMLOutputIterator(DocAccessible* aDocument, nsIContent* aElement);
1.151 + virtual ~HTMLOutputIterator() { }
1.152 +
1.153 + /**
1.154 + * Return next output accessible associated with the given element.
1.155 + */
1.156 + virtual Accessible* Next();
1.157 +
1.158 +private:
1.159 + HTMLOutputIterator();
1.160 + HTMLOutputIterator(const HTMLOutputIterator&);
1.161 + HTMLOutputIterator& operator = (const HTMLOutputIterator&);
1.162 +
1.163 + RelatedAccIterator mRelIter;
1.164 +};
1.165 +
1.166 +
1.167 +/**
1.168 + * Used to iterate through XUL labels associated with the given element.
1.169 + */
1.170 +class XULLabelIterator : public AccIterable
1.171 +{
1.172 +public:
1.173 + XULLabelIterator(DocAccessible* aDocument, nsIContent* aElement);
1.174 + virtual ~XULLabelIterator() { }
1.175 +
1.176 + /**
1.177 + * Return next label accessible associated with the given element.
1.178 + */
1.179 + virtual Accessible* Next();
1.180 +
1.181 +private:
1.182 + XULLabelIterator();
1.183 + XULLabelIterator(const XULLabelIterator&);
1.184 + XULLabelIterator& operator = (const XULLabelIterator&);
1.185 +
1.186 + RelatedAccIterator mRelIter;
1.187 +};
1.188 +
1.189 +
1.190 +/**
1.191 + * Used to iterate through XUL descriptions associated with the given element.
1.192 + */
1.193 +class XULDescriptionIterator : public AccIterable
1.194 +{
1.195 +public:
1.196 + XULDescriptionIterator(DocAccessible* aDocument, nsIContent* aElement);
1.197 + virtual ~XULDescriptionIterator() { }
1.198 +
1.199 + /**
1.200 + * Return next description accessible associated with the given element.
1.201 + */
1.202 + virtual Accessible* Next();
1.203 +
1.204 +private:
1.205 + XULDescriptionIterator();
1.206 + XULDescriptionIterator(const XULDescriptionIterator&);
1.207 + XULDescriptionIterator& operator = (const XULDescriptionIterator&);
1.208 +
1.209 + RelatedAccIterator mRelIter;
1.210 +};
1.211 +
1.212 +/**
1.213 + * Used to iterate through IDs, elements or accessibles pointed by IDRefs
1.214 + * attribute. Note, any method used to iterate through IDs, elements, or
1.215 + * accessibles moves iterator to next position.
1.216 + */
1.217 +class IDRefsIterator : public AccIterable
1.218 +{
1.219 +public:
1.220 + IDRefsIterator(DocAccessible* aDoc, nsIContent* aContent,
1.221 + nsIAtom* aIDRefsAttr);
1.222 + virtual ~IDRefsIterator() { }
1.223 +
1.224 + /**
1.225 + * Return next ID.
1.226 + */
1.227 + const nsDependentSubstring NextID();
1.228 +
1.229 + /**
1.230 + * Return next element.
1.231 + */
1.232 + nsIContent* NextElem();
1.233 +
1.234 + /**
1.235 + * Return the element with the given ID.
1.236 + */
1.237 + nsIContent* GetElem(const nsDependentSubstring& aID);
1.238 +
1.239 + // AccIterable
1.240 + virtual Accessible* Next();
1.241 +
1.242 +private:
1.243 + IDRefsIterator();
1.244 + IDRefsIterator(const IDRefsIterator&);
1.245 + IDRefsIterator operator = (const IDRefsIterator&);
1.246 +
1.247 + nsString mIDs;
1.248 + nsIContent* mContent;
1.249 + DocAccessible* mDoc;
1.250 + nsAString::index_type mCurrIdx;
1.251 +};
1.252 +
1.253 +/**
1.254 + * Iterator that points to a single accessible returning it on the first call
1.255 + * to Next().
1.256 + */
1.257 +class SingleAccIterator : public AccIterable
1.258 +{
1.259 +public:
1.260 + SingleAccIterator(Accessible* aTarget): mAcc(aTarget) { }
1.261 + virtual ~SingleAccIterator() { }
1.262 +
1.263 + virtual Accessible* Next();
1.264 +
1.265 +private:
1.266 + SingleAccIterator();
1.267 + SingleAccIterator(const SingleAccIterator&);
1.268 + SingleAccIterator& operator = (const SingleAccIterator&);
1.269 +
1.270 + nsRefPtr<Accessible> mAcc;
1.271 +};
1.272 +
1.273 +
1.274 +/**
1.275 + * Used to iterate items of the given item container.
1.276 + */
1.277 +class ItemIterator : public AccIterable
1.278 +{
1.279 +public:
1.280 + ItemIterator(Accessible* aItemContainer) :
1.281 + mContainer(aItemContainer), mAnchor(nullptr) { }
1.282 + virtual ~ItemIterator() { }
1.283 +
1.284 + virtual Accessible* Next();
1.285 +
1.286 +private:
1.287 + ItemIterator() MOZ_DELETE;
1.288 + ItemIterator(const ItemIterator&) MOZ_DELETE;
1.289 + ItemIterator& operator = (const ItemIterator&) MOZ_DELETE;
1.290 +
1.291 + Accessible* mContainer;
1.292 + Accessible* mAnchor;
1.293 +};
1.294 +
1.295 +
1.296 +/**
1.297 + * Used to iterate through XUL tree items of the same level.
1.298 + */
1.299 +class XULTreeItemIterator : public AccIterable
1.300 +{
1.301 +public:
1.302 + XULTreeItemIterator(XULTreeAccessible* aXULTree, nsITreeView* aTreeView,
1.303 + int32_t aRowIdx);
1.304 + virtual ~XULTreeItemIterator() { }
1.305 +
1.306 + virtual Accessible* Next();
1.307 +
1.308 +private:
1.309 + XULTreeItemIterator() MOZ_DELETE;
1.310 + XULTreeItemIterator(const XULTreeItemIterator&) MOZ_DELETE;
1.311 + XULTreeItemIterator& operator = (const XULTreeItemIterator&) MOZ_DELETE;
1.312 +
1.313 + XULTreeAccessible* mXULTree;
1.314 + nsITreeView* mTreeView;
1.315 + int32_t mRowCount;
1.316 + int32_t mContainerLevel;
1.317 + int32_t mCurrRowIdx;
1.318 +};
1.319 +
1.320 +} // namespace a11y
1.321 +} // namespace mozilla
1.322 +
1.323 +#endif
