Changeset bd5f3b7 in mainline for uspace/lib/clui/tinput.h

Timestamp:

2011-08-21T13:07:35Z (13 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

00aece0, f1a9e87

Parents:

86a34d3e (diff), a6480d5 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge mainline changes.

File:

• uspace/lib/clui/tinput.h (modified) (4 diffs)

uspace/lib/clui/tinput.h

@@ -1 +1 @@
 /*
- * Copyright (c) 2010 Jiri Svoboda
+ * Copyright (c) 2011 Jiri Svoboda
  * All rights reserved.
  *
@@ -37 +37 @@
 #define LIBCLUI_TINPUT_H_
 
-#include <stdio.h>
+#include <adt/list.h>
 #include <async.h>
 #include <inttypes.h>
 #include <io/console.h>
+#include <stdio.h>
 
 #define HISTORY_LEN     10
 #define INPUT_MAX_SIZE  1024
+
+/** Begin enumeration of text completions.
+ *
+ * When user requests text completion, tinput will call this function to start
+ * text completion operation. @a *cstart should be set to the position
+ * (character index) of the first character of the 'word' that is being
+ * completed. The resulting text is obtained by replacing the range of text
+ * starting at @a *cstart and ending at @a pos with the completion text.
+ *
+ * The function can pass information to the get_next and fini functions
+ * via @a state. The init function allocates the state object and stores
+ * a pointer to it to @a *state. The fini function destroys the state object.
+ *
+ * @param text          Current contents of edit buffer (null-terminated).
+ * @param pos           Current caret position.
+ * @param cstart        Output, position in text where completion begins from.
+ * @param state         Output, pointer to a client state object.
+ *
+ * @return              EOK on success, negative error code on failure.
+ */
+typedef int (*tinput_compl_init_fn)(wchar_t *text, size_t pos, size_t *cstart,
+    void **state);
+
+/** Obtain one text completion alternative.
+ *
+ * Upon success the function sets @a *compl to point to a string, the
+ * completion text. The caller (Tinput) should not modify or free the text.
+ * The pointer is only valid until the next invocation of any completion
+ * function.
+ *
+ * @param state         Pointer to state object created by the init funtion.
+ * @param compl         Output, the completion text, ownership retained.
+ *
+ * @return              EOK on success, negative error code on failure.
+ */
+typedef int (*tinput_compl_get_next_fn)(void *state, char **compl);
+
+
+/** Finish enumeration of text completions.
+ *
+ * The function must deallocate any state information allocated by the init
+ * function or temporary data allocated by the get_next function.
+ *
+ * @param state         Pointer to state object created by the init funtion.
+ */
+typedef void (*tinput_compl_fini_fn)(void *state);
+
+/** Text completion ops. */
+typedef struct {
+        tinput_compl_init_fn init;
+        tinput_compl_get_next_fn get_next;
+        tinput_compl_fini_fn fini;
+} tinput_compl_ops_t;
 
 /** Text input field (command line).
@@ -53 +107 @@
         console_ctrl_t *console;
         
+        /** Prompt string */
+        char *prompt;
+        
+        /** Completion ops. */
+        tinput_compl_ops_t *compl_ops;
+        
         /** Buffer holding text currently being edited */
         wchar_t buffer[INPUT_MAX_SIZE + 1];
         
-        /** Screen coordinates of the top-left corner of the text field */
-        sysarg_t col0;
-        sysarg_t row0;
+        /** Linear position on screen where the prompt starts */
+        unsigned prompt_coord;
+        /** Linear position on screen where the text field starts */
+        unsigned text_coord;
         
         /** Screen dimensions */
@@ -90 +151 @@
 
 extern tinput_t *tinput_new(void);
+extern int tinput_set_prompt(tinput_t *, const char *);
+extern void tinput_set_compl_ops(tinput_t *, tinput_compl_ops_t *);
 extern void tinput_destroy(tinput_t *);
 extern int tinput_read(tinput_t *, char **);