author | Tero Marttila <terom@fixme.fi> |
Tue, 31 Mar 2009 22:09:53 +0300 | |
changeset 98 | f357f835f0d5 |
parent 93 | 42ade8285570 |
child 137 | c607c357c486 |
permissions | -rw-r--r-- |
92
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
1 |
#ifndef CONSOLE_H |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
2 |
#define CONSOLE_H |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
3 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
4 |
/** |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
5 |
* @file |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
6 |
* |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
7 |
* An interactive line-based console interface for runtime configuration. |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
8 |
* |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
9 |
* This uses the GNU readline library to implement the console, and hence, the console uses global state, and there |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
10 |
* can only be one console per process - not that it should matter, since the console requires a tty. |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
11 |
* |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
12 |
* XXX: the log module interferes with this |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
13 |
*/ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
14 |
#include "error.h" |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
15 |
#include <event2/event.h> |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
16 |
#include <stdbool.h> |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
17 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
18 |
/** |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
19 |
* Callbacks for event-based actions |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
20 |
*/ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
21 |
struct console_callbacks { |
93
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
22 |
/** |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
23 |
* A line was read from the console. |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
24 |
* |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
25 |
* XXX: currently, line might be NULL on EOF, but this is probably a second callback |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
26 |
*/ |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
27 |
void (*on_line) (const char *line, void *arg); |
92
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
28 |
}; |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
29 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
30 |
/** |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
31 |
* Configuration info for console operation |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
32 |
*/ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
33 |
struct console_config { |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
34 |
/** The prompt to use when displaying lines */ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
35 |
const char *prompt; |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
36 |
}; |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
37 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
38 |
/** |
93
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
39 |
* The console state. |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
40 |
* |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
41 |
* You may replace the callbacks/cb_arg field with a new one at any time, using console_set_callbacks(). |
92
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
42 |
*/ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
43 |
struct console { |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
44 |
/** The input event */ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
45 |
struct event *ev; |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
46 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
47 |
/** The callback functions */ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
48 |
const struct console_callbacks *callbacks; |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
49 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
50 |
/** The callback context argument */ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
51 |
void *cb_arg; |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
52 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
53 |
/** Already initialized? */ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
54 |
bool initialized; |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
55 |
}; |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
56 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
57 |
/** |
93
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
58 |
* Initialize the console, setting up the TTY and input handler. |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
59 |
* |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
60 |
* @param console_ptr returned new console struct |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
61 |
* @param ev_base the libevent base to use |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
62 |
* @param config configuration things for the console |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
63 |
* @param callbacks optional callbacks, can be updated later |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
64 |
* @param cb_arg option callback argument, can be updated later |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
65 |
* @param err returned error info |
92
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
66 |
*/ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
67 |
err_t console_init (struct console **console_ptr, struct event_base *ev_base, const struct console_config *config, |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
68 |
const struct console_callbacks *callbacks, void *cb_arg, struct error_info *err); |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
69 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
70 |
/** |
93
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
71 |
* Replace the current callbacks with the given new ones. |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
72 |
*/ |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
73 |
void console_set_callbacks (struct console *console, const struct console_callbacks *callbacks, void *cb_arg); |
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
74 |
|
42ade8285570
add some rudimentary lua support, by having a simple interactive console, and providing access to irc_client_quit
Tero Marttila <terom@fixme.fi>
parents:
92
diff
changeset
|
75 |
/** |
92
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
76 |
* Deinitialize the console, restoring the TTY and releasing resources |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
77 |
*/ |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
78 |
void console_destroy (struct console *console); |
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
79 |
|
99661e5aac91
add a simple interactive readline console
Tero Marttila <terom@fixme.fi>
parents:
diff
changeset
|
80 |
#endif /* CONSOLE_H */ |