CppSharp/src/Bridge/Declaration.cs

using System;
using System.Collections.Generic;

namespace CppSharp
{
    public interface IRedeclarableDecl
    {
        Declaration PreviousDecl { get; }
    }

    public interface ITypedDecl
    {
        Type Type { get; }
        QualifiedType QualifiedType { get; }
    }

    public interface INamedDecl
    {
        string Name { get; set; }
    }

    public interface IMangledDecl
    {
        string Mangled { get; set; }
    }

    [Flags]
    public enum IgnoreFlags
    {
        None = 0,
        Generation = 1 << 0,
        Processing = 1 << 1,
        Explicit   = 1 << 2
    }

    /// <summary>
    /// Represents a C++ declaration.
    /// </summary>
    public abstract class Declaration : INamedDecl
    {
        // Namespace the declaration is contained in.
        public DeclarationContext Namespace;

        private string name;

        // Name of the declaration.
        public string Name
        {
            get { return name; }
            set
            {
                name = value;
                if (string.IsNullOrEmpty(OriginalName))
                    OriginalName = name;
            }
        }

        public string QualifiedName
        {
            get
            {
                if (Namespace == null)
                    return Name;
                return Namespace.IsRoot ? Name
                    : string.Format("{0}::{1}", Namespace.QualifiedName, Name);
            }
        }

        // Name of the declaration.
        public string OriginalName;

        public string QualifiedOriginalName
        {
            get
            {
                if (Namespace == null)
                    return OriginalName;
                return Namespace.IsRoot ? OriginalName
                    : string.Format("{0}::{1}", Namespace.QualifiedOriginalName, OriginalName);
            }
        }

        // Doxygen-style brief comment.
        public string BriefComment;

        // Keeps flags to know the type of ignore.
        public IgnoreFlags IgnoreFlags { get; set; }

        // Whether the declaration should be generated.
        public virtual bool IsGenerated
        {
            get
            {
                var isGenerated = !IgnoreFlags.HasFlag(IgnoreFlags.Generation);

                if (Namespace == null)
                    return isGenerated;

                return isGenerated && Namespace.IsGenerated;
            }

            set
            {
                if (value)
                    IgnoreFlags &= ~IgnoreFlags.Generation;
                else
                    IgnoreFlags |= IgnoreFlags.Generation;
            }
        }

        // Whether the declaration should be processed.
        public virtual bool IsProcessed
        {
            get
            {
                return !IgnoreFlags.HasFlag(IgnoreFlags.Processing) &&
                    Namespace.IsProcessed;
            }

            set
            {
                if (value)
                    IgnoreFlags &= ~IgnoreFlags.Processing;
                else
                    IgnoreFlags |= IgnoreFlags.Processing;
            }
        }

        // Whether the declaration was explicitly ignored.
        public bool ExplicityIgnored
        {
            get { return IgnoreFlags.HasFlag(IgnoreFlags.Explicit); }

            set
            {
                if (value)
                    IgnoreFlags |= IgnoreFlags.Explicit;
                else
                    IgnoreFlags &= ~IgnoreFlags.Explicit;
            }
        }

        // Whether the declaration should be ignored.
        public virtual bool Ignore
        {
            get
            {
                var isIgnored = IgnoreFlags != IgnoreFlags.None;

                if (Namespace != null)
                    isIgnored |= Namespace.Ignore;

                return isIgnored;
            }
        }

        // Contains debug text about the declaration.
        public string DebugText;

        // True if the declaration is incomplete (no definition).
        public bool IsIncomplete;

        // True if the declaration is dependent.
        public bool IsDependent;

        // Keeps a reference to the complete version of this declaration.
        public Declaration CompleteDeclaration;

        // Tracks the original declaration definition order.
        public uint DefinitionOrder;

        // Passes that should not be run on this declaration.
        public ISet<System.Type> ExcludeFromPasses;

        // List of preprocessed entities attached to this declaration.
        public IList<PreprocessedEntity> PreprocessedEntities; 

        protected Declaration()
        {
            IgnoreFlags = IgnoreFlags.None;
            ExcludeFromPasses = new HashSet<System.Type>();
            PreprocessedEntities = new List<PreprocessedEntity>();
        }

        protected Declaration(string name)
            : this()
        {
            Name = name;
        }

        public override string ToString()
        {
            return OriginalName;
        }

        public abstract T Visit<T>(IDeclVisitor<T> visitor);
    }

    /// <summary>
    /// Represents a type definition in C++.
    /// </summary>
    public class TypedefDecl : Declaration, ITypedDecl
    {
        public Type Type { get { return QualifiedType.Type; } }
        public QualifiedType QualifiedType { get; set; }

        public override T Visit<T>(IDeclVisitor<T> visitor)
        {
            return visitor.VisitTypedefDecl(this);
        }
    }

    public interface IDeclVisitor<out T>
    {
        T VisitDeclaration(Declaration decl);
        T VisitClassDecl(Class @class);
        T VisitFieldDecl(Field field);
        T VisitFunctionDecl(Function function);
        T VisitMethodDecl(Method method);
        T VisitParameterDecl(Parameter parameter);
        T VisitTypedefDecl(TypedefDecl typedef);
        T VisitEnumDecl(Enumeration @enum);
        T VisitVariableDecl(Variable variable);
        T VisitClassTemplateDecl(ClassTemplate template);
        T VisitFunctionTemplateDecl(FunctionTemplate template);
        T VisitMacroDefinition(MacroDefinition macro);
        T VisitNamespace(Namespace @namespace);
        T VisitEvent(Event @event);
        T VisitProperty(Property @property);
    }
}