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 System;

using Nova.CodeDOM;

namespace Nova
{
    /// <summary>
    /// Supports logging of messages.
    /// </summary>
    public static class Log
    {
        /// <summary>
        /// The logging level.
        /// </summary>
        public enum Level
        {
            /// <summary>No logging at all.</summary>
            None,
            /// <summary>Minimal logging, error messages only.  Doesn't log any assembly loading information.</summary>
            Minimal,
            /// <summary>Normal logging, error and warning messages.</summary>
            Normal,
            /// <summary>Detailed logging, all messages.  Includes details of assembly and type loading.</summary>
            Detailed
        }

        /// <summary>
        /// Determines if detail log messages are created.
        /// </summary>
        public static Level LogLevel = Level.Minimal;

        /// <summary>
        /// The callback delegate that gets called to create log entries.
        /// </summary>
        private static Action<string, string> _logWriteLineCallback;

        static Log()
        {
            // Force a reference to CodeObject to trigger the loading of any config file if it hasn't been done yet
            CodeObject.ForceReference();
        }

        /// <summary>
        /// Set the callback method that gets called for each log entry.
        /// </summary>
        /// <param name="callback">A method that accepts a message to be logged, and a tooltip to be displayed for the message.</param>
        public static void SetLogWriteLineCallback(Action<string, string> callback)
        {
            _logWriteLineCallback = callback;
        }

        /// <summary>
        /// Log a message.
        /// </summary>
        public static void WriteLine(string message)
        {
            WriteLine(message, null);
        }

        /// <summary>
        /// Log a message, with a tooltip to display detailed information in a UI.
        /// </summary>
        public static void WriteLine(string message, string toolTip)
        {
            if (LogLevel > Level.None)
            {
                if (_logWriteLineCallback != null)
                    _logWriteLineCallback(message, toolTip);
                else
                {
                    // Holy crap!  At least in the debugger, this takes forever!  If a few thousand errors
                    // are logged, this takes the total time from half a second to 48 seconds!  The generation
                    // of the messages and GUI display in the callback is nothing compared to this console write!
                    // For this reason, we don't do this unless no logging callback is set.
                    Console.WriteLine(message);
                }
            }
        }

        /// <summary>
        /// Log a message if detailed logging is enabled.
        /// </summary>
        public static void DetailWriteLine(string message, string toolTip)
        {
            if (LogLevel >= Level.Detailed)
                WriteLine(message, toolTip);
        }

        /// <summary>
        /// Log a message if detailed logging is enabled.
        /// </summary>
        public static void DetailWriteLine(string message)
        {
            if (LogLevel >= Level.Detailed)
                WriteLine(message, null);
        }

        /// <summary>
        /// Log an exception (also returns the generic message that was logged).
        /// </summary>
        public static string Exception(Exception ex, string message)
        {
            message = "EXCEPTION " + message + ": " + ex.Message;
            if (ex is UnauthorizedAccessException)
                message += "  File might be read-only or in use.";
            string details = ex.ToString().TrimEnd();
            // We put the details in the tooltip in the UI, but we really also need them in the text message (for console apps)
            message += "\n" + details;
            WriteLine(message, details);
            return message;
        }
    }
}

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