/usr/include/girara/types.h is in libgirara-dev 0.2.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 | /* See LICENSE file for license and copyright information */
#ifndef GIRARA_TYPES_H
#define GIRARA_TYPES_H
#include "version.h"
#include <stdbool.h>
typedef struct girara_tree_node_s girara_tree_node_t;
typedef struct girara_list_s girara_list_t;
typedef struct girara_list_iterator_s girara_list_iterator_t;
typedef struct girara_setting_s girara_setting_t;
typedef struct girara_session_s girara_session_t;
typedef struct girara_session_private_s girara_session_private_t;
typedef struct girara_command_s girara_command_t;
typedef struct girara_mouse_event_s girara_mouse_event_t;
typedef struct girara_config_handle_s girara_config_handle_t;
typedef struct girara_mode_string_s girara_mode_string_t;
typedef struct girara_tab_s girara_tab_t;
typedef struct girara_statusbar_item_s girara_statusbar_item_t;
typedef struct girara_argument_s girara_argument_t;
typedef struct girara_shortcut_mapping_s girara_shortcut_mapping_t;
typedef struct girara_argument_mapping_s girara_argument_mapping_t;
typedef struct girara_completion_element_s girara_completion_element_t;
typedef struct girara_completion_s girara_completion_t;
typedef struct girara_completion_group_s girara_completion_group_t;
typedef struct girara_shortcut_s girara_shortcut_t;
typedef struct girara_inputbar_shortcut_s girara_inputbar_shortcut_t;
typedef struct girara_special_command_s girara_special_command_t;
typedef struct girara_event_s girara_event_t;
/**
* This structure defines the possible argument identifiers
*/
enum
{
GIRARA_HIDE = 1, /**< Hide the completion list */
GIRARA_NEXT, /**< Next entry */
GIRARA_PREVIOUS, /**< Previous entry */
GIRARA_NEXT_GROUP, /**< Next group in the completion list */
GIRARA_PREVIOUS_GROUP, /**< Previous group in the completion list */
GIRARA_HIGHLIGHT, /**< Highlight the entry */
GIRARA_NORMAL, /**< Set to the normal state */
GIRARA_DELETE_LAST_WORD, /**< Delete the last word */
GIRARA_DELETE_LAST_CHAR, /**< Delete the last character */
GIRARA_NEXT_CHAR, /**< Go to the next character */
GIRARA_PREVIOUS_CHAR, /**< Go to the previous character */
GIRARA_DELETE_TO_LINE_START, /**< Delete the line to the start */
GIRARA_DELETE_TO_LINE_END, /**< Delete the line to the end */
GIRARA_DELETE_CURR_CHAR, /**< Delete current char */
GIRARA_GOTO_START, /**< Go to start of the line */
GIRARA_GOTO_END /**< Go to end of the line */
};
/**
* Debug levels
*/
typedef enum girara_debug_level_e
{
GIRARA_DEBUG, /**> Debug messages */
GIRARA_INFO, /**> Information debug output */
GIRARA_WARNING, /**> Warning level */
GIRARA_ERROR /**> Error */
} girara_debug_level_t;
/**
* Mode identifier
*/
typedef int girara_mode_t;
/**
* Function declaration of a function that generates a completion group
*
* @param session The current girara session
* @param input The current input
* @return The completion group
*/
typedef girara_completion_t* (*girara_completion_function_t)(
girara_session_t* session, const char* input);
/**
* Function declaration of a inputbar special function
*
* @param session The current girara session
* @param input The current input
* @param argument The given argument
* @return TRUE No error occured
* @return FALSE Error occured
*/
typedef bool (*girara_inputbar_special_function_t)(girara_session_t* session,
const char* input, girara_argument_t* argument);
/**
* Function declaration of a command function
*
* @param session The current girara session
* @param argc Number of arguments
* @param argv Arguments
*/
typedef bool (*girara_command_function_t)(girara_session_t* session,
girara_list_t* argument_list);
/**
* Function declaration of a shortcut function
*
* If a numeric value has been written into the buffer, this function gets as
* often executed as the value defines or until the function returns false the
* first time.
*/
typedef bool (*girara_shortcut_function_t)(girara_session_t*,
girara_argument_t*, girara_event_t*, unsigned int);
/**
* Function declaration of a function that frees something.
*
* @param data the data to be freed.
*/
typedef void (*girara_free_function_t)(void* data);
/** Function declaration of a function called as callback from girara_list_*
* functions.
*
* @param data a list element.
* @param userdata data passed as userdata to the calling function.
*/
typedef void (*girara_list_callback_t)(void* data, void* userdata);
/** Function declaration of a function which compares two elements.
*
* @param data1 the first element.
* @param data2 the second element.
* @return -1 if data1 < data2, 0 if data1 == data2 and 1 if data1 > data2
*/
typedef int (*girara_compare_function_t)(const void* data1, const void* data2);
/**
* This structure defines the possible types that a setting value can have
*/
typedef enum girara_setting_type_e
{
BOOLEAN, /**< Boolean type */
FLOAT, /**< Floating number */
INT, /**< Integer */
STRING, /**< String */
UNKNOWN = 0xFFFF /**< Unknown type */
} girara_setting_type_t;
/**
* Function declaration for a settings callback
*
* @param session The current girara session
* @param name The name of the affected settting
* @param type The type of the affected setting
* @param value Pointer to the new value
* @param data User data
*/
typedef void (*girara_setting_callback_t)(girara_session_t* session,
const char* name, girara_setting_type_t type, void* value, void* data);
/**
* Definition of an argument of a shortcut or buffered command
*/
struct girara_argument_s
{
int n; /**< Identifier */
void *data; /**< Data */
};
/**
* Define mouse buttons
*/
typedef enum girara_mouse_button_e
{
GIRARA_MOUSE_BUTTON1 = 1, /**< Button 1 */
GIRARA_MOUSE_BUTTON2 = 2, /**< Button 2 */
GIRARA_MOUSE_BUTTON3 = 3, /**< Button 3 */
GIRARA_MOUSE_BUTTON4 = 4, /**< Button 4 */
GIRARA_MOUSE_BUTTON5 = 5, /**< Button 5 */
GIRARA_MOUSE_BUTTON6 = 6, /**< Button 6 */
GIRARA_MOUSE_BUTTON7 = 7, /**< Button 7 */
GIRARA_MOUSE_BUTTON8 = 8, /**< Button 8 */
GIRARA_MOUSE_BUTTON9 = 9 /**< Button 9 */
} girara_mouse_button_t;
/**
* Describes the types of a girara
*/
typedef enum girara_event_type_e
{
GIRARA_EVENT_BUTTON_PRESS, /**< Single click */
GIRARA_EVENT_2BUTTON_PRESS, /**< Double click */
GIRARA_EVENT_3BUTTON_PRESS, /**< Triple click */
GIRARA_EVENT_BUTTON_RELEASE, /**< Button released */
GIRARA_EVENT_MOTION_NOTIFY, /**< Cursor moved */
GIRARA_EVENT_SCROLL_UP, /**< Scroll event */
GIRARA_EVENT_SCROLL_DOWN, /**< Scroll event */
GIRARA_EVENT_SCROLL_LEFT, /**< Scroll event */
GIRARA_EVENT_SCROLL_RIGHT, /**< Scroll event */
GIRARA_EVENT_OTHER, /**< Unknown event */
GIRARA_EVENT_SCROLL_BIDIRECTIONAL /**< Scroll event that carries extra data
* in girara_argument_t with motion
* information as double[2].
* First component is horizontal shift,
* second - vertical.
*/
} girara_event_type_t;
/**
* Describes a girara event
*/
struct girara_event_s
{
girara_event_type_t type; /**< The event type */
double x; /**< X coordinates where the event occured */
double y; /**< Y coordinates where the event occured */
};
typedef struct girara_input_history_io_s GiraraInputHistoryIO;
typedef struct girara_input_history_io_interface_s GiraraInputHistoryIOInterface;
typedef struct girara_input_history_s GiraraInputHistory;
typedef struct girara_input_history_class_s GiraraInputHistoryClass;
typedef struct girara_template_s GiraraTemplate;
typedef struct girara_template_class_s GiraraTemplateClass;
#endif
|