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 |
48 NumberStyles.AllowLeadingWhite |
49 NumberStyles.AllowTrailingWhite;
51 const NumberStyles integerStyle = NumberStyles.Integer |
52 NumberStyles.AllowLeadingWhite |
53 NumberStyles.AllowTrailingWhite;
55 static readonly string [] datetimeFormats = {
58 "yyyy-MM-ddTHH:mm:sszzz",
59 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
60 "yyyy-MM-ddTHH:mm:ssZ",
61 "yyyy-MM-ddTHH:mm:ss.FFFFFFFZ",
62 "yyyy-MM-ddTHH:mm:ss",
63 "yyyy-MM-ddTHH:mm:ss.FFFFFFF",
67 "HH:mm:ss.FFFFFFFzzz",
70 #else // it is not required in trunk but should make it easy to backport...
71 "yyyy-MM-ddTHH:mm:sszzz",
72 "yyyy-MM-ddTHH:mm:ss.fzzz",
73 "yyyy-MM-ddTHH:mm:ss.ffzzz",
74 "yyyy-MM-ddTHH:mm:ss.fffzzz",
75 "yyyy-MM-ddTHH:mm:ss.ffffzzz",
76 "yyyy-MM-ddTHH:mm:ss.fffffzzz",
77 "yyyy-MM-ddTHH:mm:ss.ffffffzzz",
78 "yyyy-MM-ddTHH:mm:ss.fffffffzzz",
79 "yyyy-MM-ddTHH:mm:ssZ",
80 "yyyy-MM-ddTHH:mm:ss.fZ",
81 "yyyy-MM-ddTHH:mm:ss.ffZ",
82 "yyyy-MM-ddTHH:mm:ss.fffZ",
83 "yyyy-MM-ddTHH:mm:ss.ffffZ",
84 "yyyy-MM-ddTHH:mm:ss.fffffZ",
85 "yyyy-MM-ddTHH:mm:ss.ffffffZ",
86 "yyyy-MM-ddTHH:mm:ss.fffffffZ",
87 "yyyy-MM-ddTHH:mm:ss",
88 "yyyy-MM-ddTHH:mm:ss.f",
89 "yyyy-MM-ddTHH:mm:ss.ff",
90 "yyyy-MM-ddTHH:mm:ss.fff",
91 "yyyy-MM-ddTHH:mm:ss.ffff",
92 "yyyy-MM-ddTHH:mm:ss.fffff",
93 "yyyy-MM-ddTHH:mm:ss.ffffff",
94 "yyyy-MM-ddTHH:mm:ss.fffffff",
110 "HH:mm:ss.ffffffzzz",
111 "HH:mm:ss.fffffffzzz",
144 static readonly string [] defaultDateTimeFormats = new string [] {
145 "yyyy-MM-ddTHH:mm:ss", // dateTime(1)
146 "yyyy-MM-ddTHH:mm:ss.FFFFFFF", // dateTime(2)
147 "yyyy-MM-dd", // date
149 "yyyy-MM", // gYearMonth
151 "--MM-dd", // gMonthDay
155 static readonly string [] roundtripDateTimeFormats;
156 static readonly string [] localDateTimeFormats;
157 static readonly string [] utcDateTimeFormats;
158 static readonly string [] unspecifiedDateTimeFormats;
162 int l = defaultDateTimeFormats.Length;
163 roundtripDateTimeFormats = new string [l];
164 localDateTimeFormats = new string [l];
165 utcDateTimeFormats = new string [l * 3];
166 unspecifiedDateTimeFormats = new string [l * 4];
167 for (int i = 0; i < l; i++) {
168 string s = defaultDateTimeFormats [i];
169 localDateTimeFormats [i] = s + "zzz";
170 roundtripDateTimeFormats [i] = s + 'K';
171 utcDateTimeFormats [i * 3] = s;
172 utcDateTimeFormats [i * 3 + 1] = s + 'Z';
173 utcDateTimeFormats [i * 3 + 2] = s + "zzz";
174 unspecifiedDateTimeFormats [i * 4] = s;
175 unspecifiedDateTimeFormats [i * 4 + 1] = localDateTimeFormats [i];
176 unspecifiedDateTimeFormats [i * 4 + 2] = roundtripDateTimeFormats [i];
177 unspecifiedDateTimeFormats [i * 4 + 3] = utcDateTimeFormats [i];
181 static DateTimeStyles _defaultStyle = DateTimeStyles.AllowLeadingWhite | DateTimeStyles.AllowTrailingWhite;
186 private static string TryDecoding (string s)
188 if (s == null || s.Length < 6)
193 c = (char) Int32.Parse (s.Substring (1, 4), NumberStyles.HexNumber, CultureInfo.InvariantCulture);
195 return s [0] + DecodeName (s.Substring (1));
199 return c.ToString ();
200 return c + DecodeName (s.Substring (6));
203 public static string DecodeName (string name)
205 if (name == null || name.Length == 0)
208 int pos = name.IndexOf ('_');
209 if (pos == -1 || pos + 6 >= name.Length)
212 if ((name [pos + 1] != 'X' && name [pos + 1] != 'x') || name [pos + 6] != '_')
213 return name [0] + DecodeName (name.Substring (1));
215 return name.Substring (0, pos) + TryDecoding (name.Substring (pos + 1));
218 public static string EncodeLocalName (string name)
223 string encoded = EncodeName (name);
224 int pos = encoded.IndexOf (':');
227 return encoded.Replace (":", encodedColon);
230 internal static bool IsInvalid (char c, bool firstOnlyLetter)
232 if (c == ':') // Special case. allowed in EncodeName, but encoded in EncodeLocalName
236 return !XmlChar.IsFirstNameChar (c);
238 return !XmlChar.IsNameChar (c);
241 private static string EncodeName (string name, bool nmtoken)
243 if (name == null || name.Length == 0)
246 StringBuilder sb = new StringBuilder ();
247 int length = name.Length;
248 for (int i = 0; i < length; i++) {
250 if (IsInvalid (c, i == 0 && !nmtoken))
251 sb.AppendFormat ("_x{0:X4}_", (int) c);
252 else if (c == '_' && i + 6 < length && name [i+1] == 'x' && name [i + 6] == '_')
253 sb.Append ("_x005F_");
257 return sb.ToString ();
260 public static string EncodeName (string name)
262 return EncodeName (name, false);
265 public static string EncodeNmToken (string name)
267 if (name == String.Empty)
268 throw new XmlException ("Invalid NmToken: ''");
269 return EncodeName (name, true);
272 // {true, false, 1, 0}
273 public static bool ToBoolean(string s)
275 s = s.Trim (XmlChar.WhitespaceChars);
287 throw new FormatException(s + " is not a valid boolean value");
291 // LAMESPEC: It has been documented as public, but is marked as internal.
292 internal static string ToBinHexString (byte [] buffer)
294 StringWriter w = new StringWriter ();
295 WriteBinHex (buffer, 0, buffer.Length, w);
296 return w.ToString ();
299 internal static void WriteBinHex (byte [] buffer, int index, int count, TextWriter w)
302 throw new ArgumentNullException ("buffer");
304 throw new ArgumentOutOfRangeException (
308 "index must be non negative integer.");
311 throw new ArgumentOutOfRangeException (
315 "count must be non negative integer.");
317 if (buffer.Length < index + count)
318 throw new ArgumentOutOfRangeException ("index and count must be smaller than the length of the buffer.");
320 // Copied from XmlTextWriter.WriteBinHex ()
321 int end = index + count;
322 for (int i = index; i < end; i++) {
323 int val = buffer [i];
327 w.Write ((char) (high + 55));
329 w.Write ((char) (high + 0x30));
331 w.Write ((char) (low + 55));
333 w.Write ((char) (low + 0x30));
337 public static byte ToByte(string s)
339 return Byte.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
342 public static char ToChar(string s)
345 return Char.Parse(s);
348 throw new ArgumentNullException ("s");
351 throw new FormatException ("String contain more than one char");
360 public static DateTime ToDateTime (string s)
362 return ToDateTime (s, datetimeFormats);
366 public static DateTime ToDateTime (string value, XmlDateTimeSerializationMode mode)
370 case XmlDateTimeSerializationMode.Local:
371 dt = ToDateTime (value, localDateTimeFormats);
372 return dt == DateTime.MinValue || dt == DateTime.MaxValue ? dt : dt.ToLocalTime ();
373 case XmlDateTimeSerializationMode.RoundtripKind:
374 return ToDateTime (value, roundtripDateTimeFormats, _defaultStyle | DateTimeStyles.RoundtripKind);
375 case XmlDateTimeSerializationMode.Utc:
376 dt = ToDateTime (value, utcDateTimeFormats);
377 return dt == DateTime.MinValue || dt == DateTime.MaxValue ? dt : dt.ToUniversalTime ();
378 case XmlDateTimeSerializationMode.Unspecified:
379 return ToDateTime (value, unspecifiedDateTimeFormats);
381 return ToDateTime (value, defaultDateTimeFormats);
385 public static DateTime ToDateTime(string s, string format)
387 //DateTimeFormatInfo d = new DateTimeFormatInfo();
388 //d.FullDateTimePattern = format;
389 //return DateTime.Parse(s, d);
390 DateTimeStyles style = DateTimeStyles.AllowLeadingWhite |
391 DateTimeStyles.AllowTrailingWhite;
392 return DateTime.ParseExact (s, format, DateTimeFormatInfo.InvariantInfo, style);
395 public static DateTime ToDateTime(string s, string[] formats)
397 return ToDateTime (s, formats, _defaultStyle);
400 private static DateTime ToDateTime (string s, string [] formats, DateTimeStyles style)
402 return DateTime.ParseExact (s, formats, DateTimeFormatInfo.InvariantInfo, style);
405 public static Decimal ToDecimal(string s)
407 return Decimal.Parse(s, CultureInfo.InvariantCulture);
410 public static double ToDouble(string s)
413 throw new ArgumentNullException();
415 float f = TryParseStringFloatConstants (s);
419 return Double.Parse (s, floatStyle, CultureInfo.InvariantCulture);
422 static float TryParseStringFloatConstants (string s)
425 while (sidx < s.Length && Char.IsWhiteSpace (s [sidx]))
427 if (sidx == s.Length)
428 throw new FormatException ();
429 int sEndPos = s.Length - 1;
430 while (Char.IsWhiteSpace (s [sEndPos]))
433 if (TryParseStringConstant ("NaN", s, sidx, sEndPos))
435 if (TryParseStringConstant ("INF", s, sidx, sEndPos))
436 return Single.PositiveInfinity;
437 if (TryParseStringConstant ("-INF", s, sidx, sEndPos))
438 return Single.NegativeInfinity;
439 // Handle these here because Single.Parse("Infinity") is invalid while XmlConvert.ToSingle("Infinity") is valid.
440 if (TryParseStringConstant ("Infinity", s, sidx, sEndPos))
441 return Single.PositiveInfinity;
442 if (TryParseStringConstant ("-Infinity", s, sidx, sEndPos))
443 return Single.NegativeInfinity;
447 static bool TryParseStringConstant (string format, string s, int start, int end)
449 return end - start + 1 == format.Length && String.CompareOrdinal (format, 0, s, start, format.Length) == 0;
452 public static Guid ToGuid (string s)
456 } catch (FormatException ex) {
457 throw new FormatException (String.Format ("Invalid Guid input '{0}'", ex.InnerException));
461 public static short ToInt16(string s)
463 return Int16.Parse (s, integerStyle, CultureInfo.InvariantCulture);
466 public static int ToInt32(string s)
468 return Int32.Parse (s, integerStyle, CultureInfo.InvariantCulture);
471 public static long ToInt64(string s)
473 return Int64.Parse (s, integerStyle, CultureInfo.InvariantCulture);
476 [CLSCompliant (false)]
477 public static SByte ToSByte(string s)
479 return SByte.Parse(s, integerStyle, CultureInfo.InvariantCulture);
482 public static float ToSingle(string s)
485 throw new ArgumentNullException();
487 float f = TryParseStringFloatConstants (s);
491 return Single.Parse(s, floatStyle, CultureInfo.InvariantCulture);
494 public static string ToString(Guid value)
496 return value.ToString("D", CultureInfo.InvariantCulture);
499 public static string ToString(int value)
501 return value.ToString(CultureInfo.InvariantCulture);
504 public static string ToString(short value)
506 return value.ToString(CultureInfo.InvariantCulture);
509 public static string ToString(byte value)
511 return value.ToString(CultureInfo.InvariantCulture);
514 public static string ToString(long value)
516 return value.ToString(CultureInfo.InvariantCulture);
519 public static string ToString(char value)
521 return value.ToString(CultureInfo.InvariantCulture);
524 public static string ToString(bool value)
526 if (value) return "true";
530 [CLSCompliant (false)]
531 public static string ToString(SByte value)
533 return value.ToString(CultureInfo.InvariantCulture);
536 public static string ToString(Decimal value)
538 return value.ToString (CultureInfo.InvariantCulture);
541 [CLSCompliant (false)]
542 public static string ToString(UInt64 value)
544 return value.ToString(CultureInfo.InvariantCulture);
547 public static string ToString (TimeSpan value)
549 if (value == TimeSpan.Zero)
552 StringBuilder builder = new StringBuilder ();
553 if (value.Ticks < 0) {
554 builder.Append ('-');
555 value = value.Negate ();
557 builder.Append ('P');
559 builder.Append (value.Days).Append ('D');
560 if (value.Days > 0 || value.Hours > 0 || value.Minutes > 0 || value.Seconds > 0 || value.Milliseconds > 0) {
563 builder.Append (value.Hours).Append ('H');
564 if (value.Minutes > 0)
565 builder.Append (value.Minutes).Append ('M');
566 if (value.Seconds > 0 || value.Milliseconds > 0) {
567 builder.Append (value.Seconds);
568 long ticks = value.Ticks % TimeSpan.TicksPerMillisecond;
570 builder.Append ('.').AppendFormat ("{0:0000000}", value.Ticks % TimeSpan.TicksPerSecond);
571 else if (value.Milliseconds > 0)
572 builder.Append ('.').AppendFormat ("{0:000}", value.Milliseconds);
574 builder.Append ('S');
577 return builder.ToString ();
580 public static string ToString(double value)
582 if (Double.IsNegativeInfinity(value)) return "-INF";
583 if (Double.IsPositiveInfinity(value)) return "INF";
584 if (Double.IsNaN(value)) return "NaN";
585 return value.ToString("R", CultureInfo.InvariantCulture);
588 public static string ToString(float value)
590 if (Single.IsNegativeInfinity(value)) return "-INF";
591 if (Single.IsPositiveInfinity(value)) return "INF";
592 if (Single.IsNaN(value)) return "NaN";
593 return value.ToString("R", CultureInfo.InvariantCulture);
596 [CLSCompliant (false)]
597 public static string ToString(UInt32 value)
599 return value.ToString(CultureInfo.InvariantCulture);
602 [CLSCompliant (false)]
603 public static string ToString(UInt16 value)
605 return value.ToString(CultureInfo.InvariantCulture);
611 public static string ToString (DateTime value)
613 return value.ToString ("yyyy-MM-ddTHH:mm:ss.fffffffzzz", CultureInfo.InvariantCulture);
617 public static string ToString (DateTime value, XmlDateTimeSerializationMode mode)
619 // Unlike usual DateTime formatting, it preserves
620 // MaxValue/MinValue as is.
622 case XmlDateTimeSerializationMode.Local:
623 return (value == DateTime.MinValue ? DateTime.MinValue : value == DateTime.MaxValue ? value : value.ToLocalTime ()).ToString (
624 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
625 CultureInfo.InvariantCulture);
626 case XmlDateTimeSerializationMode.RoundtripKind:
627 return value.ToString (
628 "yyyy-MM-ddTHH:mm:ss.FFFFFFFK",
629 CultureInfo.InvariantCulture);
631 return value.ToString (
632 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
633 CultureInfo.InvariantCulture);
634 case XmlDateTimeSerializationMode.Utc:
635 return (value == DateTime.MinValue ? DateTime.MinValue : value == DateTime.MaxValue ? value : value.ToUniversalTime ()).ToString (
636 "yyyy-MM-ddTHH:mm:ss.FFFFFFFZ",
637 CultureInfo.InvariantCulture);
638 case XmlDateTimeSerializationMode.Unspecified:
639 return value.ToString (
640 "yyyy-MM-ddTHH:mm:ss.FFFFFFF",
641 CultureInfo.InvariantCulture);
646 public static string ToString(DateTime value, string format)
648 return value.ToString(format, CultureInfo.InvariantCulture);
651 public static TimeSpan ToTimeSpan(string s)
654 throw new FormatException ("Invalid format string for duration schema datatype.");
659 bool minusValue = (start == 1);
661 if (s [start] != 'P')
662 throw new FormatException ("Invalid format string for duration schema datatype.");
672 int parsedDigits = 0;
677 while (i < s.Length) {
685 for (; i < s.Length; i++)
686 if (s [i] < '0' || '9' < s [i])
689 parsedDigits = i - start;
690 int value = int.Parse (s.Substring (start, i - start), CultureInfo.InvariantCulture);
691 if (parseStep == 7) {
692 // adjust to 7 digits so that it makes sense as millisecond digits
693 for (; parsedDigits > 7; parsedDigits--)
695 for (; parsedDigits < 7; parsedDigits++)
708 days += 365 * (value / 12) + 30 * (value % 12);
710 } else if (isTime && parseStep < 6) {
726 if (!isTime || parseStep > 4)
736 if (!isTime || parseStep > 7)
757 throw new FormatException ("Invalid format string for duration schema datatype.");
758 TimeSpan ts = new TimeSpan (days, hours, minutes, seconds);
760 return TimeSpan.FromTicks (- (ts.Ticks + ticks));
762 return TimeSpan.FromTicks (ts.Ticks + ticks);
765 [CLSCompliant (false)]
766 public static UInt16 ToUInt16(string s)
768 return UInt16.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
771 [CLSCompliant (false)]
772 public static UInt32 ToUInt32(string s)
774 return UInt32.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
777 [CLSCompliant (false)]
778 public static UInt64 ToUInt64(string s)
780 return UInt64.Parse(s, NumberStyles.Integer, CultureInfo.InvariantCulture);
783 public static string VerifyName (string name)
785 if (name == null || name.Length == 0)
786 throw new ArgumentNullException("name");
788 if (!XmlChar.IsName (name))
789 throw new XmlException("'" + name + "' is not a valid XML Name");
794 public static string VerifyNCName (string ncname)
796 if (ncname == null || ncname.Length == 0)
797 throw new ArgumentNullException("ncname");
799 if (!XmlChar.IsNCName (ncname))
800 throw new XmlException ("'" + ncname + "' is not a valid XML NCName");
805 public static string VerifyTOKEN (string name)
807 internal static string VerifyTOKEN (string name)
811 throw new ArgumentNullException("name");
813 if (name.Length == 0)
816 if (XmlChar.IsWhitespace (name [0]) ||
817 XmlChar.IsWhitespace (name [name.Length - 1]))
818 throw new XmlException ("Whitespace characters (#xA, #xD, #x9, #x20) are not allowed as leading or trailing whitespaces of xs:token.");
820 for (int i = 0; i < name.Length; i++)
821 if (XmlChar.IsWhitespace (name [i]) && name [i] != ' ')
822 throw new XmlException ("Either #xA, #xD or #x9 are not allowed inside xs:token.");
828 public static string VerifyNMTOKEN (string name)
830 internal static string VerifyNMTOKEN (string name)
834 throw new ArgumentNullException("name");
836 if (!XmlChar.IsNmToken (name))
837 throw new XmlException("'" + name + "' is not a valid XML NMTOKEN");
842 // It is documented as public method, but in fact it is not.
843 internal static byte [] FromBinHexString (string s)
845 char [] chars = s.ToCharArray ();
846 byte [] bytes = new byte [chars.Length / 2 + chars.Length % 2];
847 FromBinHexString (chars, 0, chars.Length, bytes);
851 internal static int FromBinHexString (char [] chars, int offset, int charLength, byte [] buffer)
853 int bufIndex = offset;
854 for (int i = 0; i < charLength - 1; i += 2) {
855 buffer [bufIndex] = (chars [i] > '9' ?
856 (byte) (chars [i] - 'A' + 10) :
857 (byte) (chars [i] - '0'));
858 buffer [bufIndex] <<= 4;
859 buffer [bufIndex] += chars [i + 1] > '9' ?
860 (byte) (chars [i + 1] - 'A' + 10) :
861 (byte) (chars [i + 1] - '0');
864 if (charLength %2 != 0)
865 buffer [bufIndex++] = (byte)
866 ((chars [charLength - 1] > '9' ?
867 (byte) (chars [charLength - 1] - 'A' + 10) :
868 (byte) (chars [charLength - 1] - '0'))
871 return bufIndex - offset;
874 #if NET_2_0 // actually NET_3_5
877 public static DateTimeOffset ToDateTimeOffset (string s)
879 return ToDateTimeOffset (s, datetimeFormats);
882 public static DateTimeOffset ToDateTimeOffset (string s, string format)
884 return DateTimeOffset.ParseExact (s, format, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal);
887 public static DateTimeOffset ToDateTimeOffset (string s, string [] formats)
889 DateTimeStyles style = DateTimeStyles.AllowLeadingWhite |
890 DateTimeStyles.AllowTrailingWhite |
891 DateTimeStyles.AssumeUniversal;
892 return DateTimeOffset.ParseExact (s, formats, CultureInfo.InvariantCulture, style);
895 public static string ToString (DateTimeOffset value)
897 return ToString (value, "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz");
900 public static string ToString (DateTimeOffset value, string format)
902 return value.ToString (format, CultureInfo.InvariantCulture);
906 // it is used only from 2.1 System.Xml.Serialization.dll from
907 // MS Silverlight SDK. We don't use it so far.
908 internal static Uri ToUri (string s)
910 return new Uri (s, UriKind.RelativeOrAbsolute);