@@ -27,10 +27,12 @@ #endif #import "OFStream.h" OF_ASSUME_NONNULL_BEGIN + +/** @file */ #if defined(OF_WINDOWS) typedef __int64 OFStreamOffset; #elif defined(OF_ANDROID) typedef long long OFStreamOffset; @@ -40,10 +42,22 @@ typedef off64_t OFStreamOffset; #else typedef off_t OFStreamOffset; #endif +/** + * @brief From where to seek. + */ +typedef enum { + /** Seek to the end of the stream + offset. */ + OFSeekSet, + /** Seek to the current location + offset. */ + OFSeekCurrent, + /** Seek to the specified byte. */ + OFSeekEnd +} OFSeekWhence; + /** * @class OFSeekableStream OFSeekableStream.h ObjFW/OFSeekableStream.h * * @brief A stream that supports seeking. * @@ -60,20 +74,15 @@ /** * @brief Seeks to the specified offset. * * @param offset The offset in bytes - * @param whence From where to seek.@n - * Possible values are: - * Value | Description - * -----------|--------------------------------------- - * `SEEK_SET` | Seek to the specified byte - * `SEEK_CUR` | Seek to the current location + offset - * `SEEK_END` | Seek to the end of the stream + offset + * @param whence From where to seek. * @return The new offset form the start of the file */ -- (OFStreamOffset)seekToOffset: (OFStreamOffset)offset whence: (int)whence; +- (OFStreamOffset)seekToOffset: (OFStreamOffset)offset + whence: (OFSeekWhence)whence; /** * @brief Seek the stream on the lowlevel. * * @warning Do not call this directly! @@ -80,19 +89,13 @@ * * @note Override this method with your actual seek implementation when * subclassing! * * @param offset The offset to seek to - * @param whence From where to seek.@n - * Possible values are: - * Value | Description - * -----------|--------------------------------------- - * `SEEK_SET` | Seek to the specified byte - * `SEEK_CUR` | Seek to the current location + offset - * `SEEK_END` | Seek to the end of the stream + offset + * @param whence From where to seek. * @return The new offset from the start of the file */ - (OFStreamOffset)lowlevelSeekToOffset: (OFStreamOffset)offset - whence: (int)whence; + whence: (OFSeekWhence)whence; @end OF_ASSUME_NONNULL_END