/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* GNU Lesser General Public License                                 */
/*                                                                   */
/* This library is free software; you can redistribute it and/or     */
/* modify it under the terms of the GNU Lesser General Public        */
/* License as published by the Free Software Foundation,             */
/* version 2.1 of the License.                                       */
/*                                                                   */
/* This library is distributed in the hope that it will be useful,   */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of    */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU */
/* Lesser General Public License for more details.                   */
/*                                                                   */
/* You should have received a copy of the GNU Lesser General Public  */
/* License along with this library; if not, write to the             */
/* Free Software Foundation, Inc., 59 Temple Place - Suite 330,      */
/* Boston, MA  02111-1307, USA.                                      */
/*                                                                   */
/*********************************************************************/
using System;

namespace AgentService.Agent
{
    //A custom attribute class to descript
    //all the KnowledgeType that could be present in a
    //Knowlegde instance.
    [AttributeUsage(AttributeTargets.Method)]
    public class KnowledgeItemAttribute:Attribute
    {
        #region Members

        /// <summary>
        /// the name of the KnowledgeItemAttribute
        /// </summary>
        protected string name;

        /// <summary>
        /// Gets the name of the KnowledgeItem 
        /// </summary>
        public string Name
        {
            get
            {
                return this.name;
            }
        }
        /// <summary>
        /// the type of the KnowledgeItem
        /// </summary>
        protected Type type;

        /// <summary>
        /// Gets the type of the KnowledgeItem
        /// </summary>
        public Type Type
        {
            get
            {
                return this.type;
            }
        }

        /// <summary>
        /// true if is attribute of a get method,
        /// false if is attribute of a set method
        /// </summary>
        protected bool getset;

        /// <summary>
        /// Gets if is a Set or a Get Method
        /// </summary>
        public bool GetSet
        {
            get
            {
                return this.getset;
            }
        }

        #endregion
        
        #region Constructor
        /// <summary>
        /// Constructor for KnowlegdeItemAttribute must be used in declaration 
        /// of Knowledges Types
        /// </summary>
        /// <param name="name">the name of the KnowledgeItem</param>
        /// <param name="type">the type of the KnowlegdeItem</param>
        /// <param name="getset">true if a get method, false if a set</param>
        public KnowledgeItemAttribute(String name, Type type, bool getset)
        {
            this.name = name;
            this.type = type;
            this.getset = getset;
        }
        #endregion

        #region Overrides
        /// <summary>
        /// Compare two instances for equality test.
        /// </summary>
        /// <param name="obj">instance to compare to</param>
        /// <returns>true if the two KnowledgeItemAttribute have the same name, the same type and the same accessors</returns>
        public override bool Equals(object obj)
        {
            KnowledgeItemAttribute kia = obj as KnowledgeItemAttribute;
            if (kia == null)
                return false;
            return ((kia.Type == this.type) &&
                    (kia.Name.CompareTo(this.name) == 0) &&
                    (kia.GetSet == this.getset));
        }

        ///<summary>
        /// Returns the hash code for this instance.
        ///</summary>
        ///<returns>A 32-bit signed integer hash code.</returns>
        public override int GetHashCode()
        {
            return (this.name.GetHashCode() *
                    this.type.ToString().GetHashCode() *
                    this.getset.GetHashCode());
        }
        #endregion
    }

    //A custom attribute class to descript
    //all the Knowledge that are present
    //in a particular Behaviour
    [AttributeUsage(AttributeTargets.Class)]
    public class KnowledgeAttribute : Attribute
    {
        #region Members

        /// <summary>
        /// the types of the Knowledges
        /// </summary>
        protected Type[] types;

        /// <summary>
        /// Gets the types of Knowlegdes in this Behaviour
        /// </summary>
        public Type[] Types
        {
            get
            {
                return this.types;
            }
        }

        #endregion
        
        #region Constructor
        /// <summary>
        /// Constructor of KnowledgeAttribute must be used in declaration
        /// of Behaviour Types
        /// </summary>
        /// <param name="types">the types of knowledges in behaviour</param>
        public KnowledgeAttribute(params Type[] types)
        {
            this.types = types;
        }
        #endregion

        #region Overrides
        /// <summary>
        /// Compare two instances for equality test.
        /// </summary>
        /// <param name="obj">instance to compare to</param>
        /// <returns>true if the two KnowledgeAttribute have same types</returns>
        public override bool Equals(object obj)
        {
            KnowledgeAttribute ka = obj as KnowledgeAttribute;
            if (ka == null)
            {
                return false;
            }
            return (ka.types.Equals(this.types));
        }

        ///<summary>
        /// Returns the hash code for this instance.
        ///</summary>
        ///<returns>A 32-bit signed integer hash code.</returns>
        public override int GetHashCode()
        {
            int hashcode = 1;
            foreach (Type type in this.types)
            {
                hashcode *= type.ToString().GetHashCode();
            }
            return hashcode;
        }
        #endregion
    }

    //A custom attribute class to descript
    //all the Knowledges registered by the AgentTemplate
    [AttributeUsage(AttributeTargets.Class)]
    public class AgentKnowledgesAttribute : Attribute
    {
        #region Members

        /// <summary>
        /// the types of the Knowledges
        /// </summary>
        protected Type[] types;

        /// <summary>
        /// Gets the types of The Knowledges in this AgentTemplate
        /// </summary>
        public Type[] Types
        {
            get
            {
                return this.types;
            }
        }

        #endregion
        
        #region Constructor
        /// <summary>
        /// Constructor of the AgentKnowlegdeAttribute must be used
        /// in declaration of AgentTemplate Types
        /// </summary>
        /// <param name="types">Types of knowlegdes in this agent template</param>
        public AgentKnowledgesAttribute(params Type[] types)
        {
            this.types = types;
        }
        #endregion

        #region Overrides
        /// <summary>
        /// Compare two instances for equality test.
        /// </summary>
        /// <param name="obj">instance to compare to</param>
        /// <returns>true if the two AgentKnowledgesAttribute have same types</returns>
        public override bool Equals(object obj)
        {
            AgentKnowledgesAttribute aka = obj as AgentKnowledgesAttribute;
            if (aka == null)
                return false;
            return (aka.types.Equals(this.types));
        }

        ///<summary>
        /// Returns the hash code for this instance.
        ///</summary>
        ///<returns>A 32-bit signed integer hash code.</returns>
        public override int GetHashCode()
        {
            int hashcode = 1;
            foreach (Type type in this.types)
            {
                hashcode *= type.ToString().GetHashCode();
            }
            return hashcode;
        }
        #endregion
    }

    //A custom attribute class to descript
    //all the Behaviours registered by the AgentTemplate
    [AttributeUsage(AttributeTargets.Class)]
    public class AgentBehavioursAttribute : Attribute
    {
        #region Members

        /// <summary>
        /// the types of Behaviours registered by the AgentTemplate
        /// </summary>
        protected Type[] types;

        /// <summary>
        /// Gets the types of Behaviours registered by the AgentTemplate
        /// </summary>
        public Type[] Types
        {
            get
            {
                return this.types;
            }
        }

        #endregion
        
        #region Constructor
        /// <summary>
        /// Constructor of the AgentBehaviourAttribute must be used 
        /// in declaration of AgentTemplate types
        /// </summary>
        /// <param name="types">The Behaviours used by this AgentTemplate</param>
        public AgentBehavioursAttribute(params Type[] types)
        {
            this.types = types;
        }
        #endregion

        #region Overrides
        /// <summary>
        /// Compare two instances for equality test.
        /// </summary>
        /// <param name="obj">instance to compare to</param>
        /// <returns>true if the two AgentBehavioursAttribute have same types</returns>
        public override bool Equals(object obj)
        {
            AgentBehavioursAttribute aba = obj as AgentBehavioursAttribute;
            if (aba == null)
                return false;
            return (aba.types.Equals(this.types));
        }

        ///<summary>
        /// Returns the hash code for this instance.
        ///</summary>
        ///<returns>A 32-bit signed integer hash code.</returns>
        public override int GetHashCode()
        {
            int hashcode = 1;
            foreach (Type type in this.types)
            {
                hashcode *= type.ToString().GetHashCode();
            }
            return hashcode;
        }
        #endregion
    }

    /// <summary>
    /// This class  handles agent attribute exceptions.
    /// </summary>
    public class AgentAttributeException : Exception
    {

        /// <summary>
        /// Constructs an agent attribute exception with a given message string.
        /// </summary>
        /// <param name="message">The message string.</param>
        public AgentAttributeException(string message)
            : base(message)
        {
            // TODO: Fix with Debug.WriteLine("AGENT ATTRIBUTE: {0}", message);
            // System.Console.WriteLine("AGENT ATTRIBUTE: {0}", message);
        }

        /// <summary>
        /// Constructs an agent attribute exception with a given message string and exception.
        /// </summary>
        /// <param name="message">The message string.</param>
        /// <param name="innerException">The exception.</param>
        public AgentAttributeException(string message, Exception innerException)
            : base(message, innerException)
        {
            // TODO: Fix with Debug.WriteLine("ERROR: AgentAttributeException: {0}.{1}", message, innerException.ToString());
            // System.Console.WriteLine("ERROR: AgentAttributeException: {0}.{1}", message, innerException.ToString());
        }
    }
}