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;
140 int l = defaultDateTimeFormats.Length;
141 roundtripDateTimeFormats = new string [l];
142 localDateTimeFormats = new string [l];
143 utcDateTimeFormats = new string [l];
144 for (int i = 0; i < l; i++) {
145 string s = defaultDateTimeFormats [i];
146 localDateTimeFormats [i] = s + "zzz";
147 roundtripDateTimeFormats [i] = s + 'K';
148 utcDateTimeFormats [i] = s + 'Z';
156 private static string TryDecoding (string s)
158 if (s == null || s.Length < 6)
163 c = (char) Int32.Parse (s.Substring (1, 4), NumberStyles.HexNumber, CultureInfo.InvariantCulture);
165 return s [0] + DecodeName (s.Substring (1));
169 return c.ToString ();
170 return c + DecodeName (s.Substring (6));
173 public static string DecodeName (string name)
175 if (name == null || name.Length == 0)
178 int pos = name.IndexOf ('_');
179 if (pos == -1 || pos + 6 >= name.Length)
182 if ((name [pos + 1] != 'X' && name [pos + 1] != 'x') || name [pos + 6] != '_')
183 return name [0] + DecodeName (name.Substring (1));
185 return name.Substring (0, pos) + TryDecoding (name.Substring (pos + 1));
188 public static string EncodeLocalName (string name)
193 string encoded = EncodeName (name);
194 int pos = encoded.IndexOf (':');
197 return encoded.Replace (":", encodedColon);
200 internal static bool IsInvalid (char c, bool firstOnlyLetter)
202 if (c == ':') // Special case. allowed in EncodeName, but encoded in EncodeLocalName
206 return !XmlChar.IsFirstNameChar (c);
208 return !XmlChar.IsNameChar (c);
211 private static string EncodeName (string name, bool nmtoken)
213 if (name == null || name.Length == 0)
216 StringBuilder sb = new StringBuilder ();
217 int length = name.Length;
218 for (int i = 0; i < length; i++) {
220 if (IsInvalid (c, i == 0 && !nmtoken))
221 sb.AppendFormat ("_x{0:X4}_", (int) c);
222 else if (c == '_' && i + 6 < length && name [i+1] == 'x' && name [i + 6] == '_')
223 sb.Append ("_x005F_");
227 return sb.ToString ();
230 public static string EncodeName (string name)
232 return EncodeName (name, false);
235 public static string EncodeNmToken (string name)
237 if (name == String.Empty)
238 throw new XmlException ("Invalid NmToken: ''");
239 return EncodeName (name, true);
242 // {true, false, 1, 0}
243 public static bool ToBoolean(string s)
245 s = s.Trim (XmlChar.WhitespaceChars);
257 throw new FormatException(s + " is not a valid boolean value");
261 // LAMESPEC: It has been documented as public, but is marked as internal.
262 internal static string ToBinHexString (byte [] buffer)
264 StringWriter w = new StringWriter ();
265 WriteBinHex (buffer, 0, buffer.Length, w);
266 return w.ToString ();
269 internal static void WriteBinHex (byte [] buffer, int index, int count, TextWriter w)
272 throw new ArgumentNullException ("buffer");
274 throw new ArgumentOutOfRangeException (
278 "index must be non negative integer.");
281 throw new ArgumentOutOfRangeException (
285 "count must be non negative integer.");
287 if (buffer.Length < index + count)
288 throw new ArgumentOutOfRangeException ("index and count must be smaller than the length of the buffer.");
290 // Copied from XmlTextWriter.WriteBinHex ()
291 int end = index + count;
292 for (int i = index; i < end; i++) {
293 int val = buffer [i];
297 w.Write ((char) (high + 55));
299 w.Write ((char) (high + 0x30));
301 w.Write ((char) (low + 55));
303 w.Write ((char) (low + 0x30));
307 public static byte ToByte(string s)
309 return Byte.Parse(s, CultureInfo.InvariantCulture);
312 public static char ToChar(string s)
314 return Char.Parse(s);
320 public static DateTime ToDateTime (string s)
322 return ToDateTime (s, datetimeFormats);
326 public static DateTime ToDateTime (string value, XmlDateTimeSerializationMode mode)
328 string modestr = null;
331 case XmlDateTimeSerializationMode.Local:
332 dt = ToDateTime (value, localDateTimeFormats);
333 return dt == DateTime.MinValue || dt == DateTime.MaxValue ? dt : dt.ToLocalTime ();
334 case XmlDateTimeSerializationMode.RoundtripKind:
335 return ToDateTime (value, roundtripDateTimeFormats);
336 case XmlDateTimeSerializationMode.Utc:
337 dt = ToDateTime (value, utcDateTimeFormats);
338 return dt == DateTime.MinValue || dt == DateTime.MaxValue ? dt : dt.ToUniversalTime ();
339 case XmlDateTimeSerializationMode.Unspecified:
341 return ToDateTime (value, defaultDateTimeFormats);
345 public static DateTime ToDateTime(string s, string format)
347 //DateTimeFormatInfo d = new DateTimeFormatInfo();
348 //d.FullDateTimePattern = format;
349 //return DateTime.Parse(s, d);
350 DateTimeStyles style = DateTimeStyles.AllowLeadingWhite |
351 DateTimeStyles.AllowTrailingWhite;
352 return DateTime.ParseExact (s, format, DateTimeFormatInfo.InvariantInfo, style);
355 public static DateTime ToDateTime(string s, string[] formats)
357 DateTimeStyles style = DateTimeStyles.AllowLeadingWhite |
358 DateTimeStyles.AllowTrailingWhite;
359 return DateTime.ParseExact (s, formats, DateTimeFormatInfo.InvariantInfo, style);
362 public static Decimal ToDecimal(string s)
364 return Decimal.Parse(s, CultureInfo.InvariantCulture);
367 public static double ToDouble(string s)
370 throw new ArgumentNullException();
372 return Double.PositiveInfinity;
374 return Double.NegativeInfinity;
377 return Double.Parse (s, floatStyle, CultureInfo.InvariantCulture);
380 public static Guid ToGuid(string s)
385 public static short ToInt16(string s)
387 return Int16.Parse (s, NumberStyles.Integer, CultureInfo.InvariantCulture);
390 public static int ToInt32(string s)
392 return Int32.Parse (s, NumberStyles.Integer, CultureInfo.InvariantCulture);
395 public static long ToInt64(string s)
397 return Int64.Parse (s, NumberStyles.Integer, CultureInfo.InvariantCulture);
400 [CLSCompliant (false)]
401 public static SByte ToSByte(string s)
403 return SByte.Parse(s, CultureInfo.InvariantCulture);
406 public static float ToSingle(string s)
409 throw new ArgumentNullException();
411 return Single.PositiveInfinity;
413 return Single.NegativeInfinity;
416 return Single.Parse(s, floatStyle, CultureInfo.InvariantCulture);
419 public static string ToString(Guid value)
421 return value.ToString("D", CultureInfo.InvariantCulture);
424 public static string ToString(int value)
426 return value.ToString(CultureInfo.InvariantCulture);
429 public static string ToString(short value)
431 return value.ToString(CultureInfo.InvariantCulture);
434 public static string ToString(byte value)
436 return value.ToString(CultureInfo.InvariantCulture);
439 public static string ToString(long value)
441 return value.ToString(CultureInfo.InvariantCulture);
444 public static string ToString(char value)
446 return value.ToString(CultureInfo.InvariantCulture);
449 public static string ToString(bool value)
451 if (value) return "true";
455 [CLSCompliant (false)]
456 public static string ToString(SByte value)
458 return value.ToString(CultureInfo.InvariantCulture);
461 public static string ToString(Decimal value)
463 return value.ToString (CultureInfo.InvariantCulture);
466 [CLSCompliant (false)]
467 public static string ToString(UInt64 value)
469 return value.ToString(CultureInfo.InvariantCulture);
472 public static string ToString (TimeSpan value)
474 if (value == TimeSpan.Zero)
477 StringBuilder builder = new StringBuilder ();
478 if (value.Ticks < 0) {
479 builder.Append ('-');
480 value = value.Negate ();
482 builder.Append ('P');
484 builder.Append (value.Days).Append ('D');
485 if (value.Days > 0 || value.Hours > 0 || value.Minutes > 0 || value.Seconds > 0 || value.Milliseconds > 0) {
488 builder.Append (value.Hours).Append ('H');
489 if (value.Minutes > 0)
490 builder.Append (value.Minutes).Append ('M');
491 if (value.Seconds > 0 || value.Milliseconds > 0) {
492 builder.Append (value.Seconds);
493 long ticks = value.Ticks % TimeSpan.TicksPerMillisecond;
495 builder.Append ('.').AppendFormat ("{0:0000000}", value.Ticks % TimeSpan.TicksPerSecond);
496 else if (value.Milliseconds > 0)
497 builder.Append ('.').AppendFormat ("{0:000}", value.Milliseconds);
499 builder.Append ('S');
502 return builder.ToString ();
505 public static string ToString(double value)
507 if (Double.IsNegativeInfinity(value)) return "-INF";
508 if (Double.IsPositiveInfinity(value)) return "INF";
509 if (Double.IsNaN(value)) return "NaN";
510 return value.ToString(CultureInfo.InvariantCulture);
513 public static string ToString(float value)
515 if (Single.IsNegativeInfinity(value)) return "-INF";
516 if (Single.IsPositiveInfinity(value)) return "INF";
517 if (Single.IsNaN(value)) return "NaN";
518 return value.ToString(CultureInfo.InvariantCulture);
521 [CLSCompliant (false)]
522 public static string ToString(UInt32 value)
524 return value.ToString(CultureInfo.InvariantCulture);
527 [CLSCompliant (false)]
528 public static string ToString(UInt16 value)
530 return value.ToString(CultureInfo.InvariantCulture);
536 public static string ToString (DateTime value)
538 return value.ToString ("yyyy-MM-ddTHH:mm:ss.fffffffzzz", CultureInfo.InvariantCulture);
542 public static string ToString (DateTime value, XmlDateTimeSerializationMode mode)
544 // Unlike usual DateTime formatting, it preserves
545 // MaxValue/MinValue as is.
546 string modestr = null;
548 case XmlDateTimeSerializationMode.Local:
549 return (value == DateTime.MinValue ? DateTime.MinValue : value == DateTime.MaxValue ? value : value.ToLocalTime ()).ToString (
550 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
551 CultureInfo.InvariantCulture);
553 case XmlDateTimeSerializationMode.RoundtripKind:
554 return value.ToString (
555 "yyyy-MM-ddTHH:mm:ss.FFFFFFFK",
556 CultureInfo.InvariantCulture);
559 return value.ToString (
560 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
561 CultureInfo.InvariantCulture);
563 case XmlDateTimeSerializationMode.Utc:
564 return (value == DateTime.MinValue ? DateTime.MinValue : value == DateTime.MaxValue ? value : value.ToUniversalTime ()).ToString (
565 "yyyy-MM-ddTHH:mm:ss.FFFFFFFZ",
566 CultureInfo.InvariantCulture);
568 case XmlDateTimeSerializationMode.Unspecified:
569 return value.ToString (
570 "yyyy-MM-ddTHH:mm:ss.FFFFFFF",
571 CultureInfo.InvariantCulture);
577 public static string ToString(DateTime value, string format)
579 return value.ToString(format, CultureInfo.InvariantCulture);
582 public static TimeSpan ToTimeSpan(string s)
585 throw new ArgumentException ("Invalid format string for duration schema datatype.");
590 bool minusValue = (start == 1);
592 if (s [start] != 'P')
593 throw new ArgumentException ("Invalid format string for duration schema datatype.");
603 int parsedDigits = 0;
608 while (i < s.Length) {
616 for (; i < s.Length; i++)
617 if (s [i] < '0' || '9' < s [i])
620 parsedDigits = i - start;
621 int value = int.Parse (s.Substring (start, i - start), CultureInfo.InvariantCulture);
622 if (parseStep == 7) {
623 // adjust to 7 digits so that it makes sense as millisecond digits
624 for (; parsedDigits > 7; parsedDigits--)
626 for (; parsedDigits < 7; parsedDigits++)
639 days += 365 * (value / 12) + 30 * (value % 12);
641 } else if (isTime && parseStep < 6) {
657 if (!isTime || parseStep > 4)
667 if (!isTime || parseStep > 7)
688 throw new ArgumentException ("Invalid format string for duration schema datatype.");
689 TimeSpan ts = new TimeSpan (days, hours, minutes, seconds);
691 return TimeSpan.FromTicks (- (ts.Ticks + ticks));
693 return TimeSpan.FromTicks (ts.Ticks + ticks);
696 [CLSCompliant (false)]
697 public static UInt16 ToUInt16(string s)
699 return UInt16.Parse(s, CultureInfo.InvariantCulture);
702 [CLSCompliant (false)]
703 public static UInt32 ToUInt32(string s)
705 return UInt32.Parse(s, CultureInfo.InvariantCulture);
708 [CLSCompliant (false)]
709 public static UInt64 ToUInt64(string s)
711 return UInt64.Parse(s, CultureInfo.InvariantCulture);
714 public static string VerifyName (string name)
716 if (name == null || name.Length == 0)
717 throw new ArgumentNullException("name");
719 if (!XmlChar.IsName (name))
720 throw new XmlException("'" + name + "' is not a valid XML Name");
725 public static string VerifyNCName (string ncname)
727 if (ncname == null || ncname.Length == 0)
728 throw new ArgumentNullException("ncname");
730 if (!XmlChar.IsNCName (ncname))
731 throw new XmlException ("'" + ncname + "' is not a valid XML NCName");
736 public static string VerifyTOKEN (string name)
738 internal static string VerifyTOKEN (string name)
742 throw new ArgumentNullException("name");
744 if (name.Length == 0)
747 if (XmlChar.IsWhitespace (name [0]) ||
748 XmlChar.IsWhitespace (name [name.Length - 1]))
749 throw new XmlException ("Whitespace characters (#xA, #xD, #x9, #x20) are not allowed as leading or trailing whitespaces of xs:token.");
751 for (int i = 0; i < name.Length; i++)
752 if (XmlChar.IsWhitespace (name [i]) && name [i] != ' ')
753 throw new XmlException ("Either #xA, #xD or #x9 are not allowed inside xs:token.");
759 public static string VerifyNMTOKEN (string name)
761 internal static string VerifyNMTOKEN (string name)
765 throw new ArgumentNullException("name");
767 if (!XmlChar.IsNmToken (name))
768 throw new XmlException("'" + name + "' is not a valid XML NMTOKEN");
773 // It is documented as public method, but in fact it is not.
774 internal static byte [] FromBinHexString (string s)
776 char [] chars = s.ToCharArray ();
777 byte [] bytes = new byte [chars.Length / 2 + chars.Length % 2];
778 FromBinHexString (chars, 0, chars.Length, bytes);
782 internal static int FromBinHexString (char [] chars, int offset, int charLength, byte [] buffer)
784 int bufIndex = offset;
785 for (int i = 0; i < charLength - 1; i += 2) {
786 buffer [bufIndex] = (chars [i] > '9' ?
787 (byte) (chars [i] - 'A' + 10) :
788 (byte) (chars [i] - '0'));
789 buffer [bufIndex] <<= 4;
790 buffer [bufIndex] += chars [i + 1] > '9' ?
791 (byte) (chars [i + 1] - 'A' + 10) :
792 (byte) (chars [i + 1] - '0');
795 if (charLength %2 != 0)
796 buffer [bufIndex++] = (byte)
797 ((chars [charLength - 1] > '9' ?
798 (byte) (chars [charLength - 1] - 'A' + 10) :
799 (byte) (chars [charLength - 1] - '0'))
802 return bufIndex - offset;
805 #if NET_2_0 // actually NET_3_5
807 public static DateTimeOffset ToDateTimeOffset (string s)
809 return ToDateTimeOffset (s, datetimeFormats);
812 public static DateTimeOffset ToDateTimeOffset (string s, string format)
814 return ToDateTimeOffset (s, format);
817 public static DateTimeOffset ToDateTimeOffset (string s, string [] formats)
819 return ToDateTimeOffset (s, formats);
822 public static string ToString (DateTimeOffset value)
824 return ToString (value, "yyyy-MM-ddTHH:mm:ss.fffffffzzz");
827 public static string ToString (DateTimeOffset value, string format)
829 return value.ToString (format, CultureInfo.InvariantCulture);