elenakrittik/godotxml

Advanced XML support for Godot 4

GodotXML - advanced XML support for Godot 4.

This addon adds support for manipulating XML data in Godot 4 with ease.

Supports Godot 4.0-4.2, and likely future versions too.

HINT: Migrating from v1? See changelog for a complete list of breaking (and not) changes.

Features

• Pure-Godot - everything is done using built-in XMLParser;
• Loading and dumping XML data into/from a convenient class-based format;
• Beautifying XML;
• Converting XML into dictionaries;
• Access uniquely named children of nodes as if they were regular attributes (works in the editor too!);
• Decent error messages for when the input is malformed (i mean, XMLParser doesn't have them at all, so :> ).

Installation

Search for the "GodotXML" addon on the asset library (link) or alternatively copy the addons/ folder into your project's root.

API

All functions and attributes that are meant for use by you do not have _ before their name and are also listed before any internal function.

All other functions and attributes are not meant to be used by you, though of course you can edit them as you like.

Roadmap

• Setup automated tests.

godotxml's Issues

Improve typing

There are quite a few places in code with missing or redundant type hints. These shall be fixed

Invalid closing tags are being silently ignored.

#18 broke dotted access

String values in attributes that match XML node template string will get replaced when dumping

Version

GodotXML v2.1.0, Godot 4.2.2.rc2

Issue

When you add an attribute of type String with value "{children}" to a node, it gets replaced with the actual string of the nodes children when dumping.

Expected

The string is saved as an attribute of the node.

Blank space in `XMLNode.content` is trimmed away.

The problem is that when you have a node with content that has spaces, these spaces will get removed from the edges when parsing.

Yep, that's intentional (but can be reverted, of course). I did it because i don't think that with, e.g.:

<node>
  Hello!
</node>

..one would expected the content to be "\n Hello!\n". At the same time i recognize that this practically forbids you from having multiline content, but that's an intentional trade-off i made in my mind when i've written it. Personally, my rule of thumb is "single-line data => make it an attribute; multi-line data => make it a CDATA", but i'm always open to feedback and we can change that (under an option).

Reading the comment, it seems like a workaround for a Godot xml parser problem?

In this case, it's more of an "unwanted" thing than an "issue" (the _cleanup_double_blankets() function below does exist to workaround an issue, but i assume that's out of your concern?).

Originally posted by @elenakrittik in #26 (comment)

It's probably better to leave trimming to the user, but i'm afraid of this being too breaking

Support multiple roots

All newlines in the input string are removed, instead of only last ones.

Empty standalone node in beautify mode gets two spaces before `>`

Public interface for dumping individual nodes

Currently public interface can only dump whole document. You can use XMLNode._dump, but it's private, i.e. "not ideal". A public XMLNode.dump is therefore needed.

Factor out dumping templates for better re-usability

Character escaping

We currently don't transform sequences like &quot when parsing, nor do we escape characters when dumping.

Concatenate node content instead of ignoring subsequent ones

<![CDATA[ ]]> Is being ignored and do not appear as a content

content Is being ignored and do not appear as a children content

Parsed Dictionary:

{
   "__name__":"entry",
   "__content__":"",
   "attrs":{
      
   },
   "children":{
      "title":{
         "__name__":"title",
         "__content__":"",
         "attrs":{
            
         },
         "children":{
            
         }
      },
      "link":{
         "__name__":"link",
         "__content__":"",
         "attrs":{
            "rel":"alternate",
            "href":"https://xxxx.com/blog/dfssdfa33"
         },
         "children":{
            
         }
      },
      "id":{
         "__name__":"id",
         "__content__":"https://xxxx.com/33",
         "attrs":{
            
         },
         "children":{
            
         }
      },
      "author":{
         "__name__":"author",
         "__content__":"",
         "attrs":{
            
         },
         "children":{
            "name":{
               "__name__":"name",
               "__content__":"",
               "attrs":{
                  
               },
               "children":{
                  
               }
            }
         }
      },
      "summary":{
         "__name__":"summary",
         "__content__":"",
         "attrs":{
            "type":"html"
         },
         "children":{
            
         }
      },
      "updated":{
         "__name__":"updated",
         "__content__":"2024-02-29T03:50:32+00:00",
         "attrs":{
            
         },
         "children":{
            
         }
      }
   }
}

Original XML:

<entry>
<title>
<![CDATA[ Oieee ]]>
</title>
<link rel="alternate" href="https://xxxx.com/blog/dfssdfa33"/>
<id>https://xxxx.com/33</id>
<author>
<name>
<![CDATA[ Suerin ]]>
</name>
</author>
<summary type="html">
<![CDATA[ sfdfgsfgddfg ]]>
</summary>
<updated>2024-02-29T03:50:32+00:00</updated>
</entry>
</feed>