Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version

Resolving Symbolic References in a CodeDOM (Part 7)

, 2 Dec 2012 CDDL
Resolving symbolic references in a CodeDOM.
Nova.0.6.exe.zip
Mono.Cecil.dll
Nova.CLI.exe
Nova.CodeDOM.dll
Nova.Examples.exe
Nova.Studio.exe
Nova.Test.exe
Nova.UI.dll
Nova.0.6.zip
Nova.CLI
Properties
Nova.CodeDOM
CodeDOM
Annotations
Base
Comments
Base
DocComments
CodeRef
Base
List
Name
Base
Other
Simple
CompilerDirectives
Base
Conditionals
Base
Messages
Base
Pragmas
Base
Symbols
Base
Base
Interfaces
Expressions
AnonymousMethods
Base
Operators
Base
Binary
Arithmetic
Base
Assignment
Base
Bitwise
Base
Conditional
Relational
Base
Shift
Base
Other
Base
Unary
Base
Other
References
Base
GotoTargets
Base
Methods
Namespaces
Other
Properties
Types
Base
Variables
Base
Projects
Assemblies
Namespaces
References
Base
Statements
Base
Conditionals
Base
Exceptions
Generics
Constraints
Base
Iterators
Base
Jumps
Loops
Methods
OperatorDecls
Miscellaneous
Namespaces
Properties
Base
Events
Types
Base
Variables
Base
Parsing
Base
Properties
Rendering
Resolving
Utilities
Mono.Cecil
Reflection
Nova.Examples
Properties
Nova.Studio
Images
About.png
Configuration.png
EditCopy.png
EditCut.png
EditDelete.png
EditPaste.png
EditRedo.png
EditUndo.png
Error.png
Exit.png
FileNew.png
FileOpen.png
FileSave.png
FileSaveAll.png
FileSaveAs.png
Find.png
Help.png
Info.png
Logo.png
Options.png
Print.png
PrintPreview.png
Properties.png
Todo.png
Warning.png
Objects.ico
Properties
Settings.settings
Nova.Test
Properties
Nova.UI
CodeDOM
Annotations
Base
Comments
Base
DocComments
CodeRef
Base
List
Name
Base
Other
Simple
CompilerDirectives
Base
Conditionals
Base
Messages
Base
Pragmas
Base
Symbols
Base
Base
Expressions
AnonymousMethods
Base
Operators
Base
Binary
Arithmetic
Base
Assignment
Base
Bitwise
Base
Conditional
Relational
Base
Shift
Base
Other
Base
Unary
Base
Other
References
Base
GotoTargets
Base
Methods
Namespaces
Other
Properties
Types
Base
Variables
Base
Projects
Namespaces
References
Base
Statements
Base
Conditionals
Base
Exceptions
Generics
Constraints
Base
Iterators
Base
Jumps
Loops
Methods
OperatorDecls
Miscellaneous
Namespaces
Properties
Base
Events
Types
Base
Variables
Base
Properties
Resolving
Utilties
// The Nova Project by Ken Beckett.
// Copyright (C) 2007-2012 Inevitable Software, all rights reserved.
// Released under the Common Development and Distribution License, CDDL-1.0: http://opensource.org/licenses/cddl1.php

using System.Collections.Generic;

using Nova.Parsing;
using Nova.Rendering;
using Nova.Resolving;

namespace Nova.CodeDOM
{
    /// <summary>
    /// The common base class of all user-defined types with optionally declared base types (<see cref="ClassDecl"/>,
    /// <see cref="StructDecl"/>, <see cref="InterfaceDecl"/>, and <see cref="EnumDecl"/>).
    /// </summary>
    public abstract class BaseListTypeDecl : TypeDecl
    {
        #region /* FIELDS */

        /// <summary>
        /// List of base types, each of which is an <see cref="Expression"/> that must evaluate to a <see cref="TypeRef"/> in valid code.
        /// </summary>
        protected ChildList<Expression> _baseTypes;

        #endregion

        #region /* CONSTRUCTORS */

        protected BaseListTypeDecl(string name, Modifiers modifiers)
            : base(name, modifiers)
        { }

        protected BaseListTypeDecl(string name, Modifiers modifiers, params TypeParameter[] typeParameters)
            : base(name, modifiers, typeParameters)
        { }

        protected BaseListTypeDecl(string name, Modifiers modifiers, params Expression[] baseTypes)
            : base(name, modifiers)
        {
            CreateBaseTypes().AddRange(baseTypes);
        }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The list of base types.
        /// </summary>
        public ChildList<Expression> BaseTypes
        {
            get { return _baseTypes; }
        }

        /// <summary>
        /// True if there are any base types.
        /// </summary>
        public bool HasBaseTypes
        {
            get { return (_baseTypes != null && _baseTypes.Count > 0); }
        }

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Create the list of base type <see cref="Expression"/>s, or return the existing one.
        /// </summary>
        public ChildList<Expression> CreateBaseTypes()
        {
            if (_baseTypes == null)
                _baseTypes = new ChildList<Expression>(this);
            return _baseTypes;
        }

        /// <summary>
        /// Add one or more base type <see cref="Expression"/>s.
        /// </summary>
        public void AddBaseTypes(params Expression[] baseTypes)
        {
            CreateBaseTypes().AddRange(baseTypes);
        }

        /// <summary>
        /// Get all base type expressions, including those of other parts if this is a partial type.
        /// </summary>
        /// <returns>The list of base type expressions, which might be either null or empty if there aren't any.</returns>
        public List<Expression> GetAllBaseTypes()
        {
            // Get the list of base types, building it if this is a partial type
            if (IsPartial)
            {
                List<Expression> baseTypes = new List<Expression>();
                if (_baseTypes != null)
                    baseTypes.AddRange(_baseTypes);
                foreach (TypeDecl otherPart in GetOtherParts())
                {
                    if (otherPart is BaseListTypeDecl)
                    {
                        BaseListTypeDecl baseListTypeDecl = (BaseListTypeDecl)otherPart;
                        if (baseListTypeDecl.HasBaseTypes)
                            baseTypes.AddRange(baseListTypeDecl.BaseTypes);
                    }
                }
                return baseTypes;
            }
            return _baseTypes;
        }

        /// <summary>
        /// Get the method with the specified name and parameter types.
        /// </summary>
        public override MethodRef GetMethod(string name, params TypeRefBase[] parameterTypes)
        {
            // Look for the method in the type declaration
            MethodDeclBase found = GetMethod<MethodDeclBase>(name, parameterTypes);
            if (found != null)
                return (MethodRef)found.CreateRef();

            // Look for the method in any base types
            List<Expression> baseTypes = GetAllBaseTypes();
            if (baseTypes != null)
            {
                foreach (Expression baseTypeExpression in baseTypes)
                {
                    TypeRef typeRef = baseTypeExpression.EvaluateType() as TypeRef;
                    if (typeRef != null)
                    {
                        MethodRef methodRef = typeRef.GetMethod(name, parameterTypes);
                        if (methodRef != null)
                            return methodRef;
                    }
                }
            }

            // Finally, look for the method in the 'object' base type
            return TypeRef.ObjectRef.GetMethod(name, parameterTypes);
        }

        /// <summary>
        /// Get all methods with the specified name.
        /// </summary>
        public override void GetMethods(string name, bool searchBaseClasses, NamedCodeObjectGroup results)
        {
            FindInAllParts<MethodDeclBase>(name, results);
            if (searchBaseClasses)
            {
                List<Expression> baseTypes = GetAllBaseTypes();
                if (baseTypes != null)
                {
                    foreach (Expression baseTypeExpression in baseTypes)
                    {
                        TypeRef typeRef = baseTypeExpression.EvaluateType() as TypeRef;
                        if (typeRef != null)
                            typeRef.GetMethods(name, true, results);
                    }
                }
            }
        }

        /// <summary>
        /// Get the property with the specified name.
        /// </summary>
        public override PropertyRef GetProperty(string name)
        {
            // Look for the property in the type declaration
            NamedCodeObjectGroup found = new NamedCodeObjectGroup();
            FindInAllParts<PropertyDecl>(name, found);
            if (found.Count > 0)
                return (PropertyRef)((PropertyDecl)found[0]).CreateRef();

            // Look for the property in any base types
            List<Expression> baseTypes = GetAllBaseTypes();
            if (baseTypes != null)
            {
                foreach (Expression baseTypeExpression in baseTypes)
                {
                    TypeRef typeRef = baseTypeExpression.EvaluateType() as TypeRef;
                    if (typeRef != null)
                    {
                        PropertyRef propertyRef = typeRef.GetProperty(name);
                        if (propertyRef != null)
                            return propertyRef;
                    }
                }
            }

            return null;
        }

        /// <summary>
        /// Determine if the type is assignable from the specified type.
        /// </summary>
        public override bool IsAssignableFrom(TypeRef typeRef)
        {
            if (typeRef == null)
                return false;

            TypeRef thisTypeRef = CreateRef();
            return (typeRef.IsSameRef(thisTypeRef) || typeRef.IsSubclassOf(thisTypeRef) || (typeRef.IsImplementationOf(thisTypeRef)));
        }

        /// <summary>
        /// Determine if the type implements the specified interface type.
        /// </summary>
        public override bool IsImplementationOf(TypeRef interfaceTypeRef)
        {
            List<Expression> baseTypes = GetAllBaseTypes();
            if (baseTypes != null)
            {
                // Check all interfaces implemented directly by the type declaration
                foreach (Expression baseTypeExpression in baseTypes)
                {
                    TypeRef baseTypeRef = baseTypeExpression.EvaluateType() as TypeRef;
                    if (baseTypeRef != null && baseTypeRef.IsInterface && baseTypeRef.IsSameRef(interfaceTypeRef))
                        return true;
                }
                // If we didn't find a match yet, search all base types/interfaces for implemented interfaces
                foreach (Expression baseTypeExpression in baseTypes)
                {
                    TypeRef baseTypeRef = baseTypeExpression.EvaluateType() as TypeRef;
                    if (baseTypeRef != null)
                    {
                        if (baseTypeRef.IsImplementationOf(interfaceTypeRef))
                            return true;
                    }
                }
            }

            return false;
        }

        /// <summary>
        /// Deep-clone the code object.
        /// </summary>
        public override CodeObject Clone()
        {
            BaseListTypeDecl clone = (BaseListTypeDecl)base.Clone();
            clone._baseTypes = ChildListHelpers.Clone(_baseTypes, clone);
            return clone;
        }

        #endregion

        #region /* PARSING */

        /// <summary>
        /// The token used to parse the code object.
        /// </summary>
        public const string ParseToken = ":";

        protected BaseListTypeDecl(Parser parser, CodeObject parent)
            : base(parser, parent)
        { }

        protected void ParseBaseTypeList(Parser parser)
        {
            // Check for compiler directives, storing them as infix annotations on the parent
            Block.ParseCompilerDirectives(parser, this, AnnotationFlags.IsInfix1);

            // Parse the base-type list (if any)
            if (parser.TokenText == ParseToken)
            {
                Token lastHeaderToken = parser.LastToken;
                parser.NextToken();  // Move past the ':'
                bool isFirstOnLine = parser.LastToken.IsFirstOnLine;

                _baseTypes = Expression.ParseList(parser, this, null);
                if (_baseTypes != null && _baseTypes.Count > 0)
                {
                    _baseTypes[0].IsFirstOnLine = isFirstOnLine;
                    // Move any regular comments from before the ':' to the first object in the list
                    _baseTypes[0].MoveComments(lastHeaderToken);
                }
            }
        }

        /// <summary>
        /// Move any trailing post annotations on the last base type to the first constraint (if any) as prefix annotations.
        /// </summary>
        protected void AdjustBaseTypePostComments()
        {
            if (_baseTypes != null)
            {
                int baseTypes = _baseTypes.Count;
                if (baseTypes > 0 && _baseTypes[baseTypes - 1].HasPostAnnotations && HasConstraintClauses)
                {
                    ChildList<Annotation> annotations = _baseTypes[baseTypes - 1].Annotations;
                    for (int i = 0; i < annotations.Count;)
                    {
                        Annotation annotation = annotations[i];
                        if (annotation.IsPostfix)
                        {
                            annotation.IsPostfix = false;
                            annotations.RemoveAt(i);
                            if (annotation.IsListed)
                                NotifyListedAnnotationRemoved(annotation);
                            ConstraintClauses[0].AttachAnnotation(annotation);
                            continue;
                        }
                        ++i;
                    }
                    if (annotations.Count == 0)
                        _baseTypes[baseTypes - 1].Annotations = null;
                }
            }
        }

        #endregion

        #region /* RESOLVING */

        /// <summary>
        /// Resolve all child symbolic references, using the specified <see cref="ResolveCategory"/> and <see cref="ResolveFlags"/>.
        /// </summary>
        public override CodeObject Resolve(ResolveCategory resolveCategory, ResolveFlags flags)
        {
            // Resolve base types in Phase 1 for top-level types, or Phase 2 for nested types
            if ((flags & ((_parent is TypeDecl ? ResolveFlags.Phase1 : ResolveFlags.Phase2) | ResolveFlags.Phase3)) == 0)
                ChildListHelpers.Resolve(_baseTypes, ResolveCategory.Type, flags);
            return base.Resolve(ResolveCategory.CodeObject, flags);
        }

        /// <summary>
        /// Returns true if the code object is an <see cref="UnresolvedRef"/> or has any <see cref="UnresolvedRef"/> children.
        /// </summary>
        public override bool HasUnresolvedRef()
        {
            if (ChildListHelpers.HasUnresolvedRef(_baseTypes))
                return true;
            return base.HasUnresolvedRef();
        }

        /// <summary>
        /// Find a type argument in a base class for the specified type parameter.
        /// </summary>
        public override TypeRefBase FindTypeArgumentInBase(TypeParameterRef typeParameterRef)
        {
            List<Expression> baseTypes = GetAllBaseTypes();
            if (baseTypes != null)
            {
                foreach (Expression baseType in baseTypes)
                {
                    TypeRefBase baseTypeRef = baseType.EvaluateType();
                    if (baseTypeRef != null)
                    {
                        TypeRefBase found = baseTypeRef.FindTypeArgument(typeParameterRef);
                        if (found != null)
                            return found;
                    }
                }
            }
            return null;
        }

        #endregion

        #region /* FORMATTING */

        /// <summary>
        /// Determines if the code object only requires a single line for display.
        /// </summary>
        public override bool IsSingleLine
        {
            get { return (base.IsSingleLine && (_baseTypes == null || _baseTypes.Count == 0 || (!_baseTypes[0].IsFirstOnLine && _baseTypes.IsSingleLine))); }
            set
            {
                base.IsSingleLine = value;
                if (value && _baseTypes != null && _baseTypes.Count > 0)
                {
                    _baseTypes[0].IsFirstOnLine = false;
                    _baseTypes.IsSingleLine = true;
                }
            }
        }

        #endregion

        #region /* RENDERING */

        protected override void AsTextSuffix(CodeWriter writer, RenderFlags flags)
        {
            if (!HasBaseTypes)
                base.AsTextSuffix(writer, flags);
        }

        protected override void AsTextAfter(CodeWriter writer, RenderFlags flags)
        {
            AsTextAnnotations(writer, AnnotationFlags.IsInfix1, flags);

            if (HasBaseTypes)
            {
                // Increase the indent level for any newlines that occur within the base list unless specifically told not to
                bool increaseIndent = !flags.HasFlag(RenderFlags.NoIncreaseIndent);
                if (increaseIndent)
                    writer.BeginIndentOnNewLine(this);

                RenderFlags passFlags = (flags & RenderFlags.PassMask);
                if (_baseTypes[0].IsFirstOnLine)
                {
                    // If the first base type is on a new line, create a new line now for the ':'
                    writer.WriteLine();
                    passFlags |= RenderFlags.SuppressNewLine;
                }
                else
                    writer.Write(" ");

                // Render any prefix annotations for the first item in the list before the ':'
                _baseTypes[0].AsTextAnnotations(writer, flags);
                writer.Write(ParseToken + " ");
                writer.WriteList(_baseTypes, passFlags | RenderFlags.NoPreAnnotations | (HasConstraintClauses ? 0 : RenderFlags.HasTerminator), this);

                // Reset the indent level
                if (increaseIndent)
                    writer.EndIndentation(this);
            }

            base.AsTextAfter(writer, flags);
        }

        #endregion
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Common Development and Distribution License (CDDL)

Share

About the Author

KenBeckett
Software Developer (Senior)
United States United States
I've been writing software since the late 70's, currently focusing mainly on C#.NET. I also like to travel around the world, and I own a Chocolate Factory (sadly, none of my employees are oompa loompas).

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.150129.1 | Last Updated 2 Dec 2012
Article Copyright 2012 by KenBeckett
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid