Node and Element: Change to new behavior for previously deprecated functions

Rename usage of previously deprecated functions to use the new names.

Author: mikke89

CMake/Utilities.cmake

@@ -103,9 +103,9 @@ function(set_common_target_options target)
 
 	if(RMLUI_COMPILER_OPTIONS)
 		if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU")
-			target_compile_options(${target} PRIVATE -Wall -Wextra -pedantic -Wno-deprecated-declarations)
+			target_compile_options(${target} PRIVATE -Wall -Wextra -pedantic)
 		elseif(MSVC)
-			target_compile_options(${target} PRIVATE /W4 /w44062 /wd4458 /wd4251 /wd4996 /permissive-)
+			target_compile_options(${target} PRIVATE /W4 /w44062 /wd4458 /wd4251 /permissive-)
 			target_compile_definitions(${target} PRIVATE _CRT_SECURE_NO_WARNINGS)
 			if(CMAKE_GENERATOR MATCHES "Visual Studio")
 				target_compile_options(${target} PRIVATE /MP)

Include/RmlUi/Core/Element.h

@@ -431,20 +431,16 @@ class RMLUICORE_API Element : public Node, public EnableObserverPtr<Element> {
 	/// Gets the element immediately following this one in the tree.
 	/// @return This element's next sibling element, or nullptr if there is no sibling element.
 	Element* GetNextElementSibling() const;
-	[[deprecated("Use GetNextElementSibling")]] Element* GetNextSibling() const;
 	/// Gets the element immediately preceding this one in the tree.
 	/// @return This element's previous sibling element, or nullptr if there is no sibling element.
 	Element* GetPreviousElementSibling() const;
-	[[deprecated("Use GetPreviousElementSibling")]] Element* GetPreviousSibling() const;
 
 	/// Returns the first child of this element.
 	/// @return This element's first child, or nullptr if it contains no children.
 	Element* GetFirstElementChild() const;
-	[[deprecated("Use GetFirstElementChild")]] Element* GetFirstChild() const;
 	/// Gets the last child of this element.
 	/// @return This element's last child, or nullptr if it contains no children.
 	Element* GetLastElementChild() const;
-	[[deprecated("Use GetLastElementChild")]] Element* GetLastChild() const;
 	/// Get the child element at the given index.
 	/// @param[in] index Index of child to get.
 	/// @return The child element at the given index.

Include/RmlUi/Core/Node.h

@@ -39,6 +39,7 @@ class Context;
 class Element;
 class ElementDocument;
 class NodeInstancer;
+class NodePtrProxy;
 using OwnedNodeList = Vector<NodePtr>;
 
 /**
@@ -62,34 +63,43 @@ class RMLUICORE_API Node : public ScriptInterface {
 	/// @return True if the node has at least one DOM child, false otherwise.
 	bool HasChildNodes() const;
 
+	/// Returns the first child of this node.
+	/// @return This node's first child, or nullptr if it contains no children.
+	Node* GetFirstChild() const;
+	/// Gets the last child of this node.
+	/// @return This node's last child, or nullptr if it contains no children.
+	Node* GetLastChild() const;
+	/// Gets the node immediately following this one in the tree.
+	/// @return This node's next sibling node, or nullptr if there is no sibling node.
+	Node* GetNextSibling() const;
+	/// Gets the node immediately preceding this one in the tree.
+	/// @return This node's previous sibling node, or nullptr if there is no sibling node.
+	Node* GetPreviousSibling() const;
+
 	/// Append a child to this node.
 	/// @param[in] node The node to append as a child.
 	/// @param[in] dom_node True if the node is to be part of the DOM, false otherwise. Only set this to false if you know what you're doing!
 	/// @return A pointer to the just inserted node.
-	Node* AppendChild(NodePtr node, bool dom_node = true);
-	[[deprecated("Use the NodePtr version of this function")]] Element* AppendChild(ElementPtr element, bool dom_element = true);
+	Node* AppendChild(NodePtrProxy node, bool dom_node = true);
 	/// Adds a child to this node directly before the adjacent node. The new node inherits the DOM/non-DOM
 	/// status from the adjacent node.
 	/// @param[in] node Node to be inserted.
 	/// @param[in] adjacent_node The reference node which the new node will be inserted before.
 	/// @return A pointer to the just inserted node.
-	Node* InsertBefore(NodePtr node, Node* adjacent_node);
-	[[deprecated("Use the NodePtr version of this function")]] Element* InsertBefore(ElementPtr element, Element* adjacent_element);
+	Node* InsertBefore(NodePtrProxy node, Node* adjacent_node);
 	/// Replaces the second node with the first node.
 	/// @param[in] inserted_node The node that will be inserted and replace the other node.
 	/// @param[in] replaced_node The existing node that will be replaced. If this doesn't exist, inserted_node will be appended.
 	/// @return A unique pointer to the replaced node if found, discard the result to immediately destroy.
-	NodePtr ReplaceChild(NodePtr inserted_node, Node* replaced_node);
-	[[deprecated("Use the NodePtr version of this function")]] ElementPtr ReplaceChild(ElementPtr inserted_element, Element* replaced_element);
+	NodePtr ReplaceChild(NodePtrProxy inserted_node, Node* replaced_node);
 	/// Remove a child node from this node.
 	/// @param[in] node The node to remove.
 	/// @return A unique pointer to the node if found, discard the result to immediately destroy.
 	NodePtr RemoveChild(Node* node);
-	[[deprecated("Use the NodePtr version of this function")]] ElementPtr RemoveChild(Element* element);
 
 	/// Gets this nodes's parent node.
 	/// @return This node's parent.
-	[[deprecated("Use GetParentElement")]] Element* GetParentNode() const;
+	Node* GetParentNode() const;
 	/// Gets this nodes's parent element.
 	/// @return This node's parent if it is an element, otherwise false.
 	Element* GetParentElement() const;
@@ -311,6 +321,18 @@ class RMLUICORE_API Node : public ScriptInterface {
 	friend class Rml::Context;
 };
 
+class RMLUICORE_API NodePtrProxy {
+public:
+	NodePtrProxy(NodePtr node);
+	NodePtrProxy(ElementPtr element);
+	Node* Get();
+	NodePtr Extract();
+	explicit operator bool() const;
+
+private:
+	NodePtr node;
+};
+
 } // namespace Rml
 
 #endif

Samples/basic/demo/src/DemoEventListener.cpp

@@ -53,7 +53,7 @@ void DemoEventListener::ProcessEvent(Rml::Event& event)
 	else if (value == "move_child")
 	{
 		const Vector2f mouse_pos = {event.GetParameter("mouse_x", 0.0f), event.GetParameter("mouse_y", 0.0f)};
-		if (Element* child = element->GetFirstChild())
+		if (Element* child = element->GetFirstElementChild())
 		{
 			Vector2f new_pos = mouse_pos - element->GetAbsoluteOffset() - Vector2f(0.35f * child->GetClientWidth(), 0.9f * child->GetClientHeight());
 			Property destination = Transform::MakeProperty({Transforms::Translate2D(new_pos.x, new_pos.y)});

Samples/basic/demo/src/DemoWindow.cpp

@@ -72,8 +72,7 @@ bool DemoWindow::Initialize(const Rml::String& title, Rml::Context* context)
 	if (auto target = document->GetElementById("sandbox_target"))
 	{
 		iframe = context->CreateDocument();
-		auto iframe_ptr = iframe->GetParentNode()->RemoveChild(iframe);
-		target->AppendChild(std::move(iframe_ptr));
+		target->AppendChild(iframe->Remove());
 		iframe->SetProperty(PropertyId::Position, Property(Style::Position::Absolute));
 		iframe->SetProperty(PropertyId::Display, Property(Style::Display::Block));
 		iframe->SetInnerRML("<p>Rendered output goes here.</p>");

Samples/basic/drag/src/DragListener.cpp

@@ -47,8 +47,7 @@ void DragListener::ProcessEvent(Rml::Event& event)
 		if (dest_container == dest_element)
 		{
 			// The dragged element was dragged directly onto a container.
-			Rml::ElementPtr element = drag_element->GetParentNode()->RemoveChild(drag_element);
-			dest_container->AppendChild(std::move(element));
+			dest_container->AppendChild(drag_element->Remove());
 		}
 		else
 		{
@@ -59,25 +58,25 @@ void DragListener::ProcessEvent(Rml::Event& event)
 
 			// Unless of course if it was dragged on top of an item in its own container; we need
 			// to check then if it was moved up or down with the container.
-			if (drag_element->GetParentNode() == dest_container)
+			if (drag_element->GetParentElement() == dest_container)
 			{
 				// Check whether we're moving this icon from the left or the right.
 
-				Rml::Element* previous_icon = insert_before->GetPreviousSibling();
+				Rml::Element* previous_icon = insert_before->GetPreviousElementSibling();
 				while (previous_icon != nullptr)
 				{
 					if (previous_icon == drag_element)
 					{
-						insert_before = insert_before->GetNextSibling();
+						insert_before = insert_before->GetNextElementSibling();
 						break;
 					}
 
-					previous_icon = previous_icon->GetPreviousSibling();
+					previous_icon = previous_icon->GetPreviousElementSibling();
 				}
 			}
 
-			Rml::ElementPtr element = drag_element->GetParentNode()->RemoveChild(drag_element);
-			dest_container->InsertBefore(std::move(element), insert_before);
+			Rml::NodePtr node = drag_element->GetParentElement()->RemoveChild(drag_element);
+			dest_container->InsertBefore(std::move(node), insert_before);
 		}
 	}
 }

Samples/basic/drag/src/Inventory.cpp

@@ -63,6 +63,6 @@ void Inventory::AddItem(const Rml::String& name)
 		return;
 
 	// Create the new 'icon' element.
-	Rml::Element* icon = content->AppendChild(Rml::As<Rml::ElementPtr>(Rml::Factory::InstanceNode("icon", "icon")));
+	Rml::Element* icon = Rml::As<Rml::Element*>(content->AppendChild(Rml::Factory::InstanceNode("icon", "icon")));
 	icon->SetInnerRML(name);
 }

Samples/tutorial/drag/src/Inventory.cpp

@@ -29,6 +29,6 @@ void Inventory::AddItem(const Rml::String& name)
 		return;
 
 	// Create the new 'icon' element.
-	Rml::Element* icon = content->AppendChild(Rml::As<Rml::ElementPtr>(Rml::Factory::InstanceNode("icon", "icon")));
+	Rml::Element* icon = Rml::As<Rml::Element*>(content->AppendChild(Rml::Factory::InstanceNode("icon", "icon")));
 	icon->SetInnerRML(name);
 }

Source/Core/Context.cpp

@@ -363,8 +363,8 @@ void Context::UnloadDocument(ElementDocument* _document)
 		document->DispatchEvent(EventId::Unload, Dictionary());
 		PluginRegistry::NotifyDocumentUnload(document);
 
-		// Move document to a temporary location to be released later.
-		unloaded_documents.push_back(root->RemoveChild(document));
+		// Remove from root and place document in a temporary location to be released later.
+		unloaded_documents.push_back(document->Remove());
 	}
 
 	// Remove the item from the focus history.
@@ -635,7 +635,7 @@ static Element* FindFocusElement(Element* element)
 
 	while (element && element->GetComputedValues().focus() == Style::Focus::None)
 	{
-		element = element->GetParentNode();
+		element = element->GetParentElement();
 	}
 
 	return element;
@@ -710,7 +710,7 @@ bool Context::ProcessMouseButtonDown(int button_index, int key_modifier_state)
 				Style::Drag drag_style = drag->GetComputedValues().drag();
 				switch (drag_style)
 				{
-				case Style::Drag::None: drag = drag->GetParentNode(); continue;
+				case Style::Drag::None: drag = drag->GetParentElement(); continue;
 				case Style::Drag::Block: drag = nullptr; continue;
 				default: drag_verbose = (drag_style == Style::Drag::DragDrop || drag_style == Style::Drag::Clone);
 				}
@@ -1233,15 +1233,15 @@ bool Context::OnFocusChange(Element* new_focus, bool focus_visible)
 	while (element)
 	{
 		old_chain.insert(element);
-		element = element->GetParentNode();
+		element = element->GetParentElement();
 	}
 
 	// Build the new chain
 	element = new_focus;
 	while (element)
 	{
 		new_chain.insert(element);
-		element = element->GetParentNode();
+		element = element->GetParentElement();
 	}
 
 	// Send out blur/focus events.
@@ -1353,7 +1353,7 @@ void Context::UpdateHoverChain(Vector2i old_mouse_position, int key_modifier_sta
 	while (element != nullptr)
 	{
 		new_hover_chain.insert(element);
-		element = element->GetParentNode();
+		element = element->GetParentElement();
 	}
 
 	// Send mouseout / mouseover events.
@@ -1370,7 +1370,7 @@ void Context::UpdateHoverChain(Vector2i old_mouse_position, int key_modifier_sta
 		while (element != nullptr)
 		{
 			new_drag_hover_chain.insert(element);
-			element = element->GetParentNode();
+			element = element->GetParentElement();
 		}
 
 		if (drag_started && drag_verbose)
@@ -1427,7 +1427,7 @@ Element* Context::GetElementAtPoint(Vector2f point, const Element* ignore_elemen
 					if (element_hierarchy == ignore_element)
 						break;
 
-					element_hierarchy = element_hierarchy->GetParentNode();
+					element_hierarchy = element_hierarchy->GetParentElement();
 				}
 
 				if (element_hierarchy)
@@ -1495,12 +1495,12 @@ void Context::CreateDragClone(Element* element)
 	drag_clone = element_drag_clone.get();
 
 	// Append the clone to the cursor proxy element.
-	cursor_proxy->AppendChild(std::move(element_drag_clone));
+	cursor_proxy->AppendChild(As<NodePtr>(std::move(element_drag_clone)));
 
 	// Position the clone. Use projected mouse coordinates to handle any ancestor transforms.
 	const Vector2f absolute_pos = element->GetAbsoluteOffset(BoxArea::Border);
 	Vector2f projected_mouse_position = Vector2f(mouse_position);
-	if (Element* parent = element->GetParentNode())
+	if (Element* parent = element->GetParentElement())
 		parent->Project(projected_mouse_position);
 
 	drag_clone->SetProperty(PropertyId::Position, Property(Style::Position::Absolute));

Source/Core/DataModel.cpp

@@ -244,7 +244,7 @@ void DataModel::CopyAliases(Element* from_element, Element* to_element)
 	{
 		// Need to create a copy to prevent errors during concurrent modification for 3rd party containers
 		auto copy = existing_map->second;
-		for (auto const& it : copy)
+		for (const auto& it : copy)
 			aliases[to_element][it.first] = std::move(it.second);
 	}
 }
@@ -288,7 +288,7 @@ DataAddress DataModel::ResolveAddress(const String& address_str, Element* elemen
 			}
 		}
 
-		ancestor = ancestor->GetParentNode();
+		ancestor = ancestor->GetParentElement();
 	}
 
 	Log::Message(Log::LT_WARNING, "Could not find variable name '%s' in data model.", address_str.c_str());