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

namespace Nova.CodeDOM
{
    /// <summary>
    /// Represents a list of one or more unrecognized identifiers or symbols (UnresolvedRefs).
    /// If it's part of a larger expression (as opposed to being a stand-alone expression), then the last entry in the list
    /// will itself be a valid child expression.
    /// </summary>
    public class Unrecognized : Expression
    {
        #region /* FIELDS */

        protected bool _parsingBlock;
        protected bool _inDocComment;
        protected ChildList<Expression> _expressions;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// The total number of <see cref="Unrecognized"/> objects.
        /// </summary>
        public static int Count;

        /// <summary>
        /// Create an <see cref="Unrecognized"/> object.
        /// </summary>
        public Unrecognized(bool parsingBlock, bool inDocComment, params Expression[] expressions)
        {
            // Only count unrecognized "real" code - ignore any inside doc comments
            if (!inDocComment)
                ++Count;

            _parsingBlock = parsingBlock;
            _inDocComment = inDocComment;
            _expressions = new ChildList<Expression>(this);
            foreach (Expression expression in expressions)
                AddRight(expression);
        }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// True if inside a <see cref="DocComment"/>.
        /// </summary>
        public bool InDocComment
        {
            get { return _inDocComment; }
        }

        /// <summary>
        /// A collection of child <see cref="Expression"/>s.
        /// </summary>
        public ChildList<Expression> Expressions
        {
            get { return _expressions; }
        }

        /// <summary>
        /// The line number of the first contained <see cref="Expression"/>.
        /// </summary>
        public override int LineNumber
        {
            get { return _expressions[0].LineNumber; }
        }

        /// <summary>
        /// The column number of the first contained <see cref="Expression"/>.
        /// </summary>
        public override int ColumnNumber
        {
            get { return _expressions[0].ColumnNumber; }
        }

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Add an <see cref="Expression"/> to the left side.
        /// </summary>
        public void AddLeft(Expression expression)
        {
            if (expression != null)
            {
                // Move any newlines on the parent back to first item in the list, and
                // then move any newlines on the new item to the parent.
                if (_expressions.Count > 0)
                    _expressions[0].MoveFormatting(this);
                MoveFormatting(expression);

                // Clear the current parent first, to prevent a Clone() of the object, so that any
                // notified error messages don't end up pointing to an orphaned original object.
                expression.Parent = null;
                _expressions.Insert(0, expression);
            }
        }

        /// <summary>
        /// Add an <see cref="Expression"/> to the right side.
        /// </summary>
        public void AddRight(Expression expression)
        {
            if (expression != null)
            {
                // Move any newlines to the parent
                if (_expressions.Count == 0 && expression.IsFirstOnLine)
                    MoveFormatting(expression);

                // Clear the current parent first, to prevent a Clone() of the object, so that any
                // notified error messages don't end up pointing to an orphaned original object.
                expression.Parent = null;
                _expressions.Add(expression);
            }
        }

        /// <summary>
        /// Update the attached error message with the current content.
        /// </summary>
        public void UpdateMessage()
        {
            RemoveAllMessages(MessageSource.Parse);
            if (_inDocComment)
            {
                AttachMessage("Unrecognized code in doc comment: '" + AsString() + "'"
                    + (_parsingBlock ? " - use '<c></c>' for code fragments (expressions)" : ""),
                    MessageSeverity.Warning, MessageSource.Parse);
            }
            else
                AttachMessage("UNRECOGNIZED CODE: '" + AsString() + "'", MessageSeverity.Error, MessageSource.Parse);
        }

        /// <summary>
        /// Deep-clone the code object.
        /// </summary>
        public override CodeObject Clone()
        {
            Unrecognized clone = (Unrecognized)base.Clone();
            clone._expressions = ChildListHelpers.Clone(_expressions, clone);
            return clone;
        }

        #endregion

        #region /* PARSING */

        /// <summary>
        /// Determine if the specified comment should be associated with the current code object during parsing.
        /// </summary>
        public override bool AssociateCommentWhenParsing(CommentBase comment)
        {
            return false;
        }

        #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)
        {
            ChildListHelpers.Resolve(_expressions, resolveCategory, flags);
            return this;
        }

        /// <summary>
        /// Evaluate the type of the <see cref="Expression"/>.
        /// </summary>
        /// <returns>The resulting <see cref="TypeRef"/> or <see cref="UnresolvedRef"/>.</returns>
        public override TypeRefBase EvaluateType(bool withoutConstants)
        {
            // Treat unrecognized expressions as 'object' type
            return TypeRef.ObjectRef;
        }

        #endregion

        #region /* FORMATTING */

        #endregion

        #region /* RENDERING */

        public override void AsTextExpression(CodeWriter writer, RenderFlags flags)
        {
            RenderFlags passFlags = (flags & RenderFlags.PassMask);
            UpdateLineCol(writer, flags);
            writer.WriteList(_expressions, passFlags | RenderFlags.NoItemSeparators, this);
        }

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