[mvp-xml-cvs] Common/v2/src/Xsl IXmlTransform.cs,1.4,1.5 XslReader.cs,1.7,1.8

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/mvp-xml/Common/v2/src/Xsl
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21390/v2/src/Xsl

Added Files:
	IXmlTransform.cs XslReader.cs 
Log Message:


--- NEW FILE: IXmlTransform.cs ---
#region using
using System;
using System.IO;
using System.Xml;
using System.Xml.Xsl;
using System.Xml.XPath; 
#endregion

namespace Mvp.Xml.Common.Xsl {

    /// <summary>
    /// New experimental generic XML transform interface. Defines an API for
    /// transforming <see cref="XmlInput"/> into <see cref="XmlOutput"/>.
    /// </summary>
    public interface IXmlTransform {
        /// <summary>
        /// Transforms given <see cref="XmlInput"/> into <see cref="XmlOutput"/>.
        /// </summary>
        /// <param name="defaulDocument">Default input XML document</param>
        /// <param name="args">Parameters</param>
        /// <param name="output">Represents the transformation's output</param>
        void Transform(XmlInput defaulDocument, XsltArgumentList args, XmlOutput output);
        /// <summary>
        /// Defines default output settings.
        /// </summary>
        XmlWriterSettings OutputSettings { get; }
    }

    /// <summary>
    /// XmlInput class represents generic XML input to a trasnformation. The actual
    /// XML to be transformed can be provided as string URI, <see cref="Stream"/>,
    /// <see cref="TextReader"/>, <see cref="XmlReader"/> or <see cref="IXPathNavigable"/>.
    /// Optional <see cref="XmlResolver"/> is used to resolve external references when
    /// loading input XML document and URIs in a "document()" function calls during
    /// transformation.
    /// </summary>
    public class XmlInput {
        internal object      source  ;
        internal XmlResolver resolver;

        /// <summary>
        /// Creates new XmlInput object for an XML document provided as an 
        /// <see cref="XmlReader"/>. Also registers an <see cref="XmlResolver"/> to be used
        /// for resolving external references in the XML document and document() function.
        /// </summary>
        /// <param name="reader">Input XML document</param>
        /// <param name="resolver"><see cref="XmlResolver"/> to resolve external references</param>
        public XmlInput(XmlReader       reader, XmlResolver resolver) { this.source = reader; this.resolver = resolver; }
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as a 
        /// <see cref="TextReader"/>. Also registers an <see cref="XmlResolver"/> to be used
        /// for resolving external references in the XML document and document() function.
        /// </summary>
        /// <param name="reader">Input XML document</param>
        /// <param name="resolver"><see cref="XmlResolver"/> to resolve external references</param>
        public XmlInput(TextReader      reader, XmlResolver resolver) { this.source = reader; this.resolver = resolver; }
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as a 
        /// <see cref="Stream"/>. Also registers an <see cref="XmlResolver"/> to be used
        /// for resolving external references in the XML document and document() function.
        /// </summary>
        /// <param name="stream">Input XML document</param>
        /// <param name="resolver"><see cref="XmlResolver"/> to resolve external references</param>
        public XmlInput(Stream          stream, XmlResolver resolver) { this.source = stream; this.resolver = resolver; }
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as an URI. 
        /// Also registers an <see cref="XmlResolver"/> to be used
        /// for resolving external references in the XML document and document() function.
        /// </summary>
        /// <param name="uri">Input XML document</param>
        /// <param name="resolver"><see cref="XmlResolver"/> to resolve external references</param>
        public XmlInput(String          uri   , XmlResolver resolver) { this.source = uri   ; this.resolver = resolver; }
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as an 
        /// <see cref="IXPathNavigable"/>. Also registers an <see cref="XmlResolver"/> to be used
        /// for resolving document() function.
        /// </summary>
        /// <param name="nav">Input XML document</param>
        /// <param name="resolver"><see cref="XmlResolver"/> to resolve external references</param>
        public XmlInput(IXPathNavigable nav   , XmlResolver resolver) { this.source = nav   ; this.resolver = resolver; }
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as an 
        /// <see cref="XmlReader"/>. 
        /// </summary>
        /// <param name="reader">Input XML document</param>        
        public XmlInput(XmlReader       reader) : this(reader, new DefaultXmlResolver()) {}
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as a 
        /// <see cref="TextReader"/>. 
        /// </summary>
        /// <param name="reader">Input XML document</param>        
        public XmlInput(TextReader      reader) : this(reader, new DefaultXmlResolver()) {}
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as a 
        /// <see cref="Stream"/>. 
        /// </summary>
        /// <param name="stream">Input XML document</param>        
        public XmlInput(Stream          stream) : this(stream, new DefaultXmlResolver()) {}
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as an URI.        
        /// </summary>
        /// <param name="uri">Input XML document</param>        
        public XmlInput(String          uri   ) : this(uri   , new DefaultXmlResolver()) {}
        /// <summary>
        /// Creates new XmlInput object for an XML document provided as an 
        /// <see cref="IXPathNavigable"/>. 
        /// </summary>
        /// <param name="nav">Input XML document</param>        
        public XmlInput(IXPathNavigable nav   ) : this(nav   , new DefaultXmlResolver()) {}

        // We can add set of implicit constructors. 
        // I am not shre that this will be for good, so I commented them for now.
        //public static implicit operator XmlInput(XmlReader      reader) { return new XmlInput(reader); }
        //public static implicit operator XmlInput(TextReader     reader) { return new XmlInput(reader); }
        //public static implicit operator XmlInput(Stream         stream) { return new XmlInput(stream); }
        //public static implicit operator XmlInput(String         uri   ) { return new XmlInput(uri   ); }
        //public static implicit operator XmlInput(XPathNavigator nav   ) { return new XmlInput(nav   ); } // the trick doesn't work with interfaces
    }

    /// <summary>
    /// XmlOutput class represents generic XML transformation output. An output XML
    /// can be written to an URI, <see cref="Stream"/>, <see cref="TextWriter"/> or
    /// <see cref="XmlWriter"/>.
    /// </summary>
    public class XmlOutput {
        internal object destination;
        /// <summary>
        /// Creates new XmlOutput object over an <see cref="XmlWriter"/>.
        /// </summary>
        /// <param name="writer">An <see cref="XmlWriter"/> to write output to</param>
        public XmlOutput(XmlWriter  writer) { this.destination = writer; }
        /// <summary>
        /// Creates new XmlOutput object over a <see cref="TextWriter"/>.
        /// </summary>
        /// <param name="writer">A <see cref="TextWriter"/> to write output to</param>
        public XmlOutput(TextWriter writer) { this.destination = writer; }
        /// <summary>
        /// Creates new XmlOutput object over a <see cref="Stream"/>.
        /// </summary>
        /// <param name="stream">A <see cref="Stream"/> to write output to</param>
        public XmlOutput(Stream     stream  ) { this.destination = stream  ; }
        /// <summary>
        /// Creates new XmlOutput object over an URI.
        /// </summary>
        /// <param name="uri">An URI to write output to</param>
        public XmlOutput(String     uri   ) { this.destination = uri   ; }
        // We will add overrides with XmlOutputResolver here later to support multiple output documents (<xsl:result-document>)
    }

    /// <summary>
    /// XmlUrlResolver wrapper allowing us to recognize the case when no
    /// XmlResolver was passed.
    /// </summary>
    internal class DefaultXmlResolver : XmlUrlResolver
    {
        public DefaultXmlResolver()
        : base() {}
    }
}

--- NEW FILE: XslReader.cs ---
#region using
using System;
using System.Collections.Generic;
using System.Text;
using System.IO;
using System.Xml;
using System.Xml.Xsl;
using System.Xml.XPath;
using System.Diagnostics;
using System.Threading; 
#endregion

namespace Mvp.Xml.Common.Xsl {

    /// <summary>
    /// <para>XslReader provides an efficient way to read results of an XSL 
    /// transformation via an <see cref="XmlReader"/> API. Due to 
    /// architectural and performance reasons the <see cref="XslCompiledTransform"/>
    /// class doesn't support transforming to an <see cref="XmlReader"/> as obsolete 
[...1065 lines suppressed...]
                }
            }

            public override void Close() {
                Write(XmlNodeType.None, null, null);
                lock (this) {
                    Monitor.Pulse(this);
                }
            }

            public override void GetToken(int attNum, out QName name, out string value) {
                Debug.Assert(0 <= attNum && attNum < readEndPos - readStartPos - 1);
                XmlNodeType nodeType;
                XmlToken.Get(ref buffer[(readStartPos + attNum) & mask], out nodeType, out name, out value);
                Debug.Assert(nodeType == (attNum == 0 ? XmlNodeType.Element : XmlNodeType.Attribute), "We use GetToken() only to access parts of start element tag.");
            }
        }
#endregion  ------------------------------- Supporting classes ------------------------------
    }
}