1 /*
2  * Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #ifndef MINIBUFFER_H
18 #define MINIBUFFER_H
19 
20 #include "telescope.h"
21 
22 /* need to be true-ish */
23 #define MB_READ		1
24 #define MB_COMPREAD	2
25 
26 /*
27  * Completion provider function.  These functions are called
28  * asynchronously.  The function should compute the next completion
29  * using the given parameter `state' and modify it eventually.  To
30  * signal the end of the completions, complfn should return NULL: the
31  * value of state will then be discarded and the function never called
32  * again.  The second parameter is some extra metadata per-line; it'll
33  * be available as line->data on the selected line during the
34  * minibuffer lifecycle.  The third parameter is an extra description
35  * field for the current item.
36  */
37 typedef const char *(complfn)(void **, void **, const char **);
38 
39 struct ministate {
40 	char		*curmesg;
41 
42 	char		 prompt[64];
43 	void		 (*donefn)(void);
44 	void		 (*abortfn)(void);
45 
46 	char		 buf[1025];
47 	struct line	 line;
48 	struct vline	 vline;
49 	struct buffer	 buffer;
50 
51 	struct histhead	*history;
52 	struct hist	*hist_cur;
53 	size_t		 hist_off;
54 
55 	struct {
56 		struct buffer	 buffer;
57 		complfn		*fn;
58 		void		*data;
59 	} compl;
60 };
61 extern struct ministate ministate;
62 
63 extern struct buffer minibufferwin;
64 
65 void	 recompute_completions(int);
66 
67 void	 minibuffer_taint_hist(void);
68 void	 minibuffer_self_insert(void);
69 void	 sensible_self_insert(void);
70 void	 eecmd_self_insert(void);
71 void	 eecmd_select(void);
72 void	 ir_self_insert(void);
73 void	 ir_select(void);
74 void	 lu_select(void);
75 void	 bp_select(void);
76 void	 ts_select(void);
77 void	 ls_select(void);
78 void	 swiper_select(void);
79 void	 toc_select(void);
80 
81 void	 enter_minibuffer(void(*)(void), void(*)(void), void(*)(void),
82     struct histhead *,
83     complfn *, void *);
84 
85 void	 exit_minibuffer(void);
86 void	 yornp(const char *, void (*)(int, struct tab *), struct tab *);
87 
88 /*
89  * completing_read asks the user for something using the minibuffer.
90  * The first argument is the string prompt.  The second and third are
91  * the callback to call when done and the data; the callback function
92  * can't be NULL.
93  */
94 void	 completing_read(const char *,
95     void (*)(const char *, struct tab *), struct tab *);
96 
97 #endif