* 2. blob->overrun should be false, (otherwise, too much was read).
*/
struct blob_reader {
- uint8_t *data;
- uint8_t *end;
- uint8_t *current;
+ const uint8_t *data;
+ const uint8_t *end;
+ const uint8_t *current;
bool overrun;
};
* \return An offset to space allocated within \blob to which \to_write bytes
* can be written, (or -1 in case of any allocation error).
*/
-ssize_t
+intptr_t
blob_reserve_bytes(struct blob *blob, size_t to_write);
+/**
+ * Similar to \sa blob_reserve_bytes, but only reserves an uint32_t worth of
+ * space. Note that this must be used if later reading with \sa
+ * blob_read_uint32, since it aligns the offset correctly.
+ */
+intptr_t
+blob_reserve_uint32(struct blob *blob);
+
+/**
+ * Similar to \sa blob_reserve_bytes, but only reserves an intptr_t worth of
+ * space. Note that this must be used if later reading with \sa
+ * blob_read_intptr, since it aligns the offset correctly.
+ */
+intptr_t
+blob_reserve_intptr(struct blob *blob);
+
/**
* Overwrite some data previously written to the blob.
*
*
* size_t offset;
*
- * offset = blob->size;
- * blob_write_uint32 (blob, 0); // placeholder
+ * offset = blob_reserve_uint32(blob);
* ... various blob write calls, writing N items ...
* blob_overwrite_uint32 (blob, offset, N);
*
bool
blob_write_intptr(struct blob *blob, intptr_t value);
+/**
+ * Overwrite an intptr_t previously written to the blob.
+ *
+ * Writes a intptr_t value to an existing portion of the blob at an offset of
+ * \offset. This data range must have previously been written to the blob by
+ * one of the blob_write_* calls.
+ *
+ * For example usage, see blob_overwrite_uint32
+ *
+ * \return True unless the requested position or position+to_write lie outside
+ * the current blob's size.
+ */
+bool
+blob_overwrite_intptr(struct blob *blob,
+ size_t offset,
+ intptr_t value);
+
/**
* Add a NULL-terminated string to a blob, (including the NULL terminator).
*
* current value is unchanged before and after the call.
*/
void
-blob_reader_init(struct blob_reader *blob, uint8_t *data, size_t size);
+blob_reader_init(struct blob_reader *blob, const void *data, size_t size);
/**
* Read some unstructured, fixed-size data from the current location, (and
*
* \return The bytes read (see note above about memory lifetime).
*/
-void *
+const void *
blob_read_bytes(struct blob_reader *blob, size_t size);
/**
* it to \dest (and update the current location to just past this data)
*/
void
-blob_copy_bytes(struct blob_reader *blob, uint8_t *dest, size_t size);
+blob_copy_bytes(struct blob_reader *blob, void *dest, size_t size);
/**
* Read a uint32_t from the current location, (and update the current location