ensure the file is closed in XmlWriter.Create(filename)
[mono.git] / mcs / class / System.XML / System.Xml / XmlException.cs
1 //
2 // XmlException.cs
3 //
4 // Author:
5 //   Jason Diamond (jason@injektilo.org)
6 //   Atsushi Enomoto (atsushi@ximian.com)
7 //
8 // (C) 2002 Jason Diamond  http://injektilo.org/
9 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
10 //
11 // Permission is hereby granted, free of charge, to any person obtaining
12 // a copy of this software and associated documentation files (the
13 // "Software"), to deal in the Software without restriction, including
14 // without limitation the rights to use, copy, modify, merge, publish,
15 // distribute, sublicense, and/or sell copies of the Software, and to
16 // permit persons to whom the Software is furnished to do so, subject to
17 // the following conditions:
18 // 
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
21 // 
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 //
30
31 using System.Globalization;
32 using System.Runtime.Serialization;
33 using System.Security.Permissions;
34
35 namespace System.Xml
36 {
37         [Serializable]
38         public class XmlException : SystemException
39         {
40                 #region Fields
41
42                 int lineNumber;
43                 int linePosition;
44                 string sourceUri;
45                 string res;
46                 string [] messages;
47
48                 #endregion
49
50                 #region consts
51
52                 private const string Xml_DefaultException = "Xml_DefaultException";
53                 private  const string Xml_UserException = "Xml_UserException";
54
55                 #endregion
56
57                 #region Constructors
58
59                 public XmlException () 
60                         : base ()
61                 {
62                         this.res = Xml_DefaultException;
63                         this.messages = new string [1];
64                 }
65
66                 public XmlException (string message, Exception innerException) 
67                         : base (message, innerException)
68                 {
69                         this.res = Xml_UserException;
70                         this.messages = new string [] {message};
71                 }
72
73                 protected XmlException (SerializationInfo info, StreamingContext context)
74                         : base (info, context)
75                 {
76                         this.lineNumber = info.GetInt32 ("lineNumber");
77                         this.linePosition = info.GetInt32 ("linePosition");
78                         this.res = info.GetString ("res");
79                         this.messages = (string []) info.GetValue ("args", typeof(string []));
80 #if NET_2_0
81                         this.sourceUri = info.GetString ("sourceUri");
82 #endif
83                 }
84
85                 public XmlException (string message)
86                         : base (message)
87                 {
88                         this.res = Xml_UserException;
89                         this.messages = new string [] {message};
90                 }
91
92                 internal XmlException (IXmlLineInfo li,
93                         string sourceUri,
94                         string message)
95                         : this (li, null, sourceUri, message)
96                 {
97                 }
98
99                 internal XmlException (IXmlLineInfo li,
100                         Exception innerException,
101                         string sourceUri,
102                         string message)
103                         : this (message, innerException)
104                 {
105                         if (li != null) {
106                                 this.lineNumber = li.LineNumber;
107                                 this.linePosition = li.LinePosition;
108                         }
109                         this.sourceUri = sourceUri;
110                 }
111
112                 public XmlException (string message, Exception innerException, int lineNumber, int linePosition)
113                         : this (message, innerException)
114                 {
115                         this.lineNumber = lineNumber;
116                         this.linePosition = linePosition;
117                 }
118
119                 #endregion
120
121                 #region Properties
122
123                 public int LineNumber {
124                         get { return lineNumber; }
125                 }
126
127                 public int LinePosition {
128                         get { return linePosition; }
129                 }
130
131 #if NET_2_0
132                 public string SourceUri {
133                         get { return sourceUri; }
134                 }
135 #endif
136
137                 public override string Message {
138                         get {
139                                 if (lineNumber == 0)
140                                         return base.Message;
141
142                                 return String.Format (CultureInfo.InvariantCulture, "{0} {3} Line {1}, position {2}.",
143                                                       base.Message, lineNumber, linePosition, sourceUri);
144                         }
145                 }
146
147                 #endregion
148
149                 #region Methods
150
151                 [SecurityPermission (SecurityAction.Demand, SerializationFormatter = true)]
152                 public override void GetObjectData (SerializationInfo info, StreamingContext context)
153                 {
154                         base.GetObjectData (info, context);
155                         info.AddValue ("lineNumber", lineNumber);
156                         info.AddValue ("linePosition", linePosition);
157                         info.AddValue ("res", res);
158                         info.AddValue ("args", messages);
159 #if NET_2_0
160                         info.AddValue ("sourceUri", sourceUri);
161 #endif
162                 }
163
164                 #endregion
165         }
166 }