SvgDocument.cs 15.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
        private SvgElementIdManager _idManager;
21

davescriven's avatar
davescriven committed
22

23

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

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

44
                return _idManager;
davescriven's avatar
davescriven committed
45
46
47
            }
        }

48
49
50
        /// <summary>
        /// Gets or sets the Pixels Per Inch of the rendered image.
        /// </summary>
51
52
53
54
55
        public int Ppi { get; set; }

        #region ITypeDescriptorContext Members

        IContainer ITypeDescriptorContext.Container
davescriven's avatar
davescriven committed
56
        {
57
            get { throw new NotImplementedException(); }
davescriven's avatar
davescriven committed
58
59
        }

60
        object ITypeDescriptorContext.Instance
davescriven's avatar
davescriven committed
61
        {
62
63
64
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
            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
95
96
        }

97
98
99
100
101
102
103
104
105
        /// <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);
        }
106
107
108
109
110
111
112
113
114
115
116
        
                /// <summary>
        /// Opens the document at the specified path and loads the SVG contents.
        /// </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)
        {
            return Open<SvgDocument>(path, null);
        }
117

davescriven's avatar
davescriven committed
118
        /// <summary>
119
        /// Opens the document at the specified path and loads the SVG contents.
davescriven's avatar
davescriven committed
120
121
122
123
        /// </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>
124
        public static T Open<T>(string path) where T : SvgDocument, new()
125
        {
126
            return Open<T>(path, null);
127
128
        }

129
        /// <summary>
130
        /// Opens the document at the specified path and loads the SVG contents.
131
132
133
134
        /// </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>
135
        /// <exception cref="FileNotFoundException">The document at the specified <paramref name="path"/> cannot be found.</exception>
136
        public static T Open<T>(string path, Dictionary<string, string> entities) where T : SvgDocument, new()
davescriven's avatar
davescriven committed
137
        {
138
139
140
141
142
            if (string.IsNullOrEmpty(path))
            {
                throw new ArgumentNullException("path");
            }

davescriven's avatar
davescriven committed
143
            if (!File.Exists(path))
144
            {
davescriven's avatar
davescriven committed
145
                throw new FileNotFoundException("The specified document cannot be found.", path);
146
            }
davescriven's avatar
davescriven committed
147

148
            return Open<T>(File.OpenRead(path), entities);
davescriven's avatar
davescriven committed
149
150
        }

151
152
153
154
        /// <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>
155
        public static T Open<T>(Stream stream) where T : SvgDocument, new()
davescriven's avatar
davescriven committed
156
        {
157
            return Open<T>(stream, null);
davescriven's avatar
davescriven committed
158
159
        }

160
        /// <summary>
161
        /// Opens an SVG document from the specified <see cref="Stream"/> and adds the specified entities.
162
163
164
        /// </summary>
        /// <param name="stream">The <see cref="Stream"/> containing the SVG document to open.</param>
        /// <param name="entities">Custom entity definitions.</param>
165
        /// <exception cref="ArgumentNullException">The <paramref name="stream"/> parameter cannot be <c>null</c>.</exception>
166
        public static T Open<T>(Stream stream, Dictionary<string, string> entities) where T : SvgDocument, new()
davescriven's avatar
davescriven committed
167
        {
168
169
170
171
172
            if (stream == null)
            {
                throw new ArgumentNullException("stream");
            }

173
            //Trace.TraceInformation("Begin Read");
davescriven's avatar
davescriven committed
174

175
            using (var reader = new SvgTextReader(stream, entities))
davescriven's avatar
davescriven committed
176
            {
177
178
                var elementStack = new Stack<SvgElement>();
                var value = new StringBuilder();
179
                bool elementEmpty;
davescriven's avatar
davescriven committed
180
                SvgElement element = null;
181
                SvgElement parent;
182
                T svgDocument = null;
davescriven's avatar
davescriven committed
183
184
185
186
187
188
189
190
191
192
193
194
                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)
195
                                elementEmpty = reader.IsEmptyElement;
davescriven's avatar
davescriven committed
196
197
                                // Create element
                                if (elementStack.Count > 0)
198
                                {
davescriven's avatar
davescriven committed
199
                                    element = SvgElementFactory.CreateElement(reader, svgDocument);
200
                                }
davescriven's avatar
davescriven committed
201
202
                                else
                                {
203
204
                                    svgDocument = SvgElementFactory.CreateDocument<T>(reader);
                                    element = svgDocument;
davescriven's avatar
davescriven committed
205
206
207
                                }

                                if (element == null)
208
                                {
davescriven's avatar
davescriven committed
209
                                    continue;
210
                                }
davescriven's avatar
davescriven committed
211
212
213
214
215
216
217
218
219
220
221
222

                                // 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
223
                                if (elementEmpty)
224
                                {
davescriven's avatar
davescriven committed
225
                                    goto case XmlNodeType.EndElement;
226
                                }
davescriven's avatar
davescriven committed
227
228
229

                                break;
                            case XmlNodeType.EndElement:
230
231
232
233
                                // 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
234
                                    continue;
235
                                }
davescriven's avatar
davescriven committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
                                // 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);
                    }
                }

258
                //Trace.TraceInformation("End Read");
davescriven's avatar
davescriven committed
259
260
261
262
                return svgDocument;
            }
        }

263
264
265
266
267
        /// <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>
268
        public static SvgDocument Open(XmlDocument document)
davescriven's avatar
davescriven committed
269
        {
270
271
272
273
274
            if (document == null)
            {
                throw new ArgumentNullException("document");
            }

275
            Stream stream = new MemoryStream(UTF8Encoding.Default.GetBytes(document.InnerXml));
276
            return Open<SvgDocument>(stream, null);
davescriven's avatar
davescriven committed
277
278
279
280
281
282
283
        }

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

284
        public static Bitmap OpenAsBitmap(XmlDocument document)
davescriven's avatar
davescriven committed
285
286
287
288
289
290
        {
            return null;
        }

        public RectangleF GetDimensions()
        {
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
        	var w = Width.ToDeviceValue();
        	var h = Height.ToDeviceValue();
        	
        	RectangleF bounds = new RectangleF();
        	var isWidthperc = Width.Type == SvgUnitType.Percentage;
        	var isHeightperc = Height.Type == SvgUnitType.Percentage;

        	if(isWidthperc || isHeightperc)
        	{
        		bounds = this.Bounds; //do just one call to the recursive bounds property
        		if(isWidthperc) w = (bounds.Width + bounds.X) * (w * 0.01f);
        		if(isHeightperc) h = (bounds.Height + bounds.Y) * (h * 0.01f);
        	}
        	
            return new RectangleF(0, 0, w, h);
davescriven's avatar
davescriven committed
306
307
        }

308
309
310
311
        /// <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>
312
        /// <exception cref="ArgumentNullException">The <paramref name="renderer"/> parameter cannot be <c>null</c>.</exception>
313
        public void Draw(SvgRenderer renderer)
davescriven's avatar
davescriven committed
314
        {
315
316
317
318
319
            if (renderer == null)
            {
                throw new ArgumentNullException("renderer");
            }

320
            this.Render(renderer);
davescriven's avatar
davescriven committed
321
322
        }

323
324
325
326
327
328
329
330
331
332
333
334
        /// <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");
            }

335
            this.Render(SvgRenderer.FromGraphics(graphics));
336
337
        }

338
339
340
341
        /// <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
342
343
        public virtual Bitmap Draw()
        {
344
            //Trace.TraceInformation("Begin Render");
davescriven's avatar
davescriven committed
345

346
            var size = GetDimensions();
347
            var bitmap = new Bitmap((int)Math.Ceiling(size.Width), (int)Math.Ceiling(size.Height));
348
       // 	bitmap.SetResolution(300, 300);
Tebjan Halm's avatar
Tebjan Halm committed
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
            try
            {
                Draw(bitmap);
            }
            catch
            {
                bitmap.Dispose();
                throw;
            }

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

        /// <summary>
        /// Renders the <see cref="SvgDocument"/> into a given Bitmap <see cref="Bitmap"/>.
        /// </summary>
        public virtual void Draw(Bitmap bitmap)
        {
            //Trace.TraceInformation("Begin Render");

370
            try
davescriven's avatar
davescriven committed
371
            {
372
                using (var renderer = SvgRenderer.FromImage(bitmap))
373
                {
374
375
376
377
378
                    renderer.TextRenderingHint = TextRenderingHint.AntiAlias;
                    renderer.TextContrast = 1;
                    renderer.PixelOffsetMode = PixelOffsetMode.Half;
                    this.Render(renderer);
                    renderer.Save();
379
380
381
382
383
                }
            }
            catch
            {
                throw;
davescriven's avatar
davescriven committed
384
385
            }

386
            //Trace.TraceInformation("End Render");
davescriven's avatar
davescriven committed
387
388
389
390
        }

        public void Write(Stream stream)
        {
Tebjan Halm's avatar
Tebjan Halm committed
391
392
393

            var xmlWriter = new XmlTextWriter(stream, Encoding.UTF8);
            xmlWriter.Formatting = Formatting.Indented;
394

Tebjan Halm's avatar
Tebjan Halm committed
395
396
397
398
            xmlWriter.WriteDocType("svg", "-//W3C//DTD SVG 1.1//EN", "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd", null);

            this.WriteElement(xmlWriter);

Tebjan Halm's avatar
Tebjan Halm committed
399
            xmlWriter.Flush();
davescriven's avatar
davescriven committed
400
401
402
403
        }

        public void Write(string path)
        {
Tebjan Halm's avatar
Tebjan Halm committed
404
405
406
407
            using(var fs = new FileStream(path, FileMode.Create, FileAccess.Write))
            {
                this.Write(fs);
            }
davescriven's avatar
davescriven committed
408
        }
409

davescriven's avatar
davescriven committed
410
411
    }
}