File size: 14,101 Bytes
fab29d7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
using System.IO;
using System.Threading.Tasks;
using VersOne.Epub.Environment;
using VersOne.Epub.Environment.Implementation;
using VersOne.Epub.Internal;
using VersOne.Epub.Options;
namespace VersOne.Epub
{
/// <summary>
/// The main entry point of the EpubReader library. The methods in this class let the consumer to open/read EPUB books from a file or a <see cref="Stream" />.
/// </summary>
public static class EpubReader
{
private static readonly IEnvironmentDependencies environmentDependencies;
static EpubReader()
{
environmentDependencies = new EnvironmentDependencies();
}
/// <summary>
/// Opens the book synchronously without reading its content. The object returned by this method holds a handle to the EPUB file.
/// </summary>
/// <param name="filePath">Path to the EPUB file.</param>
/// <param name="epubReaderOptionsPreset">
/// A preset to configure the behavior of the EPUB reader.
/// Default value is <c>EpubReaderOptionsPreset.RELAXED</c>.
/// </param>
/// <returns>EPUB book reference. This object holds a handle to the EPUB file.</returns>
public static EpubBookRef OpenBook(string filePath, EpubReaderOptionsPreset epubReaderOptionsPreset = EpubReaderOptionsPreset.RELAXED)
{
BookRefReader bookRefReader = new(environmentDependencies, new EpubReaderOptions(epubReaderOptionsPreset));
return bookRefReader.OpenBook(filePath);
}
/// <summary>
/// Opens the book synchronously without reading its content. The object returned by this method holds a handle to the EPUB file.
/// </summary>
/// <param name="filePath">Path to the EPUB file.</param>
/// <param name="epubReaderOptions">Various options to configure the behavior of the EPUB reader.</param>
/// <returns>EPUB book reference. This object holds a handle to the EPUB file.</returns>
public static EpubBookRef OpenBook(string filePath, EpubReaderOptions? epubReaderOptions)
{
BookRefReader bookRefReader = new(environmentDependencies, epubReaderOptions);
return bookRefReader.OpenBook(filePath);
}
/// <summary>
/// Opens the book synchronously without reading its content. The object returned by this method holds a handle to the EPUB file.
/// </summary>
/// <param name="stream">Seekable stream containing the EPUB file.</param>
/// <param name="epubReaderOptionsPreset">
/// A preset to configure the behavior of the EPUB reader.
/// Default value is <c>EpubReaderOptionsPreset.RELAXED</c>.
/// </param>
/// <returns>EPUB book reference. This object holds a handle to the EPUB file.</returns>
public static EpubBookRef OpenBook(Stream stream, EpubReaderOptionsPreset epubReaderOptionsPreset = EpubReaderOptionsPreset.RELAXED)
{
BookRefReader bookRefReader = new(environmentDependencies, new EpubReaderOptions(epubReaderOptionsPreset));
return bookRefReader.OpenBook(stream);
}
/// <summary>
/// Opens the book synchronously without reading its content. The object returned by this method holds a handle to the EPUB file.
/// </summary>
/// <param name="stream">Seekable stream containing the EPUB file.</param>
/// <param name="epubReaderOptions">Various options to configure the behavior of the EPUB reader.</param>
/// <returns>EPUB book reference. This object holds a handle to the EPUB file.</returns>
public static EpubBookRef OpenBook(Stream stream, EpubReaderOptions? epubReaderOptions)
{
BookRefReader bookRefReader = new(environmentDependencies, epubReaderOptions);
return bookRefReader.OpenBook(stream);
}
/// <summary>
/// Opens the book asynchronously without reading its content. The object returned by this method holds a handle to the EPUB file.
/// </summary>
/// <param name="filePath">Path to the EPUB file.</param>
/// <param name="epubReaderOptionsPreset">
/// A preset to configure the behavior of the EPUB reader.
/// Default value is <c>EpubReaderOptionsPreset.RELAXED</c>.
/// </param>
/// <returns>EPUB book reference. This object holds a handle to the EPUB file.</returns>
public static Task<EpubBookRef> OpenBookAsync(string filePath, EpubReaderOptionsPreset epubReaderOptionsPreset = EpubReaderOptionsPreset.RELAXED)
{
BookRefReader bookRefReader = new(environmentDependencies, new EpubReaderOptions(epubReaderOptionsPreset));
return bookRefReader.OpenBookAsync(filePath);
}
/// <summary>
/// Opens the book asynchronously without reading its content. The object returned by this method holds a handle to the EPUB file.
/// </summary>
/// <param name="filePath">Path to the EPUB file.</param>
/// <param name="epubReaderOptions">Various options to configure the behavior of the EPUB reader.</param>
/// <returns>EPUB book reference. This object holds a handle to the EPUB file.</returns>
public static Task<EpubBookRef> OpenBookAsync(string filePath, EpubReaderOptions? epubReaderOptions)
{
BookRefReader bookRefReader = new(environmentDependencies, epubReaderOptions);
return bookRefReader.OpenBookAsync(filePath);
}
/// <summary>
/// Opens the book asynchronously without reading its content. The object returned by this method holds a handle to the EPUB file.
/// </summary>
/// <param name="stream">Seekable stream containing the EPUB file.</param>
/// <param name="epubReaderOptionsPreset">
/// A preset to configure the behavior of the EPUB reader.
/// Default value is <c>EpubReaderOptionsPreset.RELAXED</c>.
/// </param>
/// <returns>EPUB book reference. This object holds a handle to the EPUB file.</returns>
public static Task<EpubBookRef> OpenBookAsync(Stream stream, EpubReaderOptionsPreset epubReaderOptionsPreset = EpubReaderOptionsPreset.RELAXED)
{
BookRefReader bookRefReader = new(environmentDependencies, new EpubReaderOptions(epubReaderOptionsPreset));
return bookRefReader.OpenBookAsync(stream);
}
/// <summary>
/// Opens the book asynchronously without reading its content. The object returned by this method holds a handle to the EPUB file.
/// </summary>
/// <param name="stream">Seekable stream containing the EPUB file.</param>
/// <param name="epubReaderOptions">Various options to configure the behavior of the EPUB reader.</param>
/// <returns>EPUB book reference. This object holds a handle to the EPUB file.</returns>
public static Task<EpubBookRef> OpenBookAsync(Stream stream, EpubReaderOptions? epubReaderOptions)
{
BookRefReader bookRefReader = new(environmentDependencies, epubReaderOptions);
return bookRefReader.OpenBookAsync(stream);
}
/// <summary>
/// Opens the book synchronously and reads all of its content into the memory. The object returned by this method does not retain a handle to the EPUB file.
/// </summary>
/// <param name="filePath">Path to the EPUB file.</param>
/// <param name="epubReaderOptionsPreset">
/// A preset to configure the behavior of the EPUB reader.
/// Default value is <c>EpubReaderOptionsPreset.RELAXED</c>.
/// </param>
/// <returns>EPUB book with all its content. This object does not retain a handle to the EPUB file.</returns>
public static EpubBook ReadBook(string filePath, EpubReaderOptionsPreset epubReaderOptionsPreset = EpubReaderOptionsPreset.RELAXED)
{
BookReader bookReader = new(environmentDependencies, new EpubReaderOptions(epubReaderOptionsPreset));
return bookReader.ReadBook(filePath);
}
/// <summary>
/// Opens the book synchronously and reads all of its content into the memory. The object returned by this method does not retain a handle to the EPUB file.
/// </summary>
/// <param name="filePath">Path to the EPUB file.</param>
/// <param name="epubReaderOptions">Various options to configure the behavior of the EPUB reader.</param>
/// <returns>EPUB book with all its content. This object does not retain a handle to the EPUB file.</returns>
public static EpubBook ReadBook(string filePath, EpubReaderOptions? epubReaderOptions)
{
BookReader bookReader = new(environmentDependencies, epubReaderOptions);
return bookReader.ReadBook(filePath);
}
/// <summary>
/// Opens the book synchronously and reads all of its content into the memory. The object returned by this method does not retain a handle to the EPUB file.
/// </summary>
/// <param name="stream">Seekable stream containing the EPUB file.</param>
/// <param name="epubReaderOptionsPreset">
/// A preset to configure the behavior of the EPUB reader.
/// Default value is <c>EpubReaderOptionsPreset.RELAXED</c>.
/// </param>
/// <returns>EPUB book with all its content. This object does not retain a handle to the EPUB file.</returns>
public static EpubBook ReadBook(Stream stream, EpubReaderOptionsPreset epubReaderOptionsPreset = EpubReaderOptionsPreset.RELAXED)
{
BookReader bookReader = new(environmentDependencies, new EpubReaderOptions(epubReaderOptionsPreset));
return bookReader.ReadBook(stream);
}
/// <summary>
/// Opens the book synchronously and reads all of its content into the memory. The object returned by this method does not retain a handle to the EPUB file.
/// </summary>
/// <param name="stream">Seekable stream containing the EPUB file.</param>
/// <param name="epubReaderOptions">Various options to configure the behavior of the EPUB reader.</param>
/// <returns>EPUB book with all its content. This object does not retain a handle to the EPUB file.</returns>
public static EpubBook ReadBook(Stream stream, EpubReaderOptions? epubReaderOptions)
{
BookReader bookReader = new(environmentDependencies, epubReaderOptions);
return bookReader.ReadBook(stream);
}
/// <summary>
/// Opens the book asynchronously and reads all of its content into the memory. The object returned by this method does not retain a handle to the EPUB file.
/// </summary>
/// <param name="filePath">Path to the EPUB file.</param>
/// <param name="epubReaderOptionsPreset">
/// A preset to configure the behavior of the EPUB reader.
/// Default value is <c>EpubReaderOptionsPreset.RELAXED</c>.
/// </param>
/// <returns>EPUB book with all its content. This object does not retain a handle to the EPUB file.</returns>
public static Task<EpubBook> ReadBookAsync(string filePath, EpubReaderOptionsPreset epubReaderOptionsPreset = EpubReaderOptionsPreset.RELAXED)
{
BookReader bookReader = new(environmentDependencies, new EpubReaderOptions(epubReaderOptionsPreset));
return bookReader.ReadBookAsync(filePath);
}
/// <summary>
/// Opens the book asynchronously and reads all of its content into the memory. The object returned by this method does not retain a handle to the EPUB file.
/// </summary>
/// <param name="filePath">Path to the EPUB file.</param>
/// <param name="epubReaderOptions">Various options to configure the behavior of the EPUB reader.</param>
/// <returns>EPUB book with all its content. This object does not retain a handle to the EPUB file.</returns>
public static Task<EpubBook> ReadBookAsync(string filePath, EpubReaderOptions? epubReaderOptions)
{
BookReader bookReader = new(environmentDependencies, epubReaderOptions);
return bookReader.ReadBookAsync(filePath);
}
/// <summary>
/// Opens the book asynchronously and reads all of its content into the memory. The object returned by this method does not retain a handle to the EPUB file.
/// </summary>
/// <param name="stream">Seekable stream containing the EPUB file.</param>
/// <param name="epubReaderOptionsPreset">
/// A preset to configure the behavior of the EPUB reader.
/// Default value is <c>EpubReaderOptionsPreset.RELAXED</c>.
/// </param>
/// <returns>EPUB book with all its content. This object does not retain a handle to the EPUB file.</returns>
public static Task<EpubBook> ReadBookAsync(Stream stream, EpubReaderOptionsPreset epubReaderOptionsPreset = EpubReaderOptionsPreset.RELAXED)
{
BookReader bookReader = new(environmentDependencies, new EpubReaderOptions(epubReaderOptionsPreset));
return bookReader.ReadBookAsync(stream);
}
/// <summary>
/// Opens the book asynchronously and reads all of its content into the memory. The object returned by this method does not retain a handle to the EPUB file.
/// </summary>
/// <param name="stream">Seekable stream containing the EPUB file.</param>
/// <param name="epubReaderOptions">Various options to configure the behavior of the EPUB reader.</param>
/// <returns>EPUB book with all its content. This object does not retain a handle to the EPUB file.</returns>
public static Task<EpubBook> ReadBookAsync(Stream stream, EpubReaderOptions? epubReaderOptions)
{
BookReader bookReader = new(environmentDependencies, epubReaderOptions);
return bookReader.ReadBookAsync(stream);
}
}
}
|