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>
    /// Represents a generic method declaration with type parameters.
    /// </summary>
    public class GenericMethodDecl : MethodDecl, ITypeParameters
    {
        #region /* FIELDS */

        protected ChildList<TypeParameter> _typeParameters;
        protected ChildList<ConstraintClause> _constraintClauses;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a <see cref="GenericMethodDecl"/> with the specified name, return type, and modifiers.
        /// </summary>
        public GenericMethodDecl(string name, Expression returnType, Modifiers modifiers, params TypeParameter[] typeParameters)
            : base(name, returnType, modifiers)
        {
            CreateTypeParameters().AddRange(typeParameters);
        }

        /// <summary>
        /// Create a <see cref="GenericMethodDecl"/> with the specified name, return type, and modifiers.
        /// </summary>
        public GenericMethodDecl(string name, Expression returnType, Modifiers modifiers, CodeObject body, params ParameterDecl[] parameters)
            : base(name, returnType, modifiers, body, parameters)
        { }

        /// <summary>
        /// Create a <see cref="GenericMethodDecl"/> with the specified name, return type, and modifiers.
        /// </summary>
        public GenericMethodDecl(string name, Expression returnType, Modifiers modifiers, params ParameterDecl[] parameters)
            : base(name, returnType, modifiers, parameters)
        { }

        /// <summary>
        /// Create a <see cref="GenericMethodDecl"/> with the specified name and return type.
        /// </summary>
        public GenericMethodDecl(string name, Expression returnType, params TypeParameter[] typeParameters)
            : this(name, returnType, Modifiers.None, typeParameters)
        { }

        /// <summary>
        /// Create a <see cref="GenericMethodDecl"/> with the specified name and return type.
        /// </summary>
        public GenericMethodDecl(string name, Expression returnType, CodeObject body, params ParameterDecl[] parameters)
            : base(name, returnType, body, parameters)
        { }

        /// <summary>
        /// Create a <see cref="GenericMethodDecl"/> with the specified name and return type.
        /// </summary>
        public GenericMethodDecl(string name, Expression returnType, params ParameterDecl[] parameters)
            : base(name, returnType, parameters)
        { }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The list of <see cref="TypeParameter"/>s.
        /// </summary>
        public ChildList<TypeParameter> TypeParameters
        {
            get { return _typeParameters; }
        }

        /// <summary>
        /// True if there are any <see cref="TypeParameter"/>s.
        /// </summary>
        public bool HasTypeParameters
        {
            get { return (_typeParameters != null && _typeParameters.Count > 0); }
        }

        /// <summary>
        /// The number of <see cref="TypeParameter"/>s.
        /// </summary>
        public int TypeParameterCount
        {
            get { return (_typeParameters != null ? _typeParameters.Count : 0); }
        }

        /// <summary>
        /// The list of <see cref="ConstraintClause"/>s.
        /// </summary>
        public ChildList<ConstraintClause> ConstraintClauses
        {
            get { return _constraintClauses; }
        }

        /// <summary>
        /// True if there are any <see cref="ConstraintClause"/>s.
        /// </summary>
        public bool HasConstraintClauses
        {
            get { return (_constraintClauses != null && _constraintClauses.Count > 0); }
        }

        /// <summary>
        /// Always <c>true</c>.
        /// </summary>
        public override bool IsGenericMethod
        {
            get { return true; }
        }

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Create the list of <see cref="TypeParameter"/>s, or return the existing one.
        /// </summary>
        public ChildList<TypeParameter> CreateTypeParameters()
        {
            if (_typeParameters == null)
                _typeParameters = new ChildList<TypeParameter>(this);
            return _typeParameters;
        }

        /// <summary>
        /// Add one or more <see cref="TypeParameter"/>s.
        /// </summary>
        public void AddTypeParameters(params TypeParameter[] typeParameters)
        {
            CreateTypeParameters().AddRange(typeParameters);
        }

        /// <summary>
        /// Create the list of <see cref="ConstraintClause"/>s, or return the existing one.
        /// </summary>
        public ChildList<ConstraintClause> CreateConstraintClauses()
        {
            if (_constraintClauses == null)
                _constraintClauses = new ChildList<ConstraintClause>(this);
            return _constraintClauses;
        }

        /// <summary>
        /// Add one or more <see cref="ConstraintClause"/>s.
        /// </summary>
        public void AddConstraintClauses(params ConstraintClause[] constraintClauses)
        {
            CreateConstraintClauses().AddRange(constraintClauses);
        }

        /// <summary>
        /// Get any constraints for the specified <see cref="TypeParameter"/> on this method, or on the base virtual method if this method is an override.
        /// </summary>
        public List<TypeParameterConstraint> GetTypeParameterConstraints(TypeParameter typeParameter)
        {
            // Override methods don't specify constraints - they inherit them from the base virtual method.
            // In order to handle invalid code, just look in the first occurrence of constraints, searching
            // any base method if the current one is an override.
            if (_constraintClauses != null && _constraintClauses.Count > 0)
            {
                foreach (ConstraintClause constraintClause in _constraintClauses)
                {
                    if (constraintClause.TypeParameter.Reference == typeParameter)
                        return constraintClause.Constraints;
                }
            }
            else
            {
                MethodRef baseMethodRef = FindBaseMethod();
                if (baseMethodRef != null)
                {
                    // If the constraints are from a base method, we have to translate the type parameter
                    int index = FindTypeParameterIndex(typeParameter);
                    TypeParameterRef typeParameterRef = baseMethodRef.GetTypeParameter(index);
                    return baseMethodRef.GetTypeParameterConstraints(typeParameterRef);
                }
            }
            return null;
        }

        /// <summary>
        /// Create a reference to the <see cref="GenericMethodDecl"/>.
        /// </summary>
        /// <param name="isFirstOnLine">True if the reference should be displayed on a new line.</param>
        /// <returns>A <see cref="MethodRef"/>.</returns>
        public override SymbolicRef CreateRef(bool isFirstOnLine)
        {
            return new MethodRef(this, isFirstOnLine);
        }

        /// <summary>
        /// Create a reference to the <see cref="GenericMethodDecl"/>.
        /// </summary>
        /// <returns>A <see cref="MethodRef"/>.</returns>
        public MethodRef CreateRef(bool isFirstOnLine, ChildList<Expression> typeArguments)
        {
            return new MethodRef(this, isFirstOnLine, typeArguments);
        }

        /// <summary>
        /// Create a reference to the <see cref="GenericMethodDecl"/>.
        /// </summary>
        /// <returns>A <see cref="MethodRef"/>.</returns>
        public MethodRef CreateRef(ChildList<Expression> typeArguments)
        {
            return new MethodRef(this, false, typeArguments);
        }

        /// <summary>
        /// Create a reference to the <see cref="GenericMethodDecl"/>.
        /// </summary>
        /// <returns>A <see cref="MethodRef"/>.</returns>
        public MethodRef CreateRef(bool isFirstOnLine, params Expression[] typeArguments)
        {
            return new MethodRef(this, isFirstOnLine, typeArguments);
        }

        /// <summary>
        /// Create a reference to the <see cref="GenericMethodDecl"/>.
        /// </summary>
        /// <returns>A <see cref="MethodRef"/>.</returns>
        public MethodRef CreateRef(params Expression[] typeArguments)
        {
            return new MethodRef(this, false, typeArguments);
        }

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

        /// <summary>
        /// Find the index of the specified type parameter.
        /// </summary>
        public int FindTypeParameterIndex(TypeParameter typeParameter)
        {
            int index = 0;
            foreach (TypeParameter genericParameter in TypeParameters)
            {
                if (genericParameter == typeParameter)
                    return index;
                ++index;
            }
            return -1;
        }

        /// <summary>
        /// Get the type parameter at the specified index.
        /// </summary>
        public TypeParameter GetTypeParameter(int index)
        {
            if (_typeParameters != null)
            {
                if (index >= 0 && index < _typeParameters.Count)
                    return _typeParameters[index];
            }
            return null;
        }

        /// <summary>
        /// Get the full name of the <see cref="INamedCodeObject"/>, including any namespace name.
        /// </summary>
        /// <param name="descriptive">True to display type parameters and method parameters, otherwise false.</param>
        public override string GetFullName(bool descriptive)
        {
            string name = Name;
            if (descriptive)
            {
                if (_typeParameters != null && _typeParameters.Count > 0)
                    name += TypeDecl.GetTypeParametersAsString(_typeParameters);
                name += GetParametersAsString();
            }
            if (_parent is TypeDecl)
                name = ((TypeDecl)_parent).GetFullName(descriptive) + "." + name;
            return name;
        }

        #endregion

        #region /* PARSING */

        /// <summary>
        /// The token used to parse the start of the type arguments.
        /// </summary>
        public const string ParseTokenArgumentStart = TypeRefBase.ParseTokenArgumentStart;

        /// <summary>
        /// The token used to parse the end of the type arguments.
        /// </summary>
        public const string ParseTokenArgumentEnd = TypeRefBase.ParseTokenArgumentEnd;

        // Alternate type argument delimiters are allowed for code embedded inside documentation comments.
        // The C# style delimiters are also allowed in doc comments, although they shouldn't show up
        // usually, since they cause errors with parsing the XML properly - but they could be used
        // programmatically in certain situations.  Both styles are thus supported inside doc comments,
        // but the open and close delimiters must match for each pair.

        /// <summary>
        /// The alternate token used to parse the start of type arguments inside documentation comments.
        /// </summary>
        public const string ParseTokenAltArgumentStart = TypeRefBase.ParseTokenAltArgumentStart;

        /// <summary>
        /// The alternate token used to parse the start of type arguments inside documentation comments.
        /// </summary>
        public const string ParseTokenAltArgumentEnd = TypeRefBase.ParseTokenAltArgumentEnd;

        internal static new void AddParsePoints()
        {
            // Generic methods are only valid with a TypeDecl parent, but we'll allow any IBlock so that we can
            // properly parse them if they accidentally end up at the wrong level (only to flag them as errors).
            // This also allows for them to be embedded in a DocCode object.
            // Use a parse-priority of 0 (UnresolvedRef uses 100, LessThan uses 200).
            Parser.AddParsePoint(ParseTokenArgumentStart, 0, Parse, typeof(IBlock));
            // Support alternate symbols for doc comments:
            // Use a parse-priority of 0 (UnresolvedRef uses 100, PropertyDeclBase uses 200, BlockDecl uses 300, Initializer uses 400)
            Parser.AddParsePoint(ParseTokenAltArgumentStart, ParseAlt, typeof(IBlock));
        }

        /// <summary>
        /// Parse a <see cref="GenericMethodDecl"/>.
        /// </summary>
        public static new GenericMethodDecl Parse(Parser parser, CodeObject parent, ParseFlags flags)
        {
            // If our parent is a TypeDecl, verify that we have an unused identifier (a Dot operator is possible
            // for explicit interface implementations, but is handled by MethodDecl, which then calls the constructor
            // below).  Otherwise, require a possible return type in addition to the identifier.  Also verify that
            // we seem to match a type argument list pattern followed by a '('.
            // If it doesn't seem to match the proper pattern, abort so that other types can try parsing it.
            if (((parent is TypeDecl && parser.HasUnusedIdentifier) || parser.HasUnusedTypeRefAndIdentifier)
                && TypeRefBase.PeekTypeArguments(parser, TypeRefBase.ParseTokenArgumentEnd, flags) && parser.LastPeekedTokenText == ParseTokenStart)
                return new GenericMethodDecl(parser, parent, false, flags);
            return null;
        }

        /// <summary>
        /// Parse a <see cref="GenericMethodDecl"/> using alternate type argument delimiters.
        /// </summary>
        public static GenericMethodDecl ParseAlt(Parser parser, CodeObject parent, ParseFlags flags)
        {
            // Verify that this alternate form is inside a doc comment (subroutines will look for the appropriate
            // delimiters according to the parser state) in addition to passing other verifications as above.
            // If it doesn't seem to match the proper pattern, abort so that other types can try parsing it.
            if (parser.InDocComment && ((parent is TypeDecl && parser.HasUnusedIdentifier) || parser.HasUnusedTypeRefAndIdentifier)
                && TypeRefBase.PeekTypeArguments(parser, TypeRefBase.ParseTokenAltArgumentEnd, flags) && parser.LastPeekedTokenText == ParseTokenStart)
                return new GenericMethodDecl(parser, parent, false, flags);
            return null;
        }

        protected internal GenericMethodDecl(Parser parser, CodeObject parent, bool typeParametersAlreadyParsed, ParseFlags flags)
            : base(parser, parent, false, flags)
        {
            if (typeParametersAlreadyParsed)
            {
                // The type parameters were already parsed on the unused Dot expression - fetch them from there
                UnresolvedRef unresolvedRef = (UnresolvedRef)((Dot)parser.LastUnusedCodeObject).Right;
                _typeParameters = new ChildList<TypeParameter>(this);
                foreach (Expression expression in unresolvedRef.TypeArguments)
                    _typeParameters.Add(new TypeParameter(expression is UnresolvedRef ? ((UnresolvedRef)expression).Name : null));
                unresolvedRef.TypeArguments = null;
            }
            ParseMethodNameAndType(parser, parent, true, false);
            ParseModifiersAndAnnotations(parser);  // Parse any attributes and/or modifiers
            if (!typeParametersAlreadyParsed)
                _typeParameters = TypeParameter.ParseList(parser, this);  // Parse any type parameters
            ParseParameters(parser);
            _constraintClauses = ConstraintClause.ParseList(parser, this);  // Parse any constraint clauses
            ParseTerminatorOrBody(parser, flags);
        }

        #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)
        {
            ChildListHelpers.Resolve(_typeParameters, ResolveCategory.CodeObject, flags);  // Resolve any attributes on the TypeParameters
            ChildListHelpers.Resolve(_constraintClauses, ResolveCategory.CodeObject, flags);
            return base.Resolve(ResolveCategory.CodeObject, flags);
        }

        /// <summary>
        /// Resolve child code objects that match the specified name, moving up the tree until a complete match is found.
        /// </summary>
        public override void ResolveRefUp(string name, Resolver resolver)
        {
            if (resolver.ResolveCategory == ResolveCategory.Parameter)
                ChildListHelpers.ResolveRef(_parameters, name, resolver);
            else if (resolver.ResolveCategory == ResolveCategory.LocalTypeParameter)
                ChildListHelpers.ResolveRef(_typeParameters, name, resolver);
            else
            {
                if (_body != null)
                {
                    _body.ResolveRef(name, resolver);
                    if (resolver.HasCompleteMatch) return;  // Abort if we found a match
                }
                ChildListHelpers.ResolveRef(_typeParameters, name, resolver);
                if (resolver.HasCompleteMatch) return;  // Abort if we found a match
                ChildListHelpers.ResolveRef(_parameters, name, resolver);
                if (_parent != null && !resolver.HasCompleteMatch)
                    _parent.ResolveRefUp(name, resolver);
            }
        }

        /// <summary>
        /// Similar to <see cref="ResolveRefUp"/>, but skips trying to resolve the symbol in the body or parameters of a
        /// method (used for resolving parameter types).
        /// </summary>
        public override void ResolveRefUpSkipMethodBody(string name, Resolver resolver)
        {
            ChildListHelpers.ResolveRef(_typeParameters, name, resolver);
            if (_parent != null && !resolver.HasCompleteMatch)
                _parent.ResolveRefUp(name, resolver);
        }

        /// <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(_typeParameters))
                return true;
            if (ChildListHelpers.HasUnresolvedRef(_constraintClauses))
                return true;
            return base.HasUnresolvedRef();
        }

        /// <summary>
        /// Determine if the type argument counts match those in the specified <see cref="UnresolvedRef"/>.
        /// </summary>
        public virtual bool DoTypeArgumentCountsMatch(UnresolvedRef unresolvedRef)
        {
            if (TypeParameterCount == unresolvedRef.TypeArgumentCount)
                return true;
            if (unresolvedRef.TypeArgumentCount == 0)
            {
                // Arguments to generic methods can be omitted and inferred from the parameter types, so if the
                // actual count is 0, it's still considered a match *if* we have at least one method parameter.
                if (ParameterCount > 0)
                    return true;

                // If the UnresolvedRef is part of an explicit interface implementation of a GenericMethodDecl,
                // then match the actual type argument count.
                if (unresolvedRef.IsExplicitInterfaceImplementation && unresolvedRef.Parent.Parent is GenericMethodDecl)
                    return (TypeParameterCount == ((GenericMethodDecl)unresolvedRef.Parent.Parent).TypeParameterCount);
            }
            return false;
        }

        #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 && (_typeParameters == null || _typeParameters.Count == 0 || (!_typeParameters[0].IsFirstOnLine && _typeParameters.IsSingleLine))
                    && (_constraintClauses == null || _constraintClauses.Count == 0 || (!_constraintClauses[0].IsFirstOnLine && _constraintClauses.IsSingleLine)));
            }
            set
            {
                base.IsSingleLine = value;
                if (value)
                {
                    if (_typeParameters != null && _typeParameters.Count > 0)
                    {
                        _typeParameters[0].IsFirstOnLine = false;
                        _typeParameters.IsSingleLine = true;
                    }
                    if (_constraintClauses != null && _constraintClauses.Count > 0)
                    {
                        _constraintClauses[0].IsFirstOnLine = false;
                        _constraintClauses.IsSingleLine = true;
                    }
                }
            }
        }

        #endregion

        #region /* RENDERING */

        internal override void AsTextName(CodeWriter writer, RenderFlags flags)
        {
            base.AsTextName(writer, flags);
            if (HasTypeParameters)
                TypeParameter.AsTextTypeParameters(writer, _typeParameters, flags);
        }

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

        protected override void AsTextAfter(CodeWriter writer, RenderFlags flags)
        {
            ConstraintClause.AsTextConstraints(writer, _constraintClauses, flags | RenderFlags.HasTerminator);
            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
Web04 | 2.8.150327.1 | Last Updated 2 Dec 2012
Article Copyright 2012 by KenBeckett
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid