1 /*
2 * SysDB - src/tools/sysdb/input.h
3 * Copyright (C) 2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #include "utils/strbuf.h"
30 #ifndef SYSDB_INPUT_H
31 #define SYSDB_INPUT_H 1
33 typedef struct {
34 sdb_strbuf_t *buf;
36 size_t tokenizer_pos;
37 } sdb_input_t;
39 #define SDB_INPUT_INIT { NULL, 0 }
41 /*
42 * sdb_input_readline:
43 * This function is supposed to be used with a flex scanner's YY_INPUT. It
44 * reads input from the user using reading() and places available input in the
45 * specified buffer, returning the number of bytes in 'n_chars' (no more than
46 * 'max_chars'.
47 *
48 * Returns:
49 * - The number of newly read bytes.
50 * - A negative value in case of an error.
51 */
52 ssize_t
53 sdb_input_readline(sdb_input_t *input, char *buf,
54 int *n_chars, size_t max_chars);
56 /*
57 * scanner
58 */
60 void
61 sdb_input_set(sdb_input_t *new_input);
63 #endif /* SYSDB_INPUT_H */
65 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */