ImmDoc .NET - a tool for generating HTML documentation

/*
 * Copyright 2007 Marek St�j
 * 
 * This file is part of ImmDoc .NET.
 *
 * ImmDoc .NET is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * ImmDoc .NET 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with ImmDoc .NET; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

using System;
using System.Text;
using System.IO;
using System.Reflection;
using System.Diagnostics;

using Imm.ImmDocNetLib.MyReflection.Attributes;
using Imm.ImmDocNetLib.Documenters;

namespace Imm.ImmDocNetLib.MyReflection.MetaClasses
{
    class MyEventInfo : MetaClass, ISummarisableMember
    {
        private string typeFullName;
        private string typeFullNameWithoutRevArrayStrings;
        private MyEventAttributes attributes;
        private MyInvokableMemberAttributes underlyingMethodsAttributes;
        private string example = String.Empty;

        #region Constructor(s)

        public MyEventInfo(EventInfo eventInfo, MyClassInfo declaringType)
            : base()
        {
            this.name = eventInfo.Name;

            string[] readableForms = Tools.GetHumanReadableForms(eventInfo.EventHandlerType);
            this.typeFullName = readableForms[0];
            this.typeFullNameWithoutRevArrayStrings = readableForms[1];

            this.declaringType = declaringType;

            MethodInfo adderInfo = eventInfo.GetAddMethod(true);
            Debug.Assert(adderInfo != null, "Impossible! add_Event() must have been generated.");

            this.attributes = GetMyEventAttributes(eventInfo);
            this.underlyingMethodsAttributes = GetMyInvokableMemberAttributes(adderInfo);

            this.CheckSupport(eventInfo, adderInfo.Attributes);
        }

        #endregion

        #region Private helper methods

        private void CheckSupport(EventInfo eventInfo, MethodAttributes methodAttributes)
        {
            EventAttributes eventAttributes = eventInfo.Attributes;

            string warningTemplate = "Event '" + name + "' has unsupported attribute: '{0}'.";

            // in order to reduce output we warn only about important attributes which are not currently
            // supported:

            // EventInfo properties
            if (!eventInfo.IsMulticast) { Logger.Warning("Event '" + name + "' is not multicast (such events are not supported)."); }

            // EventAttributes
            //if ((eventAttributes & EventAttributes.RTSpecialName) != 0) { Logger.Warning(warningTemplate, "RTSpecialName"); }
            //if ((eventAttributes & EventAttributes.SpecialName) != 0) { Logger.Warning(warningTemplate, "SpecialName"); }

            // MethodAttributes
            //if ((methodAttributes & MethodAttributes.CheckAccessOnOverride) != 0) { Logger.Warning(warningTemplate, "CheckAccessOnOverride"); }
            //if ((methodAttributes & MethodAttributes.FamANDAssem) != 0) { Logger.Warning(warningTemplate, "FamANDAssem"); }
            // TODO: support this: if ((methodAttributes & MethodAttributes.HasSecurity) != 0) { Logger.Warning(warningTemplate, "HasSecurity"); }
            //if ((methodAttributes & MethodAttributes.HideBySig) != 0) { Logger.Warning(warningTemplate, "HideBySig"); }
            //if ((methodAttributes & MethodAttributes.NewSlot) != 0) { Logger.Warning(warningTemplate, "NewSlot"); }
            // TODO: support this: if ((methodAttributes & MethodAttributes.PinvokeImpl) != 0) { Logger.Warning(warningTemplate, "PinvokeImpl"); }
            //if ((methodAttributes & MethodAttributes.PrivateScope) != 0) { Logger.Warning(warningTemplate, "PrivateScope"); }
            // TODO: support this: if ((methodAttributes & MethodAttributes.RequireSecObject) != 0) { Logger.Warning(warningTemplate, "RequiresSecObject"); }
            //if ((methodAttributes & MethodAttributes.ReuseSlot) != 0) { Logger.Warning(warningTemplate, "ReuseSlot"); }
            //if ((methodAttributes & MethodAttributes.RTSpecialName) != 0) { Logger.Warning(warningTemplate, "RTSpecialName"); }
            //if ((methodAttributes & MethodAttributes.SpecialName) != 0) { Logger.Warning(warningTemplate, "SpecialName"); }
            // TODO: support this: if ((methodAttributes & MethodAttributes.UnmanagedExport) != 0) { Logger.Warning(warningTemplate, "UnmanagedExport"); }
        }

        private static MyEventAttributes GetMyEventAttributes(EventInfo eventInfo)
        {
            MyEventAttributes myEventAttributes = MyEventAttributes.None;

            return myEventAttributes;
        }

        private static MyInvokableMemberAttributes GetMyInvokableMemberAttributes(MethodInfo methodInfo)
        {
            return MyInvokableMemberInfo.GetMyInvokableMemberAttributes(methodInfo);
        }

        private static string MyEventAndMyInvokableMemberAttributesToString(MyEventAttributes myEventAttributes, MyInvokableMemberAttributes myInvokableMemberAttributes)
        {
            // for now only MyInvokableMemberInfo attributes
            return MyInvokableMemberInfo.MyInvokableMemberAttributesToString(myInvokableMemberAttributes);
        }

        #endregion

        #region Public properties

        public string TypeFullName
        {
            get { return typeFullName; }
        }

        public string AttributesString
        {
            get { return MyEventAndMyInvokableMemberAttributesToString(attributes, underlyingMethodsAttributes); }
        }

        public bool IsPublic
        {
            get { return (underlyingMethodsAttributes & MyInvokableMemberAttributes.Public) != 0; }
        }

        public bool IsProtected
        {
            get { return (underlyingMethodsAttributes & MyInvokableMemberAttributes.Protected) != 0; }
        }

        public bool IsStatic
        {
            get { return (underlyingMethodsAttributes & MyInvokableMemberAttributes.Static) != 0; }
        }

        public bool IsAbstract
        {
            get { return (underlyingMethodsAttributes & MyInvokableMemberAttributes.Abstract) != 0; }
        }

        public bool IsVirtual
        {
            get { return (underlyingMethodsAttributes & MyInvokableMemberAttributes.Virtual) != 0; }
        }

        public string Example
        {
            get { return example; }
            set { example = value; }
        }

        #endregion

        #region ISummarisableMember Members

        public string DisplayableName
        {
            get { return name; }
        }

        #endregion

        #region MetaClass overrides

        public override string GetMetaName()
        {
            return "Event";
        }

        #endregion
    }
}