1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*
* rofi
*
* MIT/X11 License
* Copyright © 2013-2022 Qball Cow <qball@gmpclient.org>
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#ifndef ROFI_MODE_PRIVATE_H
#define ROFI_MODE_PRIVATE_H
#include "mode.h"
#include <gmodule.h>
G_BEGIN_DECLS
/** ABI version to check if loaded plugin is compatible. */
#define ABI_VERSION 6u
/**
* @param data Pointer to #Mode object.
*
* Mode free function.
*/
typedef void (*_mode_free)(Mode *data);
/**
* @param sw The #Mode pointer
* @param selected_line The selected line
* @param state The state to display [out]
* @param attribute_list List of extra (pango) attribute to apply when
* displaying. [out][null]
* @param get_entry if it should only return the state
*
* Get the value for displaying.
*
* @return the string and state for displaying.
*/
typedef char *(*_mode_get_display_value)(const Mode *sw,
unsigned int selected_line, int *state,
GList **attribute_list, int get_entry);
/**
* @param sw The #Mode pointer
* @param selected_line The selected line
*
* Obtains the icon if available
*
* @return Get the icon
*/
typedef cairo_surface_t *(*_mode_get_icon)(const Mode *sw,
unsigned int selected_line,
int height);
/**
* @param sw The #Mode pointer
* @param selected_line The selected line
*
* Obtains the string to complete.
*
* @return Get the completion string
*/
typedef char *(*_mode_get_completion)(const Mode *sw,
unsigned int selected_line);
/**
* @param tokens List of (input) tokens to match.
* @param input The entry to match against.
* @param case_sensitive Whether case is significant.
* @param index The current selected index.
* @param data User data.
*
* Function prototype for the matching algorithm.
*
* @returns 1 when it matches, 0 if not.
*/
typedef int (*_mode_token_match)(const Mode *data, rofi_int_matcher **tokens,
unsigned int index);
/**
* @param sw The #Mode pointer
*
* Initialize the mode.
*
* @returns TRUE is successful
*/
typedef int (*__mode_init)(Mode *sw);
/**
* @param sw The #Mode pointer
*
* Get the number of entries.
*
* @returns the number of entries
*/
typedef unsigned int (*__mode_get_num_entries)(const Mode *sw);
/**
* @param sw The #Mode pointer
*
* Destroy the current mode. Still ready to restart.
*
*/
typedef void (*__mode_destroy)(Mode *sw);
/**
* @param sw The #Mode pointer
* @param menu_retv The return value
* @param input The input string
* @param selected_line The selected line
*
* Handle the user accepting an entry.
*
* @returns the next action to take
*/
typedef ModeMode (*_mode_result)(Mode *sw, int menu_retv, char **input,
unsigned int selected_line);
/**
* @param sw The #Mode pointer
* @param input The input string
*
* Preprocess the input for sorting.
*
* @returns Entry stripped from markup for sorting
*/
typedef char *(*_mode_preprocess_input)(Mode *sw, const char *input);
/**
* @param sw The #Mode pointer
*
* Message to show in the message bar.
*
* @returns the (valid pango markup) message to display.
*/
typedef char *(*_mode_get_message)(const Mode *sw);
/**
* Structure defining a switcher.
* It consists of a name, callback and if enabled
* a textbox for the sidebar-mode.
*/
struct rofi_mode {
/** Used for external plugins. */
unsigned int abi_version;
/** Name (max 31 char long) */
char *name;
char cfg_name_key[128];
char *display_name;
/**
* A switcher normally consists of the following parts:
*/
/** Initialize the Mode */
__mode_init _init;
/** Destroy the switcher, e.g. free all its memory. */
__mode_destroy _destroy;
/** Get number of entries to display. (unfiltered). */
__mode_get_num_entries _get_num_entries;
/** Process the result of the user selection. */
_mode_result _result;
/** Token match. */
_mode_token_match _token_match;
/** Get the string to display for the entry. */
_mode_get_display_value _get_display_value;
/** Get the icon for the entry. */
_mode_get_icon _get_icon;
/** Get the 'completed' entry. */
_mode_get_completion _get_completion;
_mode_preprocess_input _preprocess_input;
_mode_get_message _get_message;
/** Pointer to private data. */
void *private_data;
/**
* Free SWitcher
* Only to be used when the switcher object itself is dynamic.
* And has data in `ed`
*/
_mode_free free;
/** Extra fields for script */
void *ed;
/** Module */
GModule *module;
};
G_END_DECLS
#endif // ROFI_MODE_PRIVATE_H
|
