AppleII::ProDOS 0.08

AppleII::ProDOS is a Perl module created to access files on Apple II ProDOS disk images.

SYNOPSIS

use AppleII::ProDOS;
my $vol = AppleII::ProDOS->open(image.dsk); # Open an existing disk
print $vol->catalog; # List files in volume directory
my $file = $vol->get_file(Startup); # Read file from disk
$vol->path(Subdir); # Move into a subdirectory
$vol->put_file($file); # And write it back there

AppleII::ProDOS provides high-level access to ProDOS volumes stored in the disk image files used by most Apple II emulators. (For information about Apple II emulators, try the Apple II Emulator Page at http://www.ecnet.net/users/mumbv/pages/apple2.shtml.) It uses the AppleII::Disk module to handle low-level access to image files.
All the following classes have two constructors. Constructors named open are for creating an object to represent existing data in the image file. Constructors named new are for creating a new object to be added to an image file.

AppleII::ProDOS

AppleII::ProDOS is the primary interface to ProDOS volumes. It provides the following methods:

$vol = AppleII::ProDOS->new($volume, $size, $filename, [$mode])

Constructs a new image file and an AppleII::ProDOS object to access it. $volume is the volume name. $size is the size in blocks. $filename is the name of the image file. The optional $mode is a string specifying how to open the image (see the open method for details). You always receive read and write access.

$vol = AppleII::ProDOS->open($filename, [$mode])

Constructs an AppleII::ProDOS object to access an existing image file. $filename is the name of the image file. The optional $mode is a string specifying how to open the image. It can consist of the following characters (case sensitive):

r Allow reads (this is actually ignored; you can always read)
w Allow writes
d Disk image is in DOS 3.3 order
p Disk image is in ProDOS order

$vol = AppleII::ProDOS->open($disk)

Constructs an AppleII::ProDOS object to access an existing image file. $disk is the AppleII::Disk object representing the image file.

$bitmap = $vol->bitmap

Returns the volume bitmap as an AppleII::ProDOS::Bitmap object.

$dir = $vol->dir

Returns the current directory as an AppleII::ProDOS::Directory object.

$disk = $vol->disk

Returns the AppleII::ProDOS::Disk object which represents the image file.

$disk = $vol->disk_size

Returns the size of the volume in blocks. This is the logical size of the ProDOS volume, which is not necessarily the same as the actual size of the image file.

$name = $vol->name

Returns the volume name.

$path = $vol->path([$newpath])

Gets or sets the current path. $newpath is the new pathname, which may be either relative or absolute. `.. may be used to specify the parent directory, but this must occur at the beginning of the path (`../../dir is valid, but `../dir/.. is not). If $newpath is omitted, then the current path is not changed. Returns the current path as a string beginning and ending with /.

$catalog = $vol->catalog

$file = $vol->get_file($filename)

$entry = $vol->new_dir($name)

$vol->put_file($file)

These methods are passed to the current directory. See AppleII::ProDOS::Directory for details.