2 * Copyright (c) <2010>, Intel Corporation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
17 * - Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
32 * OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
37 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions are met:
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * * Neither the name of the University of California, Berkeley nor the
47 * names of its contributors may be used to endorse or promote products
48 * derived from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
51 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
52 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
53 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
54 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
55 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
56 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
57 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
59 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
65 #include "cmdline_rdline.h"
70 cmdline_parse_ctx_t *ctx;
72 char prompt[RDLINE_PROMPT_SIZE];
73 #ifdef CMDLINE_TERMIOS
74 struct termios oldterm;
80 * Allocate and initialize a new command line structure, using the
81 * specified prompt and specified input/output file descriptors to
82 * communicate with the user.
84 struct cmdline *cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt,
88 * Set the prompt of the given command line.
90 void cmdline_set_prompt(struct cmdline *cl, const char *prompt);
93 * Free a previously allocated command line: data pointed by the cl
94 * pointer is freed. Note: the user should call cmdline_quit() before
95 * calling this function.
97 void cmdline_free(struct cmdline *cl);
100 * write a buffer, just use rdline
102 ssize_t cmdline_write(void *arg, void *buf, size_t count);
105 * Display data on the output file descriptor of command line, using
106 * printf-like arguments.
108 int cmdline_printf(const struct cmdline *cl, const char *fmt, ...);
111 * Push an input buffer in the command line. Typically, this function
112 * is called by cmdline_interact() to send the inpu characters to the
113 * cmdline process. It can also be called by a user callback function,
114 * when a buffer is received from the input socket.
116 * The function returns the number of processed characters, or a
117 * negative value on error (EOF reached or command line exited.
119 int cmdline_in(struct cmdline *cl, const char *buf, int size);
122 * Start command line on configured file descriptor. This function
123 * loops until the user explicitelly call cmdline_quit(), or if the
124 * input fd reaches EOF.
126 void cmdline_interact(struct cmdline *cl);
129 * Interrupt a running command line process. Actually it will call
130 * rdline_quit() on the rdline descriptor.
132 void cmdline_quit(struct cmdline *cl);
134 #endif /* _CMDLINE_SOCKET_H_ */