resonance 1.0.1
Loading...
Searching...
No Matches
Tools::BuildImage::DirectoryVolume Class Referencefinal

An ISO9660 volume built from the files of a disc root directory. More...

#include <directoryvolume.h>

Inheritance diagram for Tools::BuildImage::DirectoryVolume:
Collaboration diagram for Tools::BuildImage::DirectoryVolume:

Public Member Functions

std::expected< LocatedFile, Error > find (const std::string &name) override
 Locate a file by name anywhere in the tree.
std::expected< void, Error > readSector (std::uint32_t lba, std::span< std::uint8_t, kSectorData > sector) override
 Read the data bytes of one sector.
std::uint32_t volumeSectors () const override
 Report the sector count of the volume.
Public Member Functions inherited from Tools::BuildImage::Volume
virtual ~Volume ()=default
 Release the medium.
virtual std::expected< std::size_t, Error > readSectors (std::uint32_t lba, std::span< std::uint8_t > sectors)
 Read the data bytes of consecutive sectors, stopping where the medium ends.
std::expected< std::string, Error > bootExecutable ()
 Read the name of the executable the disc boots.

Static Public Member Functions

static std::expected< std::unique_ptr< DirectoryVolume >, Error > create (const std::filesystem::path &root, std::optional< std::vector< std::uint8_t > > systemArea)
 Build the volume layout.
static std::expected< std::string, Error > identify (const std::filesystem::path &root)
 Read the name of the executable a disc root boots, without building the volume.
Static Public Member Functions inherited from Tools::BuildImage::Volume
static std::expected< std::string, Error > parseBoot2 (std::span< const std::uint8_t > data)
 Read the executable name from the text of SYSTEM.CNF.
static std::uint32_t sectorsFor (std::uint64_t size)
 Count the sectors that a length in bytes occupies.
static std::string upperAscii (std::string_view text)
 Convert the ASCII letters of a text to upper case.
static std::string lowerAscii (std::string_view text)
 Convert the ASCII letters of a text to lower case.
static std::unexpected< Error > pastEnd (std::uint32_t lba)
 Report that a sector lies past the end of the medium.

Additional Inherited Members

Public Types inherited from Tools::BuildImage::Volume
using Sector = std::array<std::uint8_t, kSectorData>
 The data bytes of one sector.
Static Public Attributes inherited from Tools::BuildImage::Volume
static constexpr std::size_t kSectorData = 2048
 Data bytes in one sector.
static constexpr std::uint32_t kPvdSector = 16
 Sector of the primary volume descriptor.
static constexpr std::string_view kPvdMagic = "CD001"
 Identifier of an ISO9660 volume descriptor.
static constexpr std::string_view kSystemCnf = "SYSTEM.CNF"
 Name of the boot configuration file.
static constexpr std::string_view kPalExecutable = "SCES_507.91"
 Executable of the European release.
static constexpr std::string_view kNtscExecutable = "SCUS_971.25"
 Executable of the North American release.

Detailed Description

An ISO9660 volume built from the files of a disc root directory.

The primary volume descriptor, the terminator, and the path tables take the sectors the original disc gives them. The directories follow in path table order, and then the files in the same order. Metadata sectors are built in memory, and file sectors are read from the source files on demand. Each record has the modification time of its file, and a directory has the newest time of itself and every entry beneath it.

Member Function Documentation

◆ create()

std::expected< std::unique_ptr< DirectoryVolume >, Error > Tools::BuildImage::DirectoryVolume::create ( const std::filesystem::path & root,
std::optional< std::vector< std::uint8_t > > systemArea )
static

Build the volume layout.

Parameters
rootDisc root directory with SYSTEM.CNF.
systemAreaThe 12 sectors of boot logo data. The sectors are zero when omitted.
Returns
The volume, or an error when the directory is not a disc root, a name is not valid, a file cannot be examined, or the system area has the wrong size.

◆ identify()

std::expected< std::string, Error > Tools::BuildImage::DirectoryVolume::identify ( const std::filesystem::path & root)
static

Read the name of the executable a disc root boots, without building the volume.

Parameters
rootDisc root directory with SYSTEM.CNF.
Returns
File name from the BOOT2 line of SYSTEM.CNF, without the version suffix, or an error when the directory lacks SYSTEM.CNF or SYSTEM.CNF does not boot a known release.

◆ find()

std::expected< LocatedFile, Error > Tools::BuildImage::DirectoryVolume::find ( const std::string & name)
overridevirtual

Locate a file by name anywhere in the tree.

Parameters
nameFile name without the version suffix.
Returns
Extent and containing directory of the match, or an error when the file is missing or spans several extents.

Implements Tools::BuildImage::Volume.

◆ readSector()

std::expected< void, Error > Tools::BuildImage::DirectoryVolume::readSector ( std::uint32_t lba,
std::span< std::uint8_t, kSectorData > sector )
overridevirtual

Read the data bytes of one sector.

Parameters
lbaSector number relative to the track start.
sectorDestination of the 2048 data bytes.
Returns
Nothing, or an error when the medium ends before the sector.

Implements Tools::BuildImage::Volume.

◆ volumeSectors()

std::uint32_t Tools::BuildImage::DirectoryVolume::volumeSectors ( ) const
nodiscardoverridevirtual

Report the sector count of the volume.

Returns
Sectors described by the primary volume descriptor.

Implements Tools::BuildImage::Volume.


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