SvgDocument.cs 15 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
    /// </summary>
    public class SvgDocument : SvgFragment, ITypeDescriptorContext
    {
19
        public static readonly int PointsPerInch = 96;
20
        private SvgElementIdManager _idManager;
21

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

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

42
                return _idManager;
davescriven's avatar
davescriven committed
43
44
            }
        }
45
46
47
48
49
50
51
52
53
        
        /// <summary>
        /// Overwrites the current IdManager with a custom implementation. 
        /// Be careful with this: If elements have been inserted into the document before,
        /// you have to take care that the new IdManager also knows of them.
        /// </summary>
        /// <param name="manager"></param>
        public void OverwriteIdManager(SvgElementIdManager manager)
        {
James Welle's avatar
James Welle committed
54
            _idManager = manager;
55
        }
davescriven's avatar
davescriven committed
56

57
58
59
        /// <summary>
        /// Gets or sets the Pixels Per Inch of the rendered image.
        /// </summary>
60
61
62
63
64
        public int Ppi { get; set; }

        #region ITypeDescriptorContext Members

        IContainer ITypeDescriptorContext.Container
davescriven's avatar
davescriven committed
65
        {
66
            get { throw new NotImplementedException(); }
davescriven's avatar
davescriven committed
67
68
        }

69
        object ITypeDescriptorContext.Instance
davescriven's avatar
davescriven committed
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
99
100
101
102
103
            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
104
105
        }

106
107
108
109
110
111
112
113
114
        /// <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);
        }
115
116
117
118
119
120
121
122
123
124
125
        
                /// <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);
        }
126

davescriven's avatar
davescriven committed
127
        /// <summary>
128
        /// Opens the document at the specified path and loads the SVG contents.
davescriven's avatar
davescriven committed
129
130
131
132
        /// </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>
133
        public static T Open<T>(string path) where T : SvgDocument, new()
134
        {
135
            return Open<T>(path, null);
136
137
        }

138
        /// <summary>
139
        /// Opens the document at the specified path and loads the SVG contents.
140
141
142
143
        /// </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>
144
        /// <exception cref="FileNotFoundException">The document at the specified <paramref name="path"/> cannot be found.</exception>
145
        public static T Open<T>(string path, Dictionary<string, string> entities) where T : SvgDocument, new()
davescriven's avatar
davescriven committed
146
        {
147
148
149
150
151
            if (string.IsNullOrEmpty(path))
            {
                throw new ArgumentNullException("path");
            }

davescriven's avatar
davescriven committed
152
            if (!File.Exists(path))
153
            {
davescriven's avatar
davescriven committed
154
                throw new FileNotFoundException("The specified document cannot be found.", path);
155
            }
davescriven's avatar
davescriven committed
156

157
            return Open<T>(File.OpenRead(path), entities);
davescriven's avatar
davescriven committed
158
159
        }

160
161
162
163
        /// <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>
164
        public static T Open<T>(Stream stream) where T : SvgDocument, new()
davescriven's avatar
davescriven committed
165
        {
166
            return Open<T>(stream, null);
davescriven's avatar
davescriven committed
167
168
        }

169
        /// <summary>
170
        /// Opens an SVG document from the specified <see cref="Stream"/> and adds the specified entities.
171
172
173
        /// </summary>
        /// <param name="stream">The <see cref="Stream"/> containing the SVG document to open.</param>
        /// <param name="entities">Custom entity definitions.</param>
174
        /// <exception cref="ArgumentNullException">The <paramref name="stream"/> parameter cannot be <c>null</c>.</exception>
175
        public static T Open<T>(Stream stream, Dictionary<string, string> entities) where T : SvgDocument, new()
davescriven's avatar
davescriven committed
176
        {
177
178
179
180
181
            if (stream == null)
            {
                throw new ArgumentNullException("stream");
            }

182
            //Trace.TraceInformation("Begin Read");
davescriven's avatar
davescriven committed
183

184
            using (var reader = new SvgTextReader(stream, entities))
davescriven's avatar
davescriven committed
185
            {
186
187
                var elementStack = new Stack<SvgElement>();
                var value = new StringBuilder();
188
                bool elementEmpty;
davescriven's avatar
davescriven committed
189
                SvgElement element = null;
190
                SvgElement parent;
191
                T svgDocument = null;
davescriven's avatar
davescriven committed
192
193
194
195
196
197
198
199
200
201
202
203
                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)
204
                                elementEmpty = reader.IsEmptyElement;
davescriven's avatar
davescriven committed
205
206
                                // Create element
                                if (elementStack.Count > 0)
207
                                {
davescriven's avatar
davescriven committed
208
                                    element = SvgElementFactory.CreateElement(reader, svgDocument);
209
                                }
davescriven's avatar
davescriven committed
210
211
                                else
                                {
212
213
                                    svgDocument = SvgElementFactory.CreateDocument<T>(reader);
                                    element = svgDocument;
davescriven's avatar
davescriven committed
214
215
216
217
218
219
                                }

                                // Add to the parents children
                                if (elementStack.Count > 0)
                                {
                                    parent = elementStack.Peek();
220
221
                                    if (parent != null && element != null)
                                        parent.Children.Add(element);
davescriven's avatar
davescriven committed
222
223
224
225
226
227
                                }

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

                                // Need to process if the element is empty
228
                                if (elementEmpty)
229
                                {
davescriven's avatar
davescriven committed
230
                                    goto case XmlNodeType.EndElement;
231
                                }
davescriven's avatar
davescriven committed
232
233
234

                                break;
                            case XmlNodeType.EndElement:
tebjan's avatar
tebjan committed
235

davescriven's avatar
davescriven committed
236
237
238
                                // Pop the element out of the stack
                                element = elementStack.Pop();

tebjan's avatar
tebjan committed
239
                                if (value.Length > 0 && element != null)
davescriven's avatar
davescriven committed
240
                                {
tebjan's avatar
tebjan committed
241
242
                                    element.Content = value.ToString();
                                    
davescriven's avatar
davescriven committed
243
                                    // Reset content value for new element
244
                                    value.Clear();
davescriven's avatar
davescriven committed
245
246
247
248
249
250
                                }
                                break;
                            case XmlNodeType.CDATA:
                            case XmlNodeType.Text:
                                value.Append(reader.Value);
                                break;
251
252
253
254
                            case XmlNodeType.EntityReference:
                                reader.ResolveEntity();
                                value.Append(reader.Value);
                                break;
davescriven's avatar
davescriven committed
255
256
257
258
259
260
261
262
                        }
                    }
                    catch (Exception exc)
                    {
                        Trace.TraceError(exc.Message);
                    }
                }

263
                //Trace.TraceInformation("End Read");
davescriven's avatar
davescriven committed
264
265
266
267
                return svgDocument;
            }
        }

268
269
270
271
272
        /// <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>
273
        public static SvgDocument Open(XmlDocument document)
davescriven's avatar
davescriven committed
274
        {
275
276
277
278
279
            if (document == null)
            {
                throw new ArgumentNullException("document");
            }

280
281
            Stream stream = new MemoryStream(UTF8Encoding.Default.GetBytes(document.InnerXml));
            return Open<SvgDocument>(stream, null);
davescriven's avatar
davescriven committed
282
283
284
285
286
287
288
        }

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

289
        public static Bitmap OpenAsBitmap(XmlDocument document)
davescriven's avatar
davescriven committed
290
291
292
293
        {
            return null;
        }

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

306
            this.Render(renderer);
davescriven's avatar
davescriven committed
307
308
        }

309
310
311
312
313
314
315
316
317
318
319
320
        /// <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");
            }

321
            this.Render(SvgRenderer.FromGraphics(graphics));
322
323
        }

324
325
326
327
        /// <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
328
329
        public virtual Bitmap Draw()
        {
330
            //Trace.TraceInformation("Begin Render");
davescriven's avatar
davescriven committed
331

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

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

372
            //Trace.TraceInformation("End Render");
davescriven's avatar
davescriven committed
373
374
375
376
        }

        public void Write(Stream stream)
        {
Tebjan Halm's avatar
Tebjan Halm committed
377
378
379

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

Tebjan Halm's avatar
Tebjan Halm committed
381
382
383
384
            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
385
            xmlWriter.Flush();
davescriven's avatar
davescriven committed
386
387
388
389
        }

        public void Write(string path)
        {
Tebjan Halm's avatar
Tebjan Halm committed
390
391
392
393
            using(var fs = new FileStream(path, FileMode.Create, FileAccess.Write))
            {
                this.Write(fs);
            }
davescriven's avatar
davescriven committed
394
395
        }
    }
396
}