xref: /linux/tools/perf/ui/browser.h (revision e9f0878c4b2004ac19581274c1ae4c61ae3ca70e)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _PERF_UI_BROWSER_H_
3 #define _PERF_UI_BROWSER_H_ 1
4 
5 #include <linux/types.h>
6 #include <stdarg.h>
7 
8 #define HE_COLORSET_TOP		50
9 #define HE_COLORSET_MEDIUM	51
10 #define HE_COLORSET_NORMAL	52
11 #define HE_COLORSET_SELECTED	53
12 #define HE_COLORSET_JUMP_ARROWS	54
13 #define HE_COLORSET_ADDR	55
14 #define HE_COLORSET_ROOT	56
15 
16 struct ui_browser {
17 	u64	      index, top_idx;
18 	void	      *top, *entries;
19 	u16	      y, x, width, height, rows, columns, horiz_scroll;
20 	u8	      extra_title_lines;
21 	int	      current_color;
22 	void	      *priv;
23 	const char    *title;
24 	char	      *helpline;
25 	void 	      (*refresh_dimensions)(struct ui_browser *browser);
26 	unsigned int  (*refresh)(struct ui_browser *browser);
27 	void	      (*write)(struct ui_browser *browser, void *entry, int row);
28 	void	      (*seek)(struct ui_browser *browser, off_t offset, int whence);
29 	bool	      (*filter)(struct ui_browser *browser, void *entry);
30 	u32	      nr_entries;
31 	bool	      navkeypressed;
32 	bool	      use_navkeypressed;
33 };
34 
35 int  ui_browser__set_color(struct ui_browser *browser, int color);
36 void ui_browser__set_percent_color(struct ui_browser *browser,
37 				   double percent, bool current);
38 bool ui_browser__is_current_entry(struct ui_browser *browser, unsigned row);
39 void ui_browser__refresh_dimensions(struct ui_browser *browser);
40 void ui_browser__reset_index(struct ui_browser *browser);
41 
42 void ui_browser__gotorc_title(struct ui_browser *browser, int y, int x);
43 void ui_browser__gotorc(struct ui_browser *browser, int y, int x);
44 void ui_browser__write_nstring(struct ui_browser *browser, const char *msg,
45 			       unsigned int width);
46 void ui_browser__vprintf(struct ui_browser *browser, const char *fmt, va_list args);
47 void ui_browser__printf(struct ui_browser *browser, const char *fmt, ...);
48 void ui_browser__write_graph(struct ui_browser *browser, int graph);
49 void __ui_browser__line_arrow(struct ui_browser *browser, unsigned int column,
50 			      u64 start, u64 end);
51 void ui_browser__mark_fused(struct ui_browser *browser, unsigned int column,
52 			    unsigned int row, bool arrow_down);
53 void __ui_browser__show_title(struct ui_browser *browser, const char *title);
54 void ui_browser__show_title(struct ui_browser *browser, const char *title);
55 int ui_browser__show(struct ui_browser *browser, const char *title,
56 		     const char *helpline, ...);
57 void ui_browser__hide(struct ui_browser *browser);
58 int ui_browser__refresh(struct ui_browser *browser);
59 int ui_browser__run(struct ui_browser *browser, int delay_secs);
60 void ui_browser__update_nr_entries(struct ui_browser *browser, u32 nr_entries);
61 void ui_browser__handle_resize(struct ui_browser *browser);
62 void __ui_browser__vline(struct ui_browser *browser, unsigned int column,
63 			 u16 start, u16 end);
64 
65 int ui_browser__warning(struct ui_browser *browser, int timeout,
66 			const char *format, ...);
67 int ui_browser__help_window(struct ui_browser *browser, const char *text);
68 bool ui_browser__dialog_yesno(struct ui_browser *browser, const char *text);
69 int ui_browser__input_window(const char *title, const char *text, char *input,
70 			     const char *exit_msg, int delay_sec);
71 struct perf_env;
72 int tui__header_window(struct perf_env *env);
73 
74 void ui_browser__argv_seek(struct ui_browser *browser, off_t offset, int whence);
75 unsigned int ui_browser__argv_refresh(struct ui_browser *browser);
76 
77 void ui_browser__rb_tree_seek(struct ui_browser *browser, off_t offset, int whence);
78 unsigned int ui_browser__rb_tree_refresh(struct ui_browser *browser);
79 
80 void ui_browser__list_head_seek(struct ui_browser *browser, off_t offset, int whence);
81 unsigned int ui_browser__list_head_refresh(struct ui_browser *browser);
82 
83 void ui_browser__init(void);
84 #endif /* _PERF_UI_BROWSER_H_ */
85