EpubReader/Source/VersOne.Epub/Options/XmlReaderOptions.cs

using System.Diagnostics.CodeAnalysis;

namespace VersOne.Epub.Options
{
    /// <summary>
    /// Various options to configure how EPUB reader handles XML files.
    /// </summary>
    public class XmlReaderOptions
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="XmlReaderOptions" /> class.
        /// </summary>
        /// <param name="preset">An optional preset to initialize the <see cref="XmlReaderOptions" /> class with a predefined set of options.</param>
        [SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Temporarily ignore unused 'preset' parameter.")]
        public XmlReaderOptions(EpubReaderOptionsPreset? preset = null)
        {
            SkipXmlHeaders = false;
        }

        /// <summary>
        /// Gets or sets a value indicating whether XML reader should skip XML headers for all schema files before attempting to read them.
        /// This is a workaround for handling XML 1.1 files due to the lack of their support in .NET (only XML 1.0 files are currently supported).
        /// If this property is set to <c>true</c>, XML reader will check if an XML file contains a declaration (&lt;?xml version="..." encoding="UTF-8"?&gt;)
        /// in which case the reader will skip it before passing the file to the underlying .NET XDocument class. This lets the library to handle
        /// EPUB files containing XML 1.1 files at the expense of an additional processing overhead for every schema file inside the EPUB file.
        /// If this property is set to <c>false</c>, then there is no overhead for processing XML files. However in an attempt to open an EPUB
        /// with an XML 1.1 file, an XmlException "Version number '1.1' is invalid" will be thrown.
        /// Default value is <c>false</c>.
        /// </summary>
        public bool SkipXmlHeaders { get; set; }
    }
}