LibreOffice Module comphelper (master) 1
container.cxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#include <com/sun/star/uno/XInterface.hpp>
21#include <com/sun/star/container/XIndexAccess.hpp>
22#include <com/sun/star/container/XChild.hpp>
24#include <o3tl/any.hxx>
25#include <utility>
26#include <osl/diagnose.h>
27
28
29namespace comphelper
30{
31
32
33IndexAccessIterator::IndexAccessIterator(css::uno::Reference< css::uno::XInterface> xStartingPoint)
34 :m_xStartingPoint(std::move(xStartingPoint))
35{
36 OSL_ENSURE(m_xStartingPoint.is(), "IndexAccessIterator::IndexAccessIterator : no starting point !");
37}
38
40
41
42css::uno::Reference< css::uno::XInterface> const & IndexAccessIterator::Next()
43{
44 bool bCheckingStartingPoint = !m_xCurrentObject.is();
45 // Is the current node the starting point?
46 bool bAlreadyCheckedCurrent = m_xCurrentObject.is();
47 // Have I already tested the current node through ShouldHandleElement?
48 if (!m_xCurrentObject.is())
50
51 css::uno::Reference< css::uno::XInterface> xSearchLoop( m_xCurrentObject);
52 bool bHasMoreToSearch = true;
53 bool bFoundSomething = false;
54 while (!bFoundSomething && bHasMoreToSearch)
55 {
56 // Priming loop
57 if (!bAlreadyCheckedCurrent && ShouldHandleElement(xSearchLoop))
58 {
59 m_xCurrentObject = xSearchLoop;
60 bFoundSomething = true;
61 }
62 else
63 {
64 // First, check to see if there's a match below
65 css::uno::Reference< css::container::XIndexAccess> xContainerAccess(xSearchLoop, css::uno::UNO_QUERY);
66 if (xContainerAccess.is() && xContainerAccess->getCount() && ShouldStepInto(xContainerAccess))
67 {
68 css::uno::Any aElement(xContainerAccess->getByIndex(0));
69 xSearchLoop = *o3tl::doAccess<css::uno::Reference<css::uno::XInterface>>(aElement);
70 bCheckingStartingPoint = false;
71
72 m_arrChildIndizies.push_back(sal_Int32(0));
73 }
74 else
75 { // otherwise, look above and to the right, if possible
76 while (!m_arrChildIndizies.empty())
77 { // If the list isn't empty and there's nothing above
78 css::uno::Reference< css::container::XChild> xChild(xSearchLoop, css::uno::UNO_QUERY);
79 OSL_ENSURE(xChild.is(), "IndexAccessIterator::Next : a content has no appropriate interface !");
80
81 css::uno::Reference< css::uno::XInterface> xParent( xChild->getParent());
82 xContainerAccess.set(xParent, css::uno::UNO_QUERY);
83 OSL_ENSURE(xContainerAccess.is(), "IndexAccessIterator::Next : a content has an invalid parent !");
84
85 // Remove the index that SearchLoop had within this parent from my stack
86 sal_Int32 nOldSearchChildIndex = m_arrChildIndizies[m_arrChildIndizies.size() - 1];
87 m_arrChildIndizies.pop_back();
88
89 if (nOldSearchChildIndex < xContainerAccess->getCount() - 1)
90 { // Move to the right in this row
91 ++nOldSearchChildIndex;
92 // and check the next child
93 css::uno::Any aElement(xContainerAccess->getByIndex(nOldSearchChildIndex));
94 xSearchLoop = *o3tl::doAccess<css::uno::Reference<css::uno::XInterface>>(aElement);
95 bCheckingStartingPoint = false;
96 // and update its position in the list.
97 m_arrChildIndizies.push_back(nOldSearchChildIndex);
98
99 break;
100 }
101 // Finally, if there's nothing more to do in this row (to the right), we'll move on to the next row.
102 xSearchLoop = xParent;
103 bCheckingStartingPoint = false;
104 }
105
106 if (m_arrChildIndizies.empty() && !bCheckingStartingPoint)
107 { //This is the case if there is nothing to the right in the original search loop
108 bHasMoreToSearch = false;
109 }
110 }
111
112 if (bHasMoreToSearch)
113 { // If there is still a node in the tree which can be tested
114 if (ShouldHandleElement(xSearchLoop))
115 {
116 m_xCurrentObject = xSearchLoop;
117 bFoundSomething = true;
118 }
119 else
120 if (bCheckingStartingPoint)
121 bHasMoreToSearch = false;
122 bAlreadyCheckedCurrent = true;
123 }
124 }
125 }
126
127 if (!bFoundSomething)
128 {
129 OSL_ENSURE(m_arrChildIndizies.empty(), "IndexAccessIterator::Next : items left on stack ! how this ?");
130 Invalidate();
131 }
132
133 return m_xCurrentObject;
134}
135
136
137} // namespace comphelper
138
139
140/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual bool ShouldStepInto(const css::uno::Reference< css::uno::XInterface > &) const
Definition: container.hxx:66
::std::vector< sal_Int32 > m_arrChildIndizies
Definition: container.hxx:43
css::uno::Reference< css::uno::XInterface > m_xStartingPoint
Definition: container.hxx:39
css::uno::Reference< css::uno::XInterface > m_xCurrentObject
Definition: container.hxx:41
virtual bool ShouldHandleElement(const css::uno::Reference< css::uno::XInterface > &)
Definition: container.hxx:59
css::uno::Reference< css::uno::XInterface > const & Next()
Definition: container.cxx:42
IndexAccessIterator(css::uno::Reference< css::uno::XInterface > xStartingPoint)
Definition: container.cxx:33