girara
types.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: Zlib */
2 
3 #ifndef GIRARA_TYPES_H
4 #define GIRARA_TYPES_H
5 
6 #include "girara-version.h"
7 #include <stdbool.h>
8 
9 typedef struct girara_tree_node_s girara_tree_node_t;
10 typedef struct girara_list_s girara_list_t;
11 typedef struct girara_list_iterator_s girara_list_iterator_t;
12 typedef struct girara_setting_s girara_setting_t;
13 typedef struct girara_session_s girara_session_t;
14 typedef struct girara_session_private_s girara_session_private_t;
15 typedef struct girara_command_s girara_command_t;
16 typedef struct girara_mouse_event_s girara_mouse_event_t;
17 typedef struct girara_config_handle_s girara_config_handle_t;
18 typedef struct girara_mode_string_s girara_mode_string_t;
19 typedef struct girara_tab_s girara_tab_t;
20 typedef struct girara_statusbar_item_s girara_statusbar_item_t;
21 typedef struct girara_argument_s girara_argument_t;
22 typedef struct girara_shortcut_mapping_s girara_shortcut_mapping_t;
23 typedef struct girara_argument_mapping_s girara_argument_mapping_t;
24 typedef struct girara_completion_element_s girara_completion_element_t;
25 typedef struct girara_completion_s girara_completion_t;
26 typedef struct girara_completion_group_s girara_completion_group_t;
27 typedef struct girara_shortcut_s girara_shortcut_t;
28 typedef struct girara_inputbar_shortcut_s girara_inputbar_shortcut_t;
29 typedef struct girara_special_command_s girara_special_command_t;
30 typedef struct girara_event_s girara_event_t;
31 
35 enum
36 {
53 };
54 
58 typedef int girara_mode_t;
59 
67 typedef girara_completion_t* (*girara_completion_function_t)(
68  girara_session_t* session, const char* input);
69 
79 typedef bool (*girara_inputbar_special_function_t)(girara_session_t* session,
80  const char* input, girara_argument_t* argument);
81 
89 typedef bool (*girara_command_function_t)(girara_session_t* session,
90  girara_list_t* argument_list);
91 
99 typedef bool (*girara_shortcut_function_t)(girara_session_t*,
100  girara_argument_t*, girara_event_t*, unsigned int);
101 
107 typedef void (*girara_free_function_t)(void* data);
108 
115 typedef void (*girara_list_callback_t)(void* data, void* userdata);
116 
123 typedef int (*girara_compare_function_t)(const void* data1, const void* data2);
124 
128 typedef enum girara_setting_type_e
129 {
132  INT,
134  UNKNOWN = 0xFFFF
136 
146 typedef void (*girara_setting_callback_t)(girara_session_t* session,
147  const char* name, girara_setting_type_t type, const void* value, void* data);
148 
153 {
154  int n;
155  void *data;
156 };
157 
161 typedef enum girara_mouse_button_e
162 {
173 
177 typedef enum girara_event_type_e
178 {
196 
201 {
204  double x;
205  double y;
206 };
207 
208 typedef struct girara_input_history_io_s GiraraInputHistoryIO;
209 typedef struct girara_input_history_io_interface_s GiraraInputHistoryIOInterface;
210 typedef struct girara_input_history_s GiraraInputHistory;
211 typedef struct girara_input_history_class_s GiraraInputHistoryClass;
212 
213 typedef struct girara_template_s GiraraTemplate;
214 typedef struct girara_template_class_s GiraraTemplateClass;
215 
216 #endif
girara_mode_t
int girara_mode_t
Definition: types.h:58
GIRARA_NEXT_GROUP
Definition: types.h:40
girara_compare_function_t
int(* girara_compare_function_t)(const void *data1, const void *data2)
Definition: types.h:123
girara_command_function_t
bool(* girara_command_function_t)(girara_session_t *session, girara_list_t *argument_list)
Definition: types.h:89
GIRARA_GOTO_END
Definition: types.h:52
GIRARA_EVENT_BUTTON_RELEASE
Definition: types.h:182
girara_setting_callback_t
void(* girara_setting_callback_t)(girara_session_t *session, const char *name, girara_setting_type_t type, const void *value, void *data)
Definition: types.h:146
GIRARA_NORMAL
Definition: types.h:43
GIRARA_EVENT_SCROLL_DOWN
Definition: types.h:185
GIRARA_MOUSE_BUTTON9
Definition: types.h:171
GIRARA_PREVIOUS
Definition: types.h:39
GIRARA_DELETE_LAST_WORD
Definition: types.h:44
girara_input_history_class_s
Definition: input-history.h:58
girara_completion_t
struct girara_completion_s girara_completion_t
Definition: types.h:25
GIRARA_EVENT_BUTTON_PRESS
Definition: types.h:179
GIRARA_EVENT_3BUTTON_PRESS
Definition: types.h:181
girara_tree_node_t
struct girara_tree_node_s girara_tree_node_t
Definition: types.h:9
girara_argument_s::n
int n
Definition: types.h:154
girara_event_s::y
double y
Definition: types.h:205
GIRARA_DELETE_TO_LINE_START
Definition: types.h:48
girara_template_class_s
Definition: template.h:14
GIRARA_EVENT_SCROLL_UP
Definition: types.h:184
girara_session_s
Definition: session.h:18
girara_config_handle_s
Definition: internal.h:240
girara_event_s::x
double x
Definition: types.h:204
GIRARA_PREVIOUS_CHAR
Definition: types.h:47
GIRARA_EVENT_OTHER
Definition: types.h:188
GIRARA_EVENT_MOTION_NOTIFY
Definition: types.h:183
girara_mode_string_s
Definition: internal.h:165
GIRARA_DELETE_LAST_CHAR
Definition: types.h:45
girara_input_history_io_interface_s
Definition: input-history.h:10
girara_shortcut_function_t
bool(* girara_shortcut_function_t)(girara_session_t *, girara_argument_t *, girara_event_t *, unsigned int)
Definition: types.h:99
girara_shortcut_mapping_s
Definition: internal.h:174
girara_list_callback_t
void(* girara_list_callback_t)(void *data, void *userdata)
Definition: types.h:115
BOOLEAN
Definition: types.h:130
GIRARA_MOUSE_BUTTON2
Definition: types.h:164
FLOAT
Definition: types.h:131
girara_completion_group_t
struct girara_completion_group_s girara_completion_group_t
Definition: types.h:26
girara_tab_t
struct girara_tab_s girara_tab_t
Definition: types.h:19
girara_inputbar_shortcut_s
Definition: internal.h:205
girara_session_private_s
Definition: internal.h:258
girara_mouse_button_t
girara_mouse_button_t
Definition: types.h:161
girara_event_type_t
girara_event_type_t
Definition: types.h:177
GIRARA_MOUSE_BUTTON7
Definition: types.h:169
GIRARA_MOUSE_BUTTON1
Definition: types.h:163
girara_setting_t
struct girara_setting_s girara_setting_t
Definition: types.h:12
girara_command_s
Definition: internal.h:156
GIRARA_NEXT_CHAR
Definition: types.h:46
girara_template_s
Definition: template.h:10
girara_argument_mapping_s
Definition: internal.h:183
girara_input_history_s
Definition: input-history.h:54
GIRARA_EVENT_SCROLL_BIDIRECTIONAL
Definition: types.h:189
girara_argument_s
Definition: types.h:152
GIRARA_MOUSE_BUTTON8
Definition: types.h:170
GIRARA_HIGHLIGHT
Definition: types.h:42
girara_inputbar_special_function_t
bool(* girara_inputbar_special_function_t)(girara_session_t *session, const char *input, girara_argument_t *argument)
Definition: types.h:79
UNKNOWN
Definition: types.h:134
GIRARA_EVENT_SCROLL_RIGHT
Definition: types.h:187
GIRARA_MOUSE_BUTTON3
Definition: types.h:165
GIRARA_MOUSE_BUTTON5
Definition: types.h:167
GIRARA_NEXT
Definition: types.h:38
GIRARA_GOTO_START
Definition: types.h:51
girara_mouse_event_s
Definition: internal.h:227
girara_shortcut_s
Definition: internal.h:192
girara_argument_s::data
void * data
Definition: types.h:155
GIRARA_MOUSE_BUTTON4
Definition: types.h:166
girara_event_s
Definition: types.h:200
STRING
Definition: types.h:133
girara_list_iterator_t
struct girara_list_iterator_s girara_list_iterator_t
Definition: types.h:11
girara_list_t
struct girara_list_s girara_list_t
Definition: types.h:10
GIRARA_DELETE_CURR_CHAR
Definition: types.h:50
GiraraInputHistoryIO
struct girara_input_history_io_s GiraraInputHistoryIO
Definition: types.h:208
girara_free_function_t
void(* girara_free_function_t)(void *data)
Definition: types.h:107
GIRARA_EVENT_SCROLL_LEFT
Definition: types.h:186
girara-version.h
girara_event_s::type
girara_event_type_t type
Definition: types.h:202
GIRARA_DELETE_TO_LINE_END
Definition: types.h:49
GIRARA_HIDE
Definition: types.h:37
INT
Definition: types.h:132
GIRARA_PREVIOUS_GROUP
Definition: types.h:41
girara_completion_element_t
struct girara_completion_element_s girara_completion_element_t
Definition: types.h:24
girara_statusbar_item_s
Definition: internal.h:249
GIRARA_EVENT_2BUTTON_PRESS
Definition: types.h:180
GIRARA_MOUSE_BUTTON6
Definition: types.h:168
girara_special_command_s
Definition: internal.h:216
girara_setting_type_t
girara_setting_type_t
Definition: types.h:128