1 #ifndef __DALI_SCRIPT_TREE_NODE_H__
2 #define __DALI_SCRIPT_TREE_NODE_H__
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <utility> // pair
24 #include <dali-toolkit/public-api/dali-toolkit-common.h>
32 namespace Internal DALI_INTERNAL
35 class TreeNodeManipulator;
37 } // namespace Internal
41 * TreeNode describes a tree of nodes.
42 * TreeNode does not own its string data which is held by a container eg JsonParser
43 * Modification operations should be done through a container.
45 class DALI_TOOLKIT_API TreeNode
49 * enum typedef describing the node type
63 * Non virtual destructor; this class should not be inherited from.
67 typedef std::pair<const char*, const TreeNode&> KeyNodePair;
70 * Iterator to iterate through children
75 typedef KeyNodePair value_type;
76 typedef KeyNodePair *pointer;
77 typedef const KeyNodePair *const_pointer;
78 typedef KeyNodePair &reference;
79 typedef const KeyNodePair &const_reference;
80 typedef size_t size_type;
81 typedef std::ptrdiff_t difference_type;
82 typedef std::forward_iterator_tag iterator_category;
87 explicit ConstIterator(TreeNode* v);
92 ConstIterator& operator ++();
97 ConstIterator operator ++(int);
102 bool operator!=( const ConstIterator& rhs ) const;
107 KeyNodePair operator*();
113 * Iterate begin() over the nodes children
114 * @return a const interator
116 ConstIterator CBegin() const;
120 * @return a const interator
122 ConstIterator CEnd() const;
125 * Size (number of children)
126 * @return The number of children
131 * Count (the number of children of a sub child node)
132 * @param childName The name of the child to find
133 * @return the number of children in the found child
135 size_t Count(const std::string& childName) const;
139 * @return The nodes name
141 const char* GetName() const;
144 * Gets the nodes type
145 * @return The nodes type
147 NodeType GetType() const;
150 * Gets the nodes string value
151 * Only valid if the type == TreeNode::STRING
152 * @return The string value
154 const char* GetString() const;
157 * Gets the nodes float value
158 * Only valid if the type == TreeNode::FLOAT
159 * @return The float value
161 float GetFloat() const;
164 * Gets the nodes integer value
165 * Only valid if the type == TreeNode::INTEGER
166 * @return The integer value
168 int GetInteger() const;
171 * Gets the nodes boolean value
172 * Only valid if the type == TreeNode::BOOLEAN
173 * @return The boolean value
175 bool GetBoolean() const;
178 * Gets the substituion flag
179 * Only valid if the type == TreeNode::STRING
180 * @return The substitution flag
182 bool HasSubstitution() const;
185 * Gets a child of the node (using case sensitive matching)
186 * @param name The name of the child.
187 * @return The child if found, else NULL
189 const TreeNode* GetChild(const std::string& name) const;
192 * Gets a child of the node (using case insensitive matching)
193 * @param name The name of the child in lower case
194 * @return The child if found, else NULL
196 const TreeNode* GetChildIgnoreCase(const std::string& name) const;
199 * Recursively search for a child of the node
200 * @param name The name of the child
201 * @return The child if found, else NULL
203 const TreeNode* Find(const std::string& name) const;
206 friend class Internal::TreeNodeManipulator;
211 DALI_INTERNAL TreeNode();
213 // non copyable or assignable
214 DALI_INTERNAL TreeNode(TreeNode &);
215 DALI_INTERNAL TreeNode& operator=(const TreeNode&);
217 const char* mName; ///< The nodes name (if any)
219 TreeNode* mParent; ///< The nodes parent
220 TreeNode* mNextSibling; ///< The nodes next sibling
221 TreeNode* mFirstChild; ///< The nodes first child
222 TreeNode* mLastChild; ///< The nodes last child
226 const char* mStringValue; ///< The node string value
227 int mIntValue; ///< The node integer value
228 float mFloatValue; ///< The node float value
231 NodeType mType; ///< The nodes type
232 bool mSubstituion; ///< String substitution flag
236 } // namespace Toolkit
240 #endif // __DALI_SCRIPT_TREE_NODE_H__