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 Nova.Parsing;
using Nova.Rendering;
using Nova.Resolving;

namespace Nova.CodeDOM
{
    /// <summary>
    /// Used together with compiler command-line options to create additional root-level namespaces.
    ///  </summary>
    /// <remarks>
    /// Allows multiple assemblies with the same namespaces (such as different versions of an assembly)
    /// to be used simultaneously.
    /// </remarks>
    public class ExternAlias : Statement, INamedCodeObject
    {
        #region /* CONSTANTS */

        /// <summary>
        /// The constant name of the global extern alias.
        /// </summary>
        public const string GlobalName = "global";

        #endregion

        #region /* FIELDS */

        /// <summary>
        /// The referenced root-level namespace.
        /// </summary>
        protected SymbolicRef _rootNamespaceRef;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create an <see cref="ExternAlias"/> with the specified <see cref="RootNamespace"/>.
        /// </summary>
        public ExternAlias(RootNamespace rootNamespace)
        {
            RootNamespaceRef = rootNamespace.CreateRef();
        }

        /// <summary>
        /// Create an <see cref="ExternAlias"/> with the specified namespace reference.
        /// </summary>
        public ExternAlias(SymbolicRef rootNamespaceRef)
        {
            RootNamespaceRef = rootNamespaceRef;
        }

        /// <summary>
        /// Create an <see cref="ExternAlias"/> with the specified name.
        /// </summary>
        public ExternAlias(string name)
        {
            RootNamespaceRef = new UnresolvedRef(name, ResolveCategory.Namespace);
        }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The referenced root-level namespace.
        /// </summary>
        public SymbolicRef RootNamespaceRef
        {
            get { return _rootNamespaceRef; }
            set { SetField(ref _rootNamespaceRef, value, false); }
        }

        /// <summary>
        /// The name of the referenced root-level namespace.
        /// </summary>
        public string Name
        {
            get { return _rootNamespaceRef.Name; }
        }

        /// <summary>
        /// True if the extern alias is 'global'.
        /// </summary>
        public bool IsGlobal
        {
            get { return (_rootNamespaceRef.Name == GlobalName); }
        }

        /// <summary>
        /// The keyword associated with the <see cref="Statement"/>.
        /// </summary>
        public override string Keyword
        {
            get { return ParseToken1 + " " + ParseToken2; }
        }

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

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Create a reference to the <see cref="ExternAlias"/>.
        /// </summary>
        /// <param name="isFirstOnLine">True if the reference should be displayed on a new line.</param>
        /// <returns>An <see cref="ExternAliasRef"/>.</returns>
        public override SymbolicRef CreateRef(bool isFirstOnLine)
        {
            return new ExternAliasRef(this, isFirstOnLine);
        }

        /// <summary>
        /// Add the <see cref="CodeObject"/> to the specified dictionary.
        /// </summary>
        public virtual void AddToDictionary(NamedCodeObjectDictionary dictionary)
        {
            dictionary.Add(Name, this);
        }

        /// <summary>
        /// Remove the <see cref="CodeObject"/> from the specified dictionary.
        /// </summary>
        public virtual void RemoveFromDictionary(NamedCodeObjectDictionary dictionary)
        {
            dictionary.Remove(Name, this);
        }

        /// <summary>
        /// Deep-clone the code object.
        /// </summary>
        public override CodeObject Clone()
        {
            ExternAlias clone = (ExternAlias)base.Clone();
            clone.CloneField(ref clone._rootNamespaceRef, _rootNamespaceRef);
            return clone;
        }

        /// <summary>
        /// Get the full name of the <see cref="INamedCodeObject"/>, including any namespace name.
        /// </summary>
        public string GetFullName(bool descriptive)
        {
            return Name;
        }

        /// <summary>
        /// Get the full name of the <see cref="INamedCodeObject"/>, including any namespace name.
        /// </summary>
        public string GetFullName()
        {
            return Name;
        }

        #endregion

        #region /* PARSING */

        /// <summary>
        /// The primary token used to parse the code object.
        /// </summary>
        public const string ParseToken1 = "extern";

        /// <summary>
        /// The secondary token used to parse the code object.
        /// </summary>
        public const string ParseToken2 = "alias";

        internal static void AddParsePoints()
        {
            // Set parse-point on 2nd of the 2 keywords
            Parser.AddParsePoint(ParseToken2, Parse, typeof(NamespaceDecl));
        }

        /// <summary>
        /// Parse an <see cref="ExternAlias"/>.
        /// </summary>
        public static ExternAlias Parse(Parser parser, CodeObject parent, ParseFlags flags)
        {
            // Validate 'extern' keyword
            if (parser.LastUnusedTokenText == ParseToken1)
                return new ExternAlias(parser, parent);
            return null;
        }

        protected ExternAlias(Parser parser, CodeObject parent)
            : base(parser, parent)
        {
            Token token = (Token)parser.RemoveLastUnused();
            NewLines = token.NewLines;
            SetLineCol(token);
            parser.NextToken();                        // Move past 'alias' keyword
            token = parser.Token;
            string name = parser.GetIdentifierText();  // Parse the name
            RootNamespaceRef = new UnresolvedRef(name, ResolveCategory.Namespace, token.LineNumber, token.ColumnNumber);
            ParseTerminator(parser);
        }

        #endregion

        #region /* RESOLVING */

        /// <summary>
        /// Resolve all child symbolic references, using the specified <see cref="ResolveCategory"/> and <see cref="ResolveFlags"/>.
        /// </summary>
        public override CodeObject Resolve(ResolveCategory resolveCategory, ResolveFlags flags)
        {
            if ((flags & (ResolveFlags.Phase2 | ResolveFlags.Phase3)) == 0)
                _rootNamespaceRef = (SymbolicRef)_rootNamespaceRef.Resolve(ResolveCategory.RootNamespace, flags);
            return this;
        }

        /// <summary>
        /// Returns true if the code object is an <see cref="UnresolvedRef"/> or has any <see cref="UnresolvedRef"/> children.
        /// </summary>
        public override bool HasUnresolvedRef()
        {
            if (_rootNamespaceRef != null && _rootNamespaceRef.HasUnresolvedRef())
                return true;
            return base.HasUnresolvedRef();
        }

        #endregion

        #region /* FORMATTING */

        /// <summary>
        /// True if the <see cref="Statement"/> has parens around its argument.
        /// </summary>
        public override bool HasArgumentParens
        {
            get { return false; }
        }

        /// <summary>
        /// True if the <see cref="Statement"/> has a terminator character by default.
        /// </summary>
        public override bool HasTerminatorDefault
        {
            get { return true; }
        }

        /// <summary>
        /// Determine a default of 1 or 2 newlines when adding items to a <see cref="Block"/>.
        /// </summary>
        public override int DefaultNewLines(CodeObject previous)
        {
            // Default to a preceeding blank line if the object has first-on-line annotations, or if
            // it's not another extern alias.
            if (HasFirstOnLineAnnotations || !(previous is ExternAlias))
                return 2;
            return 1;
        }

        /// <summary>
        /// Determines if the code object only requires a single line for display.
        /// </summary>
        public override bool IsSingleLine
        {
            get { return (base.IsSingleLine && (_rootNamespaceRef == null || (!_rootNamespaceRef.IsFirstOnLine && _rootNamespaceRef.IsSingleLine))); }
            set
            {
                base.IsSingleLine = value;
                if (value && _rootNamespaceRef != null)
                {
                    _rootNamespaceRef.IsFirstOnLine = false;
                    _rootNamespaceRef.IsSingleLine = true;
                }
            }
        }

        #endregion

        #region /* RENDERING */

        protected override void AsTextArgument(CodeWriter writer, RenderFlags flags)
        {
            _rootNamespaceRef.AsText(writer, 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
Web04 | 2.8.141015.1 | Last Updated 2 Dec 2012
Article Copyright 2012 by KenBeckett
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid