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;

namespace Nova.CodeDOM
{
    /// <summary>
    /// Represents the top-level namespace (either a project's global namespace, or an extern alias namespace).
    /// </summary>
    /// <remarks>
    /// A <see cref="RootNamespace"/> maintains a dictionary of child namespaces indexed by full name for
    /// better performance when searching for namespaces.
    /// The Parent of a <see cref="Namespace"/> instance should only be another Namespace, but the Parent of a RootNamespace
    /// can be either a <see cref="Project"/> (global namespace) or a <see cref="Reference"/> (extern alias namespace).
    /// </remarks>
    public class RootNamespace : Namespace
    {
        #region /* FIELDS */

        /// <summary>
        /// All loaded namespaces under the root namespace, indexed by full name (the contents of namespaces
        /// may vary depending upon referenced assemblies, so each project must maintain its own namespaces).
        /// </summary>
        protected Dictionary<string, Namespace> _namespaces = new Dictionary<string, Namespace>();

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a <see cref="RootNamespace"/>.
        /// </summary>
        public RootNamespace(string name, CodeObject parent)
            : base(name, parent)
        { }

        #endregion

        #region /* PROPERTIES */

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

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

        /// <summary>
        /// The parent Project if this RootNamespace is a project-global namespace (otherwise null).
        /// </summary>
        public Project ParentProject
        {
            get { return (_parent as Project); }
        }

        /// <summary>
        /// The parent <see cref="Reference"/> if this RootNamespace is an extern alias for an external reference (otherwise null).
        /// </summary>
        public Reference ParentReference
        {
            get { return (_parent as Reference); }
        }

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Remove all items from the namespace.
        /// </summary>
        public override void RemoveAll()
        {
            lock (this)
            {
                base.RemoveAll();
                _namespaces.Clear();
            }
        }

        protected override void NamespaceCreated(Namespace @namespace)
        {
            // Maintain dictionary of all namespaces by full name
            lock (this)
                _namespaces.Add(@namespace.FullName, @namespace);
        }

        /// <summary>
        /// Find or create a child <see cref="Namespace"/>, including any missing parent namespaces.
        /// </summary>
        public override Namespace FindOrCreateChildNamespace(string namespaceName)
        {
            // If the namespace already exists, return it, otherwise delegate to the base
            // class to create it along with any parent namespaces.
            Namespace @namespace;
            lock (this)
            {
                if (!_namespaces.TryGetValue(namespaceName, out @namespace))
                    @namespace = base.FindOrCreateChildNamespace(namespaceName);
            }
            return @namespace;
        }

        /// <summary>
        /// Find the <see cref="Namespace"/> with the fully-specified name in the global namespace.
        /// </summary>
        public Namespace FindNamespace(string namespaceFullName)
        {
            Namespace @namespace;
            lock (this)
                _namespaces.TryGetValue(namespaceFullName, out @namespace);
            return @namespace;
        }

        /// <summary>
        /// Update the FullName (called when the Name or Parent is changed).
        /// </summary>
        protected override void UpdateFullName()
        {
            _fullName = _name;
        }

        /// <summary>
        /// Parse the specified name into a child <see cref="NamespaceRef"/> or <see cref="TypeRef"/> on the current root
        /// namespace, or a <see cref="Lookup"/> or <see cref="Dot"/> expression that evaluates to one.
        /// </summary>
        public override Expression ParseName(string name)
        {
            if (!IsGlobal)
            {
                string prefix = RemovePrefix(ref name);
                Expression expression = new Lookup(this, base.ParseName(prefix));
                return ParseName(expression, name);
            }
            return base.ParseName(name);
        }

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