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
Resolving symbolic references in a CodeDOM.
Nova.0.6.exe.zip
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;
using System.Reflection;
using Mono.Cecil;

using Nova.Rendering;
using Nova.Resolving;
using Nova.Utilities;

namespace Nova.CodeDOM
{
    /// <summary>
    /// Represents a reference to a <see cref="ConstructorDecl"/> or <see cref="MethodDefinition"/>/<see cref="ConstructorInfo"/>.
    /// </summary>
    /// <remarks>
    /// A <see cref="ConstructorRef"/> never has type arguments.  When using <see cref="NewObject"/> to create an
    /// instance of a generic type, <see cref="NewObject"/> has a <see cref="TypeRef"/> which has the type arguments
    /// plus a hidden <see cref="ConstructorRef"/> which doesn't need or have any type arguments.
    /// </remarks>
    public class ConstructorRef : MethodRef
    {
        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a <see cref="ConstructorRef"/> from a <see cref="ConstructorDecl"/>.
        /// </summary>
        public ConstructorRef(ConstructorDecl constructorDecl, bool isFirstOnLine)
            : base(constructorDecl, isFirstOnLine)
        { }

        /// <summary>
        /// Create a <see cref="ConstructorRef"/> from a <see cref="ConstructorDecl"/>.
        /// </summary>
        public ConstructorRef(ConstructorDecl constructorDecl)
            : base(constructorDecl, false)
        { }

        /// <summary>
        /// Create a <see cref="ConstructorRef"/> from a <see cref="MethodDefinition"/>.
        /// </summary>
        public ConstructorRef(MethodDefinition methodDefinition, bool isFirstOnLine)
            : base(methodDefinition, isFirstOnLine)
        { }

        /// <summary>
        /// Create a <see cref="ConstructorRef"/> from a <see cref="MethodDefinition"/>.
        /// </summary>
        public ConstructorRef(MethodDefinition methodDefinition)
            : base(methodDefinition, false)
        { }

        /// <summary>
        /// Create a <see cref="ConstructorRef"/> from a <see cref="ConstructorInfo"/>.
        /// </summary>
        public ConstructorRef(ConstructorInfo constructorInfo, bool isFirstOnLine)
            : base(constructorInfo, isFirstOnLine)
        { }

        /// <summary>
        /// Create a <see cref="ConstructorRef"/> from a <see cref="ConstructorInfo"/>.
        /// </summary>
        public ConstructorRef(ConstructorInfo constructorInfo)
            : base(constructorInfo, false)
        { }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The name of the <see cref="ConstructorRef"/>.
        /// </summary>
        public override string Name
        {
            get
            {
                if (_reference is INamedCodeObject)
                    return ((INamedCodeObject)_reference).Name;
                if (_reference is MethodDefinition)
                {
                    TypeDefinition typeDefinition = ((MethodDefinition)_reference).DeclaringType;
                    return (typeDefinition.HasGenericParameters ? TypeDefinitionUtil.NonGenericName(typeDefinition) : typeDefinition.Name);
                }
                if (_reference is ConstructorInfo)
                {
                    Type type = ((ConstructorInfo)_reference).DeclaringType;
                    if (type != null)
                        return (type.IsGenericType ? TypeUtil.NonGenericName(type) : type.Name);
                }
                return null;
            }
        }

        /// <summary>
        /// Always <c>null</c>.
        /// </summary>
        public override ChildList<Expression> TypeArguments
        {
            get { return null; }
            set
            {
                if (value != null)
                    throw new Exception("A ConstructorRef can't have type arguments!");
            }
        }

        #endregion

        #region /* STATIC METHODS */

        /// <summary>
        /// Find the constructor of the specified <see cref="TypeDecl"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(TypeDecl typeDecl, bool isFirstOnLine, params TypeRefBase[] parameterTypes)
        {
            if (typeDecl != null)
            {
                ConstructorRef constructorRef = typeDecl.GetConstructor(parameterTypes);
                if (constructorRef != null)
                {
                    constructorRef.IsFirstOnLine = isFirstOnLine;
                    return constructorRef;
                }
                return new UnresolvedRef(typeDecl.Name, isFirstOnLine, ResolveCategory.Constructor);
            }
            return null;
        }

        /// <summary>
        /// Find the constructor of the specified <see cref="TypeDecl"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(TypeDecl typeDecl, params TypeRefBase[] parameterTypes)
        {
            return Find(typeDecl, false, parameterTypes);
        }

        /// <summary>
        /// Find the constructor of the specified type <see cref="Alias"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(Alias typeAlias, bool isFirstOnLine, params TypeRefBase[] parameterTypes)
        {
            if (typeAlias != null)
            {
                ConstructorRef constructorRef = typeAlias.GetConstructor(parameterTypes);
                if (constructorRef != null)
                {
                    constructorRef.IsFirstOnLine = isFirstOnLine;
                    return constructorRef;
                }
                return new UnresolvedRef(typeAlias.Name, isFirstOnLine, ResolveCategory.Constructor);
            }
            return null;
        }

        /// <summary>
        /// Find the constructor of the specified type <see cref="Alias"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(Alias typeAlias, params TypeRefBase[] parameterTypes)
        {
            return Find(typeAlias, false, parameterTypes);
        }

        /// <summary>
        /// Find the constructor of the specified <see cref="TypeDefinition"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(TypeDefinition typeDefinition, bool isFirstOnLine, params TypeReference[] parameterTypes)
        {
            if (typeDefinition != null)
            {
                MethodDefinition constructorDefinition = TypeDefinitionUtil.GetConstructor(typeDefinition, parameterTypes);
                if (constructorDefinition != null)
                    return new ConstructorRef(constructorDefinition, isFirstOnLine);
                return new UnresolvedRef(typeDefinition.Name, isFirstOnLine, ResolveCategory.Constructor);
            }
            return null;
        }

        /// <summary>
        /// Find the constructor of the specified <see cref="TypeDefinition"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(TypeDefinition typeDefinition, params TypeReference[] parameterTypes)
        {
            return Find(typeDefinition, false, parameterTypes);
        }

        /// <summary>
        /// Find the constructor of the specified <see cref="Type"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(Type type, bool isFirstOnLine, params Type[] parameterTypes)
        {
            if (type != null)
            {
                ConstructorInfo constructorInfo = type.GetConstructor(parameterTypes);
                if (constructorInfo != null)
                    return new ConstructorRef(constructorInfo, isFirstOnLine);
                return new UnresolvedRef(type.Name, isFirstOnLine, ResolveCategory.Constructor);
            }
            return null;
        }

        /// <summary>
        /// Find the constructor of the specified <see cref="Type"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(Type type, params Type[] parameterTypes)
        {
            return Find(type, false, parameterTypes);
        }

        /// <summary>
        /// Find the constructor of the specified <see cref="TypeRefBase"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(TypeRefBase typeRefBase, bool isFirstOnLine, params TypeRefBase[] parameterTypes)
        {
            if (typeRefBase is TypeRef)
            {
                ConstructorRef constructorRef = ((TypeRef)typeRefBase).GetConstructor(parameterTypes);
                if (constructorRef != null)
                {
                    constructorRef.IsFirstOnLine = isFirstOnLine;
                    return constructorRef;
                }
                return new UnresolvedRef(typeRefBase.Name, isFirstOnLine, ResolveCategory.Constructor);
            }
            return null;
        }

        /// <summary>
        /// Find the constructor of the specified <see cref="TypeRefBase"/> with the specified signature.
        /// </summary>
        /// <returns>A <see cref="ConstructorRef"/> to the constructor, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static TypeRefBase Find(TypeRefBase typeRefBase, params TypeRefBase[] parameterTypes)
        {
            return Find(typeRefBase, false, parameterTypes);
        }

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Get the return type of the constructor (never null).
        /// </summary>
        public override TypeRefBase GetReturnType()
        {
            return GetReturnType(this, _reference);
        }

        /// <summary>
        /// Get the return type of the constructor (never null).
        /// </summary>
        public static TypeRefBase GetReturnType(TypeRefBase thisRef, object reference)
        {
            // The 'return type' of a constructor is its declaring type, along with any type parameters
            TypeRefBase typeRefBase;
            if (reference is ConstructorDecl)
            {
                ConstructorDecl constructorDecl = (ConstructorDecl)reference;
                CodeObject parent = constructorDecl.Parent;
                if (parent == null)
                {
                    // If we don't have a parent, assume we're a generated constructor for
                    // a delegate (used for the obsolete explicit delegate creation syntax), and
                    // use the type of the parameter as our type.
                    // Clone the type so we can evaluate any type arguments it has later without consequences.
                    typeRefBase = constructorDecl.Parameters[0].EvaluateType();
                    typeRefBase = (typeRefBase != null ? (TypeRefBase)typeRefBase.Clone() : TypeRef.VoidRef);
                }
                else
                    typeRefBase = (TypeRef)parent.CreateRef();
            }
            else if (reference is MethodDefinition)
                typeRefBase = TypeRef.Create(((MethodDefinition)reference).DeclaringType);
            else //if (reference is ConstructorInfo)
                typeRefBase = TypeRef.Create(((ConstructorInfo)reference).DeclaringType);

            return typeRefBase;
        }

        /// <summary>
        /// Get the declaring type of the referenced constructor.
        /// </summary>
        public override TypeRefBase GetDeclaringType()
        {
            // Do a special check for a generated constructor for an external delegate type (see TypeRef.GetConstructors())
            ConstructorDecl constructorDecl = _reference as ConstructorDecl;
            if (constructorDecl != null && constructorDecl.Parent == null && constructorDecl.IsGenerated)
            {
                ChildList<ParameterDecl> parameters = constructorDecl.Parameters;
                if (parameters.Count == 1)
                {
                    ParameterDecl parameterDecl = parameters[0];
                    if (parameterDecl.Name == DelegateDecl.DelegateConstructorParameterName)
                        return parameterDecl.Type as TypeRef;
                }
            }
            return base.GetDeclaringType();
        }

        #endregion

        #region /* RESOLVING */

        /// <summary>
        /// Find a type argument for the specified type parameter.
        /// </summary>
        public override TypeRefBase FindTypeArgument(TypeParameterRef typeParameterRef, CodeObject originatingChild)
        {
            return null;
        }

        #endregion

        #region /* RENDERING */

        public override void AsTextExpression(CodeWriter writer, RenderFlags flags)
        {
            // Display constructors as their declaring type name, including any type arguments (this
            // is the easy way to display them with the proper type arguments and any enclosing types,
            // if appropriate).
            UpdateLineCol(writer, flags);
            TypeRefBase typeRef = GetDeclaringType();
            if (typeRef != null)
                typeRef.AsText(writer, flags &~ RenderFlags.UpdateLineCol);
            else if (_reference is ConstructorDecl)
            {
                // If we failed to get the declaring type, and we have an "orphaned" ConstructorDecl,
                // go ahead and display it's name.
                writer.WriteName(((ConstructorDecl)_reference).Name, flags);
            }
        }

        public static void AsTextConstructorInfo(CodeWriter writer, ConstructorInfo constructorInfo, RenderFlags flags)
        {
            RenderFlags passFlags = flags & ~RenderFlags.Description;

            if (!flags.HasFlag(RenderFlags.NoPreAnnotations))
                Attribute.AsTextAttributes(writer, constructorInfo);
            writer.Write(ModifiersHelpers.AsString(GetMethodModifiers(constructorInfo)));
            Type declaringType = constructorInfo.DeclaringType;
            AsTextType(writer, declaringType, passFlags);
            Dot.AsTextDot(writer);
            if (declaringType != null)
                writer.WriteName(declaringType.IsGenericType ? TypeUtil.NonGenericName(declaringType) : declaringType.Name, passFlags);
            AsTextMethodParameters(writer, constructorInfo, 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 | Mobile
Web03 | 2.8.140827.1 | Last Updated 2 Dec 2012
Article Copyright 2012 by KenBeckett
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid