Apple-2-Tools/apple2ix
1
0
Fork 0
mirror of https://github.com/mauiaaron/apple2.git synced 2025-01-13 12:31:25 +00:00
Code Issues Projects Releases Wiki Activity

Clarify disk/zlib internal API comments after recent upheaval

Browse Source
This commit is contained in:
Aaron Culliney 2017-05-29 07:52:18 -10:00
parent b300e60e2a
commit 0468cea2d4
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/disk.h
View File

@ -79,8 +79,8 @@ extern drive_t disk6;
// initialize emulated 5.25 Disk ][ module
extern void disk6_init(void);
// insert 5.25 disk image file from file descriptor (internally dup()'d so caller should close() after invocation).
// file_name need NOT be a path, and is important only to determine the image type via file extension
// insert 5.25 disk image file from file descriptor (internally dup()'d so caller may close() the passed fd after
// invocation). file_name need NOT be a path, and is important only to determine the image type via file extension
extern const char *disk6_insert(int fd, int drive, const char * const file_name, int readonly);
// eject 5.25 disk image file

8
src/zlib-helpers.h
View File

@ -21,13 +21,15 @@
#define ZERR_DEFLATE_OPEN_SOURCE "Error opening source file for deflation"
#define ZERR_DEFLATE_READ_SOURCE "Error reading source file for deflation"
// inflate/uncompress from file descriptor into previously allocated buffer of expected_bytes length
// Inflate/uncompress from file descriptor into previously allocated buffer of expected_bytes length. Underlying file
// can either be gzipped or not. This is meant for readonly disk images.
const char *zlib_inflate_to_buffer(int fd, const int expected_bytescount, char *buf);
// inflate/uncompress from file descriptor back into itself
// Inflate/uncompress from file descriptor back into itself. Underlying file can either be gzipped or not. This is
// meant for read/write disk images.
const char *zlib_inflate_inplace(int fd, const int expected_bytescount, bool *is_gzipped);
// inline deflate/compress from buffer to buffer
// Deflate/compress from buffer to buffer. This is meant for ejecting read/write disk images.
const char *zlib_deflate_buffer(const char *src, const int src_bytescount, char *dst, OUTPARM off_t *dst_size);
#endif