source: mainline/uspace/lib/clui/tinput.h@ 36a75a2

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 36a75a2 was 36a75a2, checked in by Jiri Svoboda <jiri@…>, 15 years ago

Move text input from Bdsh to a separate library, clui.

  • Property mode set to 100644
File size: 2.4 KB
Line 
1/*
2 * Copyright (c) 2010 Jiri Svoboda
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - 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 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libclui
30 * @{
31 */
32/**
33 * @file
34 */
35
36#ifndef LIBCLUI_TINPUT_H_
37#define LIBCLUI_TINPUT_H_
38
39#define HISTORY_LEN 10
40#define INPUT_MAX_SIZE 1024
41
42/** Text input field (command line).
43 *
44 * Applications should treat this structure as opaque.
45 */
46typedef struct {
47 /** Buffer holding text currently being edited */
48 wchar_t buffer[INPUT_MAX_SIZE + 1];
49 /** Screen coordinates of the top-left corner of the text field */
50 int col0, row0;
51 /** Screen dimensions */
52 int con_cols, con_rows;
53 /** Number of characters in @c buffer */
54 int nc;
55 /** Caret position within buffer */
56 int pos;
57 /** Selection mark position within buffer */
58 int sel_start;
59
60 /** History (dynamically allocated strings) */
61 char *history[1 + HISTORY_LEN];
62 /** Number of entries in @c history, not counting [0] */
63 int hnum;
64 /** Current position in history */
65 int hpos;
66 /** Exit flag */
67 bool done;
68} tinput_t;
69
70extern tinput_t *tinput_new(void);
71extern void tinput_destroy(tinput_t *ti);
72extern char *tinput_read(tinput_t *ti);
73
74#endif
75
76/** @}
77 */
78
Note: See TracBrowser for help on using the repository browser.