Click here to Skip to main content
11,478,066 members (75,120 online)
Click here to Skip to main content
Add your own
alternative version

Resolving Symbolic References in a CodeDOM (Part 7)

, 2 Dec 2012 CDDL 5.7K 333 13
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;
using System.IO;
using System.Xml;

using Nova.Resolving;
using Nova.Utilities;

namespace Nova.CodeDOM
{
    /// <summary>
    /// Represents a project reference to another project in the same solution.
    /// </summary>
    public class ProjectReference : Reference
    {
        #region /* FIELDS */

        protected string _projectFileName;
        protected Guid _guid;
        protected Guid? _package;

        protected Project _referencedProject;
        protected bool _treatAsAssemblyReference;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a new <see cref="ProjectReference"/> with the specified name, file name, and GUID.
        /// </summary>
        public ProjectReference(string name, string projectFileName, Guid projectGuid)
            : base(name, false)
        {
            _projectFileName = projectFileName;
            _guid = projectGuid;
        }

        /// <summary>
        /// Create a new <see cref="ProjectReference"/> with the specified name and file name.
        /// </summary>
        public ProjectReference(string name, string projectFileName)
            : this(name, projectFileName, new Guid())
        {
            _projectFileName = projectFileName;
        }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The file name of the referenced <see cref="Project"/>.
        /// </summary>
        public string ProjectFileName
        {
            get { return _projectFileName; }
        }

        /// <summary>
        /// The unique identifier of the referenced <see cref="Project"/>.
        /// </summary>
        public Guid Guid
        {
            get { return _guid; }
        }

        /// <summary>
        /// The associated package, if any.
        /// </summary>
        public Guid? Package
        {
            get { return _package; }
        }

        /// <summary>
        /// The referenced <see cref="Project"/>.
        /// </summary>
        public Project ReferencedProject
        {
            get { return _referencedProject; }
            set { _referencedProject = value; }
        }

        /// <summary>
        /// True if the project reference should be treated as an assembly reference.
        /// </summary>
        public override bool TreatAsAssemblyReference
        {
            get { return (_referencedProject != null && _treatAsAssemblyReference); }
        }

        /// <summary>
        /// The descriptive category of the code object.
        /// </summary>
        public override string Category
        {
            get { return "Project"; }
        }

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Load the reference.
        /// </summary>
        public override void Load()
        {
            // If the project wasn't found in the solution, or the project type isn't supported (non-C# projects),
            // look for and load any last-built assembly if possible in order to resolve external type references.
            // Otherwise, we don't have to do anything - when symbols are being resolved, any referenced Projects
            // will be checked at that time.
            if (TreatAsAssemblyReference)
            {
                // Ideally, we'll at least parse the unsupported project enough to get the OutputPath and AssemblyName.
                // Otherwise, we have to make our best guess based solely upon the FileName.
                string outputPath = _referencedProject.GetFullOutputPath();
                string directory = Path.GetDirectoryName(_referencedProject.FileName);
                string assemblyPath = (!string.IsNullOrEmpty(outputPath) ? FileUtil.CombineAndNormalizePath(directory, outputPath)
                    : (directory + @"\Bin\" + (_parent != null ? ParentProject.ConfigurationName + @"\" : "")))
                    + (!string.IsNullOrEmpty(_referencedProject.AssemblyName) ? _referencedProject.AssemblyName
                    : Path.GetFileNameWithoutExtension(_referencedProject.FileName))
                    + (_referencedProject.OutputType == Project.OutputTypes.Library ? ".dll" : ".exe");

                string errorMessage = LoadAssembly(assemblyPath);
                if (errorMessage != null)
                    LogAndAttachMessage(errorMessage, MessageSeverity.Error, MessageSource.Load);
            }
        }

        #endregion

        #region /* PARSING */

        /// <summary>
        /// Parse from the specified <see cref="XmlReader"/>.
        /// </summary>
        public ProjectReference(XmlReader xmlReader, Project project)
            : base(project)
        {
            try
            {
                if (xmlReader.MoveToAttribute("Include"))
                {
                    _projectFileName = xmlReader.Value;
                    xmlReader.MoveToElement();
                    if (!xmlReader.IsEmptyElement)
                    {
                        while (xmlReader.Read())
                        {
                            if (xmlReader.IsStartElement())
                            {
                                if (xmlReader.Name == "Project")
                                    _guid = Guid.Parse(xmlReader.ReadString());
                                else if (xmlReader.Name == "Name")
                                    _name = xmlReader.ReadString();
                                else if (xmlReader.Name == "Package")
                                    _package = Guid.Parse(xmlReader.ReadString());
                                else if (xmlReader.Name == "Aliases")
                                    Alias = xmlReader.ReadString();
                            }
                            if (xmlReader.NodeType == XmlNodeType.EndElement && xmlReader.Name == "ProjectReference")
                                break;
                        }
                    }
                }
            }
            catch (Exception ex)
            {
                LogAndAttachException(ex, "parsing", MessageSource.Parse);
            }
        }

        #endregion

        #region /* RESOLVING */

        /// <summary>
        /// Resolve the reference.
        /// </summary>
        public override void Resolve(ResolveFlags flags)
        {
            // Clear any existing error messages from a previous resolve pass
            RemoveAllMessages(MessageSource.Resolve);

            // Resolve the project reference
            if (_parent != null && ParentProject.Solution != null)
            {
                Solution solution = ParentProject.Solution;
                if (_name.StartsWith("{"))
                {
                    // If the project name is a string GUID, look up the project by GUID (this is used for website projects)
                    Guid projectGuid = Guid.Parse(_name);
                    _referencedProject = solution.FindProject(projectGuid);
                    if (_referencedProject != null)
                    {
                        // Change the project reference to a direct one instead of using the GUID
                        _name = _referencedProject.Name;
                        _projectFileName = FileUtil.MakeRelative(ParentProject.GetDirectory() + @"\", _referencedProject.FileName);
                    }
                }
                else if (_projectFileName != null)
                {
                    // Using the Name to search for a Project reference won't always work, because VS doesn't update reference names
                    // when projects are renamed.  So, resolve project references based upon the project path.  
                    string projectFullFileName = FileUtil.CombineAndNormalizePath(ParentProject.GetDirectory(), _projectFileName);
                    _referencedProject = solution.FindProjectByFileName(projectFullFileName);
                    if (_referencedProject == null)
                    {
                        string message;
                        MessageSeverity severity;
                        if (solution.IsNew && !ParentProject.IsNew)
                        {
                            message = "Referenced project '" + _name + "' treated as assembly reference since project was loaded directly";
                            severity = MessageSeverity.Information;
                        }
                        else
                        {
                            message = "Referenced project '" + _name + "' not found in current solution (using any assembly instead)";
                            severity = MessageSeverity.Warning;
                        }
                        ParentProject.LogMessage(message, severity);
                        AttachMessage(message, severity, MessageSource.Resolve);

                        // If a referenced project couldn't be found in the current solution, attempt to locate and parse the
                        // project file so that we can possibly load the last-built assembly in order to resolve references.
                        if (File.Exists(projectFullFileName))
                        {
                            _referencedProject = Project.Parse(projectFullFileName, ParentProject.Solution);
                            _treatAsAssemblyReference = true;
                        }
                    }
                }
                if (_referencedProject != null)
                {
                    // Treat unsupported projects as assembly references
                    if (_referencedProject.NotSupported)
                        _treatAsAssemblyReference = true;
                }
            }
            else
                AttachMessage("Can't resolve referenced project '" + _name + "' without a parent project and solution", MessageSeverity.Error, MessageSource.Resolve);
        }

        #endregion

        #region /* RENDERING */

        /// <summary>
        /// Write to the specified <see cref="XmlWriter"/>.
        /// </summary>
        public override void AsText(XmlWriter xmlWriter)
        {
            xmlWriter.WriteStartElement("ProjectReference");
            xmlWriter.WriteAttributeString("Include", _projectFileName);
            xmlWriter.WriteElementString("Project", _guid.ToString("B").ToUpper());
            xmlWriter.WriteElementString("Name", _name);
            if (_package != null)
                xmlWriter.WriteElementString("Package", _package.Value.ToString("B").ToUpper());
            if (_alias != null)
                xmlWriter.WriteElementString("Aliases", _alias);
            xmlWriter.WriteEndElement();
        }

        #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
Web03 | 2.8.150520.1 | Last Updated 2 Dec 2012
Article Copyright 2012 by KenBeckett
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid