mono/mcs/class/System.XML/System.Xml/XmlReaderSettings.cs

//
// XmlReaderSettings.cs
//
// Author:
//   Atsushi Enomoto <[email protected]>
//
// (C) 2004 Novell Inc.
//

//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

#if NET_2_0

using System;
using System.IO;
using System.Net;
using System.Xml.Schema;

using XsValidationFlags = System.Xml.Schema.XmlSchemaValidationFlags;

namespace System.Xml
{
	public class XmlReaderSettings
	{
		private bool checkCharacters;
		private bool closeInput;
		private ConformanceLevel conformance;
		private bool ignoreComments;
		private bool ignoreProcessingInstructions;
		private bool ignoreWhitespace;
		private int lineNumberOffset;
		private int linePositionOffset;
		private bool prohibitDtd;
		private XmlNameTable nameTable;
		private XmlSchemaSet schemas;
		private XsValidationFlags validationFlags;
		private ValidationType validationType;
		private XmlResolver xmlResolver;

		public XmlReaderSettings ()
		{
			Reset ();
		}

		private XmlReaderSettings (XmlReaderSettings org)
		{
			checkCharacters = org.checkCharacters;
			closeInput = org.closeInput;
			conformance = org.conformance;
			ignoreComments = org.ignoreComments;
			ignoreProcessingInstructions = 
				org.ignoreProcessingInstructions;
			ignoreWhitespace = org.ignoreWhitespace;
			lineNumberOffset = org.lineNumberOffset;
			linePositionOffset = org.linePositionOffset;
			prohibitDtd = org.prohibitDtd;
			schemas = org.schemas;
			validationFlags = org.validationFlags;
			validationType = org.validationType;
			nameTable = org.nameTable;
			xmlResolver = org.xmlResolver;
		}

		public event ValidationEventHandler ValidationEventHandler;

		public XmlReaderSettings Clone ()
		{
			return new XmlReaderSettings (this);
		}

		public void Reset ()
		{
			checkCharacters = true;
			closeInput = false; // ? not documented
			conformance = ConformanceLevel.Document;
			ignoreComments = false;
			ignoreProcessingInstructions = false;
			ignoreWhitespace = false;
			lineNumberOffset = 0;
			linePositionOffset = 0;
			prohibitDtd = false; // ? not documented
			schemas = new XmlSchemaSet ();
			validationFlags =
				XsValidationFlags.IgnoreValidationWarnings
				| XsValidationFlags.IgnoreSchemaLocation
				| XsValidationFlags.IgnoreInlineSchema;
			validationType = ValidationType.None;
			xmlResolver = new XmlUrlResolver ();
		}

		public bool CheckCharacters {
			get { return checkCharacters; }
			set { checkCharacters = value; }
		}

		public bool CloseInput {
			get { return closeInput; }
			set { closeInput = value; }
		}

		public ConformanceLevel ConformanceLevel {
			get { return conformance; }
			set { conformance = value; }
		}

		public bool IgnoreComments {
			get { return ignoreComments; }
			set { ignoreComments = value; }
		}

		[Obsolete ("Use ValidationFlags")]
		public bool IgnoreIdentityConstraints {
			get { return (ValidationFlags & XsValidationFlags.IgnoreIdentityConstraints) != 0; }
			set {
				if (value)
					ValidationFlags |= XsValidationFlags.IgnoreIdentityConstraints;
				else
					ValidationFlags &= ~XsValidationFlags.IgnoreIdentityConstraints;
			}
		}

		[Obsolete ("Use ValidationFlags")]
		public bool IgnoreInlineSchema {
			get { return (ValidationFlags & XsValidationFlags.IgnoreInlineSchema) != 0; }
			set {
				if (value)
					ValidationFlags |= XsValidationFlags.IgnoreInlineSchema;
				else
					ValidationFlags &= ~XsValidationFlags.IgnoreInlineSchema;
			}
		}

		[Obsolete ("Use ValidationFlags")]
		public bool IgnoreSchemaLocation {
			get { return (ValidationFlags & XsValidationFlags.IgnoreSchemaLocation) != 0; }
			set {
				if (value)
					ValidationFlags |= XsValidationFlags.IgnoreSchemaLocation;
				else
					ValidationFlags &= ~XsValidationFlags.IgnoreSchemaLocation;
			}
		}

		[Obsolete ("Use ValidationFlags")]
		public bool IgnoreValidationWarnings {
			get { return (ValidationFlags & XsValidationFlags.IgnoreValidationWarnings) != 0; }
			set {
				if (value)
					ValidationFlags |= XsValidationFlags.IgnoreValidationWarnings;
				else
					ValidationFlags &= ~XsValidationFlags.IgnoreValidationWarnings;
			}
		}

		public bool IgnoreProcessingInstructions {
			get { return ignoreProcessingInstructions; }
			set { ignoreProcessingInstructions = value; }
		}

		public bool IgnoreWhitespace {
			get { return ignoreWhitespace; }
			set { ignoreWhitespace = value; }
		}

		public int LineNumberOffset {
			get { return lineNumberOffset; }
			set { lineNumberOffset = value; }
		}

		public int LinePositionOffset {
			get { return linePositionOffset; }
			set { linePositionOffset = value; }
		}

		public bool ProhibitDtd {
			get { return prohibitDtd; }
			set { prohibitDtd = value; }
		}

		// LAMESPEC: MSDN documentation says "An empty XmlNameTable
		// object" for default value, but XmlNameTable cannot be
		// instantiate. It actually returns null by default.
		public XmlNameTable NameTable {
			get { return nameTable; }
			set { nameTable = value; }
		}

		// LAMESPEC: Apparently, this property should not have a setter.
		public XmlSchemaSet Schemas {
			get { return schemas; }
			set {
				throw new XmlException ("XmlReaderSettings.Schemas is read-only and cannot be set.");
			}
		}

		internal void SetSchemas (XmlSchemaSet schemas)
		{
			this.schemas = schemas;
		}

		public XsValidationFlags ValidationFlags {
			get { return validationFlags; }
			set { validationFlags = value; }
		}

		public ValidationType ValidationType {
			get { return validationType; }
			set { validationType = value; }
		}

		public XmlResolver XmlResolver {
			internal get { return xmlResolver; }
			set { xmlResolver = value; }
		}
	}
}

#endif