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 Mono.Cecil;

using Nova.Resolving;

namespace Nova.CodeDOM
{
    /// <summary>
    /// Represents a reference to a <see cref="Namespace"/>.
    /// </summary>
    public class NamespaceRef : SymbolicRef
    {
        #region /* CONSTRUCTORS */
        
        /// <summary>
        /// Create a <see cref="NamespaceRef"/> from a <see cref="Namespace"/>.
        /// </summary>
        public NamespaceRef(Namespace @namespace, bool isFirstOnLine)
            : base(@namespace, isFirstOnLine)
        { }

        /// <summary>
        /// Create a <see cref="NamespaceRef"/> from a <see cref="Namespace"/>.
        /// </summary>
        public NamespaceRef(Namespace @namespace)
            : base(@namespace, false)
        { }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The referenced <see cref="Namespace"/>.
        /// </summary>
        public Namespace Namespace
        {
            get { return (Namespace)_reference; }
        }

        /// <summary>
        /// The full name (including parent <see cref="Namespace"/>s) of the referenced <see cref="Namespace"/>.
        /// </summary>
        public string FullName
        {
            get { return ((Namespace)_reference).FullName; }
        }

        /// <summary>
        /// The children of the referenced <see cref="Namespace"/>.
        /// </summary>
        public NamespaceTypeDictionary Children
        {
            get { return ((Namespace)_reference).Children; }
        }

        /// <summary>
        /// Determines if the referenced <see cref="Namespace"/> is root-level (global or extern alias).
        /// </summary>
        public bool IsRootLevel
        {
            get { return ((Namespace)_reference).IsRootLevel; }
        }

        /// <summary>
        /// Determines if the referenced <see cref="Namespace"/> is the project-global namespace.
        /// </summary>
        public bool IsGlobal
        {
            get { return ((Namespace)_reference).IsGlobal; }
        }

        /// <summary>
        /// True if the referenced <see cref="Namespace"/> has <see cref="NamespaceDecl"/> declarations in the current
        /// project, otherwise false (meaning items in the namespace exist only in imported assemblies and projects).
        /// </summary>
        public bool HasDeclarationsInProject
        {
            get { return ((Namespace)_reference).HasDeclarationsInProject; }
        }

        #endregion

        #region /* STATIC METHODS */

        /// <summary>
        /// Find a child namespace in the specified <see cref="Namespace"/> with the specified name.
        /// </summary>
        /// <returns>A <see cref="NamespaceRef"/> to the namespace, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static SymbolicRef Find(INamespace @namespace, string name, bool isFirstOnLine)
        {
            return Find(@namespace.Find(name), name, isFirstOnLine);
        }

        /// <summary>
        /// Find a child namespace in the specified <see cref="Namespace"/> with the specified name.
        /// </summary>
        /// <returns>A <see cref="NamespaceRef"/> to the namespace, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static SymbolicRef Find(INamespace @namespace, string name)
        {
            return Find(@namespace.Find(name), name, false);
        }

        /// <summary>
        /// Find a child namespace in the specified <see cref="NamespaceRef"/> with the specified name.
        /// </summary>
        /// <returns>A <see cref="NamespaceRef"/> to the namespace, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static SymbolicRef Find(SymbolicRef symbolicRef, string name, bool isFirstOnLine)
        {
            if (symbolicRef is NamespaceRef)
                Find(((NamespaceRef)symbolicRef).Namespace.Find(name), name, isFirstOnLine);
            return new UnresolvedRef(name, isFirstOnLine, ResolveCategory.Type);
        }

        /// <summary>
        /// Find a child namespace in the specified <see cref="NamespaceRef"/> with the specified name.
        /// </summary>
        /// <returns>A <see cref="NamespaceRef"/> to the namespace, or an <see cref="UnresolvedRef"/> if no match was found.</returns>
        public static SymbolicRef Find(SymbolicRef symbolicRef, string name)
        {
            return Find(symbolicRef, name, false);
        }

        private static SymbolicRef Find(object obj, string name, bool isFirstOnLine)
        {
            if (obj is Namespace)
                return new NamespaceRef((Namespace)obj, isFirstOnLine);
            return new UnresolvedRef(name, isFirstOnLine, ResolveCategory.NamespaceOrType);
        }

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Add a child <see cref="Namespace"/> to the namespace.
        /// </summary>
        public void Add(Namespace @namespace)
        {
            ((Namespace)_reference).Add(@namespace);
        }

        /// <summary>
        /// Add a <see cref="TypeDecl"/> to the namespace.
        /// </summary>
        public void Add(TypeDecl typeDecl)
        {
            ((Namespace)_reference).Add(typeDecl);
        }

        /// <summary>
        /// Add a <see cref="TypeDefinition"/> to the namespace.
        /// </summary>
        public void Add(TypeDefinition typeDefinition)
        {
            ((Namespace)_reference).Add(typeDefinition);
        }

        /// <summary>
        /// Add a <see cref="Type"/> to the namespace.
        /// </summary>
        public void Add(Type type)
        {
            ((Namespace)_reference).Add(type);
        }

        /// <summary>
        /// Remove a child <see cref="Namespace"/> from the namespace.
        /// </summary>
        public void Remove(Namespace @namespace)
        {
            ((Namespace)_reference).Remove(@namespace);
        }

        /// <summary>
        /// Remove a <see cref="TypeDecl"/> from the namespace.
        /// </summary>
        public void Remove(TypeDecl typeDecl)
        {
            ((Namespace)_reference).Remove(typeDecl);
        }

        /// <summary>
        /// Remove a <see cref="TypeDefinition"/> from the namespace.
        /// </summary>
        public void Remove(TypeDefinition typeDefinition)
        {
            ((Namespace)_reference).Remove(typeDefinition);
        }

        /// <summary>
        /// Remove a <see cref="Type"/> from the namespace.
        /// </summary>
        public void Remove(Type type)
        {
            ((Namespace)_reference).Remove(type);
        }

        /// <summary>
        /// Remove all items from the namespace.
        /// </summary>
        public virtual void RemoveAll()
        {
            ((Namespace)_reference).RemoveAll();
        }

        /// <summary>
        /// Find or create a child namespace, including any missing parent namespaces.
        /// </summary>
        public Namespace FindOrCreateChildNamespace(string namespaceName)
        {
            return ((Namespace)_reference).FindOrCreateChildNamespace(namespaceName);
        }

        /// <summary>
        /// Find a child <see cref="Namespace"/>, <see cref="TypeDecl"/>, or <see cref="TypeDefinition"/>/<see cref="Type"/> with
        /// the specified name.
        /// </summary>
        /// <returns>The child object if found, otherwise null.</returns>
        public object Find(string name)
        {
            return ((Namespace)_reference).Find(name);
        }

        /// <summary>
        /// Determine if the current reference refers to the same code object as the specified reference.
        /// </summary>
        public override bool IsSameRef(SymbolicRef symbolicRef)
        {
            NamespaceRef namespaceRef = (symbolicRef is AliasRef ? ((AliasRef)symbolicRef).Namespace : symbolicRef as NamespaceRef);
            return (namespaceRef != null && Reference == namespaceRef.Reference);
        }

        /// <summary>
        /// Parse the specified name into a <see cref="NamespaceRef"/> or <see cref="TypeRef"/>, or a <see cref="Dot"/> expression that evaluates to one.
        /// </summary>
        public Expression ParseName(string name)
        {
            return ((Namespace)_reference).ParseName(name);
        }

        #endregion

        #region /* RESOLVING */

        /// <summary>
        /// Resolve child code objects that match the specified name.
        /// </summary>
        public override void ResolveRef(string name, Resolver resolver)
        {
            ResolveRef(name, resolver, false);
        }

        /// <summary>
        /// Resolve child code objects that match the specified name.
        /// </summary>
        public void ResolveRef(string name, Resolver resolver, bool noNamespaces)
        {
            ((Namespace)_reference).ResolveRef(name, resolver, noNamespaces);
        }

        /// <summary>
        /// Evaluates the <see cref="NamespaceRef"/> to itself.
        /// </summary>
        /// <returns>The <see cref="NamespaceRef"/> itself.</returns>
        public override SymbolicRef EvaluateTypeOrNamespace(bool withoutConstants)
        {
            return this;
        }

        #endregion

        #region /* RENDERING */

        /// <summary>
        /// Format the <see cref="NamespaceRef"/> as a string.
        /// </summary>
        public override string ToString()
        {
            // Use full name in debugger
            return GetType().Name + ": " + Namespace.FullName;
        }

        #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
Web04 | 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