2 // System.Xml.XmlConvert
5 // Dwivedi, Ajay kumar (Adwiv@Yahoo.com)
6 // Gonzalo Paniagua Javier (gonzalo@ximian.com)
7 // Alan Tam Siu Lung (Tam@SiuLung.com)
8 // Atsushi Enomoto (ginga@kit.hi-ho.ne.jp)
10 // (C) 2002 Ximian, Inc (http://www.ximian.com)
14 // Permission is hereby granted, free of charge, to any person obtaining
15 // a copy of this software and associated documentation files (the
16 // "Software"), to deal in the Software without restriction, including
17 // without limitation the rights to use, copy, modify, merge, publish,
18 // distribute, sublicense, and/or sell copies of the Software, and to
19 // permit persons to whom the Software is furnished to do so, subject to
20 // the following conditions:
22 // The above copyright notice and this permission notice shall be
23 // included in all copies or substantial portions of the Software.
25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 using System.Globalization;
37 using System.Xml.Schema;
39 namespace System.Xml {
41 public class XmlConvert {
43 const string encodedColon = "_x003A_";
44 const NumberStyles floatStyle = NumberStyles.AllowCurrencySymbol |
45 NumberStyles.AllowExponent |
46 NumberStyles.AllowDecimalPoint |
47 NumberStyles.AllowLeadingSign;
49 static readonly string [] datetimeFormats = {
51 "yyyy-MM-ddTHH:mm:ss",
52 "yyyy-MM-ddTHH:mm:ss.f",
53 "yyyy-MM-ddTHH:mm:ss.ff",
54 "yyyy-MM-ddTHH:mm:ss.fff",
55 "yyyy-MM-ddTHH:mm:ss.ffff",
56 "yyyy-MM-ddTHH:mm:ss.fffff",
57 "yyyy-MM-ddTHH:mm:ss.ffffff",
58 "yyyy-MM-ddTHH:mm:ss.fffffff",
59 "yyyy-MM-ddTHH:mm:sszzz",
60 "yyyy-MM-ddTHH:mm:ss.fzzz",
61 "yyyy-MM-ddTHH:mm:ss.ffzzz",
62 "yyyy-MM-ddTHH:mm:ss.fffzzz",
63 "yyyy-MM-ddTHH:mm:ss.ffffzzz",
64 "yyyy-MM-ddTHH:mm:ss.fffffzzz",
65 "yyyy-MM-ddTHH:mm:ss.ffffffzzz",
66 "yyyy-MM-ddTHH:mm:ss.fffffffzzz",
67 "yyyy-MM-ddTHH:mm:ssZ",
68 "yyyy-MM-ddTHH:mm:ss.fZ",
69 "yyyy-MM-ddTHH:mm:ss.ffZ",
70 "yyyy-MM-ddTHH:mm:ss.fffZ",
71 "yyyy-MM-ddTHH:mm:ss.ffffZ",
72 "yyyy-MM-ddTHH:mm:ss.fffffZ",
73 "yyyy-MM-ddTHH:mm:ss.ffffffZ",
74 "yyyy-MM-ddTHH:mm:ss.fffffffZ",
91 "HH:mm:ss.fffffffzzz",
123 static readonly string [] defaultDateTimeFormats = new string [] {
124 "yyyy-MM-ddTHH:mm:ss", // dateTime(1)
125 "yyyy-MM-ddTHH:mm:ss.FFFFFFF", // dateTime(2)
126 "yyyy-MM-dd", // date
128 "yyyy-MM", // gYearMonth
130 "--MM-dd", // gMonthDay
134 static readonly string [] roundtripDateTimeFormats;
135 static readonly string [] localDateTimeFormats;
136 static readonly string [] utcDateTimeFormats;
137 static readonly string [] unspecifiedDateTimeFormats;
141 int l = defaultDateTimeFormats.Length;
142 roundtripDateTimeFormats = new string [l];
143 localDateTimeFormats = new string [l];
144 utcDateTimeFormats = new string [l * 3];
145 unspecifiedDateTimeFormats = new string [l * 4];
146 for (int i = 0; i < l; i++) {
147 string s = defaultDateTimeFormats [i];
148 localDateTimeFormats [i] = s + "zzz";
149 roundtripDateTimeFormats [i] = s + 'K';
150 utcDateTimeFormats [i * 3] = s;
151 utcDateTimeFormats [i * 3 + 1] = s + 'Z';
152 utcDateTimeFormats [i * 3 + 2] = s + "zzz";
153 unspecifiedDateTimeFormats [i * 4] = s;
154 unspecifiedDateTimeFormats [i * 4 + 1] = localDateTimeFormats [i];
155 unspecifiedDateTimeFormats [i * 4 + 2] = roundtripDateTimeFormats [i];
156 unspecifiedDateTimeFormats [i * 4 + 3] = utcDateTimeFormats [i];
160 static DateTimeStyles _defaultStyle = DateTimeStyles.AllowLeadingWhite | DateTimeStyles.AllowTrailingWhite;
165 private static string TryDecoding (string s)
167 if (s == null || s.Length < 6)
172 c = (char) Int32.Parse (s.Substring (1, 4), NumberStyles.HexNumber, CultureInfo.InvariantCulture);
174 return s [0] + DecodeName (s.Substring (1));
178 return c.ToString ();
179 return c + DecodeName (s.Substring (6));
182 public static string DecodeName (string name)
184 if (name == null || name.Length == 0)
187 int pos = name.IndexOf ('_');
188 if (pos == -1 || pos + 6 >= name.Length)
191 if ((name [pos + 1] != 'X' && name [pos + 1] != 'x') || name [pos + 6] != '_')
192 return name [0] + DecodeName (name.Substring (1));
194 return name.Substring (0, pos) + TryDecoding (name.Substring (pos + 1));
197 public static string EncodeLocalName (string name)
202 string encoded = EncodeName (name);
203 int pos = encoded.IndexOf (':');
206 return encoded.Replace (":", encodedColon);
209 internal static bool IsInvalid (char c, bool firstOnlyLetter)
211 if (c == ':') // Special case. allowed in EncodeName, but encoded in EncodeLocalName
215 return !XmlChar.IsFirstNameChar (c);
217 return !XmlChar.IsNameChar (c);
220 private static string EncodeName (string name, bool nmtoken)
222 if (name == null || name.Length == 0)
225 StringBuilder sb = new StringBuilder ();
226 int length = name.Length;
227 for (int i = 0; i < length; i++) {
229 if (IsInvalid (c, i == 0 && !nmtoken))
230 sb.AppendFormat ("_x{0:X4}_", (int) c);
231 else if (c == '_' && i + 6 < length && name [i+1] == 'x' && name [i + 6] == '_')
232 sb.Append ("_x005F_");
236 return sb.ToString ();
239 public static string EncodeName (string name)
241 return EncodeName (name, false);
244 public static string EncodeNmToken (string name)
246 if (name == String.Empty)
247 throw new XmlException ("Invalid NmToken: ''");
248 return EncodeName (name, true);
251 // {true, false, 1, 0}
252 public static bool ToBoolean(string s)
254 s = s.Trim (XmlChar.WhitespaceChars);
266 throw new FormatException(s + " is not a valid boolean value");
270 // LAMESPEC: It has been documented as public, but is marked as internal.
271 internal static string ToBinHexString (byte [] buffer)
273 StringWriter w = new StringWriter ();
274 WriteBinHex (buffer, 0, buffer.Length, w);
275 return w.ToString ();
278 internal static void WriteBinHex (byte [] buffer, int index, int count, TextWriter w)
281 throw new ArgumentNullException ("buffer");
283 throw new ArgumentOutOfRangeException (
287 "index must be non negative integer.");
290 throw new ArgumentOutOfRangeException (
294 "count must be non negative integer.");
296 if (buffer.Length < index + count)
297 throw new ArgumentOutOfRangeException ("index and count must be smaller than the length of the buffer.");
299 // Copied from XmlTextWriter.WriteBinHex ()
300 int end = index + count;
301 for (int i = index; i < end; i++) {
302 int val = buffer [i];
306 w.Write ((char) (high + 55));
308 w.Write ((char) (high + 0x30));
310 w.Write ((char) (low + 55));
312 w.Write ((char) (low + 0x30));
316 public static byte ToByte(string s)
318 return Byte.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
321 public static char ToChar(string s)
324 return Char.Parse(s);
327 throw new ArgumentNullException ("s");
330 throw new FormatException ("String contain more than one char");
339 public static DateTime ToDateTime (string s)
341 return ToDateTime (s, datetimeFormats);
345 public static DateTime ToDateTime (string value, XmlDateTimeSerializationMode mode)
349 case XmlDateTimeSerializationMode.Local:
350 dt = ToDateTime (value, localDateTimeFormats);
351 return dt == DateTime.MinValue || dt == DateTime.MaxValue ? dt : dt.ToLocalTime ();
352 case XmlDateTimeSerializationMode.RoundtripKind:
353 return ToDateTime (value, roundtripDateTimeFormats, _defaultStyle | DateTimeStyles.RoundtripKind);
354 case XmlDateTimeSerializationMode.Utc:
355 dt = ToDateTime (value, utcDateTimeFormats);
356 return dt == DateTime.MinValue || dt == DateTime.MaxValue ? dt : dt.ToUniversalTime ();
357 case XmlDateTimeSerializationMode.Unspecified:
358 return ToDateTime (value, unspecifiedDateTimeFormats);
360 return ToDateTime (value, defaultDateTimeFormats);
364 public static DateTime ToDateTime(string s, string format)
366 //DateTimeFormatInfo d = new DateTimeFormatInfo();
367 //d.FullDateTimePattern = format;
368 //return DateTime.Parse(s, d);
369 DateTimeStyles style = DateTimeStyles.AllowLeadingWhite |
370 DateTimeStyles.AllowTrailingWhite;
371 return DateTime.ParseExact (s, format, DateTimeFormatInfo.InvariantInfo, style);
374 public static DateTime ToDateTime(string s, string[] formats)
376 return ToDateTime (s, formats, _defaultStyle);
379 private static DateTime ToDateTime (string s, string [] formats, DateTimeStyles style)
381 return DateTime.ParseExact (s, formats, DateTimeFormatInfo.InvariantInfo, style);
384 public static Decimal ToDecimal(string s)
386 return Decimal.Parse(s, CultureInfo.InvariantCulture);
389 public static double ToDouble(string s)
392 throw new ArgumentNullException();
394 return Double.PositiveInfinity;
396 return Double.NegativeInfinity;
399 return Double.Parse (s, floatStyle, CultureInfo.InvariantCulture);
402 public static Guid ToGuid(string s)
407 public static short ToInt16(string s)
409 return Int16.Parse (s, NumberStyles.Integer, CultureInfo.InvariantCulture);
412 public static int ToInt32(string s)
414 return Int32.Parse (s, NumberStyles.Integer, CultureInfo.InvariantCulture);
417 public static long ToInt64(string s)
419 return Int64.Parse (s, NumberStyles.Integer, CultureInfo.InvariantCulture);
422 [CLSCompliant (false)]
423 public static SByte ToSByte(string s)
425 return SByte.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
428 public static float ToSingle(string s)
431 throw new ArgumentNullException();
433 return Single.PositiveInfinity;
435 return Single.NegativeInfinity;
438 return Single.Parse(s, floatStyle, CultureInfo.InvariantCulture);
441 public static string ToString(Guid value)
443 return value.ToString("D", CultureInfo.InvariantCulture);
446 public static string ToString(int value)
448 return value.ToString(CultureInfo.InvariantCulture);
451 public static string ToString(short value)
453 return value.ToString(CultureInfo.InvariantCulture);
456 public static string ToString(byte value)
458 return value.ToString(CultureInfo.InvariantCulture);
461 public static string ToString(long value)
463 return value.ToString(CultureInfo.InvariantCulture);
466 public static string ToString(char value)
468 return value.ToString(CultureInfo.InvariantCulture);
471 public static string ToString(bool value)
473 if (value) return "true";
477 [CLSCompliant (false)]
478 public static string ToString(SByte value)
480 return value.ToString(CultureInfo.InvariantCulture);
483 public static string ToString(Decimal value)
485 return value.ToString (CultureInfo.InvariantCulture);
488 [CLSCompliant (false)]
489 public static string ToString(UInt64 value)
491 return value.ToString(CultureInfo.InvariantCulture);
494 public static string ToString (TimeSpan value)
496 if (value == TimeSpan.Zero)
499 StringBuilder builder = new StringBuilder ();
500 if (value.Ticks < 0) {
501 builder.Append ('-');
502 value = value.Negate ();
504 builder.Append ('P');
506 builder.Append (value.Days).Append ('D');
507 if (value.Days > 0 || value.Hours > 0 || value.Minutes > 0 || value.Seconds > 0 || value.Milliseconds > 0) {
510 builder.Append (value.Hours).Append ('H');
511 if (value.Minutes > 0)
512 builder.Append (value.Minutes).Append ('M');
513 if (value.Seconds > 0 || value.Milliseconds > 0) {
514 builder.Append (value.Seconds);
515 long ticks = value.Ticks % TimeSpan.TicksPerMillisecond;
517 builder.Append ('.').AppendFormat ("{0:0000000}", value.Ticks % TimeSpan.TicksPerSecond);
518 else if (value.Milliseconds > 0)
519 builder.Append ('.').AppendFormat ("{0:000}", value.Milliseconds);
521 builder.Append ('S');
524 return builder.ToString ();
527 public static string ToString(double value)
529 if (Double.IsNegativeInfinity(value)) return "-INF";
530 if (Double.IsPositiveInfinity(value)) return "INF";
531 if (Double.IsNaN(value)) return "NaN";
532 return value.ToString("R", CultureInfo.InvariantCulture);
535 public static string ToString(float value)
537 if (Single.IsNegativeInfinity(value)) return "-INF";
538 if (Single.IsPositiveInfinity(value)) return "INF";
539 if (Single.IsNaN(value)) return "NaN";
540 return value.ToString("R", CultureInfo.InvariantCulture);
543 [CLSCompliant (false)]
544 public static string ToString(UInt32 value)
546 return value.ToString(CultureInfo.InvariantCulture);
549 [CLSCompliant (false)]
550 public static string ToString(UInt16 value)
552 return value.ToString(CultureInfo.InvariantCulture);
558 public static string ToString (DateTime value)
560 return value.ToString ("yyyy-MM-ddTHH:mm:ss.fffffffzzz", CultureInfo.InvariantCulture);
564 public static string ToString (DateTime value, XmlDateTimeSerializationMode mode)
566 // Unlike usual DateTime formatting, it preserves
567 // MaxValue/MinValue as is.
569 case XmlDateTimeSerializationMode.Local:
570 return (value == DateTime.MinValue ? DateTime.MinValue : value == DateTime.MaxValue ? value : value.ToLocalTime ()).ToString (
571 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
572 CultureInfo.InvariantCulture);
573 case XmlDateTimeSerializationMode.RoundtripKind:
574 return value.ToString (
575 "yyyy-MM-ddTHH:mm:ss.FFFFFFFK",
576 CultureInfo.InvariantCulture);
578 return value.ToString (
579 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
580 CultureInfo.InvariantCulture);
581 case XmlDateTimeSerializationMode.Utc:
582 return (value == DateTime.MinValue ? DateTime.MinValue : value == DateTime.MaxValue ? value : value.ToUniversalTime ()).ToString (
583 "yyyy-MM-ddTHH:mm:ss.FFFFFFFZ",
584 CultureInfo.InvariantCulture);
585 case XmlDateTimeSerializationMode.Unspecified:
586 return value.ToString (
587 "yyyy-MM-ddTHH:mm:ss.FFFFFFF",
588 CultureInfo.InvariantCulture);
593 public static string ToString(DateTime value, string format)
595 return value.ToString(format, CultureInfo.InvariantCulture);
598 public static TimeSpan ToTimeSpan(string s)
601 throw new ArgumentException ("Invalid format string for duration schema datatype.");
606 bool minusValue = (start == 1);
608 if (s [start] != 'P')
609 throw new ArgumentException ("Invalid format string for duration schema datatype.");
619 int parsedDigits = 0;
624 while (i < s.Length) {
632 for (; i < s.Length; i++)
633 if (s [i] < '0' || '9' < s [i])
636 parsedDigits = i - start;
637 int value = int.Parse (s.Substring (start, i - start), CultureInfo.InvariantCulture);
638 if (parseStep == 7) {
639 // adjust to 7 digits so that it makes sense as millisecond digits
640 for (; parsedDigits > 7; parsedDigits--)
642 for (; parsedDigits < 7; parsedDigits++)
655 days += 365 * (value / 12) + 30 * (value % 12);
657 } else if (isTime && parseStep < 6) {
673 if (!isTime || parseStep > 4)
683 if (!isTime || parseStep > 7)
704 throw new ArgumentException ("Invalid format string for duration schema datatype.");
705 TimeSpan ts = new TimeSpan (days, hours, minutes, seconds);
707 return TimeSpan.FromTicks (- (ts.Ticks + ticks));
709 return TimeSpan.FromTicks (ts.Ticks + ticks);
712 [CLSCompliant (false)]
713 public static UInt16 ToUInt16(string s)
715 return UInt16.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
718 [CLSCompliant (false)]
719 public static UInt32 ToUInt32(string s)
721 return UInt32.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
724 [CLSCompliant (false)]
725 public static UInt64 ToUInt64(string s)
727 return UInt64.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
730 public static string VerifyName (string name)
732 if (name == null || name.Length == 0)
733 throw new ArgumentNullException("name");
735 if (!XmlChar.IsName (name))
736 throw new XmlException("'" + name + "' is not a valid XML Name");
741 public static string VerifyNCName (string ncname)
743 if (ncname == null || ncname.Length == 0)
744 throw new ArgumentNullException("ncname");
746 if (!XmlChar.IsNCName (ncname))
747 throw new XmlException ("'" + ncname + "' is not a valid XML NCName");
752 public static string VerifyTOKEN (string name)
754 internal static string VerifyTOKEN (string name)
758 throw new ArgumentNullException("name");
760 if (name.Length == 0)
763 if (XmlChar.IsWhitespace (name [0]) ||
764 XmlChar.IsWhitespace (name [name.Length - 1]))
765 throw new XmlException ("Whitespace characters (#xA, #xD, #x9, #x20) are not allowed as leading or trailing whitespaces of xs:token.");
767 for (int i = 0; i < name.Length; i++)
768 if (XmlChar.IsWhitespace (name [i]) && name [i] != ' ')
769 throw new XmlException ("Either #xA, #xD or #x9 are not allowed inside xs:token.");
775 public static string VerifyNMTOKEN (string name)
777 internal static string VerifyNMTOKEN (string name)
781 throw new ArgumentNullException("name");
783 if (!XmlChar.IsNmToken (name))
784 throw new XmlException("'" + name + "' is not a valid XML NMTOKEN");
789 // It is documented as public method, but in fact it is not.
790 internal static byte [] FromBinHexString (string s)
792 char [] chars = s.ToCharArray ();
793 byte [] bytes = new byte [chars.Length / 2 + chars.Length % 2];
794 FromBinHexString (chars, 0, chars.Length, bytes);
798 internal static int FromBinHexString (char [] chars, int offset, int charLength, byte [] buffer)
800 int bufIndex = offset;
801 for (int i = 0; i < charLength - 1; i += 2) {
802 buffer [bufIndex] = (chars [i] > '9' ?
803 (byte) (chars [i] - 'A' + 10) :
804 (byte) (chars [i] - '0'));
805 buffer [bufIndex] <<= 4;
806 buffer [bufIndex] += chars [i + 1] > '9' ?
807 (byte) (chars [i + 1] - 'A' + 10) :
808 (byte) (chars [i + 1] - '0');
811 if (charLength %2 != 0)
812 buffer [bufIndex++] = (byte)
813 ((chars [charLength - 1] > '9' ?
814 (byte) (chars [charLength - 1] - 'A' + 10) :
815 (byte) (chars [charLength - 1] - '0'))
818 return bufIndex - offset;
821 #if NET_2_0 // actually NET_3_5
824 public static DateTimeOffset ToDateTimeOffset (string s)
826 return ToDateTimeOffset (s, datetimeFormats);
829 public static DateTimeOffset ToDateTimeOffset (string s, string format)
831 return ToDateTimeOffset (s, format);
834 public static DateTimeOffset ToDateTimeOffset (string s, string [] formats)
836 return ToDateTimeOffset (s, formats);
839 public static string ToString (DateTimeOffset value)
841 return ToString (value, "yyyy-MM-ddTHH:mm:ss.fffffffzzz");
844 public static string ToString (DateTimeOffset value, string format)
846 return value.ToString (format, CultureInfo.InvariantCulture);