/*

   * Licensed to the Apache Software Foundation (ASF) under one or more

   * contributor license agreements.  See the NOTICE file distributed with

   * this work for additional information regarding copyright ownership.

   * The ASF licenses this file to You under the Apache License, Version 2.0

   * (the "License"); you may not use this file except in compliance with

   * the License.  You may obtain a copy of the License at

   *

   *      http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.apache.wicket.markup;

 import java.lang.ref.WeakReference;

 import java.util.ArrayList;

 import java.util.Collection;

 import java.util.Collections;

 import java.util.Iterator;

 import java.util.LinkedList;

 import java.util.List;

 import java.util.Map;

 import org.apache.wicket.Response;

 import org.apache.wicket.behavior.IBehavior;

 import org.apache.wicket.markup.parser.XmlTag;

 import org.apache.wicket.markup.parser.XmlTag.Type;

 import org.apache.wicket.markup.parser.filter.HtmlHandler;

 import org.apache.wicket.util.string.AppendingStringBuffer;

 import org.apache.wicket.util.string.StringValue;

 import org.apache.wicket.util.string.Strings;

 import org.apache.wicket.util.value.IValueMap;

 public class ComponentTag extends MarkupElement

 {
	

 	public static final String DEFAULT_WICKET_NAMESPACE = "wicket";

	

 	private static final List EMPTY_LIST = new LinkedList();

	

 	protected ComponentTag closes;

	

 	protected final XmlTag xmlTag;

	

 	private boolean autolink = false;

	

 	private String id;

	

 	private String path;

	

 	private boolean modified = false;

	

 	private boolean ignore = false;

	

 	private WeakReference/*<Class>*/ markupClassRef = new WeakReference(null);

	

 	private boolean hasNoCloseTag = false;

	

 	// FIXME these behaviors here are merely for wicket:message attributes on

 	// tags that are also wicket components. since this addition behavors have

	// gained a significantly more sophisticated lifecycle and so managing

	// behaviors attached to markup tags like this is much harder. this should

	// be refactored into some interface that only has oncomponenttag method

	// because a full behavior is not supported nor desired imho.

	private Collection behaviors;

	

	public ComponentTag(final String name, final XmlTag.Type type)

	{

		final XmlTag tag = new XmlTag();

		tag.setName(name);

		tag.setType(type);

		xmlTag = tag;

	}

	

	public ComponentTag(final XmlTag tag)

	{

		super();

		xmlTag = tag;

	}

	

	public final void addBehavior(final IBehavior behavior)

	{

		if (behavior == null)

		{

			throw new IllegalArgumentException("Argument [behavior] cannot be null");

		}

		if (behaviors == null)

		{

			behaviors = new LinkedList();

		}

		behaviors.add(behavior);

	}

	

	public final boolean hasBehaviors()

	{

		return behaviors != null;

	}

	

	public final Iterator getBehaviors()

	{

		if (behaviors == null)

		{

			List empty = EMPTY_LIST;

			return empty.iterator();

		}

		Collection locked = Collections.unmodifiableCollection(behaviors);

		return locked.iterator();

	}

	

	public final boolean closes(final MarkupElement open)

	{

		if (open instanceof ComponentTag)

		{

			return (closes == open) || getXmlTag().closes(((ComponentTag)open).getXmlTag());

		}

		return false;

	}

	

	public final void enableAutolink(final boolean autolink)

	{

		this.autolink = autolink;

	}

	

	public final IValueMap getAttributes()

	{

		return xmlTag.getAttributes();

	}

	

	public final String getId()

	{

		return id;

	}

	

	public final int getLength()

	{

		return xmlTag.getLength();

	}

	

	public final String getName()

	{

		return xmlTag.getName();

	}

	

	public final boolean getNameChanged()

	{

		return xmlTag.getNameChanged();

	}

	

	public final String getNamespace()

	{

		return xmlTag.getNamespace();

	}

	

	public final ComponentTag getOpenTag()

	{

		return closes;

	}

	

	public final int getPos()

	{

		return xmlTag.getPos();

	}

	

	public final CharSequence getString(String key)

	{

		return xmlTag.getString(key);

	}

	

	public final Type getType()

	{

		return xmlTag.getType();

	}

	

	public final boolean isAutolinkEnabled()

	{

		return this.autolink;

	}

	

	public final boolean isClose()

	{

		return xmlTag.isClose();

	}

	

	public final boolean isOpen()

	{

		return xmlTag.isOpen();

	}

	

	public final boolean isOpen(String id)

	{

		return xmlTag.isOpen() && this.id.equals(id);

	}

	

	public final boolean isOpenClose()

	{

		return xmlTag.isOpenClose();

	}

	

	public final boolean isOpenClose(String id)

	{

		return xmlTag.isOpenClose() && this.id.equals(id);

	}

	

	public boolean hasEqualTagName(final ComponentTag tag)

	{

		return xmlTag.hasEqualTagName(tag.getXmlTag());

	}

	

	public final void makeImmutable()

	{

		xmlTag.makeImmutable();

	}

	

	public ComponentTag mutable()

	{

		if (xmlTag.isMutable())

		{

			return this;

		}

		else

		{

			final ComponentTag tag = new ComponentTag(xmlTag.mutable());

			copyPropertiesTo(tag);

			return tag;

		}

	}

	

	void copyPropertiesTo(ComponentTag dest)

	{

		dest.id = id;

		dest.setMarkupClass((Class)this.markupClassRef.get());

		dest.setHasNoCloseTag(this.hasNoCloseTag);

		dest.setPath(this.path);

		if (behaviors != null)

		{

			dest.behaviors = new ArrayList(behaviors.size());

			dest.behaviors.addAll(behaviors);

		}

	}

	

	public final void put(String key, boolean value)

	{

		xmlTag.put(key, value);

	}

	

	public final void put(String key, int value)

	{

		xmlTag.put(key, value);

	}

	

	public final void put(String key, CharSequence value)

	{

		xmlTag.put(key, value);

	}

	

	public final void put(String key, StringValue value)

	{

		xmlTag.put(key, value);

	}

	

	public final void putAll(final Map map)

	{

		xmlTag.putAll(map);

	}

	

	public final void remove(String key)

	{

		xmlTag.remove(key);

	}

	

	public final boolean requiresCloseTag()

	{

		if (getNamespace() == null)

		{

			return HtmlHandler.requiresCloseTag(getName());

		}

		else

		{

			return HtmlHandler.requiresCloseTag(getNamespace() + ":" + getName());

		}

	}

	

	public final void setId(final String id)

	{

		this.id = id;

	}

	

	public final void setName(String name)

	{

		xmlTag.setName(name);

	}

	

	public final void setNamespace(String namespace)

	{

		xmlTag.setNamespace(namespace);

	}

	

	public final void setOpenTag(final ComponentTag tag)

	{

		this.closes = tag;

		getXmlTag().setOpenTag(tag.getXmlTag());

	}

	

	public final void setType(final Type type)

	{

		xmlTag.setType(type);

	}

	

	public final CharSequence syntheticCloseTagString()

	{

		AppendingStringBuffer buf = new AppendingStringBuffer();

		buf.append("</");

		if (getNamespace() != null)

		{

			buf.append(getNamespace()).append(":");

		}

		buf.append(getName()).append(">");

		return buf;

	}

	

	public CharSequence toCharSequence()

	{

		return xmlTag.toCharSequence();

	}

	

	public final String toString()

	{

		return toCharSequence().toString();

	}

	

	public final void writeOutput(final Response response, final boolean stripWicketAttributes,

			final String namespace)

	{

		response.write("<");

		if (getType() == XmlTag.CLOSE)

		{

			response.write("/");

		}

		if (getNamespace() != null)

		{

			response.write(getNamespace());

			response.write(":");

		}

		response.write(getName());

		String namespacePrefix = null;

		if (stripWicketAttributes == true)

		{

			namespacePrefix = namespace + ":";

		}

		if (getAttributes().size() > 0)

		{

			final Iterator iterator = getAttributes().keySet().iterator();

			while (iterator.hasNext())

			{

				final String key = (String)iterator.next();

				if (key == null)

				{

					continue;

				}

				if ((namespacePrefix == null) || (key.startsWith(namespacePrefix) == false))

				{

					response.write(" ");

					response.write(key);

					CharSequence value = getString(key);

					// attributes without values are possible, e.g. 'disabled'

					if (value != null)

					{

						response.write("=\"");

						value = Strings.replaceAll(value, "\"", "\\\"");

						response.write(value);

						response.write("\"");

					}

				}

			}

		}

		if (getType() == XmlTag.OPEN_CLOSE)

		{

			response.write("/");

		}

		response.write(">");

	}

	

	public final String toUserDebugString()

	{

		return xmlTag.toUserDebugString();

	}

	

	final XmlTag getXmlTag()

	{

		return xmlTag;

	}

	

	public final void setModified(final boolean modified)

	{

		this.modified = modified;

	}


	

	public final boolean isModified()

	{

		return this.modified;

	}

	

	public String getPath()

	{

		return path;

	}

	

	void setPath(final String path)

	{

		this.path = path;

	}

	

	public boolean hasNoCloseTag()

	{

		return hasNoCloseTag;

	}

	

	public void setHasNoCloseTag(boolean hasNoCloseTag)

	{

		this.hasNoCloseTag = hasNoCloseTag;

	}

	

	public Class getMarkupClass()

	{

		return (Class)markupClassRef.get();

	}

	

	public void setMarkupClass(Class wicketHeaderClass)

	{

		this.markupClassRef = new WeakReference(wicketHeaderClass);

	}

	

	public boolean equalTo(final MarkupElement element)

	{

		if (element instanceof ComponentTag)

		{

			final ComponentTag that = (ComponentTag)element;

			return getXmlTag().equalTo(that.getXmlTag());

		}

		return false;

	}

	

	public boolean isIgnore()

	{

		return this.ignore;

	}

	

	public void setIgnore(boolean ignore)

	{

		this.ignore = ignore;

	}

}