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",
125 private static string TryDecoding (string s)
127 if (s == null || s.Length < 6)
132 c = (char) Int32.Parse (s.Substring (1, 4), NumberStyles.HexNumber, CultureInfo.InvariantCulture);
134 return s [0] + DecodeName (s.Substring (1));
138 return c.ToString ();
139 return c + DecodeName (s.Substring (6));
142 public static string DecodeName (string name)
144 if (name == null || name.Length == 0)
147 int pos = name.IndexOf ('_');
148 if (pos == -1 || pos + 6 >= name.Length)
151 if ((name [pos + 1] != 'X' && name [pos + 1] != 'x') || name [pos + 6] != '_')
152 return name [0] + DecodeName (name.Substring (1));
154 return name.Substring (0, pos) + TryDecoding (name.Substring (pos + 1));
157 public static string EncodeLocalName (string name)
162 string encoded = EncodeName (name);
163 int pos = encoded.IndexOf (':');
166 return encoded.Replace (":", encodedColon);
169 internal static bool IsInvalid (char c, bool firstOnlyLetter)
171 if (c == ':') // Special case. allowed in EncodeName, but encoded in EncodeLocalName
175 return !XmlChar.IsFirstNameChar (c);
177 return !XmlChar.IsNameChar (c);
180 private static string EncodeName (string name, bool nmtoken)
182 if (name == null || name.Length == 0)
185 StringBuilder sb = new StringBuilder ();
186 int length = name.Length;
187 for (int i = 0; i < length; i++) {
189 if (IsInvalid (c, i == 0 && !nmtoken))
190 sb.AppendFormat ("_x{0:X4}_", (int) c);
191 else if (c == '_' && i + 6 < length && name [i+1] == 'x' && name [i + 6] == '_')
192 sb.Append ("_x005F_");
196 return sb.ToString ();
199 public static string EncodeName (string name)
201 return EncodeName (name, false);
204 public static string EncodeNmToken (string name)
206 if (name == String.Empty)
207 throw new XmlException ("Invalid NmToken: ''");
208 return EncodeName (name, true);
211 // {true, false, 1, 0}
212 public static bool ToBoolean(string s)
214 s = s.Trim (XmlChar.WhitespaceChars);
226 throw new FormatException(s + " is not a valid boolean value");
230 // LAMESPEC: It has been documented as public, but is marked as internal.
231 internal static string ToBinHexString (byte [] buffer)
233 StringWriter w = new StringWriter ();
234 WriteBinHex (buffer, 0, buffer.Length, w);
235 return w.ToString ();
238 internal static void WriteBinHex (byte [] buffer, int index, int count, TextWriter w)
241 throw new ArgumentNullException ("buffer");
243 throw new ArgumentOutOfRangeException ("index", index, "index must be non negative integer.");
245 throw new ArgumentOutOfRangeException ("count", count, "count must be non negative integer.");
246 if (buffer.Length < index + count)
247 throw new ArgumentOutOfRangeException ("index and count must be smaller than the length of the buffer.");
249 // Copied from XmlTextWriter.WriteBinHex ()
250 int end = index + count;
251 for (int i = index; i < end; i++) {
252 int val = buffer [i];
256 w.Write ((char) (high + 55));
258 w.Write ((char) (high + 0x30));
260 w.Write ((char) (low + 55));
262 w.Write ((char) (low + 0x30));
266 public static byte ToByte(string s)
268 return Byte.Parse(s, CultureInfo.InvariantCulture);
271 public static char ToChar(string s)
273 return Char.Parse(s);
279 public static DateTime ToDateTime (string s)
281 return ToDateTime (s, datetimeFormats);
285 public static DateTime ToDateTime (string value, XmlDateTimeSerializationMode mode)
287 string modestr = null;
290 case XmlDateTimeSerializationMode.Local:
291 dt = ToDateTime (value, "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz");
292 return dt == DateTime.MinValue || dt == DateTime.MaxValue ? dt : dt.ToLocalTime ();
293 case XmlDateTimeSerializationMode.RoundtripKind:
294 return ToDateTime (value, "yyyy-MM-ddTHH:mm:ss.FFFFFFF");
295 case XmlDateTimeSerializationMode.Utc:
296 dt = ToDateTime (value, "yyyy-MM-ddTHH:mm:ss.FFFFFFFZ");
297 return dt == DateTime.MinValue || dt == DateTime.MaxValue ? dt : dt.ToUniversalTime ();
298 case XmlDateTimeSerializationMode.Unspecified:
300 return ToDateTime (value, "yyyy-MM-ddTHH:mm:ss.FFFFFFF");
304 public static DateTime ToDateTime(string s, string format)
306 DateTimeFormatInfo d = new DateTimeFormatInfo();
307 d.FullDateTimePattern = format;
308 return DateTime.Parse(s, d);
311 public static DateTime ToDateTime(string s, string[] formats)
313 DateTimeStyles style = DateTimeStyles.AllowLeadingWhite |
314 DateTimeStyles.AllowTrailingWhite;
315 return DateTime.ParseExact (s, formats, DateTimeFormatInfo.InvariantInfo, style);
318 public static Decimal ToDecimal(string s)
320 return Decimal.Parse(s, CultureInfo.InvariantCulture);
323 public static double ToDouble(string s)
326 throw new ArgumentNullException();
328 return Double.PositiveInfinity;
330 return Double.NegativeInfinity;
333 return Double.Parse (s, floatStyle, CultureInfo.InvariantCulture);
336 public static Guid ToGuid(string s)
341 public static short ToInt16(string s)
343 return Int16.Parse(s, CultureInfo.InvariantCulture);
346 public static int ToInt32(string s)
348 return Int32.Parse(s, CultureInfo.InvariantCulture);
351 public static long ToInt64(string s)
353 return Int64.Parse(s, CultureInfo.InvariantCulture);
356 [CLSCompliant (false)]
357 public static SByte ToSByte(string s)
359 return SByte.Parse(s, CultureInfo.InvariantCulture);
362 public static float ToSingle(string s)
365 throw new ArgumentNullException();
367 return Single.PositiveInfinity;
369 return Single.NegativeInfinity;
372 return Single.Parse(s, floatStyle, CultureInfo.InvariantCulture);
375 public static string ToString(Guid value)
377 return value.ToString("D", CultureInfo.InvariantCulture);
380 public static string ToString(int value)
382 return value.ToString(CultureInfo.InvariantCulture);
385 public static string ToString(short value)
387 return value.ToString(CultureInfo.InvariantCulture);
390 public static string ToString(byte value)
392 return value.ToString(CultureInfo.InvariantCulture);
395 public static string ToString(long value)
397 return value.ToString(CultureInfo.InvariantCulture);
400 public static string ToString(char value)
402 return value.ToString(CultureInfo.InvariantCulture);
405 public static string ToString(bool value)
407 if (value) return "true";
411 [CLSCompliant (false)]
412 public static string ToString(SByte value)
414 return value.ToString(CultureInfo.InvariantCulture);
417 public static string ToString(Decimal value)
419 return value.ToString (CultureInfo.InvariantCulture);
422 [CLSCompliant (false)]
423 public static string ToString(UInt64 value)
425 return value.ToString(CultureInfo.InvariantCulture);
428 public static string ToString (TimeSpan value)
430 if (value == TimeSpan.Zero)
433 StringBuilder builder = new StringBuilder ();
434 if (value.Ticks < 0) {
435 builder.Append ('-');
436 value = value.Negate ();
438 builder.Append ('P');
440 builder.Append (value.Days).Append ('D');
441 if (value.Days > 0 || value.Hours > 0 || value.Minutes > 0 || value.Seconds > 0 || value.Milliseconds > 0) {
444 builder.Append (value.Hours).Append ('H');
445 if (value.Minutes > 0)
446 builder.Append (value.Minutes).Append ('M');
447 if (value.Seconds > 0 || value.Milliseconds > 0) {
448 builder.Append (value.Seconds);
449 long ticks = value.Ticks % TimeSpan.TicksPerMillisecond;
451 builder.Append ('.').AppendFormat ("{0:0000000}", value.Ticks % TimeSpan.TicksPerSecond);
452 else if (value.Milliseconds > 0)
453 builder.Append ('.').AppendFormat ("{0:000}", value.Milliseconds);
455 builder.Append ('S');
458 return builder.ToString ();
461 public static string ToString(double value)
463 if (Double.IsNegativeInfinity(value)) return "-INF";
464 if (Double.IsPositiveInfinity(value)) return "INF";
465 if (Double.IsNaN(value)) return "NaN";
466 return value.ToString(CultureInfo.InvariantCulture);
469 public static string ToString(float value)
471 if (Single.IsNegativeInfinity(value)) return "-INF";
472 if (Single.IsPositiveInfinity(value)) return "INF";
473 if (Single.IsNaN(value)) return "NaN";
474 return value.ToString(CultureInfo.InvariantCulture);
477 [CLSCompliant (false)]
478 public static string ToString(UInt32 value)
480 return value.ToString(CultureInfo.InvariantCulture);
483 [CLSCompliant (false)]
484 public static string ToString(UInt16 value)
486 return value.ToString(CultureInfo.InvariantCulture);
492 public static string ToString (DateTime value)
494 return value.ToString ("yyyy-MM-ddTHH:mm:ss.fffffffzzz", CultureInfo.InvariantCulture);
498 public static string ToString (DateTime value, XmlDateTimeSerializationMode mode)
500 // Unlike usual DateTime formatting, it preserves
501 // MaxValue/MinValue as is.
502 string modestr = null;
504 case XmlDateTimeSerializationMode.Local:
505 return (value == DateTime.MinValue ? DateTime.MinValue : value == DateTime.MaxValue ? value : value.ToLocalTime ()).ToString (
506 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
507 CultureInfo.InvariantCulture);
509 case XmlDateTimeSerializationMode.RoundtripKind:
510 return value.ToString (
511 "yyyy-MM-ddTHH:mm:ss.FFFFFFF",
512 CultureInfo.InvariantCulture);
515 return value.ToString (
516 "yyyy-MM-ddTHH:mm:ss.FFFFFFFzzz",
517 CultureInfo.InvariantCulture);
519 case XmlDateTimeSerializationMode.Utc:
520 return (value == DateTime.MinValue ? DateTime.MinValue : value == DateTime.MaxValue ? value : value.ToUniversalTime ()).ToString (
521 "yyyy-MM-ddTHH:mm:ss.FFFFFFFZ",
522 CultureInfo.InvariantCulture);
524 case XmlDateTimeSerializationMode.Unspecified:
525 return value.ToString (
526 "yyyy-MM-ddTHH:mm:ss.FFFFFFF",
527 CultureInfo.InvariantCulture);
533 public static string ToString(DateTime value, string format)
535 return value.ToString(format, CultureInfo.InvariantCulture);
538 public static TimeSpan ToTimeSpan(string s)
541 throw new ArgumentException ("Invalid format string for duration schema datatype.");
546 bool minusValue = (start == 1);
548 if (s [start] != 'P')
549 throw new ArgumentException ("Invalid format string for duration schema datatype.");
559 int parsedDigits = 0;
564 while (i < s.Length) {
572 for (; i < s.Length; i++)
573 if (s [i] < '0' || '9' < s [i])
576 parsedDigits = i - start;
577 int value = int.Parse (s.Substring (start, i - start), CultureInfo.InvariantCulture);
578 if (parseStep == 7) {
579 // adjust to 7 digits so that it makes sense as millisecond digits
580 for (; parsedDigits > 7; parsedDigits--)
582 for (; parsedDigits < 7; parsedDigits++)
595 days += 365 * (value / 12) + 30 * (value % 12);
597 } else if (isTime && parseStep < 6) {
613 if (!isTime || parseStep > 4)
623 if (!isTime || parseStep > 7)
644 throw new ArgumentException ("Invalid format string for duration schema datatype.");
645 TimeSpan ts = new TimeSpan (days, hours, minutes, seconds);
647 return TimeSpan.FromTicks (- (ts.Ticks + ticks));
649 return TimeSpan.FromTicks (ts.Ticks + ticks);
652 [CLSCompliant (false)]
653 public static UInt16 ToUInt16(string s)
655 return UInt16.Parse(s, CultureInfo.InvariantCulture);
658 [CLSCompliant (false)]
659 public static UInt32 ToUInt32(string s)
661 return UInt32.Parse(s, CultureInfo.InvariantCulture);
664 [CLSCompliant (false)]
665 public static UInt64 ToUInt64(string s)
667 return UInt64.Parse(s, CultureInfo.InvariantCulture);
670 public static string VerifyName (string name)
672 if (name == null || name.Length == 0)
673 throw new ArgumentNullException("name");
675 if (!XmlChar.IsName (name))
676 throw new XmlException("'" + name + "' is not a valid XML Name");
681 public static string VerifyNCName (string ncname)
683 if (ncname == null || ncname.Length == 0)
684 throw new ArgumentNullException("ncname");
686 if (!XmlChar.IsNCName (ncname))
687 throw new XmlException ("'" + ncname + "' is not a valid XML NCName");
692 public static string VerifyTOKEN (string name)
694 internal static string VerifyTOKEN (string name)
698 throw new ArgumentNullException("name");
700 if (name.Length == 0)
703 if (XmlChar.IsWhitespace (name [0]) ||
704 XmlChar.IsWhitespace (name [name.Length - 1]))
705 throw new XmlException ("Whitespace characters (#xA, #xD, #x9, #x20) are not allowed as leading or trailing whitespaces of xs:token.");
707 for (int i = 0; i < name.Length; i++)
708 if (XmlChar.IsWhitespace (name [i]) && name [i] != ' ')
709 throw new XmlException ("Either #xA, #xD or #x9 are not allowed inside xs:token.");
715 public static string VerifyNMTOKEN (string name)
717 internal static string VerifyNMTOKEN (string name)
721 throw new ArgumentNullException("name");
723 if (!XmlChar.IsNmToken (name))
724 throw new XmlException("'" + name + "' is not a valid XML NMTOKEN");
729 // It is documented as public method, but in fact it is not.
730 internal static byte [] FromBinHexString (string s)
732 char [] chars = s.ToCharArray ();
733 byte [] bytes = new byte [chars.Length / 2 + chars.Length % 2];
734 FromBinHexString (chars, 0, chars.Length, bytes);
738 internal static int FromBinHexString (char [] chars, int offset, int charLength, byte [] buffer)
740 int bufIndex = offset;
741 for (int i = 0; i < charLength - 1; i += 2) {
742 buffer [bufIndex] = (chars [i] > '9' ?
743 (byte) (chars [i] - 'A' + 10) :
744 (byte) (chars [i] - '0'));
745 buffer [bufIndex] <<= 4;
746 buffer [bufIndex] += chars [i + 1] > '9' ?
747 (byte) (chars [i + 1] - 'A' + 10) :
748 (byte) (chars [i + 1] - '0');
751 if (charLength %2 != 0)
752 buffer [bufIndex++] = (byte)
753 ((chars [charLength - 1] > '9' ?
754 (byte) (chars [charLength - 1] - 'A' + 10) :
755 (byte) (chars [charLength - 1] - '0'))
758 return bufIndex - offset;