Click here to Skip to main content
12,069,894 members (71,732 online)
Click here to Skip to main content

Tagged as

Stats

7K views
361 downloads
14 bookmarked
Posted

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

namespace Nova.CodeDOM
{
    /// <summary>
    /// The common base class of all documentation comment tags that have a 'cref' attribute (<see cref="DocSee"/>,
    /// <see cref="DocSeeAlso"/>, <see cref="DocException"/>, <see cref="DocPermission"/>).
    /// </summary>
    public abstract class DocCodeRefBase : DocComment
    {
        #region /* FIELDS */

        // Should evaluate to a code object reference (Expression - SymbolicRef, Dot, Call), but can also be a string.
        protected object _codeRef;

        #endregion

        #region /* CONSTRUCTORS */

        protected DocCodeRefBase(Expression codeRef, string text)
            : base(text)
        {
            CodeRef = codeRef;
        }

        protected DocCodeRefBase(Expression codeRef, params DocComment[] docComments)
            : base(docComments)
        {
            CodeRef = codeRef;
        }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The associated <see cref="CodeObject"/> or string.
        /// </summary>
        public object CodeRef
        {
            get { return _codeRef; }
            set { SetField(ref _codeRef, value, true); }
        }

        #endregion

        #region /* METHODS */

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

        #endregion

        #region /* PARSING */

        /// <summary>
        /// The name of the code-ref attribute.
        /// </summary>
        public const string AttributeName = "cref";

        /// <summary>
        /// Determines if code references are parsed as code or plain text.
        /// </summary>
        public static bool ParseRefsAsCode = true;

        protected DocCodeRefBase(Parser parser, CodeObject parent)
        {
            ParseTag(parser, parent);
        }

        protected override object ParseAttributeValue(Parser parser, string name)
        {
            // Parse the value as code unless disabled or the value is empty
            if (StringUtil.NNEqualsIgnoreCase(name, AttributeName))
            {
                // Override parsing of the 'cref' attribute to parse as an expression
                if (parser.TokenText == ParseTokenValueQuote1 || parser.TokenText == ParseTokenValueQuote2)
                {
                    string quote = parser.TokenText;
                    if (ParseRefsAsCode && parser.Char != quote[0])
                    {
                        // Some people seem to misunderstand and put type prefixes on the value - these should
                        // only exist in the generated XML file, not the tag values, so we'll just skip over
                        // any such prefix here.
                        if (parser.PeekChar == ':' && "NTFPME".IndexOf(parser.Char) >= 0)
                        {
                            parser.NextChar();
                            parser.NextChar();
                        }

                        // Parse the code expression
                        SetField(ref _codeRef, parser.ParseCodeExpressionUntil(quote, this), false);
                    }
                    else
                        _codeRef = parser.GetToDelimiter(parser.TokenText[0]);

                    // Move past the ending quote (if one was found)
                    if (parser.TokenText == quote)
                        parser.NextToken(true);
                }
                else
                {
                    // Parse a single token, and move past it
                    _codeRef = parser.TokenText;
                    parser.NextToken(true);
                }

                if (_codeRef == null)
                    _codeRef = "";
                return _codeRef;
            }
            return base.ParseAttributeValue(parser, name);
        }

        #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 (_codeRef is Expression && (flags & (ResolveFlags.Phase1 | ResolveFlags.Phase2)) == 0)
                _codeRef = ((Expression)_codeRef).Resolve(ResolveCategory.Expression, flags | ResolveFlags.InDocComment | ResolveFlags.InDocCodeRef);
            return base.Resolve(ResolveCategory.CodeObject, flags);
        }

        #endregion

        #region /* FORMATTING */

        /// <summary>
        /// Determines if the code object only requires a single line for display.
        /// </summary>
        public override bool IsSingleLine
        {
            get
            {
                return (base.IsSingleLine && (_codeRef == null || (_codeRef is string && ((string)_codeRef).IndexOf('\n') < 0)
                    || (_codeRef is CodeObject && !((CodeObject)_codeRef).IsFirstOnLine && ((CodeObject)_codeRef).IsSingleLine)));
            }
            set
            {
                base.IsSingleLine = value;
                if (_codeRef is CodeObject)
                {
                    if (value)
                        ((CodeObject)_codeRef).IsFirstOnLine = false;
                    ((CodeObject)_codeRef).IsSingleLine = value;
                }
            }
        }

        #endregion

        #region /* RENDERING */

        protected override void AsTextStart(CodeWriter writer, RenderFlags flags)
        {
            if (!flags.HasFlag(RenderFlags.Description))
                writer.Write("<" + TagName + " " + AttributeName + "=\"");
            if (_codeRef != null)
            {
                // Turn on translation of '<', '&', and '>' for content
                writer.InDocCommentContent = true;
                if (_codeRef is Expression)
                    ((Expression)_codeRef).AsText(writer, flags);
                else if (_codeRef is string)
                    DocText.AsTextText(writer, (string)_codeRef, flags);
                writer.InDocCommentContent = false;
            }
            if (!flags.HasFlag(RenderFlags.Description))
                writer.Write("\"" + (_content == null && !MissingEndTag ? "/>" : ">"));
        }

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

You may also be interested in...

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.160208.1 | Last Updated 2 Dec 2012
Article Copyright 2012 by KenBeckett
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid