1

#ifndef CONSOLE_H

     2

#define CONSOLE_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * An interactive line-based console interface for runtime configuration.

     8

 *

     9

 * This uses the GNU readline library to implement the console, and hence, the console uses global state, and there

    10

 * can only be one console per process - not that it should matter, since the console requires a tty.

    11

 *

    12

 * XXX: the log module interferes with this

    13

 */

    14

#include "error.h"

    15

#include <event2/event.h>

    16

#include <stdbool.h>

    17

    18

/**

    19

 * Callbacks for event-based actions

    20

 */

    21

struct console_callbacks {

    22

    /**

    23

     * A line was read from the console. 

    24

     *

    25

     * XXX: currently, line might be NULL on EOF, but this is probably a second callback

    26

     */

    27

    void (*on_line) (const char *line, void *arg);

    28

};

    29

    30

/**

    31

 * Configuration info for console operation

    32

 */

    33

struct console_config {

    34

    /** The prompt to use when displaying lines */

    35

    const char *prompt;

    36

};

    37

    38

/**

    39

 * The console state.

    40

 *

    41

 * You may replace the callbacks/cb_arg field with a new one at any time, using console_set_callbacks().

    42

 */

    43

struct console {

    44

    /** The input event */

    45

    struct event *ev;

    46

    47

    /** The callback functions */

    48

    const struct console_callbacks *callbacks;

    49

    50

    /** The callback context argument */

    51

    void *cb_arg;

    52

    53

    /** Already initialized? */

    54

    bool initialized;

    55

    56

    /** Set as log output function? */

    57

    bool log_output;

    58

    59

    /** In the middle of input? */

    60

    bool have_input;

    61

};

    62

    63

/**

    64

 * Initialize the console, setting up the TTY and input handler.

    65

 *

    66

 * @param console_ptr returned new console struct

    67

 * @param ev_base the libevent base to use

    68

 * @param config configuration things for the console

    69

 * @param callbacks optional callbacks, can be updated later

    70

 * @param cb_arg option callback argument, can be updated later

    71

 * @param err returned error info

    72

 */

    73

err_t console_init (struct console **console_ptr, struct event_base *ev_base, const struct console_config *config,

    74

        const struct console_callbacks *callbacks, void *cb_arg, struct error_info *err);

    75

    76

/**

    77

 * Replace the current callbacks with the given new ones.

    78

 */

    79

void console_set_callbacks (struct console *console, const struct console_callbacks *callbacks, void *cb_arg);

    80

    81

/**

    82

 * Output a full line (without included newline) on the console, trying not to interfere with the input too much.

    83

 */

    84

err_t console_print (struct console *console, const char *line);

    85

    86

/**

    87

 * Install this console as the log output handler

    88

 */

    89

void console_set_log_output (struct console *console);

    90

    91

/**

    92

 * Deinitialize the console, restoring the TTY and releasing resources

    93

 */

    94

void console_destroy (struct console *console);

    95

    96

#endif /* CONSOLE_H */