Package com.webcodepro.applecommander.storage.os.cpm

Class CpmFormatDisk

java.lang.Object

com.webcodepro.applecommander.storage.FormattedDisk

com.webcodepro.applecommander.storage.os.cpm.CpmFormatDisk

All Implemented Interfaces:

DirectoryEntry, Container

public class CpmFormatDisk
extends FormattedDisk

Manages a disk that is in the Apple CP/M format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CpmFormatDisk.CpmDiskUsage	Manage CP/M disk usage.

Nested classes/interfaces inherited from class com.webcodepro.applecommander.storage.FormattedDisk

FormattedDisk.DiskInformation, FormattedDisk.DiskUsage, FormattedDisk.FileColumnHeader

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CPM_BLOCKS_PER_TRACK	The number of CP/M blocks per physical track.
static final int	CPM_BLOCKSIZE	The size of a CP/M block.
static final int	CPM_SECTORS_PER_CPM_BLOCK	The number of CP/M sectors per CP/M block.
static final int	CPM_SECTORSIZE	The size of the CP/M sector.
static final int	FIRST_DATA_BLOCK	The underlying block number which CP/M data block #0 resides.
static final int	PHYSICAL_BLOCK_TRACK_START	The track number which CP/M block #0 resides at.
static final int	PHYSICAL_SECTORS_PER_BLOCK	The number of physical sectors per CP/M block.

Fields inherited from class com.webcodepro.applecommander.storage.FormattedDisk

FILE_DISPLAY_DETAIL, FILE_DISPLAY_NATIVE, FILE_DISPLAY_STANDARD

Constructor Summary

Constructors

Constructor	Description
CpmFormatDisk(String filename, BlockDevice device)	Construct a CP/M formatted disk.

Method Summary

Modifier and Type	Method	Description
boolean	canCreateDirectories()	Identify if additional directories can be created.
boolean	canCreateFile()	Indicates if this disk image can create a file.
boolean	canDeleteFile()	Indicates if this disk image can delete a file.
boolean	canHaveDirectories()	Identify if this disk format is capable of having directories.
boolean	canReadFileData()	Indicates if this disk image can read data from a file.
boolean	canWriteFileData()	Indicates if this disk image can write data to a file.
static CpmFormatDisk[]	create(String filename, BlockDevice device)	Create a CpmFormatDisk.
DirectoryEntry	createDirectory(String name)	Create a new DirectoryEntry.
FileEntry	createFile()	Create a new FileEntry.
void	format()	Format the disk.
<T> Optional<T>	get(Class<T> iface)
int[]	getBitmapDimensions()	Get suggested dimensions for display of bitmap.
String[]	getBitmapLabels()	Get the labels to use in the bitmap.
int	getBitmapLength()	Get the length of the bitmap.
int	getBlocksUsed()	Compute the number of CP/M blocks that are currently used.
DiskGeometry	getDiskGeometry()	Gives an indication on how this disk's geometry should be handled.
String	getDiskName()	There apparently is no corresponding CP/M disk name.
FormattedDisk.DiskUsage	getDiskUsage()	Get the disk usage iterator.
List<FormattedDisk.FileColumnHeader>	getFileColumnHeaders(int displayMode)	Get the standard file column header information.
byte[]	getFileData(FileEntry fileEntry)	Get the data associated with the specified FileEntry.
List<FileEntry>	getFiles()	Answer with a list of file entries.
String[]	getFiletypes()	Returns a list of possible file types.
String	getFormat()	Identify the operating system format of this disk.
int	getFreeSpace()	Return the amount of free space in bytes.
int	getLogicalDiskNumber()	Returns the logical disk number.
String	getSuggestedFilename(String filename)	Returns a valid filename for the given filename.
String	getSuggestedFiletype(String filetype)	Returns a valid filetype for the given filename.
int	getUsedSpace()	Return the amount of used space in bytes.
boolean	needsAddress(String filetype)	Indicates if this filetype requires an address component.
byte[]	readCpmFileEntries()
void	setFileData(FileEntry fileEntry, byte[] fileData)	Writes the raw bytes into the file.
boolean	supportsDeletedFiles()	Indicates if this disk format supports "deleted" files.
boolean	supportsDiskMap()	Indicates if this FormattedDisk supports a disk map.
String	toNativeFiletype(String prodosFiletype)	Provides conversation from a given ProDOS file type since as it is common across many archiving tools.
String	toProdosFiletype(String nativeFiletype)	Provides conversation to a given ProDOS file type since as it is common across many archiving tools.
void	writeCpmFileEntries(byte[] data)

Methods inherited from class com.webcodepro.applecommander.storage.FormattedDisk

getBootCode, getDirname, getDiskInformation, getFile, getFile, getFilename, getFormattedDisk, getSource, hasChanged, isNewImage, resizeDiskImage, resizeDiskImage, save, saveAs, setDiskName, setFilename

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CPM_SECTORSIZE

public static final int CPM_SECTORSIZE

The size of the CP/M sector. Assumed to be 128.

See Also:

• Constant Field Values

CPM_BLOCKSIZE

public static final int CPM_BLOCKSIZE

The size of a CP/M block. Assumed to be 1K.

See Also:

• Constant Field Values

CPM_SECTORS_PER_CPM_BLOCK

public static final int CPM_SECTORS_PER_CPM_BLOCK

The number of CP/M sectors per CP/M block.

See Also:

• Constant Field Values

CPM_BLOCKS_PER_TRACK

public static final int CPM_BLOCKS_PER_TRACK

The number of CP/M blocks per physical track.

See Also:

• Constant Field Values

PHYSICAL_SECTORS_PER_BLOCK

public static final int PHYSICAL_SECTORS_PER_BLOCK

The number of physical sectors per CP/M block.

See Also:

• Constant Field Values

PHYSICAL_BLOCK_TRACK_START

public static final int PHYSICAL_BLOCK_TRACK_START

The track number which CP/M block #0 resides at. (The other tracks are boot-related and not available.)

See Also:

• Constant Field Values

FIRST_DATA_BLOCK

public static final int FIRST_DATA_BLOCK

The underlying block number which CP/M data block #0 resides.

See Also:

• Constant Field Values

Constructor Details

CpmFormatDisk

public CpmFormatDisk(String filename,
 BlockDevice device)

Construct a CP/M formatted disk.

Method Details

create

public static CpmFormatDisk[] create(String filename,
 BlockDevice device)

Create a CpmFormatDisk. All CP/M disk images are expected to be 140K in size.

get

public <T> Optional<T> get(Class<T> iface)

getDiskName

public String getDiskName()

There apparently is no corresponding CP/M disk name.

Specified by:

getDiskName in class FormattedDisk

See Also:

• FormattedDisk.getDiskName()

getFormat

public String getFormat()

Identify the operating system format of this disk.

Specified by:

getFormat in class FormattedDisk

See Also:

• FormattedDisk.getFormat()

getFreeSpace

public int getFreeSpace()

Return the amount of free space in bytes.

Specified by:

getFreeSpace in class FormattedDisk

See Also:

• FormattedDisk.getFreeSpace()

getUsedSpace

public int getUsedSpace()

Return the amount of used space in bytes.

Specified by:

getUsedSpace in class FormattedDisk

See Also:

• FormattedDisk.getUsedSpace()

getBlocksUsed

public int getBlocksUsed()

Compute the number of CP/M blocks that are currently used.

getBitmapDimensions

public int[] getBitmapDimensions()

Get suggested dimensions for display of bitmap. Typically, this will be only used for 5.25" floppies. This can return null if there is no suggestion.

Specified by:

getBitmapDimensions in class FormattedDisk

See Also:

• FormattedDisk.getBitmapDimensions()

getBitmapLength

public int getBitmapLength()

Get the length of the bitmap. This is hard-coded to 140.

Specified by:

getBitmapLength in class FormattedDisk

See Also:

• FormattedDisk.getBitmapLength()

getDiskUsage

public FormattedDisk.DiskUsage getDiskUsage()

Get the disk usage iterator.

Specified by:

getDiskUsage in class FormattedDisk

See Also:

• FormattedDisk.getDiskUsage()

getBitmapLabels

public String[] getBitmapLabels()

Get the labels to use in the bitmap.

Specified by:

getBitmapLabels in class FormattedDisk

See Also:

• FormattedDisk.getBitmapLabels()

supportsDeletedFiles

public boolean supportsDeletedFiles()

Indicates if this disk format supports "deleted" files.

Specified by:

supportsDeletedFiles in class FormattedDisk

See Also:

• FormattedDisk.supportsDeletedFiles()

canReadFileData

public boolean canReadFileData()

Indicates if this disk image can read data from a file.

Specified by:

canReadFileData in class FormattedDisk

See Also:

• FormattedDisk.canReadFileData()

canWriteFileData

public boolean canWriteFileData()

Indicates if this disk image can write data to a file.

Specified by:

canWriteFileData in class FormattedDisk

See Also:

• FormattedDisk.canWriteFileData()

canHaveDirectories

public boolean canHaveDirectories()

Identify if this disk format is capable of having directories.

Specified by:

canHaveDirectories in class FormattedDisk

See Also:

• FormattedDisk.canHaveDirectories()

canDeleteFile

public boolean canDeleteFile()

Indicates if this disk image can delete a file.

Specified by:

canDeleteFile in class FormattedDisk

See Also:

• FormattedDisk.canDeleteFile()

getFileData

public byte[] getFileData(FileEntry fileEntry)

Get the data associated with the specified FileEntry. This is just the raw data. Use the FileEntry itself to read data appropriately!

Specified by:

getFileData in class FormattedDisk

See Also:

• FormattedDisk.getFileData(com.webcodepro.applecommander.storage.FileEntry)

format

public void format()

Format the disk. Simply wipes the disk to all 0xE5 - this seems to be the standard (or a requirement).

Note: Assumes that this is a 140K CP/M disk of 35 tracks and 16 physical sectors.

Specified by:

format in class FormattedDisk

See Also:

• FormattedDisk.format()

getLogicalDiskNumber

public int getLogicalDiskNumber()

Returns the logical disk number. This can be used to identify between disks when a format supports multiple logical volumes. If a value of 0 is returned, there is not multiple logical volumes to distinguish.

Specified by:

getLogicalDiskNumber in class FormattedDisk

See Also:

• FormattedDisk.getLogicalDiskNumber()

getSuggestedFilename

public String getSuggestedFilename(String filename)

Returns a valid filename for the given filename. The assumed rules are that the name must be 8 characters long (padded on the end with spaces) and alphanumeric, starting with a character.

Specified by:

getSuggestedFilename in class FormattedDisk

See Also:

• FormattedDisk.getSuggestedFilename(java.lang.String)

getSuggestedFiletype

public String getSuggestedFiletype(String filetype)

Returns a valid filetype for the given filename. Rules are very similar to the filename, but trim to 3 characters.

Specified by:

getSuggestedFiletype in class FormattedDisk

See Also:

• FormattedDisk.getSuggestedFiletype(java.lang.String)

getFiletypes

public String[] getFiletypes()

Returns a list of possible file types. Since the filetype is specific to each operating system, a simple String is used.

Specified by:

getFiletypes in class FormattedDisk

See Also:

• FormattedDisk.getFiletypes()

needsAddress

public boolean needsAddress(String filetype)

Indicates if this filetype requires an address component.

Specified by:

needsAddress in class FormattedDisk

See Also:

• FormattedDisk.needsAddress(java.lang.String)

getFiles

public List<FileEntry> getFiles()

Answer with a list of file entries.

See Also:

• DirectoryEntry.getFiles()

createFile

public FileEntry createFile()
                     throws DiskFullException

Create a new FileEntry.

Throws:

DiskFullException

See Also:

• DirectoryEntry.createFile()

canCreateDirectories

public boolean canCreateDirectories()

Identify if additional directories can be created. CP/M doesn't support directories.

See Also:

• DirectoryEntry.canCreateDirectories()

canCreateFile

public boolean canCreateFile()

Indicates if this disk image can create a file.

See Also:

• DirectoryEntry.canCreateFile()

readCpmFileEntries

public byte[] readCpmFileEntries()

writeCpmFileEntries

public void writeCpmFileEntries(byte[] data)

getFileColumnHeaders

public List<FormattedDisk.FileColumnHeader> getFileColumnHeaders(int displayMode)

Get the standard file column header information. This default implementation is intended only for standard mode.

Overrides:

getFileColumnHeaders in class FormattedDisk

supportsDiskMap

public boolean supportsDiskMap()

Indicates if this FormattedDisk supports a disk map.

Overrides:

supportsDiskMap in class FormattedDisk

setFileData

public void setFileData(FileEntry fileEntry,
 byte[] fileData)

Writes the raw bytes into the file. This bypasses any special formatting of the data (such as prepending the data with a length and/or an address). Typically, the FileEntry.setFileData method should be used.

Specified by:

setFileData in class FormattedDisk

createDirectory

public DirectoryEntry createDirectory(String name)

Create a new DirectoryEntry.

See Also:

• DirectoryEntry.createDirectory(String)

getDiskGeometry

public DiskGeometry getDiskGeometry()

Gives an indication on how this disk's geometry should be handled.

Specified by:

getDiskGeometry in class FormattedDisk

toNativeFiletype

public String toNativeFiletype(String prodosFiletype)

Provides conversation from a given ProDOS file type since as it is common across many archiving tools.

Specified by:

toNativeFiletype in class FormattedDisk

toProdosFiletype

public String toProdosFiletype(String nativeFiletype)

Provides conversation to a given ProDOS file type since as it is common across many archiving tools.

Specified by:

toProdosFiletype in class FormattedDisk