Represents a file system of Caches and Archives. More...

Collaboration diagram for com.runehive.fs.cache.FileSystem:

Public Member Functions
Archive	getArchive (int id)
	Gets an `Archive` for the specified `id`, this method fails-fast if no archive can be found.
ByteBuffer	getArchiveHashes () throws IOException
	Returns the cached `archiveHashes` if they exist, otherwise they are calculated and cached for future use.
Cache	getCache (int id)
	Gets a `Cache` for the specified `id`, this method fails-fast if no cache can be found.
ByteBuffer	getFile (int cacheId, int indexId) throws IOException
	Returns a `ByteBuffer` of file data for the specified index within the specified `Cache`.

Static Public Member Functions
static FileSystem	create (String directory) throws IOException
	Constructs and initializes a `FileSystem` from the specified `directory`.

Static Public Attributes
static final int	ANIMATION_INDEX = 2
	Represents the id of the animations cache.
static final int	CONFIG_ARCHIVE = 2
	Represents the id of the configurations archive.
static final int	CONFIG_INDEX = 0
	Represents the id of the configurations cache.
static final int	INTERFACE_ARCHIVE = 3
	Represents the id of the interface archive.
static final int	MANIFEST_ARCHIVE = 5
	Represents the id of the manifest archive.
static final int	MAP_INDEX = 4
	Represents the id of the tool.mapviewer and landscape cache.
static final int	MEDIA_ARCHIVE = 4
	Represents the id of the media and sprite archive.
static final int	MIDI_INDEX = 3
	Represents the id of the sounds and music cache.
static final int	MODEL_INDEX = 1
	Represents the id of the model cache.
static final int	SOUND_ARCHIVE = 8
	Represents the id of the sound and music archive.
static final int	TEXTURES_ARCHIVE = 6
	Represents the id of the textures archive.
static final int	TITLE_ARCHIVE = 1
	Represents the id of the title screen archive.
static final int	WORD_ARCHIVE = 7
	Represents the id of the word archive - user for storing profane or illegal words not allowed to be spoken in-game.

Private Member Functions
	FileSystem (Cache[] caches, Archive[] archives)
	Constructs a new `FileSystem` with the specified `Cache`s and `Archive`s.

Private Attributes
ByteBuffer	archiveHashes
	The cached archive hashes.
final Archive[]	archives
	All of the `Archive`s within this `FileSystem`.
final Cache[]	caches
	All of the `Cache`s within this `FileSystem`.

Static Private Attributes
static final String	DATA_PREFIX = "main_file_cache.dat"
	Represents the prefix of this `FileSystem`s main cache files.
static final String	INDEX_PREFIX = "main_file_cache.idx"
	Represents the prefix of this `FileSystem`s index files.
static final int	MAXIMUM_ARCHIVES = 9
	Represents the maximum amount of archives within this file system.
static final int	MAXIMUM_INDICES = 256
	Represents the maximum amount of indices within this file system.

Detailed Description

Represents a file system of Caches and Archives.

Author: Ryley Kimmel ryley.nosp@m..kim.nosp@m.mel@l.nosp@m.ive..nosp@m.com; Artem Batutin artem.nosp@m.batu.nosp@m.tin@g.nosp@m.mail.nosp@m..com

Definition at line 24 of file FileSystem.java.

Constructor & Destructor Documentation

◆ FileSystem()

com.runehive.fs.cache.FileSystem.FileSystem	(	Cache[]	caches,
		Archive[]	archives )

private

Constructs a new FileSystem with the specified Caches and Archives.

Parameters

caches	All of the `Cache`s within this `FileSystem`.
archives	All of the `Archive`s within this `FileSystem`.

Definition at line 98 of file FileSystem.java.

                                                           {
        this.caches = caches;
        this.archives = archives;
    }

References archives, and caches.

Referenced by create().

Here is the caller graph for this function:

Member Function Documentation

◆ create()

FileSystem com.runehive.fs.cache.FileSystem.create ( String directory ) throws IOException

static

Constructs and initializes a FileSystem from the specified directory.

Parameters

directory The directory of the FileSystem.

Returns: The constructed FileSystem instance.

Exceptions

IOException If some I/O exception occurs.

Definition at line 111 of file FileSystem.java.

                                                                         {
        Path root = Paths.get(directory);
        Preconditions.checkArgument(Files.isDirectory(root), "Supplied path must be a directory! " + root);
 
        Path data = root.resolve(DATA_PREFIX);
        Preconditions.checkArgument(Files.exists(data), "No data file found in the specified path!");
 
        SeekableByteChannel dataChannel = Files.newByteChannel(data, READ, WRITE);
 
        Cache[] caches = new Cache[MAXIMUM_INDICES];
        Archive[] archives = new Archive[MAXIMUM_ARCHIVES];
 
        for (int index = 0; index < caches.length; index++) {
            Path path = root.resolve(INDEX_PREFIX + index);
            if (Files.exists(path)) {
                SeekableByteChannel indexChannel = Files.newByteChannel(path, READ, WRITE);
                caches[index] = new Cache(dataChannel, indexChannel, index);
            }
        }
 
        // We don't use index 0
        for (int id = 1; id < archives.length; id++) {
            Cache cache = Objects.requireNonNull(caches[CONFIG_INDEX], "Configuration cache is null - unable to decode archives");
            archives[id] = Archive.decode(cache.get(id));
        }
 
        return new FileSystem(caches, archives);
    }

References archives, caches, CONFIG_INDEX, DATA_PREFIX, com.runehive.fs.cache.archive.Archive.decode(), FileSystem(), INDEX_PREFIX, MAXIMUM_ARCHIVES, and MAXIMUM_INDICES.

Referenced by com.runehive.RuneHive.processSequentialStartupTasks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArchive()

Archive com.runehive.fs.cache.FileSystem.getArchive ( int id )

Gets an Archive for the specified id, this method fails-fast if no archive can be found.

Parameters

id	The id of the `Archive` to fetch.

Returns: The Archive for the specified id.

Exceptions

NullPointerException If the archive cannot be found.

Definition at line 148 of file FileSystem.java.

                                      {
        Preconditions.checkElementIndex(id, archives.length);
        return Objects.requireNonNull(archives[id]);
    }

References archives.

◆ getArchiveHashes()

ByteBuffer com.runehive.fs.cache.FileSystem.getArchiveHashes ( ) throws IOException

Returns the cached archiveHashes if they exist, otherwise they are calculated and cached for future use.

Returns: The hashes of each Archive.

Exceptions

IOException If some I/O exception occurs.

Definition at line 189 of file FileSystem.java.

                                                            {
        synchronized (this) {
            if (archiveHashes != null) {
                return archiveHashes.duplicate();
            }
        }
 
        int[] crcs = new int[MAXIMUM_ARCHIVES];
 
        CRC32 crc32 = new CRC32();
        for (int file = 1; file < crcs.length; file++) {
            crc32.reset();
 
            ByteBuffer buffer = getFile(CONFIG_INDEX, file);
            crc32.update(buffer);
 
            crcs[file] = (int) crc32.getValue();
        }
 
        ByteBuffer buffer = ByteBuffer.allocate((crcs.length + 1) * Integer.BYTES);
 
        int hash = 1234;
        for (int crc : crcs) {
            hash = (hash << 1) + crc;
            buffer.putInt(crc);
        }
 
        buffer.putInt(hash);
        buffer.flip();
 
        synchronized (this) {
            archiveHashes = buffer.asReadOnlyBuffer();
            return archiveHashes.duplicate();
        }
    }

References archiveHashes, CONFIG_INDEX, getFile(), and MAXIMUM_ARCHIVES.

Here is the call graph for this function:

◆ getCache()

Cache com.runehive.fs.cache.FileSystem.getCache ( int id )

Gets a Cache for the specified id, this method fails-fast if no cache can be found.

Parameters

id	The id of the `Cache` to fetch.

Returns: The Cache for the specified id.

Exceptions

NullPointerException If the cache cannot be found.

Definition at line 161 of file FileSystem.java.

                                  {
        Preconditions.checkElementIndex(id, caches.length);
        return Objects.requireNonNull(caches[id]);
    }

References caches.

Referenced by getFile().

Here is the caller graph for this function:

◆ getFile()

ByteBuffer com.runehive.fs.cache.FileSystem.getFile	(	int	cacheId,
		int	indexId ) throws IOException

Returns a ByteBuffer of file data for the specified index within the specified Cache.

Parameters

cacheId	The id of the cache.
indexId	The id of the index within the cache.

Returns: A ByteBuffer of file data for the specified index.

Exceptions

IOException If some I/O exception occurs.

Definition at line 175 of file FileSystem.java.

                                                                           {
        Cache cache = getCache(cacheId);
        synchronized (cache) {
            return cache.get(indexId);
        }
    }

References getCache().

Referenced by getArchiveHashes().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ ANIMATION_INDEX

final int com.runehive.fs.cache.FileSystem.ANIMATION_INDEX = 2

static

Represents the id of the animations cache.

Definition at line 33 of file FileSystem.java.

◆ archiveHashes

ByteBuffer com.runehive.fs.cache.FileSystem.archiveHashes

private

The cached archive hashes.

Definition at line 87 of file FileSystem.java.

Referenced by getArchiveHashes().

◆ archives

final Archive [] com.runehive.fs.cache.FileSystem.archives

private

All of the Archives within this FileSystem.

Definition at line 84 of file FileSystem.java.

Referenced by create(), FileSystem(), and getArchive().

◆ caches

final Cache [] com.runehive.fs.cache.FileSystem.caches

private

All of the Caches within this FileSystem.

Definition at line 81 of file FileSystem.java.

Referenced by create(), FileSystem(), and getCache().

◆ CONFIG_ARCHIVE

final int com.runehive.fs.cache.FileSystem.CONFIG_ARCHIVE = 2

static

Represents the id of the configurations archive.

Definition at line 45 of file FileSystem.java.

Referenced by com.runehive.RuneHive.processSequentialStartupTasks(), com.runehive.fs.cache.decoder.AnimationDefinitionDecoder.run(), and com.runehive.fs.cache.decoder.ObjectDefinitionDecoder.run().

◆ CONFIG_INDEX

final int com.runehive.fs.cache.FileSystem.CONFIG_INDEX = 0

static

Represents the id of the configurations cache.

Definition at line 27 of file FileSystem.java.

Referenced by create(), and getArchiveHashes().

◆ DATA_PREFIX

final String com.runehive.fs.cache.FileSystem.DATA_PREFIX = "main_file_cache.dat"

staticprivate

Represents the prefix of this FileSystems main cache files.

Definition at line 75 of file FileSystem.java.

Referenced by create().

◆ INDEX_PREFIX

final String com.runehive.fs.cache.FileSystem.INDEX_PREFIX = "main_file_cache.idx"

staticprivate

Represents the prefix of this FileSystems index files.

Definition at line 78 of file FileSystem.java.

Referenced by create().

◆ INTERFACE_ARCHIVE

final int com.runehive.fs.cache.FileSystem.INTERFACE_ARCHIVE = 3

static

Represents the id of the interface archive.

Definition at line 48 of file FileSystem.java.

◆ MANIFEST_ARCHIVE

final int com.runehive.fs.cache.FileSystem.MANIFEST_ARCHIVE = 5

static

Represents the id of the manifest archive.

Definition at line 54 of file FileSystem.java.

Referenced by com.runehive.fs.cache.decoder.MapDefinitionDecoder.run().

◆ MAP_INDEX

final int com.runehive.fs.cache.FileSystem.MAP_INDEX = 4

static

Represents the id of the tool.mapviewer and landscape cache.

Definition at line 39 of file FileSystem.java.

Referenced by com.runehive.fs.cache.decoder.RegionDecoder.run().

◆ MAXIMUM_ARCHIVES

final int com.runehive.fs.cache.FileSystem.MAXIMUM_ARCHIVES = 9

staticprivate

Represents the maximum amount of archives within this file system.

Definition at line 69 of file FileSystem.java.

Referenced by create(), and getArchiveHashes().

◆ MAXIMUM_INDICES

final int com.runehive.fs.cache.FileSystem.MAXIMUM_INDICES = 256

staticprivate

Represents the maximum amount of indices within this file system.

Definition at line 72 of file FileSystem.java.

Referenced by create().

◆ MEDIA_ARCHIVE

final int com.runehive.fs.cache.FileSystem.MEDIA_ARCHIVE = 4

static

Represents the id of the media and sprite archive.

Definition at line 51 of file FileSystem.java.

◆ MIDI_INDEX

final int com.runehive.fs.cache.FileSystem.MIDI_INDEX = 3

static

Represents the id of the sounds and music cache.

Definition at line 36 of file FileSystem.java.

◆ MODEL_INDEX

final int com.runehive.fs.cache.FileSystem.MODEL_INDEX = 1

static

Represents the id of the model cache.

Definition at line 30 of file FileSystem.java.

◆ SOUND_ARCHIVE

final int com.runehive.fs.cache.FileSystem.SOUND_ARCHIVE = 8

static

Represents the id of the sound and music archive.

Definition at line 66 of file FileSystem.java.

◆ TEXTURES_ARCHIVE

final int com.runehive.fs.cache.FileSystem.TEXTURES_ARCHIVE = 6

static

Represents the id of the textures archive.

Definition at line 57 of file FileSystem.java.

◆ TITLE_ARCHIVE

final int com.runehive.fs.cache.FileSystem.TITLE_ARCHIVE = 1

static

Represents the id of the title screen archive.

Definition at line 42 of file FileSystem.java.

◆ WORD_ARCHIVE

final int com.runehive.fs.cache.FileSystem.WORD_ARCHIVE = 7

static

Represents the id of the word archive - user for storing profane or illegal words not allowed to be spoken in-game.

Definition at line 63 of file FileSystem.java.

The documentation for this class was generated from the following file:

java/com/runehive/fs/cache/FileSystem.java

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FileSystem()

Member Function Documentation

◆ create()

◆ getArchive()

◆ getArchiveHashes()

◆ getCache()

◆ getFile()

Member Data Documentation

◆ ANIMATION_INDEX

◆ archiveHashes

◆ archives

◆ caches

◆ CONFIG_ARCHIVE

◆ CONFIG_INDEX

◆ DATA_PREFIX

◆ INDEX_PREFIX

◆ INTERFACE_ARCHIVE

◆ MANIFEST_ARCHIVE

◆ MAP_INDEX

◆ MAXIMUM_ARCHIVES

◆ MAXIMUM_INDICES

◆ MEDIA_ARCHIVE

◆ MIDI_INDEX

◆ MODEL_INDEX

◆ SOUND_ARCHIVE

◆ TEXTURES_ARCHIVE

◆ TITLE_ARCHIVE

◆ WORD_ARCHIVE