/*       Copyright (c) Eric Ledoux.  All rights reserved.       */
/* See http://www.dwell.net/terms for code sharing information. */

// SourceFileRenderer.cs
//
// Implements class SourceFileRenderer and related types.
//

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.IO;
using System.Reflection;
using System.Text;
using System.Text.RegularExpressions;
using System.Web.UI;
using System.Xml;
using DwellNet.CodeDoc;
using CodeDocApi.Properties;

namespace DwellNet.CodeDoc
{

public abstract class SourceFileRenderer
{
    //////////////////////////////////////////////////////////////////////////
    // Private Fields
    //

    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
    SourceFile m_sourceFile;

    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
    bool m_markOfTheWeb;

    //////////////////////////////////////////////////////////////////////////
    // Public Properties
    //

    public SourceFile SourceFile
    {
        [DebuggerStepThrough]
        get
        {
            return m_sourceFile;
        }
        [DebuggerStepThrough]
        set
        {
            m_sourceFile = value;
        }
    }

    public bool MarkOfTheWeb
    {
        [DebuggerStepThrough]
        get
        {
            return m_markOfTheWeb;
        }
        [DebuggerStepThrough]
        set
        {
            m_markOfTheWeb = value;
        }
    }

    //////////////////////////////////////////////////////////////////////////
    // Public Events
    //

    public event WarningInSourceFileEventDelegate WarningInSourceFile;

    //////////////////////////////////////////////////////////////////////////
    // Public Methods
    //

    public static SourceFileRenderer CreateRenderer(string rendererAssemblyName,
        string rendererTypeName, bool markOfTheWeb)
    {
        SourceFileRenderer sourceFileRenderer =
            DocumentationSet.CreateExternalObject<SourceFileRenderer>(
                rendererAssemblyName, rendererTypeName);
        sourceFileRenderer.MarkOfTheWeb = markOfTheWeb;
        return sourceFileRenderer;
    }

    public void GenerateCodeHtml(TopicRenderer topicRenderer, string path)
    {
        using (StreamWriter streamWriter = new StreamWriter(path))
        {
            using (HtmlTextWriterHelper htmlWriter =
                    new HtmlTextWriterHelper(streamWriter))
                GenerateCodeHtml(topicRenderer, htmlWriter);
        }
    }

    public abstract void GenerateCodeHtml(TopicRenderer topicRenderer,
        HtmlTextWriterHelper htmlWriter);

    //////////////////////////////////////////////////////////////////////////
    // Protected Methods
    //

    protected void FireWarningInSourceFile(int lineNumber, string format,
        params object[] args)
    {
        if (WarningInSourceFile != null)
        {
            WarningInSourceFile(SourceFile, lineNumber,
                String.Format(format, args));
        }
    }
}

}