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 hist;
40 extern struct hist *eecmd_history;
41 extern struct hist *ir_history;
42 extern struct hist *lu_history;
43 extern struct hist *read_history;
44 
45 struct ministate {
46 	char		*curmesg;
47 
48 	char		 prompt[64];
49 	void		 (*donefn)(const char *);
50 	void		 (*abortfn)(void);
51 
52 	char		 buf[1025];
53 	struct line	 line;
54 	struct vline	 vline;
55 	struct buffer	 buffer;
56 
57 	struct hist	*hist;
58 	int		 editing;
59 
60 	struct {
61 		struct buffer	 buffer;
62 		complfn		*fn;
63 		void		*data;
64 		int		 must_select;
65 	} compl;
66 };
67 extern struct ministate	 ministate;
68 
69 extern struct buffer	 minibufferwin;
70 extern int		 in_minibuffer;
71 
72 void	 recompute_completions(int);
73 int	 minibuffer_insert_current_candidate(void);
74 void	 minibuffer_taint_hist(void);
75 void	 minibuffer_confirm(void);
76 void	 minibuffer_self_insert(void);
77 void	 sensible_self_insert(void);
78 void	 eecmd_select(const char *);
79 void	 ir_select_gemini(const char *);
80 void	 ir_select_reply(const char *);
81 void	 ir_select_gopher(const char *);
82 void	 lu_select(const char *);
83 void	 bp_select(const char *);
84 void	 ts_select(const char *);
85 void	 ls_select(const char *);
86 void	 swiper_select(const char *);
87 void	 toc_select(const char *);
88 void	 uc_select(const char *);
89 void	 search_select(const char *);
90 
91 struct minibuffer {
92 	void		(*self_insert)(void);
93 	void		(*done)(const char *);
94 	void		(*abort)(void);
95 	struct hist	*history;
96 	complfn		*complfn;
97 	void		*compldata;
98 	int		 must_select;
99 	const char	*input;
100 };
101 
102 void	 enter_minibuffer(struct minibuffer *, const char *, ...);
103 
104 void	 exit_minibuffer(void);
105 void	 yornp(const char *, void (*)(int, void *), void *);
106 
107 /*
108  * minibuffer_read asks the user for something using the minibuffer.
109  * The first argument is the string prompt.  The second and third are
110  * the callback to call when done and the data; the callback function
111  * can't be NULL.
112  */
113 void	 minibuffer_read(const char *,
114     void (*)(const char *, struct tab *), struct tab *, const char *);
115 
116 void	 vmessage(const char *, va_list);
117 void	 message(const char *, ...) __attribute__((format(printf, 1, 2)));
118 void	 minibuffer_init(void);
119 
120 #endif