/* -*-c-*-
*
- * $Id: lbuf.h,v 1.2 1999/05/17 20:36:08 mdw Exp $
+ * $Id: lbuf.h,v 1.7 2002/01/13 13:32:52 mdw Exp $
*
* Block-to-line buffering
*
/*----- Revision history --------------------------------------------------*
*
* $Log: lbuf.h,v $
+ * Revision 1.7 2002/01/13 13:32:52 mdw
+ * Pass line length to line handler function. Provide a @typedef@ for
+ * handler functions. Allow run-time configuration of line delimiters.
+ *
+ * Revision 1.6 2001/02/03 16:23:33 mdw
+ * Bug fix: handle a disable during a close-induced flush without dumping
+ * core.
+ *
+ * Revision 1.5 2001/01/20 12:06:01 mdw
+ * Define flags with macros, to ensure unsignedness.
+ *
+ * Revision 1.4 2000/06/17 10:38:14 mdw
+ * Add support for variable buffer sizes.
+ *
+ * Revision 1.3 1999/12/10 23:42:04 mdw
+ * Change header file guard names.
+ *
* Revision 1.2 1999/05/17 20:36:08 mdw
* Make the magical constants for the buffer flags uppercase.
*
*
*/
-#ifndef LBUF_H
-#define LBUF_H
+#ifndef MLIB_LBUF_H
+#define MLIB_LBUF_H
#ifdef __cplusplus
extern "C" {
#include <stddef.h>
+#ifndef MLIB_ARENA_H
+# include "arena.h"
+#endif
+
/*----- Data structures ---------------------------------------------------*/
/* --- The buffer structure --- *
* that.
*/
+struct lbuf;
+
+typedef void lbuf_func(char */*s*/, size_t /*len*/, void */*p*/);
+
typedef struct lbuf {
- void (*func)(char */*s*/, void */*p*/); /* Handler function */
+ lbuf_func *func; /* Handler function */
void *p; /* Argument for handler */
size_t len; /* Length of data in buffer */
+ size_t sz; /* Buffer size */
+ unsigned delim; /* Delimiter to look for */
unsigned f; /* Various useful state flags */
- char buf[256]; /* The actual buffer */
+ arena *a; /* Memory allocation arena */
+ char *buf; /* The actual buffer */
} lbuf;
+#define LBUF_CR 1u /* Read a carriage return */
+#define LBUF_ENABLE 2u /* Buffer is currently enabled */
+#define LBUF_CLOSE 4u /* Buffer is now closed */
+
enum {
- LBUF_CR = 1, /* Read a carriage return */
- LBUF_ENABLE = 2 /* Buffer is currently enabled */
+ LBUF_CRLF = 256,
+ LBUF_STRICTCRLF = 257
};
/*----- Functions provided ------------------------------------------------*/
extern void lbuf_snarf(lbuf */*b*/, const void */*p*/, size_t /*sz*/);
+/* --- @lbuf_setsize@ --- *
+ *
+ * Arguments: @lbuf *b@ = pointer to buffer block
+ * @size_t sz@ = requested maximum line size
+ *
+ * Returns: ---
+ *
+ * Use: Allocates a buffer of the requested size reading lines.
+ */
+
+extern void lbuf_setsize(lbuf */*b*/, size_t /*sz*/);
+
/* --- @lbuf_init@ --- *
*
* Arguments: @lbuf *b@ = pointer to buffer block
- * @void (*func)(char *s, void *p)@ = handler function
+ * @lbuf_func *func@ = handler function
* @void *p@ = argument pointer for @func@
*
* Returns: ---
* passed to @func@ for processing.
*/
-extern void lbuf_init(lbuf */*b*/,
- void (*/*func*/)(char */*s*/, void */*p*/),
- void */*p*/);
+extern void lbuf_init(lbuf */*b*/, lbuf_func */*func*/, void */*p*/);
+
+/* --- @lbuf_destroy@ --- *
+ *
+ * Arguments: @lbuf *b@ = pointer to buffer block
+ *
+ * Returns: ---
+ *
+ * Use: Deallocates a line buffer and frees any resources it owned.
+ */
+
+extern void lbuf_destroy(lbuf */*b*/);
/*----- That's all, folks -------------------------------------------------*/