| gta.h | | gta.h | |
| | | | |
| skipping to change at line 651 | | skipping to change at line 651 | |
| /** | | /** | |
| * \brief Get the total size of the array data. | | * \brief Get the total size of the array data. | |
| * \param header The header. | | * \param header The header. | |
| * \return The total size (in bytes) of the array data. | | * \return The total size (in bytes) of the array data. | |
| */ | | */ | |
| extern GTA_EXPORT uintmax_t | | extern GTA_EXPORT uintmax_t | |
| gta_get_data_size(const gta_header_t *GTA_RESTRICT header) | | gta_get_data_size(const gta_header_t *GTA_RESTRICT header) | |
| GTA_ATTR_NONNULL_ALL GTA_ATTR_PURE GTA_ATTR_NOTHROW; | | GTA_ATTR_NONNULL_ALL GTA_ATTR_PURE GTA_ATTR_NOTHROW; | |
| | | | |
| /** | | /** | |
|
| * \brief Check wether input data is stored in chunks. | | | |
| * \param header The header. | | | |
| * \return true (1) or false (0). | | | |
| * | | | |
| * Returns true if the array data is stored in chunks, which means that it | | | |
| * cannot be accessed by the out-of-core input functions.\n | | | |
| * Note that compressed data is always stored in chunk, while uncompressed | | | |
| * data is usually not stored in chunks. | | | |
| */ | | | |
| extern GTA_EXPORT int | | | |
| gta_data_is_chunked(const gta_header_t *GTA_RESTRICT header) | | | |
| GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | | | |
| | | | |
| /** | | | |
| * \brief Get the compression. | | * \brief Get the compression. | |
| * \param header The header. | | * \param header The header. | |
| * \return The compression type. | | * \return The compression type. | |
| * | | * | |
| * Gets the compression type for the header and data.\n | | * Gets the compression type for the header and data.\n | |
|
| * See \a gta_compression_t for more information on compression types. | | * See \a gta_compression_t for more information on compression types.\n | |
| | | * Compressed data is always stored in chunks, while uncompressed | |
| | | * data is never stored in chunks. | |
| */ | | */ | |
| extern GTA_EXPORT gta_compression_t | | extern GTA_EXPORT gta_compression_t | |
|
| gta_get_compression(gta_header_t *GTA_RESTRICT header) | | gta_get_compression(const gta_header_t *GTA_RESTRICT header) | |
| GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | | GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | |
| | | | |
| /** | | /** | |
| * \brief Set the compression. | | * \brief Set the compression. | |
| * \param header The header. | | * \param header The header. | |
| * \param compression The compression type. | | * \param compression The compression type. | |
| * | | * | |
| * Sets the compression type for writing the header and data.\n | | * Sets the compression type for writing the header and data.\n | |
| * See \a gta_compression_t for more information on compression types. | | * See \a gta_compression_t for more information on compression types. | |
| */ | | */ | |
| | | | |
| skipping to change at line 1271 | | skipping to change at line 1259 | |
| gta_write_elements_to_fd(const gta_header_t *GTA_RESTRICT header, gta_io_st
ate_t *GTA_RESTRICT io_state, | | gta_write_elements_to_fd(const gta_header_t *GTA_RESTRICT header, gta_io_st
ate_t *GTA_RESTRICT io_state, | |
| uintmax_t n, const void *GTA_RESTRICT buf, int fd) | | uintmax_t n, const void *GTA_RESTRICT buf, int fd) | |
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL; | |
| | | | |
| /*@}*/ | | /*@}*/ | |
| | | | |
| /** | | /** | |
| * | | * | |
| * \name Read and Write Array Blocks | | * \name Read and Write Array Blocks | |
| * | | * | |
|
| * These functions can only be used if the data is not chunked (see \a gta_
data_is_chunked()) | | * These functions can only be used if the data is not compression (see \a
gta_get_compression()) | |
| * and the input/output is seekable.\n | | * and the input/output is seekable.\n | |
| * They are suitable for applications that do not want to store the complet
e array data in | | * They are suitable for applications that do not want to store the complet
e array data in | |
| * memory.\n | | * memory.\n | |
| * A block is given by the lowest and highest element coordinates in each d
imension. | | * A block is given by the lowest and highest element coordinates in each d
imension. | |
| * For example, for a 2D array from which we want a rectangle of 20x10 elem
ents starting at | | * For example, for a 2D array from which we want a rectangle of 20x10 elem
ents starting at | |
| * element (5,3), we would store the values (5,3) in \a lower_coordinates a
nd (24, 12) in | | * element (5,3), we would store the values (5,3) in \a lower_coordinates a
nd (24, 12) in | |
| * \a higher_coordinates. | | * \a higher_coordinates. | |
| */ | | */ | |
| | | | |
| /*@{*/ | | /*@{*/ | |
| | | | |
| skipping to change at line 1293 | | skipping to change at line 1281 | |
| /** | | /** | |
| * \brief Read an array block. | | * \brief Read an array block. | |
| * \param header The header. | | * \param header The header. | |
| * \param data_offset Offset of the first data byte. | | * \param data_offset Offset of the first data byte. | |
| * \param lower_coordinates Coordinates of the lower corner element of
the block. | | * \param lower_coordinates Coordinates of the lower corner element of
the block. | |
| * \param higher_coordinates Coordinates of the higher corner element of
the block. | | * \param higher_coordinates Coordinates of the higher corner element of
the block. | |
| * \param block The block buffer. | | * \param block The block buffer. | |
| * \param read_fn The custom input function. | | * \param read_fn The custom input function. | |
| * \param seek_fn The custom seek function. | | * \param seek_fn The custom seek function. | |
| * \param userdata A parameter to the custom input function. | | * \param userdata A parameter to the custom input function. | |
|
| * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is chunked), \a GTA_OVERFLOW, \a GTA_UNEXPECTED_EOF, or \a GTA_SYSTEM_
ERROR. | | * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is compressed), \a GTA_OVERFLOW, \a GTA_UNEXPECTED_EOF, or \a GTA_SYST
EM_ERROR. | |
| * | | * | |
| * Reads the given array block and copies it to the given block buffer, whi
ch must be large enough.\n | | * Reads the given array block and copies it to the given block buffer, whi
ch must be large enough.\n | |
| * This function modifies the file position indicator of the input. | | * This function modifies the file position indicator of the input. | |
| */ | | */ | |
| extern GTA_EXPORT gta_result_t | | extern GTA_EXPORT gta_result_t | |
| gta_read_block(const gta_header_t *GTA_RESTRICT header, intmax_t data_offse
t, | | gta_read_block(const gta_header_t *GTA_RESTRICT header, intmax_t data_offse
t, | |
| const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | | const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | |
| void *GTA_RESTRICT block, gta_read_t read_fn, gta_seek_t seek_fn, i
ntptr_t userdata) | | void *GTA_RESTRICT block, gta_read_t read_fn, gta_seek_t seek_fn, i
ntptr_t userdata) | |
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL; | |
| | | | |
| /** | | /** | |
| * \brief Read an array block from a stream. | | * \brief Read an array block from a stream. | |
| * \param header The header. | | * \param header The header. | |
| * \param data_offset Offset of the first data byte. | | * \param data_offset Offset of the first data byte. | |
| * \param lower_coordinates Coordinates of the lower corner element of
the block. | | * \param lower_coordinates Coordinates of the lower corner element of
the block. | |
| * \param higher_coordinates Coordinates of the higher corner element of
the block. | | * \param higher_coordinates Coordinates of the higher corner element of
the block. | |
| * \param block The block buffer. | | * \param block The block buffer. | |
| * \param f The stream. | | * \param f The stream. | |
|
| * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is chunked), \a GTA_OVERFLOW, \a GTA_UNEXPECTED_EOF, or \a GTA_SYSTEM_
ERROR. | | * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is compressed), \a GTA_OVERFLOW, \a GTA_UNEXPECTED_EOF, or \a GTA_SYST
EM_ERROR. | |
| * | | * | |
| * Reads the given array block and copies it to the given block buffer, whi
ch must be large enough.\n | | * Reads the given array block and copies it to the given block buffer, whi
ch must be large enough.\n | |
| * This function modifies the file position indicator of the input. | | * This function modifies the file position indicator of the input. | |
| */ | | */ | |
| extern GTA_EXPORT gta_result_t | | extern GTA_EXPORT gta_result_t | |
| gta_read_block_from_stream(const gta_header_t *GTA_RESTRICT header, intmax_
t data_offset, | | gta_read_block_from_stream(const gta_header_t *GTA_RESTRICT header, intmax_
t data_offset, | |
| const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | | const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | |
| void *GTA_RESTRICT block, FILE *GTA_RESTRICT f) | | void *GTA_RESTRICT block, FILE *GTA_RESTRICT f) | |
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | |
| | | | |
| /** | | /** | |
| * \brief Read an array block from a file descriptor. | | * \brief Read an array block from a file descriptor. | |
| * \param header The header. | | * \param header The header. | |
| * \param data_offset Offset of the first data byte. | | * \param data_offset Offset of the first data byte. | |
| * \param lower_coordinates Coordinates of the lower corner element of
the block. | | * \param lower_coordinates Coordinates of the lower corner element of
the block. | |
| * \param higher_coordinates Coordinates of the higher corner element of
the block. | | * \param higher_coordinates Coordinates of the higher corner element of
the block. | |
| * \param block The block buffer. | | * \param block The block buffer. | |
| * \param fd The file descriptor. | | * \param fd The file descriptor. | |
|
| * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is chunked), \a GTA_OVERFLOW, \a GTA_UNEXPECTED_EOF, or \a GTA_SYSTEM_
ERROR. | | * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is compressed), \a GTA_OVERFLOW, \a GTA_UNEXPECTED_EOF, or \a GTA_SYST
EM_ERROR. | |
| * | | * | |
| * Reads the given array block and copies it to the given block buffer, whi
ch must be large enough.\n | | * Reads the given array block and copies it to the given block buffer, whi
ch must be large enough.\n | |
| * This function modifies the file position indicator of the input. | | * This function modifies the file position indicator of the input. | |
| */ | | */ | |
| extern GTA_EXPORT gta_result_t | | extern GTA_EXPORT gta_result_t | |
| gta_read_block_from_fd(const gta_header_t *GTA_RESTRICT header, intmax_t da
ta_offset, | | gta_read_block_from_fd(const gta_header_t *GTA_RESTRICT header, intmax_t da
ta_offset, | |
| const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | | const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | |
| void *GTA_RESTRICT block, int fd) | | void *GTA_RESTRICT block, int fd) | |
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | |
| | | | |
| /** | | /** | |
| * \brief Write an array block. | | * \brief Write an array block. | |
| * \param header The header. | | * \param header The header. | |
| * \param data_offset Offset of the first data byte. | | * \param data_offset Offset of the first data byte. | |
| * \param lower_coordinates Coordinates of the lower corner element of
the block. | | * \param lower_coordinates Coordinates of the lower corner element of
the block. | |
| * \param higher_coordinates Coordinates of the higher corner element of
the block. | | * \param higher_coordinates Coordinates of the higher corner element of
the block. | |
| * \param block The block buffer. | | * \param block The block buffer. | |
| * \param write_fn The custom output function. | | * \param write_fn The custom output function. | |
| * \param seek_fn The custom seek function. | | * \param seek_fn The custom seek function. | |
| * \param userdata A parameter to the custom output function. | | * \param userdata A parameter to the custom output function. | |
|
| * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is chunked), \a GTA_OVERFLOW, or \a GTA_SYSTEM_ERROR. | | * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is compressed), \a GTA_OVERFLOW, or \a GTA_SYSTEM_ERROR. | |
| * | | * | |
| * This function modifies the file position indicator of the output. | | * This function modifies the file position indicator of the output. | |
| */ | | */ | |
| extern GTA_EXPORT gta_result_t | | extern GTA_EXPORT gta_result_t | |
| gta_write_block(const gta_header_t *GTA_RESTRICT header, intmax_t data_offs
et, | | gta_write_block(const gta_header_t *GTA_RESTRICT header, intmax_t data_offs
et, | |
| const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | | const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | |
| const void *GTA_RESTRICT block, gta_write_t write_fn, gta_seek_t se
ek_fn, intptr_t userdata) | | const void *GTA_RESTRICT block, gta_write_t write_fn, gta_seek_t se
ek_fn, intptr_t userdata) | |
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL; | |
| | | | |
| /** | | /** | |
| * \brief Write an array block to a stream. | | * \brief Write an array block to a stream. | |
| * \param header The header. | | * \param header The header. | |
| * \param data_offset Offset of the first data byte. | | * \param data_offset Offset of the first data byte. | |
| * \param lower_coordinates Coordinates of the lower corner element of
the block. | | * \param lower_coordinates Coordinates of the lower corner element of
the block. | |
| * \param higher_coordinates Coordinates of the higher corner element of
the block. | | * \param higher_coordinates Coordinates of the higher corner element of
the block. | |
| * \param block The block buffer. | | * \param block The block buffer. | |
| * \param f The stream. | | * \param f The stream. | |
|
| * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is chunked), \a GTA_OVERFLOW, or \a GTA_SYSTEM_ERROR. | | * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is compressed), \a GTA_OVERFLOW, or \a GTA_SYSTEM_ERROR. | |
| * | | * | |
| * This function modifies the file position indicator of the output. | | * This function modifies the file position indicator of the output. | |
| */ | | */ | |
| extern GTA_EXPORT gta_result_t | | extern GTA_EXPORT gta_result_t | |
| gta_write_block_to_stream(const gta_header_t *GTA_RESTRICT header, intmax_t
data_offset, | | gta_write_block_to_stream(const gta_header_t *GTA_RESTRICT header, intmax_t
data_offset, | |
| const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | | const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | |
| const void *GTA_RESTRICT block, FILE *GTA_RESTRICT f) | | const void *GTA_RESTRICT block, FILE *GTA_RESTRICT f) | |
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | |
| | | | |
| /** | | /** | |
| * \brief Write an array block to a file descriptor. | | * \brief Write an array block to a file descriptor. | |
| * \param header The header. | | * \param header The header. | |
| * \param data_offset Offset of the first data byte. | | * \param data_offset Offset of the first data byte. | |
| * \param lower_coordinates Coordinates of the lower corner element of
the block. | | * \param lower_coordinates Coordinates of the lower corner element of
the block. | |
| * \param higher_coordinates Coordinates of the higher corner element of
the block. | | * \param higher_coordinates Coordinates of the higher corner element of
the block. | |
| * \param block The block buffer. | | * \param block The block buffer. | |
| * \param fd The file descriptor. | | * \param fd The file descriptor. | |
|
| * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is chunked), \a GTA_OVERFLOW, \a GTA_SYSTEM_ERROR. | | * \return \a GTA_OK, \a GTA_UNSUPPORTED_DATA (if the
data is compressed), \a GTA_OVERFLOW, \a GTA_SYSTEM_ERROR. | |
| * | | * | |
| * This function modifies the file position indicator of the output. | | * This function modifies the file position indicator of the output. | |
| */ | | */ | |
| extern GTA_EXPORT gta_result_t | | extern GTA_EXPORT gta_result_t | |
| gta_write_block_to_fd(const gta_header_t *GTA_RESTRICT header, intmax_t dat
a_offset, | | gta_write_block_to_fd(const gta_header_t *GTA_RESTRICT header, intmax_t dat
a_offset, | |
| const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | | const uintmax_t *GTA_RESTRICT lower_coordinates, const uintmax_t *G
TA_RESTRICT higher_coordinates, | |
| const void *GTA_RESTRICT block, int fd) | | const void *GTA_RESTRICT block, int fd) | |
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | |
| | | | |
| /*@}*/ | | /*@}*/ | |
| | | | |
End of changes. 10 change blocks. |
| 23 lines changed or deleted | | 11 lines changed or added | |
|