| 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 | #include <ipc/ipc.h>
|
|---|
| 40 |
|
|---|
| 41 | #define HISTORY_LEN 10
|
|---|
| 42 | #define INPUT_MAX_SIZE 1024
|
|---|
| 43 |
|
|---|
| 44 | /** Text input field (command line).
|
|---|
| 45 | *
|
|---|
| 46 | * Applications should treat this structure as opaque.
|
|---|
| 47 | */
|
|---|
| 48 | typedef struct {
|
|---|
| 49 | /** Buffer holding text currently being edited */
|
|---|
| 50 | wchar_t buffer[INPUT_MAX_SIZE + 1];
|
|---|
| 51 |
|
|---|
| 52 | /** Screen coordinates of the top-left corner of the text field */
|
|---|
| 53 | ipcarg_t col0;
|
|---|
| 54 | ipcarg_t row0;
|
|---|
| 55 |
|
|---|
| 56 | /** Screen dimensions */
|
|---|
| 57 | ipcarg_t con_cols;
|
|---|
| 58 | ipcarg_t con_rows;
|
|---|
| 59 |
|
|---|
| 60 | /** Number of characters in @c buffer */
|
|---|
| 61 | size_t nc;
|
|---|
| 62 |
|
|---|
| 63 | /** Caret position within buffer */
|
|---|
| 64 | size_t pos;
|
|---|
| 65 |
|
|---|
| 66 | /** Selection mark position within buffer */
|
|---|
| 67 | size_t sel_start;
|
|---|
| 68 |
|
|---|
| 69 | /** History (dynamically allocated strings) */
|
|---|
| 70 | char *history[HISTORY_LEN + 1];
|
|---|
| 71 |
|
|---|
| 72 | /** Number of entries in @c history, not counting [0] */
|
|---|
| 73 | size_t hnum;
|
|---|
| 74 |
|
|---|
| 75 | /** Current position in history */
|
|---|
| 76 | size_t hpos;
|
|---|
| 77 |
|
|---|
| 78 | /** @c true if finished with this line (return to caller) */
|
|---|
| 79 | bool done;
|
|---|
| 80 |
|
|---|
| 81 | /** @c true if user requested to abort interactive loop */
|
|---|
| 82 | bool exit_clui;
|
|---|
| 83 | } tinput_t;
|
|---|
| 84 |
|
|---|
| 85 | extern tinput_t *tinput_new(void);
|
|---|
| 86 | extern void tinput_destroy(tinput_t *);
|
|---|
| 87 | extern int tinput_read(tinput_t *, char **);
|
|---|
| 88 |
|
|---|
| 89 | #endif
|
|---|
| 90 |
|
|---|
| 91 | /** @}
|
|---|
| 92 | */
|
|---|
