SvgDocument.cs 15.1 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
using System.IO;
using System.Text;
using System.Xml;
Tebjan Halm's avatar
Tebjan Halm committed
11
12
using System.Threading;
using System.Globalization;
davescriven's avatar
davescriven committed
13
14
15
16

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

davescriven's avatar
davescriven committed
24

25

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

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

46
                return _idManager;
davescriven's avatar
davescriven committed
47
48
49
            }
        }

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

        #region ITypeDescriptorContext Members

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

62
        object ITypeDescriptorContext.Instance
davescriven's avatar
davescriven committed
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
95
96
            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
97
98
        }

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

120
        /// <summary>
121
        /// Opens the document at the specified path and loads the SVG contents.
122
123
124
125
        /// </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>
126
        /// <exception cref="FileNotFoundException">The document at the specified <paramref name="path"/> cannot be found.</exception>
127
        public static SvgDocument Open(string path, Dictionary<string, string> entities)
davescriven's avatar
davescriven committed
128
        {
129
130
131
132
133
            if (string.IsNullOrEmpty(path))
            {
                throw new ArgumentNullException("path");
            }

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

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

142
143
144
145
        /// <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
146
147
148
149
150
        public static SvgDocument Open(Stream stream)
        {
            return Open(stream, null);
        }

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

164
            //Trace.TraceInformation("Begin Read");
davescriven's avatar
davescriven committed
165

166
            using (var reader = new SvgTextReader(stream, entities))
davescriven's avatar
davescriven committed
167
            {
168
169
                var elementStack = new Stack<SvgElement>();
                var value = new StringBuilder();
170
                bool elementEmpty;
davescriven's avatar
davescriven committed
171
                SvgElement element = null;
172
                SvgElement parent;
davescriven's avatar
davescriven committed
173
174
175
176
177
178
179
180
181
182
183
184
185
                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)
186
                                elementEmpty = reader.IsEmptyElement;
davescriven's avatar
davescriven committed
187
188
                                // Create element
                                if (elementStack.Count > 0)
189
                                {
davescriven's avatar
davescriven committed
190
                                    element = SvgElementFactory.CreateElement(reader, svgDocument);
191
                                }
davescriven's avatar
davescriven committed
192
193
194
                                else
                                {
                                    element = SvgElementFactory.CreateDocument(reader);
195
                                    svgDocument = (SvgDocument)element;
davescriven's avatar
davescriven committed
196
197
198
                                }

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

                                // 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
214
                                if (elementEmpty)
215
                                {
davescriven's avatar
davescriven committed
216
                                    goto case XmlNodeType.EndElement;
217
                                }
davescriven's avatar
davescriven committed
218
219
220

                                break;
                            case XmlNodeType.EndElement:
221
222
223
224
                                // 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
225
                                    continue;
226
                                }
davescriven's avatar
davescriven committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
                                // 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);
                    }
                }

249
                //Trace.TraceInformation("End Read");
davescriven's avatar
davescriven committed
250
251
252
253
                return svgDocument;
            }
        }

254
255
256
257
258
        /// <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>
259
        public static SvgDocument Open(XmlDocument document)
davescriven's avatar
davescriven committed
260
        {
261
262
263
264
265
            if (document == null)
            {
                throw new ArgumentNullException("document");
            }

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

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

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

        public RectangleF GetDimensions()
        {
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
        	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
297
298
        }

299
300
301
302
        /// <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>
303
        /// <exception cref="ArgumentNullException">The <paramref name="renderer"/> parameter cannot be <c>null</c>.</exception>
304
        public void Draw(SvgRenderer renderer)
davescriven's avatar
davescriven committed
305
        {
306
307
308
309
310
            if (renderer == null)
            {
                throw new ArgumentNullException("renderer");
            }

311
            this.Render(renderer);
davescriven's avatar
davescriven committed
312
313
        }

314
315
316
317
318
319
320
321
322
323
324
325
        /// <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");
            }

326
            this.Render(SvgRenderer.FromGraphics(graphics));
327
328
        }

329
330
331
332
        /// <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
333
334
        public virtual Bitmap Draw()
        {
335
            //Trace.TraceInformation("Begin Render");
davescriven's avatar
davescriven committed
336

337
            var size = GetDimensions();
338
            var bitmap = new Bitmap((int)Math.Ceiling(size.Width), (int)Math.Ceiling(size.Height));
339
       // 	bitmap.SetResolution(300, 300);
Tebjan Halm's avatar
Tebjan Halm committed
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
            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");

361
            try
davescriven's avatar
davescriven committed
362
            {
363
                using (var renderer = SvgRenderer.FromImage(bitmap))
364
                {
365
366
367
368
369
                    renderer.TextRenderingHint = TextRenderingHint.AntiAlias;
                    renderer.TextContrast = 1;
                    renderer.PixelOffsetMode = PixelOffsetMode.Half;
                    this.Render(renderer);
                    renderer.Save();
370
371
372
373
374
                }
            }
            catch
            {
                throw;
davescriven's avatar
davescriven committed
375
376
            }

377
            //Trace.TraceInformation("End Render");
davescriven's avatar
davescriven committed
378
379
380
381
        }

        public void Write(Stream stream)
        {
Tebjan Halm's avatar
Tebjan Halm committed
382
383
384
385
386
387
            //Save previous culture and switch to invariant for writing
            var previousCulture = Thread.CurrentThread.CurrentCulture;
            Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture;

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

Tebjan Halm's avatar
Tebjan Halm committed
389
390
391
392
            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
393
            xmlWriter.Flush();
Tebjan Halm's avatar
Tebjan Halm committed
394
395

            Thread.CurrentThread.CurrentCulture = previousCulture;
davescriven's avatar
davescriven committed
396
397
398
399
        }

        public void Write(string path)
        {
Tebjan Halm's avatar
Tebjan Halm committed
400
401
402
403
            using(var fs = new FileStream(path, FileMode.Create, FileAccess.Write))
            {
                this.Write(fs);
            }
davescriven's avatar
davescriven committed
404
        }
405

davescriven's avatar
davescriven committed
406
407
    }
}