mono/mcs/class/System.XML/System.Xml.Schema/XmlSchemaValidator.cs

//
// XmlSchemaValidator.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.
//

//
// LAMESPEC:
//	- There is no assurance that xsi:type precedes to any other attributes,
//	  or xsi:type is not handled.
//	- There is no SourceUri provision.
//

#if NET_2_0

using System;
using System.Collections;
using System.IO;
using System.Text;
using System.Xml;
using Mono.Xml.Schema;

using QName = System.Xml.XmlQualifiedName;
using Form = System.Xml.Schema.XmlSchemaForm;
using Use = System.Xml.Schema.XmlSchemaUse;
using ContentType = System.Xml.Schema.XmlSchemaContentType;
using Validity = System.Xml.Schema.XmlSchemaValidity;
using ValidationFlags = System.Xml.Schema.XmlSchemaValidationFlags;
using ContentProc = System.Xml.Schema.XmlSchemaContentProcessing;
using SOMList = System.Xml.Schema.XmlSchemaObjectCollection;
using SOMObject = System.Xml.Schema.XmlSchemaObject;
using XsElement = System.Xml.Schema.XmlSchemaElement;
using XsAttribute = System.Xml.Schema.XmlSchemaAttribute;
using AttrGroup = System.Xml.Schema.XmlSchemaAttributeGroup;
using AttrGroupRef = System.Xml.Schema.XmlSchemaAttributeGroupRef;
using XsDatatype = System.Xml.Schema.XmlSchemaDatatype;
using SimpleType = System.Xml.Schema.XmlSchemaSimpleType;
using ComplexType = System.Xml.Schema.XmlSchemaComplexType;
using SimpleModel = System.Xml.Schema.XmlSchemaSimpleContent;
using SimpleExt = System.Xml.Schema.XmlSchemaSimpleContentExtension;
using SimpleRst = System.Xml.Schema.XmlSchemaSimpleContentRestriction;
using ComplexModel = System.Xml.Schema.XmlSchemaComplexContent;
using ComplexExt = System.Xml.Schema.XmlSchemaComplexContentExtension;
using ComplexRst = System.Xml.Schema.XmlSchemaComplexContentRestriction;
using SimpleTypeRest = System.Xml.Schema.XmlSchemaSimpleTypeRestriction;
using SimpleTypeList = System.Xml.Schema.XmlSchemaSimpleTypeList;
using SimpleTypeUnion = System.Xml.Schema.XmlSchemaSimpleTypeUnion;
using SchemaFacet = System.Xml.Schema.XmlSchemaFacet;
using LengthFacet = System.Xml.Schema.XmlSchemaLengthFacet;
using MinLengthFacet = System.Xml.Schema.XmlSchemaMinLengthFacet;
using Particle = System.Xml.Schema.XmlSchemaParticle;
using Sequence = System.Xml.Schema.XmlSchemaSequence;
using Choice = System.Xml.Schema.XmlSchemaChoice;
using ValException = System.Xml.Schema.XmlSchemaValidationException;


namespace System.Xml.Schema
{
	public class XmlSchemaValidator
	{
		enum Transition {
			None,
			Content,
			StartTag,
			Finished
		}

		static readonly XsAttribute [] emptyAttributeArray =
			new XsAttribute [0];

		public XmlSchemaValidator (
			XmlNameTable nameTable,
			XmlSchemaSet schemas,
			IXmlNamespaceResolver nsResolver,
			ValidationFlags options)
		{
			this.nameTable = nameTable;
			this.schemas = schemas;
			this.nsResolver = nsResolver;
			this.options = options;
		}

		#region Fields

		// XmlReader/XPathNavigator themselves
		object nominalEventSender;
		IXmlLineInfo lineInfo;
		IXmlNamespaceResolver nsResolver;
		string sourceUri;

		// These fields will be from XmlReaderSettings or 
		// XPathNavigator.CheckValidity(). BTW, I think we could
		// implement XPathNavigator.CheckValidity() with
		// XsdValidatingReader.
		XmlNameTable nameTable;
		XmlSchemaSet schemas;
		XmlResolver xmlResolver = new XmlUrlResolver ();

		// "partialValidationType". but not sure how it will be used.
		SOMObject startType;

		// It is perhaps from XmlReaderSettings, but XPathNavigator
		// does not have it.
		ValidationFlags options;

		// Validation state
		Transition transition;
		XsdParticleStateManager state;

		ArrayList occuredAtts = new ArrayList ();
		XsAttribute [] defaultAttributes = emptyAttributeArray;
		ArrayList defaultAttributesCache = new ArrayList ();

#region ID Constraints
		XsdIDManager idManager = new XsdIDManager ();
#endregion

#region Key Constraints
		ArrayList keyTables = new ArrayList ();
		ArrayList currentKeyFieldConsumers = new ArrayList ();
		ArrayList tmpKeyrefPool;
#endregion
		ArrayList elementQNameStack = new ArrayList ();

		StringBuilder storedCharacters = new StringBuilder ();
		bool shouldValidateCharacters;

		int depth;
		int xsiNilDepth = -1;
		int skipValidationDepth = -1;

		SOMObject currentType;


		#endregion

		#region Public properties

		// Settable Properties

		// IMHO It should just be an event that fires another event.
		public event ValidationEventHandler ValidationEventHandler;

		public object ValidationEventSender {
			get { return nominalEventSender; }
			set { nominalEventSender = value; }
		}

		// (kinda) Construction Properties

		public IXmlLineInfo LineInfoProvider {
			get { return lineInfo; }
			set { lineInfo = value; }
		}

		public XmlResolver XmlResolver {
			set { xmlResolver = value; }
		}

		[MonoTODO]
		public string SourceUri {
			get { return sourceUri; }
			// FIXME: actually there seems no setter, but then
			// it will never make sense.
			set { sourceUri = value; }
		}
		#endregion

		#region Private properties

		private XsdValidationContext Context {
			get { return state.Context; }
		}

		private bool IgnoreWarnings {
			get { return (options & ValidationFlags
				.IgnoreValidationWarnings) != 0; }
		}

		private bool IgnoreIdentity {
			get { return (options & ValidationFlags
				.IgnoreIdentityConstraints) != 0; }
		}

		#endregion

		#region Public methods

		// State Monitor

		public XmlSchemaAttribute [] GetExpectedAttributes ()
		{
			ArrayList al = new ArrayList ();
			ComplexType cType = Context.ActualType as ComplexType;
			if (cType == null)
				return emptyAttributeArray;
			foreach (DictionaryEntry entry in cType.AttributeUses)
				if (!occuredAtts.Contains ((QName) entry.Key))
					al.Add (entry.Value);
			return (XsAttribute [])
				al.ToArray (typeof (XsAttribute));
		}

		[MonoTODO]
		public XmlSchemaParticle [] GetExpectedParticles ()
		{
			throw new NotImplementedException ();
		}

		[MonoTODO ("check return type")]
		public void GetUnspecifiedDefaultAttributes (ArrayList list)
		{
			list.AddRange (defaultAttributes);
		}

		public object FindID (string name)
		{
			// It looks returning the element's local name (string)
			return idManager.FindID (name);
		}

		// State Controller

		public void Initialize ()
		{
			Initialize (null);
		}

		[MonoTODO]
		public void Initialize (SOMObject startType)
		{
			this.startType = startType;
			transition = Transition.Content;
			state = new XsdParticleStateManager ();
			if (!schemas.IsCompiled)
				schemas.Compile ();
		}

		// It must be called at the end of the validation (to check
		// identity constraints etc.).
		public void EndValidation ()
		{
			CheckState (Transition.Content);
			transition = Transition.Finished;

			if (schemas.Count == 0)
				return;

			if (depth > 0)
				throw new InvalidOperationException (String.Format ("There are {0} open element(s). ValidateEndElement() must be called for each open element.", depth));

			// 3.3.4 ElementLocallyValidElement 7 = Root Valid.
			if (!IgnoreIdentity &&
				idManager.HasMissingIDReferences ())
				HandleError ("There are missing ID references: " + idManager.GetMissingIDString ());
		}

		// I guess it is for validation error recovery
		[MonoTODO]
		public void SkipToEndElement (XmlSchemaInfo info)
		{
			CheckState (Transition.Content);
			if (schemas.Count == 0)
				return;
			throw new NotImplementedException ();
		}

		// I guess this weird XmlValueGetter is for such case that
		// value might not be required (and thus it improves 
		// performance in some cases. Doh).

		// The return value is typed primitive, is possible.
		// AttDeriv
		public object ValidateAttribute (
			string localName,
			string ns,
			XmlValueGetter attributeValue,
			XmlSchemaInfo info)
		{
			CheckState (Transition.StartTag);
			if (ns == XmlNamespaceManager.XmlnsXmlns)
				return null;
			if (ns == XmlSchema.InstanceNamespace) {
				switch (localName) {
				case "schemaLocation":
					HandleSchemaLocation (attributeValue ());
					break;
				case "noNamespaceSchemaLocation":
					HandleNoNSSchemaLocation (attributeValue ());
					break;
				case "nil":
					HandleXsiNil (attributeValue, info);
					break;
				case "type":
					string xsiTypeName = attributeValue ();
					HandleXsiType (xsiTypeName.Trim (XmlChar.WhitespaceChars));
					break;
				default:
					HandleError ("Unknown schema instance namespace attribute: " + localName);
					break;
				}
				return null; // no further validation.
			}

			if (schemas.Count == 0)
				return null;

			occuredAtts.Add (new QName (localName, ns));

			// 3.3.4 Element Locally Valid (Type) - attribute
			if (Context.ActualType is ComplexType)
				return AssessAttributeElementLocallyValidType (localName, ns, attributeValue, info);
			else
				HandleError ("Current simple type cannot accept attributes other than schema instance namespace.");
			return null;
		}

		// StartTagOpenDeriv
		public void ValidateElement (
			string localName,
			string ns,
			XmlSchemaInfo info) // How is it used?
		{
			CheckState (Transition.Content);
			transition = Transition.StartTag;
			if (schemas.Count == 0)
				return;

#region ID Constraints
			if (!IgnoreIdentity)
				idManager.OnStartElement ();
#endregion
			defaultAttributes = emptyAttributeArray;

			elementQNameStack.Add (new XmlQualifiedName (localName, ns));

			// If there is no schema information, then no validation is performed.
			if (skipValidationDepth < 0 || depth <= skipValidationDepth) {
				if (shouldValidateCharacters)
					ValidateEndSimpleContent ();

				AssessOpenStartElementSchemaValidity (localName, ns);
			}

			shouldValidateCharacters = true;
		}

		public object ValidateEndElement (XmlSchemaInfo schemaInfo)
		{
			return ValidateEndElement (schemaInfo, null);
		}

		// The return value is typed primitive, is supplied.
		// EndTagDeriv
		[MonoTODO ("Find out what 'var' parameter means.")]
		public object ValidateEndElement (XmlSchemaInfo schemaInfo,
			object var)
		{
			CheckState (Transition.Content);
			if (schemas.Count == 0)
				return null;
			if (depth == 0)
				throw new InvalidOperationException ("There was no corresponding call to 'ValidateElement' method.");

			depth--;

			object ret = null;
			if (depth == skipValidationDepth)
				skipValidationDepth = -1;
			else if (skipValidationDepth < 0 || depth <= skipValidationDepth)
				ret = AssessEndElementSchemaValidity ();

			elementQNameStack.RemoveAt (elementQNameStack.Count - 1);

			return ret;
		}

		// StartTagCloseDeriv
		public void ValidateEndOfAttributes ()
		{
			CheckState (Transition.StartTag);
			transition = Transition.Content;
			if (schemas.Count == 0)
				return;

			AssessCloseStartElementSchemaValidity ();
		}

		// TextDeriv ... without text. Maybe typed check is done by
		// ValidateAtomicValue().
		public void ValidateText (XmlValueGetter getter)
		{
			CheckState (Transition.Content);
			if (schemas.Count == 0)
				return;

			ComplexType ct = Context.ActualType as ComplexType;
			if (ct != null && storedCharacters.Length > 0) {
				switch (ct.ContentType) {
				case XmlSchemaContentType.ElementOnly:
				case XmlSchemaContentType.Empty:
					HandleError ("Not allowed character content was found.");
					break;
				}
			}

			ValidateCharacters (getter);
		}

		// TextDeriv...?
		[MonoTODO]
		public void ValidateWhitespace (XmlValueGetter getter)
		{
			CheckState (Transition.Content);
			if (schemas.Count == 0)
				return;

//			throw new NotImplementedException ();
		}

		#endregion

		#region Error handling

		private void HandleError (string message)
		{
			HandleError (message, null, false);
		}

		private void HandleError (
			string message, Exception innerException)
		{
			HandleError (message, innerException, false);
		}

		private void HandleError (string message,
			Exception innerException, bool isWarning)
		{
			if (isWarning && IgnoreWarnings)
				return;

			ValException vex = new ValException (
				message, nominalEventSender, SourceUri,
				null, innerException);
			HandleError (vex, isWarning);
		}

		private void HandleError (ValException exception)
		{
			HandleError (exception, false);
		}

		private void HandleError (ValException exception, bool isWarning)
		{
			if (isWarning && IgnoreWarnings)
				return;

			if (ValidationEventHandler == null)
				throw exception;

			ValidationEventArgs e = new ValidationEventArgs (
				exception,
				exception.Message,
				isWarning ? XmlSeverityType.Warning :
					XmlSeverityType.Error);
			ValidationEventHandler (nominalEventSender, e);
		}

		#endregion

		#region External schema resolution

		private XmlSchema ReadExternalSchema (string uri)
		{
			Uri absUri = xmlResolver.ResolveUri ((SourceUri != "" ? new Uri (SourceUri) : null), uri);
			XmlTextReader xtr = null;
			try {
				xtr = new XmlTextReader (absUri.ToString (),
					(Stream) xmlResolver.GetEntity (
						absUri, null, typeof (Stream)),
					nameTable);
				return XmlSchema.Read (
					xtr, ValidationEventHandler);
			} finally {
				if (xtr != null)
					xtr.Close ();
			}
		}

		private void HandleSchemaLocation (string schemaLocation)
		{
			if (xmlResolver == null)
				return;
			XmlSchema schema = null;

			bool schemaAdded = false;
			string [] tmp = null;
			try {
				schemaLocation = XsDatatype.FromName ("token", XmlSchema.Namespace).Normalize (schemaLocation);
				tmp = schemaLocation.Split (XmlChar.WhitespaceChars);
			} catch (Exception ex) {
				HandleError ("Invalid schemaLocation attribute format.", ex, true);
				tmp = new string [0];
			}
			if (tmp.Length % 2 != 0)
				HandleError ("Invalid schemaLocation attribute format.");
			for (int i = 0; i < tmp.Length; i += 2) {
				try {
					schema = ReadExternalSchema (tmp [i + 1]);
				} catch (Exception) { // FIXME: (wishlist) It is bad manner ;-(
					HandleError ("Could not resolve schema location URI: " + schemaLocation, null, true);
					continue;
				}
				if (schema.TargetNamespace == null)
					schema.TargetNamespace = tmp [i];
				else if (schema.TargetNamespace != tmp [i])
					HandleError ("Specified schema has different target namespace.");

				if (schema != null) {
					if (!schemas.Contains (schema.TargetNamespace)) {
						schemaAdded = true;
						schemas.Add (schema);
					}
				}
			}
			// FIXME: should call Reprocess()?
			if (schemaAdded)
				schemas.Compile ();
		}

		private void HandleNoNSSchemaLocation (string noNsSchemaLocation)
		{
			if (xmlResolver == null)
				return;
			XmlSchema schema = null;
			bool schemaAdded = false;

			Uri absUri = null;
			XmlTextReader xtr = null;
			try {
				schema = ReadExternalSchema (noNsSchemaLocation);
			} catch (Exception) { // FIXME: (wishlist) It is bad manner ;-(
				HandleError ("Could not resolve schema location URI: " + noNsSchemaLocation, null, true);
			} finally {
				if (xtr != null)
					xtr.Close ();
			}
			if (schema != null && schema.TargetNamespace != null)
				HandleError ("Specified schema has different target namespace.");

			if (schema != null) {
				if (!schemas.Contains (schema.TargetNamespace)) {
					schemaAdded = true;
					schemas.Add (schema);
				}
			}
			// FIXME: should call Reprocess()?
			if (schemaAdded)
				schemas.Compile ();
		}

		#endregion

		private void CheckState (Transition expected)
		{
			if (transition != expected) {
				if (transition == Transition.None)
					throw new InvalidOperationException ("Initialize() must be called before processing validation.");
				else
					throw new InvalidOperationException (
						String.Format ("Unexpected attempt to validation state transition from {0} to {1} was happened.",
							transition,
							expected));
			}
		}

		private XsElement FindElement (string name, string ns)
		{
			return (XsElement) schemas.GlobalElements [new XmlQualifiedName (name, ns)];
		}

		private XmlSchemaType FindType (XmlQualifiedName qname)
		{
			return (XmlSchemaType) schemas.GlobalTypes [qname];
		}

		#region Type Validation

		private void ValidateStartElementParticle (
			string localName, string ns)
		{
			if (Context.State == null)
				return;
			Context.XsiType = null;
			state.CurrentElement = null;
			Context.EvaluateStartElement (localName,
				ns);
			if (Context.IsInvalid)
				HandleError ("Invalid start element: " + ns + ":" + localName);

			Context.SetElement (state.CurrentElement);
		}

		private void AssessOpenStartElementSchemaValidity (
			string localName, string ns)
		{
			// If the reader is inside xsi:nil (and failed
			// on validation), then simply skip its content.
			if (xsiNilDepth >= 0 && xsiNilDepth < depth)
				HandleError ("Element item appeared, while current element context is nil.");

			ValidateStartElementParticle (localName, ns);

			// Create Validation Root, if not exist.
			// [Schema Validity Assessment (Element) 1.1]
			if (Context.Element == null) {
				state.CurrentElement = FindElement (localName, ns);
				Context.SetElement (state.CurrentElement);
			}

#region Key Constraints
			if (!IgnoreIdentity)
				ValidateKeySelectors ();
				ValidateKeyFields (false, xsiNilDepth == depth,
					Context.ActualType, null, null, null);
#endregion
		}

		private void AssessCloseStartElementSchemaValidity ()
		{
			if (Context.XsiType != null)
				AssessCloseStartElementLocallyValidType ();
			else if (Context.Element != null) {
				// element locally valid is checked only when
				// xsi:type does not exist.
				AssessElementLocallyValidElement ();
				if (Context.Element.ElementType != null)
					AssessCloseStartElementLocallyValidType ();
			}

			if (Context.Element == null) {
				switch (state.ProcessContents) {
				case ContentProc.Skip:
					break;
				case ContentProc.Lax:
					break;
				default:
					QName current = (QName) elementQNameStack [elementQNameStack.Count - 1];
					if (Context.XsiType == null &&
						(schemas.Contains (current.Namespace) ||
						!schemas.MissedSubComponents (current.Namespace)))
						HandleError ("Element declaration for " + current + " is missing.");
					break;
				}
			}

			// Proceed to the next depth.

			state.PushContext ();

			XsdValidationState next = null;
			if (state.ProcessContents == ContentProc.Skip)
				skipValidationDepth = depth;
			else {
				// create child particle state.
				ComplexType xsComplexType = Context.ActualType as ComplexType;
				if (xsComplexType != null)
					next = state.Create (xsComplexType.ValidatableParticle);
				else if (state.ProcessContents == ContentProc.Lax)
					next = state.Create (XmlSchemaAny.AnyTypeContent);
				else
					next = state.Create (XmlSchemaParticle.Empty);
			}
			Context.State = next;

			depth++;
		}

		// It must be invoked after xsi:nil turned out not to be in
		// this element.
		private void AssessElementLocallyValidElement ()
		{
			XsElement element = Context.Element;
			XmlQualifiedName qname = (XmlQualifiedName) elementQNameStack [elementQNameStack.Count - 1];
			// 1.
			if (element == null)
				HandleError ("Element declaration is required for " + qname);
			// 2.
			if (element.ActualIsAbstract)
				HandleError ("Abstract element declaration was specified for " + qname);
			// 3. is checked inside ValidateAttribute().
		}

		// 3.3.4 Element Locally Valid (Type)
		private void AssessCloseStartElementLocallyValidType ()
		{
			object schemaType = Context.ActualType;
			if (schemaType == null) {	// 1.
				HandleError ("Schema type does not exist.");
				return;
			}
			ComplexType cType = schemaType as ComplexType;
			SimpleType sType = schemaType as SimpleType;
			if (sType != null) {
				// 3.1.1.
				// Attributes are checked in ValidateAttribute().
			} else if (cType != null) {
				// 3.2. Also, 2. is checked there.
				AssessCloseStartElementLocallyValidComplexType (cType);
			}
		}

		// 3.4.4 Element Locally Valid (Complex Type)
		private void AssessCloseStartElementLocallyValidComplexType (ComplexType cType)
		{
			// 1.
			if (cType.IsAbstract) {
				HandleError ("Target complex type is abstract.");
				return;
			}

			// 2 (xsi:nil and content prohibition)
			// See AssessStartElementSchemaValidity() and ValidateCharacters()
			// 3. attribute uses and  5. wild IDs are handled at
			// ValidateAttribute().

			// Collect default attributes.
			// 4.
			foreach (XsAttribute attr in GetExpectedAttributes ()) {
				if (attr.ValidatedUse == XmlSchemaUse.Required && 
					attr.ValidatedFixedValue == null)
					HandleError ("Required attribute " + attr.QualifiedName + " was not found.");
				else if (attr.ValidatedDefaultValue != null || attr.ValidatedFixedValue != null)
					defaultAttributesCache.Add (attr);
			}
			if (defaultAttributesCache.Count == 0)
				defaultAttributes = emptyAttributeArray;
			else
				defaultAttributes = (XsAttribute []) 
					defaultAttributesCache.ToArray (
						typeof (XsAttribute));
			defaultAttributesCache.Clear ();
			// 5. wild IDs was already checked at ValidateAttribute().

			occuredAtts.Clear ();
		}

		private object AssessAttributeElementLocallyValidType (string localName, string ns, XmlValueGetter getter, XmlSchemaInfo info)
		{
			ComplexType cType = Context.ActualType as ComplexType;
			XmlQualifiedName qname = new XmlQualifiedName (localName, ns);
			// including 3.10.4 Item Valid (Wildcard)
			XmlSchemaObject attMatch = XmlSchemaUtil.FindAttributeDeclaration (ns, schemas, cType, qname);
			if (attMatch == null)
				HandleError ("Attribute declaration was not found for " + qname);
			XsAttribute attdecl = attMatch as XsAttribute;
			if (attdecl != null) {
				AssessAttributeLocallyValidUse (attdecl);
				return AssessAttributeLocallyValid (attdecl, getter);
			} // otherwise anyAttribute or null.
			return null;
		}

		// 3.2.4 Attribute Locally Valid and 3.4.4
		private object AssessAttributeLocallyValid (XsAttribute attr, XmlValueGetter getter)
		{
			// 2. - 4.
			if (attr.AttributeType == null)
				HandleError ("Attribute type is missing for " + attr.QualifiedName);
			XsDatatype dt = attr.AttributeType as XsDatatype;
			if (dt == null)
				dt = ((SimpleType) attr.AttributeType).Datatype;
			// It is a bit heavy process, so let's omit as long as possible ;-)
			if (dt != SimpleType.AnySimpleType || attr.ValidatedFixedValue != null) {
				string normalized = dt.Normalize (getter ());
				object parsedValue = null;
				try {
					parsedValue = dt.ParseValue (normalized, nameTable, nsResolver);
				} catch (Exception ex) { // FIXME: (wishlist) It is bad manner ;-(
					HandleError ("Attribute value is invalid against its data type " + dt.TokenizedType, ex);
				}
				if (attr.ValidatedFixedValue != null && attr.ValidatedFixedValue != normalized) {
					HandleError ("The value of the attribute " + attr.QualifiedName + " does not match with its fixed value.");
					parsedValue = dt.ParseValue (attr.ValidatedFixedValue, nameTable, nsResolver);
				}
#region ID Constraints
				if (!IgnoreIdentity) {
					string error = idManager.AssessEachAttributeIdentityConstraint (dt, parsedValue, ((QName) elementQNameStack [elementQNameStack.Count - 1]).Name);
					if (error != null)
						HandleError (error);
				}
#endregion

				#region Key Constraints
				if (!IgnoreIdentity)
					ValidateKeyFields (
						true,
						false,
						attr.AttributeType,
						attr.QualifiedName.Name,
						attr.QualifiedName.Namespace,
						getter);
				#endregion

				return parsedValue;
			}
			return null;
		}

		private void AssessAttributeLocallyValidUse (XsAttribute attr)
		{
			// This is extra check than spec 3.5.4
			if (attr.ValidatedUse == XmlSchemaUse.Prohibited)
				HandleError ("Attribute " + attr.QualifiedName + " is prohibited in this context.");
		}

		private object AssessEndElementSchemaValidity ()
		{
			ValidateEndElementParticle ();	// validate against childrens' state.

			object ret = ValidateEndSimpleContent ();

			// 3.3.4 Assess ElementLocallyValidElement 5: value constraints.
			// 3.3.4 Assess ElementLocallyValidType 3.1.3. = StringValid(3.14.4)
			// => ValidateEndSimpleContent ().

#region Key Constraints
			if (!IgnoreIdentity)
				ValidateEndElementKeyConstraints ();
#endregion

			// Reset xsi:nil, if required.
			if (xsiNilDepth == depth)
				xsiNilDepth = -1;
			return ret;
		}

		private void ValidateEndElementParticle ()
		{
			if (Context.State != null) {
				if (!Context.EvaluateEndElement ()) {
					HandleError ("Invalid end element. There are still required content items.");
				}
			}
			state.PopContext ();
		}

		// Utility for missing validation completion related to child items.
		private void ValidateCharacters (XmlValueGetter getter)
		{
			if (xsiNilDepth >= 0 && xsiNilDepth < depth)
				HandleError ("Element item appeared, while current element context is nil.");

			if (shouldValidateCharacters)
				storedCharacters.Append (getter ());
		}


		// Utility for missing validation completion related to child items.
		private object ValidateEndSimpleContent ()
		{
			object ret = null;
			if (shouldValidateCharacters)
				ret = ValidateEndSimpleContentCore ();
			shouldValidateCharacters = false;
			storedCharacters.Length = 0;
			return ret;
		}

		private object ValidateEndSimpleContentCore ()
		{
			if (Context.ActualType == null)
				return null;

			string value = storedCharacters.ToString ();
			object ret = null;

			if (value.Length == 0) {
				// 3.3.4 Element Locally Valid (Element) 5.1.2
				if (Context.Element != null) {
					if (Context.Element.ValidatedDefaultValue != null)
						value = Context.Element.ValidatedDefaultValue;
				}					
			}

			XsDatatype dt = Context.ActualType as XsDatatype;
			SimpleType st = Context.ActualType as SimpleType;
			if (dt == null) {
				if (st != null) {
					dt = st.Datatype;
				} else {
					ComplexType ct = Context.ActualType as ComplexType;
					dt = ct.Datatype;
					switch (ct.ContentType) {
					case XmlSchemaContentType.ElementOnly:
					case XmlSchemaContentType.Empty:
						if (value.Length > 0)
							HandleError ("Character content not allowed.");
						break;
					}
				}
			}
			if (dt != null) {
				// 3.3.4 Element Locally Valid (Element) :: 5.2.2.2. Fixed value constraints
				if (Context.Element != null && Context.Element.ValidatedFixedValue != null)
					if (value != Context.Element.ValidatedFixedValue)
						HandleError ("Fixed value constraint was not satisfied.");
				ret = AssessStringValid (st, dt, value);
			}

#region Key Constraints
			if (!IgnoreIdentity)
				ValidateSimpleContentIdentity (dt, value);
#endregion

			shouldValidateCharacters = false;
			return ret;
		}

		// 3.14.4 String Valid 
		private object AssessStringValid (SimpleType st,
			XsDatatype dt, string value)
		{
			XsDatatype validatedDatatype = dt;
			object ret = null;
			if (st != null) {
				string normalized = validatedDatatype.Normalize (value);
				string [] values;
				XsDatatype itemDatatype;
				SimpleType itemSimpleType;
				switch (st.DerivedBy) {
				case XmlSchemaDerivationMethod.List:
					SimpleTypeList listContent = st.Content as SimpleTypeList;
					values = normalized.Split (XmlChar.WhitespaceChars);
					// LAMESPEC: Types of each element in
					// the returned list might be 
					// inconsistent, so basically returning 
					// value does not make sense without 
					// explicit runtime type information 
					// for base primitive type.
					object [] retValues = new object [values.Length];
					itemDatatype = listContent.ValidatedListItemType as XsDatatype;
					itemSimpleType = listContent.ValidatedListItemType as SimpleType;
					for (int vi = 0; vi < values.Length; vi++) {
						string each = values [vi];
						if (each == String.Empty)
							continue;
						// validate against ValidatedItemType
						if (itemDatatype != null) {
							try {
								retValues [vi] = itemDatatype.ParseValue (each, nameTable, nsResolver);
							} catch (Exception ex) { // FIXME: (wishlist) better exception handling ;-(
								HandleError ("List type value contains one or more invalid values.", ex);
								break;
							}
						}
						else
							AssessStringValid (itemSimpleType, itemSimpleType.Datatype, each);
					}
					ret = retValues;
					break;
				case XmlSchemaDerivationMethod.Union:
					SimpleTypeUnion union = st.Content as SimpleTypeUnion;
					{
						string each = normalized;
						// validate against ValidatedItemType
						bool passed = false;
						foreach (object eachType in union.ValidatedTypes) {
							itemDatatype = eachType as XsDatatype;
							itemSimpleType = eachType as SimpleType;
							if (itemDatatype != null) {
								try {
									ret = itemDatatype.ParseValue (each, nameTable, nsResolver);
								} catch (Exception) { // FIXME: (wishlist) better exception handling ;-(
									continue;
								}
							}
							else {
								try {
									ret = AssessStringValid (itemSimpleType, itemSimpleType.Datatype, each);
								} catch (ValException) {
									continue;
								}
							}
							passed = true;
							break;
						}
						if (!passed) {
							HandleError ("Union type value contains one or more invalid values.");
							break;
						}
					}
					break;
				case XmlSchemaDerivationMethod.Restriction:
					SimpleTypeRest str = st.Content as SimpleTypeRest;
					// facet validation
					if (str != null) {
						/* Don't forget to validate against inherited type's facets 
						 * Could we simplify this by assuming that the basetype will also
						 * be restriction?
						 * */
						 // mmm, will check later.
						SimpleType baseType = st.BaseXmlSchemaType as SimpleType;
						if (baseType != null) {
							 ret = AssessStringValid (baseType, dt, normalized);
						}
						if (!str.ValidateValueWithFacets (normalized, nameTable)) {
							HandleError ("Specified value was invalid against the facets.");
							break;
						}
					}
					validatedDatatype = st.Datatype;
					break;
				}
			}
			if (validatedDatatype != null) {
				try {
					ret = validatedDatatype.ParseValue (value, nameTable, nsResolver);
				} catch (Exception ex) {	// FIXME: (wishlist) It is bad manner ;-(
					HandleError (String.Format ("Invalidly typed data was specified."), ex);
				}
			}
			return ret;
		}

		#endregion

		#region Key Constraints Validation
		private XsdKeyTable CreateNewKeyTable (XmlSchemaIdentityConstraint ident)
		{
			XsdKeyTable seq = new XsdKeyTable (ident);
			seq.StartDepth = depth;
			this.keyTables.Add (seq);
			return seq;
		}

		// 3.11.4 Identity Constraint Satisfied
		private void ValidateKeySelectors ()
		{
			if (tmpKeyrefPool != null)
				tmpKeyrefPool.Clear ();
			if (Context.Element != null && Context.Element.Constraints.Count > 0) {
				// (a) Create new key sequences, if required.
				for (int i = 0; i < Context.Element.Constraints.Count; i++) {
					XmlSchemaIdentityConstraint ident = (XmlSchemaIdentityConstraint) Context.Element.Constraints [i];
					XsdKeyTable seq = CreateNewKeyTable (ident);
					if (ident is XmlSchemaKeyref) {
						if (tmpKeyrefPool == null)
							tmpKeyrefPool = new ArrayList ();
						tmpKeyrefPool.Add (seq);
					}
				}
			}

			// (b) Evaluate current key sequences.
			for (int i = 0; i < keyTables.Count; i++) {
				XsdKeyTable seq  = (XsdKeyTable) keyTables [i];
				if (seq.SelectorMatches (this.elementQNameStack, depth) != null) {
					// creates and registers new entry.
					XsdKeyEntry entry = new XsdKeyEntry (seq, depth, lineInfo);
					seq.Entries.Add (entry);
				}
			}
		}

		private void ValidateKeyFields (bool isAttr, bool isNil, object schemaType, string attrName, string attrNs, XmlValueGetter getter)
		{
			// (c) Evaluate field paths.
			for (int i = 0; i < keyTables.Count; i++) {
				XsdKeyTable seq  = (XsdKeyTable) keyTables [i];
				// If possible, create new field entry candidates.
				for (int j = 0; j < seq.Entries.Count; j++) {
					try {
						seq.Entries [j].ProcessMatch (
							isAttr,
							elementQNameStack,
							nominalEventSender,
							nameTable,
							SourceUri,
							schemaType,
							nsResolver,
							lineInfo,
							depth,
							attrName,
							attrNs,
							getter == null ?
								null :
								getter (),
							isNil, 
							currentKeyFieldConsumers);
					} catch (ValException ex) {
						HandleError (ex);
					}
				}
			}
		}

		private void ProcessKeyEntryOne (XsdKeyEntry entry, bool isAttr, bool isNil, object schemaType, string attrName, string attrNs, XmlValueGetter getter)
		{
		}

		private void ValidateEndElementKeyConstraints ()
		{
			// Reset Identity constraints.
			for (int i = 0; i < keyTables.Count; i++) {
				XsdKeyTable seq = this.keyTables [i] as XsdKeyTable;
				if (seq.StartDepth == depth) {
					ValidateEndKeyConstraint (seq);
				} else {
					for (int k = 0; k < seq.Entries.Count; k++) {
						XsdKeyEntry entry = seq.Entries [k] as XsdKeyEntry;
						// Remove finished (maybe key not found) entries.
						if (entry.StartDepth == depth) {
							if (entry.KeyFound)
								seq.FinishedEntries.Add (entry);
							else if (seq.SourceSchemaIdentity is XmlSchemaKey)
								HandleError ("Key sequence is missing.");
							seq.Entries.RemoveAt (k);
							k--;
						}
						// Pop validated key depth to find two or more fields.
						else {
							for (int j = 0; j < entry.KeyFields.Count; j++) {
								XsdKeyEntryField kf = entry.KeyFields [j];
								if (!kf.FieldFound && kf.FieldFoundDepth == depth) {
									kf.FieldFoundDepth = 0;
									kf.FieldFoundPath = null;
								}
							}
						}
					}
				}
			}
			for (int i = 0; i < keyTables.Count; i++) {
				XsdKeyTable seq = this.keyTables [i] as XsdKeyTable;
				if (seq.StartDepth == depth) {
					keyTables.RemoveAt (i);
					i--;
				}
			}
		}

		private void ValidateEndKeyConstraint (XsdKeyTable seq)
		{
			ArrayList errors = new ArrayList ();
			for (int i = 0; i < seq.Entries.Count; i++) {
				XsdKeyEntry entry = (XsdKeyEntry) seq.Entries [i];
				if (entry.KeyFound)
					continue;
				if (seq.SourceSchemaIdentity is XmlSchemaKey)
					errors.Add ("line " + entry.SelectorLineNumber + "position " + entry.SelectorLinePosition);
			}
			if (errors.Count > 0)
				HandleError ("Invalid identity constraints were found. Key was not found. "
					+ String.Join (", ", errors.ToArray (typeof (string)) as string []));

			errors.Clear ();
			// Find reference target
			XmlSchemaKeyref xsdKeyref = seq.SourceSchemaIdentity as XmlSchemaKeyref;
			if (xsdKeyref != null) {
				for (int i = this.keyTables.Count - 1; i >= 0; i--) {
					XsdKeyTable target = this.keyTables [i] as XsdKeyTable;
					if (target.SourceSchemaIdentity == xsdKeyref.Target) {
						seq.ReferencedKey = target;
						for (int j = 0; j < seq.FinishedEntries.Count; j++) {
							XsdKeyEntry entry = (XsdKeyEntry) seq.FinishedEntries [j];
							for (int k = 0; k < target.FinishedEntries.Count; k++) {
								XsdKeyEntry targetEntry = (XsdKeyEntry) target.FinishedEntries [k];
								if (entry.CompareIdentity (targetEntry)) {
									entry.KeyRefFound = true;
									break;
								}
							}
						}
					}
				}
				if (seq.ReferencedKey == null)
					HandleError ("Target key was not found.");
				for (int i = 0; i < seq.FinishedEntries.Count; i++) {
					XsdKeyEntry entry = (XsdKeyEntry) seq.FinishedEntries [i];
					if (!entry.KeyRefFound)
						errors.Add (" line " + entry.SelectorLineNumber + ", position " + entry.SelectorLinePosition);
				}
				if (errors.Count > 0)
					HandleError ("Invalid identity constraints were found. Referenced key was not found: "
						+ String.Join (" / ", errors.ToArray (typeof (string)) as string []));
			}
		}

		private void ValidateSimpleContentIdentity (
			XmlSchemaDatatype dt, string value)
		{
			// Identity field value
			if (currentKeyFieldConsumers != null) {
				while (this.currentKeyFieldConsumers.Count > 0) {
					XsdKeyEntryField field = this.currentKeyFieldConsumers [0] as XsdKeyEntryField;
					if (field.Identity != null)
						HandleError ("Two or more identical field was found. Former value is '" + field.Identity + "' .");
					object identity = null; // This means empty value
					if (dt != null) {
						try {
							identity = dt.ParseValue (value, nameTable, nsResolver);
						} catch (Exception ex) { // FIXME: (wishlist) This is bad manner ;-(
							HandleError ("Identity value is invalid against its data type " + dt.TokenizedType, ex);
						}
					}
					if (identity == null)
						identity = value;

					if (!field.SetIdentityField (identity, depth == xsiNilDepth, dt as XsdAnySimpleType, depth, lineInfo))
						HandleError ("Two or more identical key value was found: '" + value + "' .");
					this.currentKeyFieldConsumers.RemoveAt (0);
				}
			}
		}
		#endregion

		#region xsi:type
		private object GetXsiType (string name)
		{
			object xsiType = null;
			XmlQualifiedName typeQName =
				XmlQualifiedName.Parse (name, nsResolver);
			if (typeQName == ComplexType.AnyTypeName)
				xsiType = ComplexType.AnyType;
			else if (XmlSchemaUtil.IsBuiltInDatatypeName (typeQName))
				xsiType = XsDatatype.FromName (typeQName);
			else
				xsiType = FindType (typeQName);
			return xsiType;
		}

		private void HandleXsiType (string typename)
		{
			XsElement element = Context.Element;
			object xsiType = GetXsiType (typename);
			if (xsiType == null) {
				HandleError ("The instance type was not found: " + typename);
				return;
			}
			XmlSchemaType xsiSchemaType = xsiType as XmlSchemaType;
			if (xsiSchemaType != null && Context.Element != null) {
				XmlSchemaType elemBaseType = element.ElementType as XmlSchemaType;
				if (elemBaseType != null && (xsiSchemaType.DerivedBy & elemBaseType.FinalResolved) != 0)
					HandleError ("The instance type is prohibited by the type of the context element.");
				if (elemBaseType != xsiType && (xsiSchemaType.DerivedBy & element.BlockResolved) != 0)
					HandleError ("The instance type is prohibited by the context element.");
			}
			ComplexType xsiComplexType = xsiType as ComplexType;
			if (xsiComplexType != null && xsiComplexType.IsAbstract)
				HandleError ("The instance type is abstract: " + typename);
			else {
				// If current schema type exists, then this xsi:type must be
				// valid extension of that type. See 1.2.1.2.4.
				if (element != null) {
					AssessLocalTypeDerivationOK (xsiType, element.ElementType, element.BlockResolved);
				}
				// See also ValidateEndOfAttributes().
				Context.XsiType = xsiType;
			}
		}

		// It is common to ElementLocallyValid::4 and SchemaValidityAssessment::1.2.1.2.4
		private void AssessLocalTypeDerivationOK (object xsiType, object baseType, XmlSchemaDerivationMethod flag)
		{
			XmlSchemaType xsiSchemaType = xsiType as XmlSchemaType;
			ComplexType baseComplexType = baseType as ComplexType;
			ComplexType xsiComplexType = xsiSchemaType as ComplexType;
			if (xsiType != baseType) {
				// Extracted (not extraneous) check for 3.4.6 TypeDerivationOK.
				if (baseComplexType != null)
					flag |= baseComplexType.BlockResolved;
				if (flag == XmlSchemaDerivationMethod.All) {
					HandleError ("Prohibited element type substitution.");
					return;
				} else if (xsiSchemaType != null && (flag & xsiSchemaType.DerivedBy) != 0) {
					HandleError ("Prohibited element type substitution.");
					return;
				}
			}

			if (xsiComplexType != null)
				try {
					xsiComplexType.ValidateTypeDerivationOK (baseType, null, null);
				} catch (ValException ex) {
					HandleError (ex);
				}
			else {
				SimpleType xsiSimpleType = xsiType as SimpleType;
				if (xsiSimpleType != null) {
					try {
						xsiSimpleType.ValidateTypeDerivationOK (baseType, null, null, true);
					} catch (ValException ex) {
						HandleError (ex);
					}
				}
				else if (xsiType is XsDatatype) {
					// do nothing
				}
				else
					HandleError ("Primitive data type cannot be derived type using xsi:type specification.");
			}
		}
		#endregion

		private void HandleXsiNil (XmlValueGetter getter, XmlSchemaInfo info)
		{
			XsElement element = Context.Element;
			if (!element.ActualIsNillable) {
				HandleError (String.Format ("Current element '{0}' is not nillable and thus does not allow occurence of 'nil' attribute.", Context.Element.QualifiedName));
				return;
			}
			string value = getter ().Trim (XmlChar.WhitespaceChars);
			// 3.2.
			// Note that 3.2.1 xsi:nil constraints are to be 
			// validated in AssessElementSchemaValidity() and 
			// ValidateCharacters().
			if (value == "true") {
				if (element.ValidatedFixedValue != null)
					HandleError ("Schema instance nil was specified, where the element declaration for " + element.QualifiedName + "has fixed value constraints.");
				xsiNilDepth = depth;
				if (info != null)
					info.IsNil = true;
			}
		}
	}
}

#endif