src/tools/sysdb/input.h

   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  */
  27
  28 #include "client/sock.h"
  29 #include "utils/strbuf.h"
  30
  31 #ifndef SYSDB_INPUT_H
  32 #define SYSDB_INPUT_H 1
  33
  34 typedef struct {
  35         sdb_client_t *client;
  36         char *user;
  37
  38         sdb_strbuf_t *input;
  39         size_t tokenizer_pos;
  40         size_t query_len;
  41
  42         /* indicates that we've had non-empty input */
  43         bool have_input;
  44
  45         bool interactive;
  46         bool eof;
  47 } sdb_input_t;
  48
  49 #define SDB_INPUT_INIT { NULL, NULL, NULL, 0, 0, 0, 1, 0 }
  50
  51 /*
  52  * sysdb_input:
  53  * Input object to be used by the 'sysdb' command line tool.
  54  */
  55 extern sdb_input_t *sysdb_input;
  56
  57 /*
  58  * sdb_input_init:
  59  * Initialize the input handler.
  60  */
  61 int
  62 sdb_input_init(sdb_input_t *input);
  63
  64 /*
  65  * sdb_input_reset:
  66  * Reset the input handler and free all dynamically allocated memory. The
  67  * input handler object itself will not be freed.
  68  */
  69 void
  70 sdb_input_reset(sdb_input_t *input);
  71
  72 /*
  73  * sdb_input_mainloop:
  74  * Wait for and handle all user and server input until end-of-file is read
  75  * from the user (on the standard input channel).
  76  *
  77  * Returns:
  78  *  - 0 on success
  79  *  - a negative value else
  80  */
  81 int
  82 sdb_input_mainloop(void);
  83
  84 /*
  85  * sdb_input_readline:
  86  * This function is supposed to be used with a flex scanner's YY_INPUT. It
  87  * reads input from the user using reading() and places available input in the
  88  * specified buffer, returning the number of bytes in 'n_chars' (no more than
  89  * 'max_chars'.
  90  *
  91  * Returns:
  92  *  - The number of newly read bytes.
  93  *  - A negative value in case of an error.
  94  */
  95 ssize_t
  96 sdb_input_readline(char *buf, size_t *n_chars, size_t max_chars);
  97
  98 /*
  99  * sdb_input_exec_query:
 100  * Execute the query currently stored in the input buffer. Waits for the
 101  * server's reply and prints errors or returned data to standard output.
 102  */
 103 int
 104 sdb_input_exec_query(void);
 105
 106 /*
 107  * sdb_input_reconnect:
 108  * Let the client reconnect to the server using the settings stored in
 109  * sysdb_input.
 110  */
 111 int
 112 sdb_input_reconnect(void);
 113
 114 #endif /* SYSDB_INPUT_H */
 115
 116 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 117