mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2025-10-21 08:57:38 +00:00
518eefbe10
This replaces the existing IMount openFor* method with openChannelFor* ones, which return an appropriate byte channel instead. As channels are not correctly closed when GCed, we introduce a FileSystemWrapper. We store a weak reference to this, and when it is GCed or the file closed, we will remove it from our "open file" set and ensure any underlying buffers are closed. While this change may seem a little odd, it does introduce some benefits: - We can replace JarMount with a more general FileSystemMount. This does assume a read-only file system, but could technically be used for other sources. - Add support for seekable (binary) handles. We can now look for instances of SeekableByteChannel and dynamically add it. This works for all binary filesystem and HTTP streams. - Rewrite the io library to more accurately emulate PUC Lua's implementation. We do not correctly implement some elements (most noticably "*n", but it's a definite improvement.
99 lines
4.2 KiB
Java
99 lines
4.2 KiB
Java
/*
|
|
* This file is part of the public ComputerCraft API - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2017. This API may be redistributed unmodified and in full only.
|
|
* For help using the API, and posting your mods, visit the forums at computercraft.info.
|
|
*/
|
|
|
|
package dan200.computercraft.api.filesystem;
|
|
|
|
import dan200.computercraft.api.ComputerCraftAPI;
|
|
import dan200.computercraft.api.peripheral.IComputerAccess;
|
|
import net.minecraft.world.World;
|
|
|
|
import javax.annotation.Nonnull;
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.nio.channels.Channels;
|
|
import java.nio.channels.ReadableByteChannel;
|
|
import java.util.List;
|
|
|
|
/**
|
|
* Represents a read only part of a virtual filesystem that can be mounted onto a computer using
|
|
* {@link IComputerAccess#mount(String, IMount)}
|
|
*
|
|
* Ready made implementations of this interface can be created using
|
|
* {@link ComputerCraftAPI#createSaveDirMount(World, String, long)} or
|
|
* {@link ComputerCraftAPI#createResourceMount(Class, String, String)}, or you're free to implement it yourselves!
|
|
*
|
|
* @see ComputerCraftAPI#createSaveDirMount(World, String, long)
|
|
* @see ComputerCraftAPI#createResourceMount(Class, String, String)
|
|
* @see IComputerAccess#mount(String, IMount)
|
|
* @see IWritableMount
|
|
*/
|
|
public interface IMount
|
|
{
|
|
/**
|
|
* Returns whether a file with a given path exists or not.
|
|
*
|
|
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram"
|
|
* @return If the file exists.
|
|
* @throws IOException If an error occurs when checking the existence of the file.
|
|
*/
|
|
boolean exists( @Nonnull String path ) throws IOException;
|
|
|
|
/**
|
|
* Returns whether a file with a given path is a directory or not.
|
|
*
|
|
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprograms".
|
|
* @return If the file exists and is a directory
|
|
* @throws IOException If an error occurs when checking whether the file is a directory.
|
|
*/
|
|
boolean isDirectory( @Nonnull String path ) throws IOException;
|
|
|
|
/**
|
|
* Returns the file names of all the files in a directory.
|
|
*
|
|
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprograms".
|
|
* @param contents A list of strings. Add all the file names to this list.
|
|
* @throws IOException If the file was not a directory, or could not be listed.
|
|
*/
|
|
void list( @Nonnull String path, @Nonnull List<String> contents ) throws IOException;
|
|
|
|
/**
|
|
* Returns the size of a file with a given path, in bytes
|
|
*
|
|
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
|
|
* @return The size of the file, in bytes.
|
|
* @throws IOException If the file does not exist, or its size could not be determined.
|
|
*/
|
|
long getSize( @Nonnull String path ) throws IOException;
|
|
|
|
/**
|
|
* Opens a file with a given path, and returns an {@link InputStream} representing its contents.
|
|
*
|
|
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
|
|
* @return A stream representing the contents of the file.
|
|
* @throws IOException If the file does not exist, or could not be opened.
|
|
* @deprecated Use {@link #openChannelForRead(String)} instead
|
|
*/
|
|
@Nonnull
|
|
@Deprecated
|
|
InputStream openForRead( @Nonnull String path ) throws IOException;
|
|
|
|
/**
|
|
* Opens a file with a given path, and returns an {@link ReadableByteChannel} representing its contents.
|
|
*
|
|
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
|
|
* @return A channel representing the contents of the file. If the channel implements
|
|
* {@link java.nio.channels.SeekableByteChannel}, one will be able to seek to arbitrary positions when using binary
|
|
* mode.
|
|
* @throws IOException If the file does not exist, or could not be opened.
|
|
*/
|
|
@Nonnull
|
|
@SuppressWarnings("deprecation")
|
|
default ReadableByteChannel openChannelForRead( @Nonnull String path ) throws IOException
|
|
{
|
|
return Channels.newChannel( openForRead( path ) );
|
|
}
|
|
}
|