SvgDocument.cs 13.4 KB
Newer Older
davescriven's avatar
davescriven committed
1
2
3
4
5
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics;
using System.Drawing;
6
7
using System.Drawing.Drawing2D;
using System.Drawing.Text;
davescriven's avatar
davescriven committed
8
9
10
11
12
13
14
using System.IO;
using System.Text;
using System.Xml;

namespace Svg
{
    /// <summary>
15
    /// The class used to create and load SVG documents.
davescriven's avatar
davescriven committed
16
17
18
19
    /// </summary>
    public class SvgDocument : SvgFragment, ITypeDescriptorContext
    {
        public static readonly int PPI = 96;
20

davescriven's avatar
davescriven committed
21
22
23
24
25
        /// <summary>
        /// Gets a <see cref="string"/> containing the XLink namespace (http://www.w3.org/1999/xlink).
        /// </summary>
        public static readonly string XLinkNamespace = "http://www.w3.org/1999/xlink";

26
27
        private SvgElementIdManager _idManager;

28
29
30
        /// <summary>
        /// Initializes a new instance of the <see cref="SvgDocument"/> class.
        /// </summary>
31
        public SvgDocument()
davescriven's avatar
davescriven committed
32
        {
33
            Ppi = 96;
davescriven's avatar
davescriven committed
34
35
36
37
38
39
40
41
42
        }

        /// <summary>
        /// Gets an <see cref="SvgElementIdManager"/> for this document.
        /// </summary>
        protected internal virtual SvgElementIdManager IdManager
        {
            get
            {
43
                if (_idManager == null)
44
                {
45
                    _idManager = new SvgElementIdManager(this);
46
                }
davescriven's avatar
davescriven committed
47

48
                return _idManager;
davescriven's avatar
davescriven committed
49
50
51
            }
        }

52
53
54
        /// <summary>
        /// Gets or sets the Pixels Per Inch of the rendered image.
        /// </summary>
55
56
57
58
59
        public int Ppi { get; set; }

        #region ITypeDescriptorContext Members

        IContainer ITypeDescriptorContext.Container
davescriven's avatar
davescriven committed
60
        {
61
            get { throw new NotImplementedException(); }
davescriven's avatar
davescriven committed
62
63
        }

64
        object ITypeDescriptorContext.Instance
davescriven's avatar
davescriven committed
65
        {
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
            get { return this; }
        }

        void ITypeDescriptorContext.OnComponentChanged()
        {
            throw new NotImplementedException();
        }

        bool ITypeDescriptorContext.OnComponentChanging()
        {
            throw new NotImplementedException();
        }

        PropertyDescriptor ITypeDescriptorContext.PropertyDescriptor
        {
            get { throw new NotImplementedException(); }
        }

        object IServiceProvider.GetService(Type serviceType)
        {
            throw new NotImplementedException();
        }

        #endregion

        /// <summary>
        /// Retrieves the <see cref="SvgElement"/> with the specified ID.
        /// </summary>
        /// <param name="id">A <see cref="string"/> containing the ID of the element to find.</param>
        /// <returns>An <see cref="SvgElement"/> of one exists with the specified ID; otherwise false.</returns>
        public virtual SvgElement GetElementById(string id)
        {
            return IdManager.GetElementById(id);
davescriven's avatar
davescriven committed
99
100
        }

101
102
103
104
105
106
107
108
109
110
        /// <summary>
        /// Retrieves the <see cref="SvgElement"/> with the specified ID.
        /// </summary>
        /// <param name="id">A <see cref="string"/> containing the ID of the element to find.</param>
        /// <returns>An <see cref="SvgElement"/> of one exists with the specified ID; otherwise false.</returns>
        public virtual TSvgElement GetElementById<TSvgElement>(string id) where TSvgElement : SvgElement
        {
            return (this.GetElementById(id) as TSvgElement);
        }

davescriven's avatar
davescriven committed
111
        /// <summary>
112
        /// Opens the document at the specified path and loads the SVG contents.
davescriven's avatar
davescriven committed
113
114
115
116
117
        /// </summary>
        /// <param name="path">A <see cref="string"/> containing the path of the file to open.</param>
        /// <returns>An <see cref="SvgDocument"/> with the contents loaded.</returns>
        /// <exception cref="FileNotFoundException">The document at the specified <paramref name="path"/> cannot be found.</exception>
        public static SvgDocument Open(string path)
118
119
120
121
        {
            return Open(path, null);
        }

122
        /// <summary>
123
        /// Opens the document at the specified path and loads the SVG contents.
124
125
126
127
        /// </summary>
        /// <param name="path">A <see cref="string"/> containing the path of the file to open.</param>
        /// <param name="entities">A dictionary of custom entity definitions to be used when resolving XML entities within the document.</param>
        /// <returns>An <see cref="SvgDocument"/> with the contents loaded.</returns>
128
        /// <exception cref="FileNotFoundException">The document at the specified <paramref name="path"/> cannot be found.</exception>
129
        public static SvgDocument Open(string path, Dictionary<string, string> entities)
davescriven's avatar
davescriven committed
130
        {
131
132
133
134
135
            if (string.IsNullOrEmpty(path))
            {
                throw new ArgumentNullException("path");
            }

davescriven's avatar
davescriven committed
136
            if (!File.Exists(path))
137
            {
davescriven's avatar
davescriven committed
138
                throw new FileNotFoundException("The specified document cannot be found.", path);
139
            }
davescriven's avatar
davescriven committed
140

141
            return Open(File.OpenRead(path), entities);
davescriven's avatar
davescriven committed
142
143
        }

144
145
146
147
        /// <summary>
        /// Attempts to open an SVG document from the specified <see cref="Stream"/>.
        /// </summary>
        /// <param name="stream">The <see cref="Stream"/> containing the SVG document to open.</param>
davescriven's avatar
davescriven committed
148
149
150
151
152
        public static SvgDocument Open(Stream stream)
        {
            return Open(stream, null);
        }

153
        /// <summary>
154
        /// Opens an SVG document from the specified <see cref="Stream"/> and adds the specified entities.
155
156
157
        /// </summary>
        /// <param name="stream">The <see cref="Stream"/> containing the SVG document to open.</param>
        /// <param name="entities">Custom entity definitions.</param>
158
        /// <exception cref="ArgumentNullException">The <paramref name="stream"/> parameter cannot be <c>null</c>.</exception>
159
        public static SvgDocument Open(Stream stream, Dictionary<string, string> entities)
davescriven's avatar
davescriven committed
160
        {
161
162
163
164
165
            if (stream == null)
            {
                throw new ArgumentNullException("stream");
            }

davescriven's avatar
davescriven committed
166
167
            Trace.TraceInformation("Begin Read");

168
            using (var reader = new SvgTextReader(stream, entities))
davescriven's avatar
davescriven committed
169
            {
170
171
                var elementStack = new Stack<SvgElement>();
                var value = new StringBuilder();
172
                bool elementEmpty;
davescriven's avatar
davescriven committed
173
                SvgElement element = null;
174
                SvgElement parent;
davescriven's avatar
davescriven committed
175
176
177
178
179
180
181
182
183
184
185
186
187
                SvgDocument svgDocument = null;
                reader.XmlResolver = new SvgDtdResolver();
                reader.WhitespaceHandling = WhitespaceHandling.None;

                while (reader.Read())
                {
                    try
                    {
                        switch (reader.NodeType)
                        {
                            case XmlNodeType.Element:
                                // Does this element have a value or children
                                // (Must do this check here before we progress to another node)
188
                                elementEmpty = reader.IsEmptyElement;
davescriven's avatar
davescriven committed
189
190
                                // Create element
                                if (elementStack.Count > 0)
191
                                {
davescriven's avatar
davescriven committed
192
                                    element = SvgElementFactory.CreateElement(reader, svgDocument);
193
                                }
davescriven's avatar
davescriven committed
194
195
196
                                else
                                {
                                    element = SvgElementFactory.CreateDocument(reader);
197
                                    svgDocument = (SvgDocument)element;
davescriven's avatar
davescriven committed
198
199
200
                                }

                                if (element == null)
201
                                {
davescriven's avatar
davescriven committed
202
                                    continue;
203
                                }
davescriven's avatar
davescriven committed
204
205
206
207
208
209
210
211
212
213
214
215

                                // Add to the parents children
                                if (elementStack.Count > 0)
                                {
                                    parent = elementStack.Peek();
                                    parent.Children.Add(element);
                                }

                                // Push element into stack
                                elementStack.Push(element);

                                // Need to process if the element is empty
216
                                if (elementEmpty)
217
                                {
davescriven's avatar
davescriven committed
218
                                    goto case XmlNodeType.EndElement;
219
                                }
davescriven's avatar
davescriven committed
220
221
222

                                break;
                            case XmlNodeType.EndElement:
223
224
225
226
                                // Skip if no element was created and is not the closing tag for the last
                                // known element
                                if (element == null && reader.LocalName != elementStack.Peek().ElementName)
                                {
davescriven's avatar
davescriven committed
227
                                    continue;
228
                                }
davescriven's avatar
davescriven committed
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
                                // Pop the element out of the stack
                                element = elementStack.Pop();

                                if (value.Length > 0)
                                {
                                    element.Content = value.ToString();
                                    // Reset content value for new element
                                    value = new StringBuilder();
                                }
                                break;
                            case XmlNodeType.CDATA:
                            case XmlNodeType.Text:
                                value.Append(reader.Value);
                                break;
                        }
                    }
                    catch (Exception exc)
                    {
                        Trace.TraceError(exc.Message);
                    }
                }

                Trace.TraceInformation("End Read");
                return svgDocument;
            }
        }

256
257
258
259
260
        /// <summary>
        /// Opens an SVG document from the specified <see cref="XmlDocument"/>.
        /// </summary>
        /// <param name="document">The <see cref="XmlDocument"/> containing the SVG document XML.</param>
        /// <exception cref="ArgumentNullException">The <paramref name="document"/> parameter cannot be <c>null</c>.</exception>
261
        public static SvgDocument Open(XmlDocument document)
davescriven's avatar
davescriven committed
262
        {
263
264
265
266
267
            if (document == null)
            {
                throw new ArgumentNullException("document");
            }

268
            Stream stream = new MemoryStream(UTF8Encoding.Default.GetBytes(document.InnerXml));
269
            return Open(stream, null);
davescriven's avatar
davescriven committed
270
271
272
273
274
275
276
        }

        public static Bitmap OpenAsBitmap(string path)
        {
            return null;
        }

277
        public static Bitmap OpenAsBitmap(XmlDocument document)
davescriven's avatar
davescriven committed
278
279
280
281
282
283
        {
            return null;
        }

        public RectangleF GetDimensions()
        {
284
            return new RectangleF(0, 0, Width.ToDeviceValue(), Height.ToDeviceValue());
davescriven's avatar
davescriven committed
285
286
        }

287
288
289
290
        /// <summary>
        /// Renders the <see cref="SvgDocument"/> to the specified <see cref="SvgRenderer"/>.
        /// </summary>
        /// <param name="renderer">The <see cref="SvgRenderer"/> to render the document with.</param>
291
        /// <exception cref="ArgumentNullException">The <paramref name="renderer"/> parameter cannot be <c>null</c>.</exception>
292
        public void Draw(SvgRenderer renderer)
davescriven's avatar
davescriven committed
293
        {
294
295
296
297
298
            if (renderer == null)
            {
                throw new ArgumentNullException("renderer");
            }

299
            this.Render(renderer);
davescriven's avatar
davescriven committed
300
301
        }

302
303
304
305
306
307
308
309
310
311
312
313
        /// <summary>
        /// Renders the <see cref="SvgDocument"/> to the specified <see cref="Graphics"/>.
        /// </summary>
        /// <param name="graphics">The <see cref="Graphics"/> to be rendered to.</param>
        /// <exception cref="ArgumentNullException">The <paramref name="graphics"/> parameter cannot be <c>null</c>.</exception>
        public void Draw(Graphics graphics)
        {
            if (graphics == null)
            {
                throw new ArgumentNullException("graphics");
            }

314
            this.Render(SvgRenderer.FromGraphics(graphics));
315
316
        }

317
318
319
320
        /// <summary>
        /// Renders the <see cref="SvgDocument"/> and returns the image as a <see cref="Bitmap"/>.
        /// </summary>
        /// <returns>A <see cref="Bitmap"/> containing the rendered document.</returns>
davescriven's avatar
davescriven committed
321
322
323
324
        public virtual Bitmap Draw()
        {
            Trace.TraceInformation("Begin Render");

325
            var size = GetDimensions();
326
            var bitmap = new Bitmap((int)Math.Ceiling(size.Width), (int)Math.Ceiling(size.Height));
davescriven's avatar
davescriven committed
327

328
            try
davescriven's avatar
davescriven committed
329
            {
330
                using (var renderer = SvgRenderer.FromImage(bitmap))
331
                {
332
333
334
335
336
                    renderer.TextRenderingHint = TextRenderingHint.AntiAlias;
                    renderer.TextContrast = 1;
                    renderer.PixelOffsetMode = PixelOffsetMode.Half;
                    this.Render(renderer);
                    renderer.Save();
337
338
339
340
341
342
                }
            }
            catch
            {
                bitmap.Dispose();
                throw;
davescriven's avatar
davescriven committed
343
344
345
346
347
348
349
350
            }

            Trace.TraceInformation("End Render");
            return bitmap;
        }

        public void Write(Stream stream)
        {
351

davescriven's avatar
davescriven committed
352
353
354
355
        }

        public void Write(string path)
        {
356

davescriven's avatar
davescriven committed
357
358
359
        }
    }
}