formats.h

#ifndef FORMATS_H
#define FORMATS_H
 
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
#include "format/arch.h"
 
namespace Linker
{
    class Image;
    class Format;
    class Reader;
}
 
struct format_specification
{
    std::string format;
    std::shared_ptr<Linker::Format> (* produce)();
    std::string documentation;
};
 
extern format_specification formats[];
extern const size_t formats_size;
 
enum format_type
{
    FORMAT_3P, // CauseWay /* TODO: not implemented */
    FORMAT_68K, // .68k used by CP/M-68K, Concurrent DOS 68K, GEMDOS/Atari TOS, Human68k
    FORMAT_ADAM, // Adam Seychell's DOS32 DOS extender
    FORMAT_AIF, // ARM image format /* TODO: not implemented */
    FORMAT_AOUT, // UNIX a.out
    FORMAT_APPLE, // Macintosh AppleSingle/AppleDouble, used to store Macintosh files on other systems
    FORMAT_APPLEII, // Apple ][ binary format
    FORMAT_AR, // UNIX archive files
    FORMAT_AS86, // Introl object file
    FORMAT_ATARI, // Atari 8-bit binary format
    FORMAT_BFLT, // BFLT
    FORMAT_BW, // DOS/16M .exp file
    FORMAT_COFF, // UNIX COFF
    FORMAT_CMD, // CP/M-86
    FORMAT_CPM3, // CP/M-80 Plus format
    FORMAT_D3X, // Daniel Borca's D3X DOS extender
    FORMAT_ELF, // UNIX ELF
    FORMAT_ELF_MULTIPLE, // FatELF for multiple ELF binaries
    FORMAT_FLAT, // flat unstructured file
    FORMAT_FLEX, // FLEX .cmd (6800 or 6809 CPUs)
    FORMAT_GEOS, // PC/GEOS Geode format
    FORMAT_GSOS, // Apple IIgs GS/OS format
    FORMAT_HU, // Human68k .x
    FORMAT_HUNK, // Amiga hunk
    FORMAT_JAVA, // Java class file
    FORMAT_LE, // Linear executable (OS/2, DOS/4G)
    FORMAT_LV, // CandyMan's DX64 DOS extender, LV/Float format
    FORMAT_MACBINARY, // MacBinary
    FORMAT_MACHO, // Mach-O format
    FORMAT_MACHO_MULTIPLE, // Multi-architecture binary Mach-O format
    FORMAT_MINIX, // MINIX a.out
    FORMAT_MP, // Phar Lap executable .exp and relocatable executable, .rex
    FORMAT_MZ, // MS-DOS .exe
    FORMAT_NE, // 16-bit Windows .exe
    FORMAT_O65, // 6502 binary relocation format
    FORMAT_OMF, // (old) Intel Object file, for 8080, 8051, 8096
    FORMAT_OMF86, // Intel Object file, for 8086 and derivatives
    FORMAT_P3, // Phar Lap new executable .exp
    FORMAT_PCOS, // Olivetti M20 PCOS .cmd/.sav files
    FORMAT_PE, // 32-bit Windows .exe
    FORMAT_PEF, // Classic Macintosh PowerPC executable
    FORMAT_PMODEW, // PMODE/W executable
    FORMAT_PRL, // MP/M-80 relocatable
    FORMAT_RSRC, // Classic Macintosh resource, possibly containing an executable
    FORMAT_RSRC_GS, // IIgs resource /* TODO: not implemented */
    FORMAT_SOS, // Apple /// SOS interpreter
    FORMAT_UZI280, // UZI-280 executable
    FORMAT_WASM, // WebAssembly module format
    FORMAT_W3, // Windows unique file
    FORMAT_W4, // Windows unique file
    FORMAT_XENIX, // Xenix segmented executable
    FORMAT_XENIX_BOUT, // Xenix b.out executable
    FORMAT_XP, // OS/286 or OS/386 executable
    FORMAT_Z8K, // CP/M-8000
};
 
struct format_description;
 
enum format_priority
{
    PRIORITY_DEFAULT,
    PRIORITY_LOW = -1,
    PRIORITY_NONE = -2,
};
 
struct format_magic
{
    std::string magic;
    unsigned offset;
    format_type type;
    std::string description;
    bool (* special_parse)(const std::shared_ptr<Linker::Reader>& in, format_description& description);
    format_priority priority;
};
 
struct format_description
{
    format_magic magic;
    uint32_t offset;
};
 
std::shared_ptr<Linker::Format> FetchFormat(std::string text);
 
void DetermineFormat(std::vector<format_description>& descriptions, const std::shared_ptr<Linker::Reader>& rd, uint32_t offset = 0);
 
std::shared_ptr<Linker::Contents> ReadArchiveFile(const std::shared_ptr<Linker::Reader>& rd, offset_t size);
std::shared_ptr<Linker::Contents> ReadLibraryFile(const std::shared_ptr<Linker::Reader>& rd, offset_t size);
 
std::shared_ptr<Linker::Format> CreateFormat(const std::shared_ptr<Linker::Reader>& rd, format_description& file_format, Archive::ArchiveFormat::file_reader_type * file_reader = ReadArchiveFile);
 
#endif /* FORMATS_H */