ruffle/core/src/xml.rs

//! Garbage-collectable XML DOM impl

mod document;
mod tree;

type Error = Box<dyn std::error::Error>;

pub use document::XMLDocument;
pub use tree::XMLNode;
Add rudimentary custom DOM impl on top of `quick_xml`. `quick_xml` was chosen due to it's high performance and support for zero-copy use cases. However, we are not using `minidom`, which is the already-extant DOM impl that uses `quick_xml` as it's parsing provider. This is because `minidom` nodes are not amenable to garbage collection. Specifically: we want to be able to construct a new `Object` variant that holds part of an XML node. However, `minidom::Element` directly owns it's children, meaning that we can't hold references to it from within `Object` while also keeping those objects to the `'gc` lifetime. Hence, we provide a GC-exclusive DOM implementation. I ruled out solutions such as holding an entire XML tree in an `Rc` and having AVM objects that shadow them. This works for `SwfSlice` because indexing an array is cheap; but traversing a tree can get very expensive. XML is used in many places in Flash Player, so it's important that we treat it like a first-class citizen. 2019-12-20 03:19:22 +00:00			`//! Garbage-collectable XML DOM impl`

			`mod document;`
			`mod tree;`

			`type Error = Box<dyn std::error::Error>;`

Add a new `XMLObject` variant to the AVM1 object ecosystem. This particular variant is actually a two-in-one deal: `XMLObject`s may either refer to a document or a node. 2019-12-20 05:17:05 +00:00			`pub use document::XMLDocument;`
Add rudimentary custom DOM impl on top of `quick_xml`. `quick_xml` was chosen due to it's high performance and support for zero-copy use cases. However, we are not using `minidom`, which is the already-extant DOM impl that uses `quick_xml` as it's parsing provider. This is because `minidom` nodes are not amenable to garbage collection. Specifically: we want to be able to construct a new `Object` variant that holds part of an XML node. However, `minidom::Element` directly owns it's children, meaning that we can't hold references to it from within `Object` while also keeping those objects to the `'gc` lifetime. Hence, we provide a GC-exclusive DOM implementation. I ruled out solutions such as holding an entire XML tree in an `Rc` and having AVM objects that shadow them. This works for `SwfSlice` because indexing an array is cheap; but traversing a tree can get very expensive. XML is used in many places in Flash Player, so it's important that we treat it like a first-class citizen. 2019-12-20 03:19:22 +00:00			`pub use tree::XMLNode;`