| gta.h | | gta.h | |
|---|
| /* | | /* | |
| * gta.h | | * gta.h | |
| * | | * | |
| * This file is part of libgta, a library that implements the Generic Tagge
d | | * This file is part of libgta, a library that implements the Generic Tagge
d | |
| * Array (GTA) file format. | | * Array (GTA) file format. | |
| * | | * | |
|
| * Copyright (C) 2010, 2011, 2012 | | * Copyright (C) 2010, 2011, 2012, 2014 | |
| * Martin Lambers <marlam@marlam.de> | | * Martin Lambers <marlam@marlam.de> | |
| * | | * | |
| * Libgta is free software: you can redistribute it and/or modify it under
the | | * Libgta is free software: you can redistribute it and/or modify it under
the | |
| * terms of the GNU Lesser General Public License as published by the Free | | * terms of the GNU Lesser General Public License as published by the Free | |
| * Software Foundation, either version 2.1 of the License, or (at your opti
on) | | * Software Foundation, either version 2.1 of the License, or (at your opti
on) | |
| * any later version. | | * any later version. | |
| * | | * | |
| * Libgta is distributed in the hope that it will be useful, but WITHOUT AN
Y | | * Libgta is distributed in the hope that it will be useful, but WITHOUT AN
Y | |
| * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNES
S FOR | | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNES
S FOR | |
| * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more | | * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more | |
| | | | |
| skipping to change at line 701 | | skipping to change at line 701 | |
|---|
| * | | * | |
| * Set the components of the array elements.\n | | * Set the components of the array elements.\n | |
| * The \a sizes parameter can be NULL if no components have the type \a GTA
_BLOB. | | * The \a sizes parameter can be NULL if no components have the type \a GTA
_BLOB. | |
| * Otherwise, it must point to a list that contains the sizes of these comp
onents (and only | | * Otherwise, it must point to a list that contains the sizes of these comp
onents (and only | |
| * these components). For example, if there are five components, but only t
wo have the type | | * these components). For example, if there are five components, but only t
wo have the type | |
| * \a GTA_BLOB, then the \a sizes list must contain two size values.\n | | * \a GTA_BLOB, then the \a sizes list must contain two size values.\n | |
| * All components will initially have an empty tag list.\n | | * All components will initially have an empty tag list.\n | |
| */ | | */ | |
| extern GTA_EXPORT gta_result_t | | extern GTA_EXPORT gta_result_t | |
| gta_set_components(gta_header_t *GTA_RESTRICT header, uintmax_t n, const gt
a_type_t *GTA_RESTRICT types, const uintmax_t *GTA_RESTRICT sizes) | | gta_set_components(gta_header_t *GTA_RESTRICT header, uintmax_t n, const gt
a_type_t *GTA_RESTRICT types, const uintmax_t *GTA_RESTRICT sizes) | |
|
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL2(1, 3) GTA_ATTR_NOTHROW; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL1(1) GTA_ATTR_NOTHROW; | |
| | | | |
| /** | | /** | |
| * \brief Set the dimensions. | | * \brief Set the dimensions. | |
| * \param header The header. | | * \param header The header. | |
| * \param n The number of dimensions. | | * \param n The number of dimensions. | |
| * \param sizes The array sizes in each of the \n dimensions. | | * \param sizes The array sizes in each of the \n dimensions. | |
| * \return \a GTA_OK, \a GTA_OVERFLOW, \a GTA_INVALID_DATA, or
\a GTA_SYSTEM_ERROR. | | * \return \a GTA_OK, \a GTA_OVERFLOW, \a GTA_INVALID_DATA, or
\a GTA_SYSTEM_ERROR. | |
| * | | * | |
| * Sets the array dimensions.\n | | * Sets the array dimensions.\n | |
| * All dimensions will initially have an empty tag list. | | * All dimensions will initially have an empty tag list. | |
| */ | | */ | |
| extern GTA_EXPORT gta_result_t | | extern GTA_EXPORT gta_result_t | |
| gta_set_dimensions(gta_header_t *GTA_RESTRICT header, uintmax_t n, const ui
ntmax_t *GTA_RESTRICT sizes) | | gta_set_dimensions(gta_header_t *GTA_RESTRICT header, uintmax_t n, const ui
ntmax_t *GTA_RESTRICT sizes) | |
|
| GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL_ALL GTA_ATTR_NOTHROW; | | GTA_ATTR_WARN_UNUSED_RESULT GTA_ATTR_NONNULL1(1) GTA_ATTR_NOTHROW; | |
| | | | |
| /*@}*/ | | /*@}*/ | |
| | | | |
| /** | | /** | |
| * | | * | |
| * \name Access Tag Lists | | * \name Access Tag Lists | |
| * | | * | |
| */ | | */ | |
| | | | |
| /*@{*/ | | /*@{*/ | |
| | | | |
| skipping to change at line 1087 | | skipping to change at line 1087 | |
|---|
| | | | |
| /** | | /** | |
| * \brief Get the address of a component of an array element
(non-modifiable). | | * \brief Get the address of a component of an array element
(non-modifiable). | |
| * \param header The header. | | * \param header The header. | |
| * \param element The element. | | * \param element The element. | |
| * \param i The component index. | | * \param i The component index. | |
| * \return A pointer to the component. | | * \return A pointer to the component. | |
| */ | | */ | |
| extern GTA_EXPORT const void * | | extern GTA_EXPORT const void * | |
| gta_get_component_const(const gta_header_t *GTA_RESTRICT header, const void
*GTA_RESTRICT element, uintmax_t i) | | gta_get_component_const(const gta_header_t *GTA_RESTRICT header, const void
*GTA_RESTRICT element, uintmax_t i) | |
|
| GTA_ATTR_NONNULL_ALL GTA_ATTR_PURE GTA_ATTR_NOTHROW; | | GTA_ATTR_NONNULL1(1) GTA_ATTR_PURE GTA_ATTR_NOTHROW; | |
| | | | |
| /** | | /** | |
| * \brief Get the address of a component of an array element
(modifiable). | | * \brief Get the address of a component of an array element
(modifiable). | |
| * \param header The header. | | * \param header The header. | |
| * \param element The element. | | * \param element The element. | |
| * \param i The component index. | | * \param i The component index. | |
| * \return A pointer to the component. | | * \return A pointer to the component. | |
| */ | | */ | |
| extern GTA_EXPORT void * | | extern GTA_EXPORT void * | |
| gta_get_component(const gta_header_t *GTA_RESTRICT header, void *GTA_RESTRI
CT element, uintmax_t i) | | gta_get_component(const gta_header_t *GTA_RESTRICT header, void *GTA_RESTRI
CT element, uintmax_t i) | |
|
| GTA_ATTR_NONNULL_ALL GTA_ATTR_PURE GTA_ATTR_NOTHROW; | | GTA_ATTR_NONNULL1(1) GTA_ATTR_PURE GTA_ATTR_NOTHROW; | |
| | | | |
| /*@}*/ | | /*@}*/ | |
| | | | |
| /** | | /** | |
| * | | * | |
| * \name Read and Write Array Elements | | * \name Read and Write Array Elements | |
| * | | * | |
| * These functions are intended to be used for filtering a complete array o
n a per-element basis. | | * These functions are intended to be used for filtering a complete array o
n a per-element basis. | |
| * They read or write a given number of elements, and it is expected that t
hey are used | | * They read or write a given number of elements, and it is expected that t
hey are used | |
| * repeatedly until all elements of an array have been read or written. | | * repeatedly until all elements of an array have been read or written. | |
| | | | |
| End of changes. 5 change blocks. |
|---|
| 5 lines changed or deleted | | 5 lines changed or added | |
|---|
|