Issue #2786 Amend SVG library to use XmlWriter instead of XmlTextWriter. #694

xprl-gjf · 2020-03-20T17:35:39Z

Reference Issue

Enhancement #693

What does this implement/fix? Explain your changes.

Generalize XML output to use an XmlWriter instead of the more specific XmlTextWriter. In particular, my use case is that I want to use my own custom XmlWriter to send output as part of an Asp.Net Blazor application.

The changes to the various WriteXXX(...) methods are trivial. However, the XmlWriter class performs some stricter checks than the XmlTextWriter and so I had to change the handling of namespaces. The existing code specifies namespace simply by writing an "xmlns" attribute. However, with XmlWriter, this causes an exception to be thrown (similar to this question on StackOverflow )

Note also the Microsoft documentation for XmlTextWriter:

Starting with the .NET Framework 2.0, we recommend that you use the XmlWriter class instead.

Starting with the .NET Framework 2.0, we recommend that you create XmlWriter instances by using the XmlWriter.Create method and the XmlWriterSettings class to take advantage of new functionality.

See also conformance options based on ConformanceLevel

Any other comments?

The changes impacted SvgAttributeAttribute.cs such that:

the SVG namespace (http://www.w3.org/2000/svg) is no longer included in the list of namespaces that would be written into the root SvgFragment element from this list. Instead, all SvgElements are explicitly using this namespace as per SvgElement.cs
the 'NamespaceAndName' method is no longer needed. Instead, XmlWriter.WriteAttributeString is called with the namespace and prefix to handle this. (again, in SvgElement.cs)

Since the SvgNamespace is needed more widely across SvgElement and SvgAttributeAttribute, I extracted it into its own static class.

All unit tests pass.

mrbean-bremen · 2020-03-26T19:33:17Z

Looks good to me. @H1Gdev, @wieslawsoltes - can one of you have another look please?

H1Gdev · 2020-03-27T09:41:17Z

@mrbean-bremen

I will check this PR.

H1Gdev

For PR to change from XmlTextWriter to XmlWriter, I think there are many changes.

I think the following changes.

change from XmlTextWriter to XmlWriter.
change from new XmlTextWriter() to XmlWriter.Create().
When adding SvgDocument element, also specify SVG namespace.
Change namespace specification of attributes.

H1Gdev · 2020-03-27T09:31:13Z

Source/SvgNamespace.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;


Remove unnecessary using.

H1Gdev · 2020-03-27T23:02:20Z

Source/SvgDocument.cs

@@ -727,10 +727,11 @@ public override void Write(XmlTextWriter writer)
        public void Write(Stream stream, bool useBom = true)
        {

-            var xmlWriter = new XmlTextWriter(stream, useBom ? Encoding.UTF8 : new System.Text.UTF8Encoding(false))
+            var xmlWriter = XmlWriter.Create(stream, new XmlWriterSettings


If use Create method, it should be enclosed in using ?

In case of XmlTextWriter, Stream is also disposed by Dispose method, but not in case of Create method ?

H1Gdev · 2020-03-29T03:07:36Z

Source/SvgExtentions.cs

@@ -54,12 +54,15 @@ public static string GetXML(this SvgElement elem)
                Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture;
                using (StringWriter str = new StringWriter())
                {
-                    using (XmlTextWriter xml = new XmlTextWriter(str))
+                    var writerSettings = new XmlWriterSettings


Do not use ?

H1Gdev · 2020-03-29T03:44:46Z

Source/SvgElementFactory.cs

-                if (reader.LocalName.Equals("style") && !(element is NonSvgElement))
+                if (reader.LocalName.Equals("xmlns"))
+                {
+                    // namespace should already have been processed upon reading the element; do nothing


Did you run a test or something like that and actually process this block ?

H1Gdev · 2020-03-29T05:17:49Z

Source/Document Structure/SvgFragment.cs

@@ -298,16 +293,14 @@ public override SvgElement DeepCopy<T>()
        }

        // Override the default behavior, writing out the namespaces.
-        protected override void WriteStartElement(XmlTextWriter writer)
+        protected override void WriteStartElement(XmlWriter writer)


It also adds namespace to inner SVG.(existing issue...)
This process should be in SvgDocument.

H1Gdev · 2020-03-29T05:53:29Z

Source/SvgElementFactory.cs

@@ -113,7 +113,7 @@ private SvgElement CreateElement<T>(XmlReader reader, bool fragmentIsDocument, S
            else
            {
                // All non svg element (html, ...)
-                createdElement = new NonSvgElement(elementName);
+                createdElement = new NonSvgElement(elementName, elementNS);


Does SVG embedded in HTML have an unnecessary namespace ?

H1Gdev · 2020-03-30T05:23:07Z

What is "Issue #2786" ?

H1Gdev · 2020-04-02T11:08:46Z

@bbsgfalconer

Please separate PRs for each issue.

xprl-gjf · 2020-04-02T12:07:17Z

Oops - tidying up my branches. Well separate into smaller changes and resubmit.

H1Gdev reviewed Mar 29, 2020

View reviewed changes

H1Gdev mentioned this pull request Mar 30, 2020

Fix: Output namespace in inner <svg> element. #702

Merged

xprl-gjf closed this Apr 2, 2020

xprl-gjf force-pushed the master branch from f10a789 to d7a7679 Compare April 2, 2020 11:57

xprl-gjf mentioned this pull request Sep 1, 2020

Handle element namespaces directly #760

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Issue #2786 Amend SVG library to use XmlWriter instead of XmlTextWriter. #694

Issue #2786 Amend SVG library to use XmlWriter instead of XmlTextWriter. #694

Uh oh!

xprl-gjf commented Mar 20, 2020

Uh oh!

mrbean-bremen commented Mar 26, 2020

Uh oh!

H1Gdev commented Mar 27, 2020

Uh oh!

H1Gdev left a comment •

edited

Loading

Uh oh!

H1Gdev Mar 27, 2020

Uh oh!

H1Gdev Mar 27, 2020

Uh oh!

H1Gdev Mar 29, 2020

Uh oh!

H1Gdev Mar 29, 2020

Uh oh!

H1Gdev Mar 29, 2020

Uh oh!

H1Gdev Mar 30, 2020

Uh oh!

H1Gdev Mar 29, 2020

Uh oh!

H1Gdev commented Mar 30, 2020

Uh oh!

H1Gdev commented Apr 2, 2020 •

edited

Loading

Uh oh!

xprl-gjf commented Apr 2, 2020

Uh oh!

Uh oh!

		@@ -0,0 +1,11 @@
		using System;
		using System.Collections.Generic;

Issue #2786 Amend SVG library to use XmlWriter instead of XmlTextWriter. #694

Issue #2786 Amend SVG library to use XmlWriter instead of XmlTextWriter. #694

Uh oh!

Conversation

xprl-gjf commented Mar 20, 2020

Reference Issue

What does this implement/fix? Explain your changes.

Any other comments?

Uh oh!

mrbean-bremen commented Mar 26, 2020

Uh oh!

H1Gdev commented Mar 27, 2020

Uh oh!

H1Gdev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

H1Gdev Mar 27, 2020

Choose a reason for hiding this comment

Uh oh!

H1Gdev Mar 27, 2020

Choose a reason for hiding this comment

Uh oh!

H1Gdev Mar 29, 2020

Choose a reason for hiding this comment

Uh oh!

H1Gdev Mar 29, 2020

Choose a reason for hiding this comment

Uh oh!

H1Gdev Mar 29, 2020

Choose a reason for hiding this comment

Uh oh!

H1Gdev Mar 30, 2020

Choose a reason for hiding this comment

Uh oh!

H1Gdev Mar 29, 2020

Choose a reason for hiding this comment

Uh oh!

H1Gdev commented Mar 30, 2020

Uh oh!

H1Gdev commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xprl-gjf commented Apr 2, 2020

Uh oh!

Uh oh!

H1Gdev left a comment •

edited

Loading

H1Gdev commented Apr 2, 2020 •

edited

Loading