common: Add the buffer module.
[gps-watch.git] / src / common / buffer.h
1 /*
2  * Copyright (c) 2019 Tilman Sauerbeck (tilman at code-monkey de)
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files (the
6  * "Software"), to deal in the Software without restriction, including
7  * without limitation the rights to use, copy, modify, merge, publish,
8  * distribute, sublicense, and/or sell copies of the Software, and to
9  * permit persons to whom the Software is furnished to do so, subject to
10  * the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23
24 #ifndef BUFFER_H
25 #define BUFFER_H
26
27 #include <stdlib.h> /* size_t */
28 #include <sys/types.h> /* ssize_t */
29
30 typedef ssize_t (*buffer_func_t)(void *user_data, void *buf, size_t bufsiz, size_t count);
31
32 struct buffer {
33         char *buf;
34         buffer_func_t callback;
35         void *user_data;
36         size_t allocated;
37         size_t length;
38 };
39
40 void buffer_init (struct buffer *sb, void *buf, size_t bufsiz, buffer_func_t callback, void *user_data);
41
42 int buffer_flush (struct buffer *sb);
43 ssize_t buffer_write (struct buffer *sb, const void *src, size_t srcsiz);
44 int buffer_write_all (struct buffer *sb, const void *src, size_t srcsiz);
45
46 #endif