fallout_dat: Java parsing library

Application

Fallout

KS implementation details

License: CC0-1.0

References

This page hosts a formal specification of fallout_dat using Kaitai Struct. This specification can be automatically translated into a variety of programming languages to get a parsing library.

Usage

Runtime library

All parsing code for Java generated by Kaitai Struct depends on the Java runtime library. You have to install it before you can parse data.

The Java runtime library is published in the Maven Central Repository. Refer to the artifact page for instructions how to add it into your project with the build tool that you use.

Code

Parse a local file and get structure in memory:

FalloutDat data = FalloutDat.fromFile("path/to/local/file.fallout_dat");

Or parse structure from a byte array:

byte[] someArray = new byte[] { ... };
FalloutDat data = new FalloutDat(new ByteBufferKaitaiStream(someArray));

After that, one can get various attributes from the structure by invoking getter methods like:

data.folderCount() // => get folder count

Java source code to parse fallout_dat

FalloutDat.java

// This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild

import io.kaitai.struct.ByteBufferKaitaiStream;
import io.kaitai.struct.KaitaiStruct;
import io.kaitai.struct.KaitaiStream;
import java.io.IOException;
import java.util.Map;
import java.util.HashMap;
import java.util.ArrayList;
import java.nio.charset.Charset;

public class FalloutDat extends KaitaiStruct {
    public static FalloutDat fromFile(String fileName) throws IOException {
        return new FalloutDat(new ByteBufferKaitaiStream(fileName));
    }

    public enum Compression {
        NONE(32),
        LZSS(64);

        private final long id;
        Compression(long id) { this.id = id; }
        public long id() { return id; }
        private static final Map<Long, Compression> byId = new HashMap<Long, Compression>(2);
        static {
            for (Compression e : Compression.values())
                byId.put(e.id(), e);
        }
        public static Compression byId(long id) { return byId.get(id); }
    }

    public FalloutDat(KaitaiStream _io) {
        this(_io, null, null);
    }

    public FalloutDat(KaitaiStream _io, KaitaiStruct _parent) {
        this(_io, _parent, null);
    }

    public FalloutDat(KaitaiStream _io, KaitaiStruct _parent, FalloutDat _root) {
        super(_io);
        this._parent = _parent;
        this._root = _root == null ? this : _root;
        _read();
    }
    private void _read() {
        this.folderCount = this._io.readU4be();
        this.unknown1 = this._io.readU4be();
        this.unknown2 = this._io.readU4be();
        this.timestamp = this._io.readU4be();
        folderNames = new ArrayList<Pstr>(((Number) (folderCount())).intValue());
        for (int i = 0; i < folderCount(); i++) {
            this.folderNames.add(new Pstr(this._io, this, _root));
        }
        folders = new ArrayList<Folder>(((Number) (folderCount())).intValue());
        for (int i = 0; i < folderCount(); i++) {
            this.folders.add(new Folder(this._io, this, _root));
        }
    }
    public static class Pstr extends KaitaiStruct {
        public static Pstr fromFile(String fileName) throws IOException {
            return new Pstr(new ByteBufferKaitaiStream(fileName));
        }

        public Pstr(KaitaiStream _io) {
            this(_io, null, null);
        }

        public Pstr(KaitaiStream _io, KaitaiStruct _parent) {
            this(_io, _parent, null);
        }

        public Pstr(KaitaiStream _io, KaitaiStruct _parent, FalloutDat _root) {
            super(_io);
            this._parent = _parent;
            this._root = _root;
            _read();
        }
        private void _read() {
            this.size = this._io.readU1();
            this.str = new String(this._io.readBytes(size()), Charset.forName("ASCII"));
        }
        private int size;
        private String str;
        private FalloutDat _root;
        private KaitaiStruct _parent;
        public int size() { return size; }
        public String str() { return str; }
        public FalloutDat _root() { return _root; }
        public KaitaiStruct _parent() { return _parent; }
    }
    public static class Folder extends KaitaiStruct {
        public static Folder fromFile(String fileName) throws IOException {
            return new Folder(new ByteBufferKaitaiStream(fileName));
        }

        public Folder(KaitaiStream _io) {
            this(_io, null, null);
        }

        public Folder(KaitaiStream _io, FalloutDat _parent) {
            this(_io, _parent, null);
        }

        public Folder(KaitaiStream _io, FalloutDat _parent, FalloutDat _root) {
            super(_io);
            this._parent = _parent;
            this._root = _root;
            _read();
        }
        private void _read() {
            this.fileCount = this._io.readU4be();
            this.unknown = this._io.readU4be();
            this.flags = this._io.readU4be();
            this.timestamp = this._io.readU4be();
            files = new ArrayList<File>(((Number) (fileCount())).intValue());
            for (int i = 0; i < fileCount(); i++) {
                this.files.add(new File(this._io, this, _root));
            }
        }
        private long fileCount;
        private long unknown;
        private long flags;
        private long timestamp;
        private ArrayList<File> files;
        private FalloutDat _root;
        private FalloutDat _parent;
        public long fileCount() { return fileCount; }
        public long unknown() { return unknown; }
        public long flags() { return flags; }
        public long timestamp() { return timestamp; }
        public ArrayList<File> files() { return files; }
        public FalloutDat _root() { return _root; }
        public FalloutDat _parent() { return _parent; }
    }
    public static class File extends KaitaiStruct {
        public static File fromFile(String fileName) throws IOException {
            return new File(new ByteBufferKaitaiStream(fileName));
        }

        public File(KaitaiStream _io) {
            this(_io, null, null);
        }

        public File(KaitaiStream _io, FalloutDat.Folder _parent) {
            this(_io, _parent, null);
        }

        public File(KaitaiStream _io, FalloutDat.Folder _parent, FalloutDat _root) {
            super(_io);
            this._parent = _parent;
            this._root = _root;
            _read();
        }
        private void _read() {
            this.name = new Pstr(this._io, this, _root);
            this.flags = FalloutDat.Compression.byId(this._io.readU4be());
            this.offset = this._io.readU4be();
            this.sizeUnpacked = this._io.readU4be();
            this.sizePacked = this._io.readU4be();
        }
        private byte[] contents;
        public byte[] contents() {
            if (this.contents != null)
                return this.contents;
            KaitaiStream io = _root._io();
            long _pos = io.pos();
            io.seek(offset());
            this.contents = io.readBytes((flags() == FalloutDat.Compression.NONE ? sizeUnpacked() : sizePacked()));
            io.seek(_pos);
            return this.contents;
        }
        private Pstr name;
        private Compression flags;
        private long offset;
        private long sizeUnpacked;
        private long sizePacked;
        private FalloutDat _root;
        private FalloutDat.Folder _parent;
        public Pstr name() { return name; }
        public Compression flags() { return flags; }
        public long offset() { return offset; }
        public long sizeUnpacked() { return sizeUnpacked; }
        public long sizePacked() { return sizePacked; }
        public FalloutDat _root() { return _root; }
        public FalloutDat.Folder _parent() { return _parent; }
    }
    private long folderCount;
    private long unknown1;
    private long unknown2;
    private long timestamp;
    private ArrayList<Pstr> folderNames;
    private ArrayList<Folder> folders;
    private FalloutDat _root;
    private KaitaiStruct _parent;
    public long folderCount() { return folderCount; }
    public long unknown1() { return unknown1; }
    public long unknown2() { return unknown2; }
    public long timestamp() { return timestamp; }
    public ArrayList<Pstr> folderNames() { return folderNames; }
    public ArrayList<Folder> folders() { return folders; }
    public FalloutDat _root() { return _root; }
    public KaitaiStruct _parent() { return _parent; }
}