chiark
/
gitweb
/
~mdw
/
disorder
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
'collection' no longer requires an encoding to be specified (or a module).
[disorder]
/
lib
/
sink.h
diff --git
a/lib/sink.h
b/lib/sink.h
index f19a0c64e6a1655a55b1e34aed8b01777f29439a..61345010baaa598bdd59505fe61f364f66677b0e 100644
(file)
--- a/
lib/sink.h
+++ b/
lib/sink.h
@@
-17,17
+17,29
@@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
+/** @file lib/sink.h
+ * @brief Abstract output sink type
+ */
#ifndef SINK_H
#define SINK_H
#ifndef SINK_H
#define SINK_H
-/* a sink is something you write to (the opposite would be a source) */
-
struct dynstr;
struct dynstr;
+/** @brief Sink type
+ *
+ * A sink is something you write bytes to; the opposite would be a
+ * source. We provide sink_stdio() and sink_dynstr() to create sinks
+ * to write to stdio streams and dynamic strings.
+ */
struct sink {
struct sink {
+ /** @brief Write callback
+ * @param s Sink to write to
+ * @param buffer First byte to write
+ * @param nbytes Number of bytes to write
+ * @return non-negative on success, -1 on error
+ */
int (*write)(struct sink *s, const void *buffer, int nbytes);
int (*write)(struct sink *s, const void *buffer, int nbytes);
- /* return >= 0 on success, -1 on error */
};
struct sink *sink_stdio(const char *name, FILE *fp);
};
struct sink *sink_stdio(const char *name, FILE *fp);
@@
-43,14
+55,30
@@
int sink_printf(struct sink *s, const char *fmt, ...)
attribute((format (printf, 2, 3)));
/* equivalent of vfprintf/fprintf for sink @s@ */
attribute((format (printf, 2, 3)));
/* equivalent of vfprintf/fprintf for sink @s@ */
+/** @brief Write bytes to a sink
+ * @param s Sink to write to
+ * @param buffer First byte to write
+ * @param nbytes Number of bytes to write
+ * @return non-negative on success, -1 on error
+ */
static inline int sink_write(struct sink *s, const void *buffer, int nbytes) {
return s->write(s, buffer, nbytes);
}
static inline int sink_write(struct sink *s, const void *buffer, int nbytes) {
return s->write(s, buffer, nbytes);
}
+/** @brief Write string to a sink
+ * @param s Sink to write to
+ * @param str String to write
+ * @return non-negative on success, -1 on error
+ */
static inline int sink_writes(struct sink *s, const char *str) {
return s->write(s, str, strlen(str));
}
static inline int sink_writes(struct sink *s, const char *str) {
return s->write(s, str, strlen(str));
}
+/** @brief Write one byte to a sink
+ * @param s Sink to write to
+ * @param c Byte to write (as a @c char)
+ * @return non-negative on success, -1 on error
+ */
static inline int sink_writec(struct sink *s, char c) {
return s->write(s, &c, 1);
}
static inline int sink_writec(struct sink *s, char c) {
return s->write(s, &c, 1);
}
@@
-64,4
+92,3
@@
c-basic-offset:2
comment-column:40
End:
*/
comment-column:40
End:
*/
-/* arch-tag:2f4f2c2a4e65aef8f7c59b4785121083 */