aaru-dps/Aaru
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.git synced 2025-12-16 19:24:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

REFACTOR: Final cleanup of DiscImageChef.Filters.

Browse Source
This commit is contained in:
Natalia Portillo
2017-12-24 02:43:49 +00:00
parent 4115698ac8
commit f9cc6e6918
13 changed files with 495 additions and 487 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
DiscImageChef.Filters/Filter.cs
View File

@@ -41,126 +41,127 @@ namespace DiscImageChef.Filters
public Guid UUID;
/// <summary>
/// Closes all opened streams.
/// Closes all opened streams.
/// </summary>
public abstract void Close();
/// <summary>
/// Gets the path used to open this filter.<br/>
/// UNIX: /path/to/archive.zip/path/to/file.bin => /path/to/archive.zip/path/to/file.bin <br/>
/// Windows: C:\path\to\archive.zip\path\to\file.bin => C:\path\to\archive.zip\path\to\file.bin
/// Gets the path used to open this filter.<br />
/// UNIX: /path/to/archive.zip/path/to/file.bin => /path/to/archive.zip/path/to/file.bin <br />
/// Windows: C:\path\to\archive.zip\path\to\file.bin => C:\path\to\archive.zip\path\to\file.bin
/// </summary>
/// <returns>Path used to open this filter.</returns>
public abstract string GetBasePath();
/// <summary>
/// Gets creation time of file referenced by this filter.
/// Gets creation time of file referenced by this filter.
/// </summary>
/// <returns>The creation time.</returns>
public abstract DateTime GetCreationTime();
/// <summary>
/// Gets length of this filter's data fork.
/// Gets length of this filter's data fork.
/// </summary>
/// <returns>The data fork length.</returns>
public abstract long GetDataForkLength();
/// <summary>
/// Gets a stream to access the data fork contents.
/// Gets a stream to access the data fork contents.
/// </summary>
/// <returns>The data fork stream.</returns>
public abstract Stream GetDataForkStream();
/// <summary>
/// Gets the filename for the file referenced by this filter.<br/>
/// UNIX: /path/to/archive.zip/path/to/file.bin => file.bin <br/>
/// Windows: C:\path\to\archive.zip\path\to\file.bin => file.bin
/// Gets the filename for the file referenced by this filter.<br />
/// UNIX: /path/to/archive.zip/path/to/file.bin => file.bin <br />
/// Windows: C:\path\to\archive.zip\path\to\file.bin => file.bin
/// </summary>
/// <returns>The filename.</returns>
public abstract string GetFilename();
/// <summary>
/// Gets last write time of file referenced by this filter.
/// Gets last write time of file referenced by this filter.
/// </summary>
/// <returns>The last write time.</returns>
public abstract DateTime GetLastWriteTime();
/// <summary>
/// Gets length of file referenced by ths filter.
/// Gets length of file referenced by ths filter.
/// </summary>
/// <returns>The length.</returns>
public abstract long GetLength();
/// <summary>
/// Gets full path to file referenced by this filter. If it's an archive, it's the path inside the archive.<br/>
/// UNIX: /path/to/archive.zip/path/to/file.bin => /path/to/file.bin <br/>
/// Windows: C:\path\to\archive.zip\path\to\file.bin => \path\to\file.bin
/// Gets full path to file referenced by this filter. If it's an archive, it's the path inside the archive.<br />
/// UNIX: /path/to/archive.zip/path/to/file.bin => /path/to/file.bin <br />
/// Windows: C:\path\to\archive.zip\path\to\file.bin => \path\to\file.bin
/// </summary>
/// <returns>The path.</returns>
public abstract string GetPath();
/// <summary>
/// Gets path to parent folder to the file referenced by this filter. If it's an archive, it's the full path to the archive itself.<br/>
/// UNIX: /path/to/archive.zip/path/to/file.bin => /path/to/archive.zip <br/>
/// Windows: C:\path\to\archive.zip\path\to\file.bin => C:\path\to\archive.zip
/// Gets path to parent folder to the file referenced by this filter. If it's an archive, it's the full path to the
/// archive itself.<br />
/// UNIX: /path/to/archive.zip/path/to/file.bin => /path/to/archive.zip <br />
/// Windows: C:\path\to\archive.zip\path\to\file.bin => C:\path\to\archive.zip
/// </summary>
/// <returns>The parent folder.</returns>
public abstract string GetParentFolder();
/// <summary>
/// Gets length of this filter's resource fork.
/// Gets length of this filter's resource fork.
/// </summary>
/// <returns>The resource fork length.</returns>
public abstract long GetResourceForkLength();
/// <summary>
/// Gets a stream to access the resource fork contents.
/// Gets a stream to access the resource fork contents.
/// </summary>
/// <returns>The resource fork stream.</returns>
public abstract Stream GetResourceForkStream();
/// <summary>
/// Returns true if the file referenced by this filter has a resource fork
/// Returns true if the file referenced by this filter has a resource fork
/// </summary>
public abstract bool HasResourceFork();
/// <summary>
/// Identifies if the specified path contains data recognizable by this filter instance
/// Identifies if the specified path contains data recognizable by this filter instance
/// </summary>
/// <param name="path">Path.</param>
public abstract bool Identify(string path);
/// <summary>
/// Identifies if the specified stream contains data recognizable by this filter instance
/// Identifies if the specified stream contains data recognizable by this filter instance
/// </summary>
/// <param name="stream">Stream.</param>
public abstract bool Identify(Stream stream);
/// <summary>
/// Identifies if the specified buffer contains data recognizable by this filter instance
/// Identifies if the specified buffer contains data recognizable by this filter instance
/// </summary>
/// <param name="buffer">Buffer.</param>
public abstract bool Identify(byte[] buffer);
/// <summary>
/// Returns true if the filter has a file/stream/buffer currently opened and no <see cref="Close"/> has been issued.
/// Returns true if the filter has a file/stream/buffer currently opened and no <see cref="Close" /> has been issued.
/// </summary>
public abstract bool IsOpened();
/// <summary>
/// Opens the specified path with this filter instance
/// Opens the specified path with this filter instance
/// </summary>
/// <param name="path">Path.</param>
public abstract void Open(string path);
/// <summary>
/// Opens the specified stream with this filter instance
/// Opens the specified stream with this filter instance
/// </summary>
/// <param name="stream">Stream.</param>
public abstract void Open(Stream stream);
/// <summary>
/// Opens the specified buffer with this filter instance
/// Opens the specified buffer with this filter instance
/// </summary>
/// <param name="buffer">Buffer.</param>
public abstract void Open(byte[] buffer);