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 "client/sock.h"
29 #include "utils/strbuf.h"
31 #ifndef SYSDB_INPUT_H
32 #define SYSDB_INPUT_H 1
34 typedef struct {
35 sdb_client_t *client;
37 sdb_strbuf_t *input;
38 size_t tokenizer_pos;
39 size_t query_len;
41 bool interactive;
42 bool eof;
43 } sdb_input_t;
45 #define SDB_INPUT_INIT { NULL, NULL, 0, 0, 1, 0 }
47 /*
48 * sysdb_input:
49 * Input object to be used by the 'sysdb' command line tool.
50 */
51 extern sdb_input_t *sysdb_input;
53 /*
54 * sdb_input_init:
55 * Initialize the input handler.
56 */
57 int
58 sdb_input_init(sdb_input_t *input);
60 /*
61 * sdb_input_mainloop:
62 * Wait for and handle all user and server input until end-of-file is read
63 * from the user (on the standard input channel).
64 *
65 * Returns:
66 * - 0 on success
67 * - a negative value else
68 */
69 int
70 sdb_input_mainloop(void);
72 /*
73 * sdb_input_readline:
74 * This function is supposed to be used with a flex scanner's YY_INPUT. It
75 * reads input from the user using reading() and places available input in the
76 * specified buffer, returning the number of bytes in 'n_chars' (no more than
77 * 'max_chars'.
78 *
79 * Returns:
80 * - The number of newly read bytes.
81 * - A negative value in case of an error.
82 */
83 ssize_t
84 sdb_input_readline(char *buf, size_t *n_chars, size_t max_chars);
86 /*
87 * sdb_input_exec_query:
88 * Execute the query currently stored in the input buffer. Waits for the
89 * server's reply and prints errors or returned data to standard output.
90 */
91 int
92 sdb_input_exec_query(void);
94 #endif /* SYSDB_INPUT_H */
96 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */