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.Resolving;

namespace Nova.CodeDOM
{
    /// <summary>
    /// Declares a property-like event, with add/remove accessors.
    /// </summary>
    /// <remarks>
    /// An EventDecl is like a PropertyDecl except it has an 'event' modifier, and add/remove
    /// accesors instead of get/set.
    /// Simple field-like events can also be created using FieldDecl with an 'event' modifier.
    /// </remarks>
    public class EventDecl : PropertyDeclBase
    {
        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create an <see cref="EventDecl"/> with the specified name, type, and modifiers.
        /// </summary>
        public EventDecl(string name, Expression type, Modifiers modifiers)
            : base(name, type, modifiers | Modifiers.Event, null)
        { }

        /// <summary>
        /// Create an <see cref="EventDecl"/> with the specified name and type.
        /// </summary>
        public EventDecl(string name, Expression type)
            : base(name, type, Modifiers.Event, null)
        { }

        /// <summary>
        /// Create an <see cref="EventDecl"/> with the specified name and type.
        /// </summary>
        public EventDecl(Expression name, Expression type)
            : base(name, type, Modifiers.Event)
        { }

        #endregion

        #region /* PROPERTIES */

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

        /// <summary>
        /// True if the event has an adder method.
        /// </summary>
        public bool HasAdder
        {
            get { return (_body.FindFirst<AdderDecl>() != null); }
        }

        /// <summary>
        /// True if the event has a remover method.
        /// </summary>
        public bool HasRemover
        {
            get { return (_body.FindFirst<RemoverDecl>() != null); }
        }

        /// <summary>
        /// The 'adder' method for the event.
        /// </summary>
        public AdderDecl Adder
        {
            get { return _body.FindFirst<AdderDecl>(); }
            set
            {
                if (_body != null)
                {
                    AdderDecl existing = _body.FindFirst<AdderDecl>();
                    if (existing != null)
                        _body.Remove(existing);
                }
                Insert(0, value);  // Always put the 'adder' first
            }
        }

        /// <summary>
        /// The 'remover' method for the event.
        /// </summary>
        public RemoverDecl Remover
        {
            get { return _body.FindFirst<RemoverDecl>(); }
            set
            {
                if (_body != null)
                {
                    RemoverDecl existing = _body.FindFirst<RemoverDecl>();
                    if (existing != null)
                        _body.Remove(existing);
                }
                Insert((_body != null ? _body.Count : 0), value);  // Always put the 'remover' after any 'adder'
            }
        }

        /// <summary>
        /// True if the event is readable.
        /// </summary>
        public override bool IsReadable { get { return HasAdder; } }

        /// <summary>
        /// True if the event is writable.
        /// </summary>
        public override bool IsWritable { get { return HasRemover; } }

        #endregion

        #region /* METHODS */

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

        /// <summary>
        /// Get the IsPrivate access right for the specified usage, and if not private then also get the IsProtected and IsInternal rights.
        /// </summary>
        /// <param name="isTargetOfAssignment">Usage - true if the target of an assignment ('lvalue'), otherwise false.</param>
        /// <param name="isPrivate">True if the access is private.</param>
        /// <param name="isProtected">True if the access is protected.</param>
        /// <param name="isInternal">True if the access is internal.</param>
        public override void GetAccessRights(bool isTargetOfAssignment, out bool isPrivate, out bool isProtected, out bool isInternal)
        {
            isPrivate = isProtected = isInternal = false;

            // The access rights of an event actually depend on the rights of the corresponding
            // adder/remover, depending upon whether we're assigning to it or not.
            if (isTargetOfAssignment)
            {
                AdderDecl adderDecl = Adder;
                if (adderDecl != null)
                {
                    isPrivate = adderDecl.IsPrivate;
                    if (!isPrivate)
                    {
                        isProtected = adderDecl.IsProtected;
                        isInternal = adderDecl.IsInternal;
                    }
                }
            }
            else
            {
                RemoverDecl removerDecl = Remover;
                if (removerDecl != null)
                {
                    isPrivate = removerDecl.IsPrivate;
                    if (!isPrivate)
                    {
                        isProtected = removerDecl.IsProtected;
                        isInternal = removerDecl.IsInternal;
                    }
                }
            }
        }

        #endregion

        #region /* PARSING */

        /// <summary>
        /// Parse an <see cref="EventDecl"/>.
        /// </summary>
        public EventDecl(Parser parser, CodeObject parent)
            : base(parser, parent, true)
        {
            _modifiers |= Modifiers.Event;
        }

        #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.Phase1 | ResolveFlags.Phase3)) == 0)
            {
                _type = (Expression)_type.Resolve(ResolveCategory.Type, flags);
                if (_name is Expression)
                    _name = ((Expression)_name).Resolve(ResolveCategory.Event, flags);
            }
            if ((flags & (ResolveFlags.Phase1 | ResolveFlags.Phase2)) == 0)
            {
                ResolveAttributes(flags);
                if (_body != null)
                    _body.Resolve(ResolveCategory.CodeObject, flags);
                ResolveDocComments(flags);
            }
            return 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.150123.1 | Last Updated 2 Dec 2012
Article Copyright 2012 by KenBeckett
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid