//
// ObjectDescriptionCollection.cs
//
// Author:
//   Lluis Sanchez Gual
//
// Copyright (C) 2007 Novell, Inc (http://www.novell.com)
//
// 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.
//


using System;
using System.Xml;
using System.Collections;
using System.Collections.Specialized;

namespace Mono.Addins.Description
{
	/// <summary>
	/// Base class for add-in description collections.
	/// </summary>
	public class ObjectDescriptionCollection: CollectionBase
	{
		object owner;
		
		internal ObjectDescriptionCollection (object owner)
		{
			this.owner = owner;
		}
		
		/// <summary>
		/// Initializes a new instance of the <see cref="Mono.Addins.Description.ObjectDescriptionCollection"/> class.
		/// </summary>
		public ObjectDescriptionCollection ()
		{
		}
		
		/// <summary>
		/// Add an object.
		/// </summary>
		/// <param name='ep'>
		/// The object.
		/// </param>
		public void Add (ObjectDescription ep)
		{
			List.Add (ep);
		}
		
		/// <summary>
		/// Adds a collection of objects.
		/// </summary>
		/// <param name='collection'>
		/// The objects to add.
		/// </param>
		public void AddRange (ObjectDescriptionCollection collection)
		{
			foreach (ObjectDescription ob in collection)
				Add (ob);
		}
		
		/// <summary>
		/// Insert an object.
		/// </summary>
		/// <param name='index'>
		/// Insertion index.
		/// </param>
		/// <param name='ep'>
		/// The object.
		/// </param>
		public void Insert (int index, ObjectDescription ep)
		{
			List.Insert (index, ep);
		}
		
		/// <summary>
		/// Removes an object.
		/// </summary>
		/// <param name='ep'>
		/// Object to remove.
		/// </param>
		public void Remove (ObjectDescription ep)
		{
			List.Remove (ep);
		}
		
		/// <summary>
		/// Checks if an object is present in the collection.
		/// </summary>
		/// <param name='ob'>
		/// Objecect to check.
		/// </param>
		public bool Contains (ObjectDescription ob)
		{
			return List.Contains (ob);
		}
		
#pragma warning disable 1591
		protected override void OnRemove (int index, object value)
		{
			ObjectDescription ep = (ObjectDescription) value;
			if (ep.Element != null) {
				ep.Element.ParentNode.RemoveChild (ep.Element);
				ep.Element = null;
			}
			if (owner != null)
				ep.SetParent (null);
		}
		
		protected override void OnInsertComplete (int index, object value)
		{
			if (owner != null)
				((ObjectDescription)value).SetParent (owner);
		}

		protected override void OnSetComplete (int index, object oldValue, object newValue)
		{
			if (owner != null) {
				((ObjectDescription)newValue).SetParent (owner);
				((ObjectDescription)oldValue).SetParent (null);
			}
		}

		protected override void OnClear ()
		{
			if (owner != null) {
				foreach (ObjectDescription ob in List)
					ob.SetParent (null);
			}
		}
#pragma warning restore 1591

		
		internal void SaveXml (XmlElement parent)
		{
			foreach (ObjectDescription ob in this)
				ob.SaveXml (parent);
		}
		
		internal void Verify (string location, StringCollection errors)
		{
			int n=0;
			foreach (ObjectDescription ob in this) {
				ob.Verify (location + "[" + n + "]/", errors);
				n++;
			}
		}
	}
}
