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

namespace Nova.CodeDOM
{
    /// <summary>
    /// Represents a generated message associated with a <see cref="CodeObject"/> (error, warning, suggestion, or hint).
    /// </summary>
    public class Message : Annotation
    {
        #region /* FIELDS */

        protected string _text;
        protected MessageSeverity _severity;
        protected MessageSource _source;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a <see cref="Message"/> with the specified text, severity, and source.
        /// </summary>
        public Message(string text, MessageSeverity severity, MessageSource source)
        {
            _text = text;
            _severity = severity;
            _source = source;
        }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The text of the <see cref="Message"/>.
        /// </summary>
        public override string Text
        {
            get { return _text; }
            set { _text = value; }
        }

        /// <summary>
        /// The <see cref="MessageSeverity"/> of the message.
        /// </summary>
        public MessageSeverity Severity
        {
            get { return _severity; }
        }

        /// <summary>
        /// The <see cref="MessageSource"/> of the message.
        /// </summary>
        public MessageSource Source
        {
            get { return _source; }
        }

        /// <summary>
        /// The line number associated with the Parent <see cref="CodeObject"/> of the <see cref="Message"/> (if any, 0 if none).
        /// </summary>
        /// <remarks>
        /// The line number will match the input file when the object is parsed, but may differ if the code tree is modified.
        /// Parsing messages that relate to a <see cref="Token"/> will use <see cref="TokenMessage"/>, in which case the line
        /// number will be that of the related <see cref="Token"/>.
        /// </remarks>
        public override int LineNumber
        {
            get { return (_parent != null ? _parent.LineNumber : 0); }
        }

        /// <summary>
        /// The column number associated with the Parent <see cref="CodeObject"/> of the <see cref="Message"/> (if any, 0 if none).
        /// </summary>
        /// <remarks>
        /// The line number will match the input file when the object is parsed, but may differ if the code tree is modified.
        /// Parsing messages that relate to a <see cref="Token"/> will use <see cref="TokenMessage"/>, in which case the column
        /// will be that of the related <see cref="Token"/>.
        /// </remarks>
        public override int ColumnNumber
        {
            get { return _parent.ColumnNumber; }
        }

        /// <summary>
        /// The category of the message.
        /// </summary>
        public string Category
        {
            get
            {
                switch (_severity)
                {
                    case MessageSeverity.Error:
                        return "ERROR";
                    case MessageSeverity.Warning:
                        return "Warning";
                    case MessageSeverity.Suggestion:
                        return "Suggestion";
                    case MessageSeverity.Hint:
                        return "Hint";
                    case MessageSeverity.Information:
                        return "Information";
                }
                return null;
            }
        }

        /// <summary>
        /// Always <c>true</c> for <see cref="Message"/> annotations.
        /// </summary>
        public override bool IsListed
        {
            get { return true; }
        }

        #endregion

        #region /* RENDERING */

        public override void AsText(CodeWriter writer, RenderFlags flags)
        {
            if (!flags.HasFlag(RenderFlags.SuppressNewLine))
                writer.WriteLine();
            writer.Write(Category + ": " + _text);
        }

        #endregion
    }

    /// <summary>
    /// Represents a <see cref="Message"/> associated with a parse <see cref="Token"/>.
    /// </summary>
    /// <remarks>
    /// A <see cref="TokenMessage"/> will still be associated with a Parent <see cref="CodeObject"/> like any
    /// other <see cref="Message"/>, but it also contains the specific <see cref="Token"/> related to the message
    /// generated by the parser.  The <see cref="LineNumber"/> and <see cref="ColumnNumber"/> properties will return
    /// the information from the <see cref="Token"/> instead of the Parent <see cref="CodeObject"/>.
    /// </remarks>
    public class TokenMessage : Message
    {
        #region /* FIELDS */

        protected Token _token;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a parse error <see cref="Message"/> with the specified text, in connection with the specified <see cref="Token"/>.
        /// </summary>
        protected internal TokenMessage(string text, Token token)
            : base(text, token.InDocComment ? MessageSeverity.Warning : MessageSeverity.Error, MessageSource.Parse)
        {
            _token = token;
        }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The <see cref="Token"/> that the message is associated with.
        /// </summary>
        public Token Token
        {
            get { return _token; }
        }

        /// <summary>
        /// The line number associated with the related <see cref="Token"/> (if any, 0 if none).
        /// </summary>
        /// <remarks>
        /// The line number will match the input file from when the object was parsed.
        /// </remarks>
        public override int LineNumber
        {
            get { return _token.LineNumber; }
        }

        /// <summary>
        /// The column number associated with the related <see cref="Token"/> (if any, 0 if none).
        /// </summary>
        /// <remarks>
        /// The column will match the input file from when the object was parsed.
        /// </remarks>
        public override int ColumnNumber
        {
            get { return _token.ColumnNumber; }
        }

        #endregion
    }


    #region /* ENUMS */

    /// <summary>
    /// The severity of a message.
    /// </summary>
    public enum MessageSeverity : byte
    {
        Unspecified,
        Error,
        Warning,
        Suggestion,
        Hint,
        Information
    }

    /// <summary>
    /// The source of a message.
    /// </summary>
    public enum MessageSource : byte
    {
        Unspecified,
        Load,
        Parse,
        Resolve,
        Analyze,
        Save
    }

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

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