linux-packaging-mono/mcs/class/System.Configuration/System.Configuration/ConfigurationLockCollection.cs

//
// System.Configuration.ConfigurationLockCollection.cs
//
// Authors:
//	Chris Toshok (toshok@ximian.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.
//
// Copyright (C) 2005 Novell, Inc (http://www.novell.com)
//

using System;
using System.Collections;

namespace System.Configuration 
{
	[Flags]
	internal enum ConfigurationLockType
	{
		Attribute = 0x01,
		Element = 0x02,

		Exclude = 0x10
	}

	public sealed class ConfigurationLockCollection : ICollection, IEnumerable
	{
		ArrayList names;
		ConfigurationElement element;
		ConfigurationLockType lockType;
		bool is_modified;
		Hashtable valid_name_hash;
		string valid_names;

		internal ConfigurationLockCollection (ConfigurationElement element,
						      ConfigurationLockType lockType)
		{
			names = new ArrayList ();
			this.element = element;
			this.lockType = lockType;
		}

		void CheckName (string name)
		{
			bool isAttribute = (lockType & ConfigurationLockType.Attribute) == ConfigurationLockType.Attribute;

			if (valid_name_hash == null) {
				valid_name_hash = new Hashtable ();
				foreach (ConfigurationProperty prop in element.Properties) {
					if (isAttribute == prop.IsElement)
						continue;
					valid_name_hash.Add (prop.Name, true);
				}

				/* add the add/remove/clear names of the
				 * default collection if there is one */
				if (!isAttribute) {
					ConfigurationElementCollection c = element.GetDefaultCollection ();
					valid_name_hash.Add (c.AddElementName, true);
					valid_name_hash.Add (c.ClearElementName, true);
					valid_name_hash.Add (c.RemoveElementName, true);
				}

				string[] valid_name_array = new string[valid_name_hash.Keys.Count];
				valid_name_hash.Keys.CopyTo (valid_name_array, 0);
				
				valid_names = String.Join (",", valid_name_array);
			}

			if (valid_name_hash [name] == null)
				throw new ConfigurationErrorsException (
						String.Format ("The {2} '{0}' is not valid in the locked list for this section.  The following {3} can be locked: '{1}'",
							       name, valid_names, isAttribute ? "attribute" : "element", isAttribute ? "attributes" : "elements"));
		}

		public void Add (string name)
		{
			CheckName (name);
			if (!names.Contains (name)) {
				names.Add (name);
				is_modified = true;
			}
		}

		public void Clear ()
		{
			names.Clear ();
			is_modified = true;
		}

		public bool Contains (string name)
		{
			return names.Contains (name);
		}

		public void CopyTo (string[] array, int index)
		{
			names.CopyTo (array, index);
		}

		public IEnumerator GetEnumerator()
		{
			return names.GetEnumerator ();
		}

		[MonoInternalNote ("we can't possibly *always* return false here...")]
		public bool IsReadOnly (string name)
		{
			for (int i = 0; i < names.Count; i ++) {
				if ((string)names[i] == name) {
					/* this test used to switch off whether the collection was 'Exclude' or not
					 * (the LockAll*Except collections), but that doesn't seem to be the crux of
					 * it.  maybe this returns true if the element/attribute is locked in a parent
					 * element's lock collections? */
					return false;
				}
			}

			throw new ConfigurationErrorsException (String.Format ("The entry '{0}' is not in the collection.", name));
		}

		public void Remove (string name)
		{
			names.Remove (name);
			is_modified = true;
		}

		public void SetFromList (string attributeList)
		{
			Clear ();

			char [] split = {','};
			string [] attrs = attributeList.Split (split);
			foreach (string a in attrs) {
				Add (a.Trim ());
			}
		}

		void ICollection.CopyTo (System.Array array, int index)
		{
			names.CopyTo (array, index);
		}

		public string AttributeList {
			get {
				string[] name_arr = new string[names.Count];
				names.CopyTo (name_arr, 0);
				return String.Join (",", name_arr);
			}
		}

		public int Count {
			get { return names.Count; }
		}

		[MonoTODO]
		public bool HasParentElements {
			get { return false; /* XXX */ }
		}

		[MonoTODO]
		public bool IsModified {
			get { return is_modified; }
			internal set { is_modified = value; }
		}

		[MonoTODO]
		public bool IsSynchronized {
			get { return false; /* XXX */ }
		}

		[MonoTODO]
		public object SyncRoot {
			get { return this; /* XXX */ }
		}
	}
}