Click here to Skip to main content
15,896,063 members
Articles / Programming Languages / C#

Creating a CodeDOM: Modeling the Semantics of Code (Part 2)

Rate me:
Please Sign up or sign in to vote.
5.00/5 (17 votes)
9 Nov 2012CDDL24 min read 41.3K   757   33  
Creating a CodeDOM for C#
// 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.
    /// </summary>
    /// <remarks>
    /// A <see cref="RootNamespace"/> maintains a dictionary of child namespaces indexed by full name for
    /// better performance when searching for namespaces.
    /// </remarks>
    public class RootNamespace : Namespace
    {
        #region /* FIELDS */

        /// <summary>
        /// All loaded namespaces under the root namespace, indexed by full name.
        /// </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 global namespace.
        /// </summary>
        public override bool IsGlobal
        {
            get { return (_name == ExternAlias.GlobalName); }
        }

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


Written By
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).

Comments and Discussions