#include "version.h"
#include <stdbool.h>
Go to the source code of this file.
Typedefs |
typedef int | girara_mode_t |
typedef girara_completion_t *(* | girara_completion_function_t )(girara_session_t *session, const char *input) |
typedef bool(* | girara_inputbar_special_function_t )(girara_session_t *session, const char *input, girara_argument_t *argument) |
typedef bool(* | girara_command_function_t )(girara_session_t *session, girara_list_t *argument_list) |
typedef bool(* | girara_shortcut_function_t )(girara_session_t *, girara_argument_t *, girara_event_t *, unsigned int) |
typedef void(* | girara_free_function_t )(void *data) |
typedef void(* | girara_list_callback_t )(void *data, void *userdata) |
typedef int(* | girara_compare_function_t )(const void *data1, const void *data2) |
typedef void(* | girara_setting_callback_t )(girara_session_t *session, const char *name, girara_setting_type_t type, void *value, void *data) |
Enumerations |
enum | {
GIRARA_HIDE = 1,
GIRARA_NEXT,
GIRARA_PREVIOUS,
GIRARA_NEXT_GROUP,
GIRARA_PREVIOUS_GROUP,
GIRARA_HIGHLIGHT,
GIRARA_NORMAL,
GIRARA_DELETE_LAST_WORD,
GIRARA_DELETE_LAST_CHAR,
GIRARA_NEXT_CHAR,
GIRARA_PREVIOUS_CHAR,
GIRARA_DELETE_TO_LINE_START,
GIRARA_DELETE_TO_LINE_END,
GIRARA_DELETE_CURR_CHAR,
GIRARA_GOTO_START,
GIRARA_GOTO_END
} |
enum | girara_debug_level_t { GIRARA_INFO,
GIRARA_WARNING,
GIRARA_DEBUG,
GIRARA_ERROR
} |
enum | girara_setting_type_t {
BOOLEAN,
FLOAT,
INT,
STRING,
UNKNOWN = 0xFFFF
} |
enum | girara_mouse_button_t {
GIRARA_MOUSE_BUTTON1 = 1,
GIRARA_MOUSE_BUTTON2 = 2,
GIRARA_MOUSE_BUTTON3 = 3,
GIRARA_MOUSE_BUTTON4 = 4,
GIRARA_MOUSE_BUTTON5 = 5,
GIRARA_MOUSE_BUTTON6 = 6,
GIRARA_MOUSE_BUTTON7 = 7,
GIRARA_MOUSE_BUTTON8 = 8,
GIRARA_MOUSE_BUTTON9 = 9
} |
enum | girara_event_type_t {
GIRARA_EVENT_BUTTON_PRESS,
GIRARA_EVENT_2BUTTON_PRESS,
GIRARA_EVENT_3BUTTON_PRESS,
GIRARA_EVENT_BUTTON_RELEASE,
GIRARA_EVENT_MOTION_NOTIFY,
GIRARA_EVENT_SCROLL_UP,
GIRARA_EVENT_SCROLL_DOWN,
GIRARA_EVENT_SCROLL_LEFT,
GIRARA_EVENT_SCROLL_RIGHT,
GIRARA_EVENT_OTHER
} |
Typedef Documentation
typedef bool(* girara_command_function_t)(girara_session_t *session, girara_list_t *argument_list) |
Function declaration of a command function
- Parameters
-
session | The current girara session |
argc | Number of arguments |
argv | Arguments |
Definition at line 99 of file types.h.
typedef int(* girara_compare_function_t)(const void *data1, const void *data2) |
Function declaration of a function which compares two elements.
- Parameters
-
data1 | the first element. |
data2 | the second element. |
- Returns
- -1 if data1 < data2, 0 if data1 == data2 and 1 if data1 > data2
Definition at line 133 of file types.h.
typedef girara_completion_t*(* girara_completion_function_t)(girara_session_t *session, const char *input) |
Function declaration of a function that generates a completion group
- Parameters
-
session | The current girara session |
input | The current input |
- Returns
- The completion group
Definition at line 77 of file types.h.
typedef void(* girara_free_function_t)(void *data) |
Function declaration of a function that frees something.
- Parameters
-
data | the data to be freed. |
Definition at line 117 of file types.h.
typedef bool(* girara_inputbar_special_function_t)(girara_session_t *session, const char *input, girara_argument_t *argument) |
Function declaration of a inputbar special function
- Parameters
-
session | The current girara session |
input | The current input |
argument | The given argument |
- Returns
- TRUE No error occured
-
FALSE Error occured
Definition at line 89 of file types.h.
typedef void(* girara_list_callback_t)(void *data, void *userdata) |
Function declaration of a function called as callback from girara_list_* functions.
- Parameters
-
data | a list element. |
userdata | data passed as userdata to the calling function. |
Definition at line 125 of file types.h.
Mode identifier
Definition at line 68 of file types.h.
typedef void(* girara_setting_callback_t)(girara_session_t *session, const char *name, girara_setting_type_t type, void *value, void *data) |
Function declaration for a settings callback
- Parameters
-
session | The current girara session |
name | The name of the affected settting |
type | The type of the affected setting |
value | Pointer to the new value |
data | User data |
Definition at line 156 of file types.h.
typedef bool(* girara_shortcut_function_t)(girara_session_t *, girara_argument_t *, girara_event_t *, unsigned int) |
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.
Definition at line 109 of file types.h.
Enumeration Type Documentation
This structure defines the possible argument identifiers
- Enumerator:
GIRARA_HIDE |
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
|
Definition at line 34 of file types.h.
Debug levels
- Enumerator:
GIRARA_INFO |
|
GIRARA_WARNING |
Information debug output
|
GIRARA_DEBUG |
Warning level
|
GIRARA_ERROR |
Debug messages
Error
|
Definition at line 57 of file types.h.
Describes the types of a girara
- Enumerator:
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
|
Definition at line 187 of file types.h.
Define mouse buttons
- Enumerator:
GIRARA_MOUSE_BUTTON1 |
Button 1
|
GIRARA_MOUSE_BUTTON2 |
Button 2
|
GIRARA_MOUSE_BUTTON3 |
Button 3
|
GIRARA_MOUSE_BUTTON4 |
Button 4
|
GIRARA_MOUSE_BUTTON5 |
Button 5
|
GIRARA_MOUSE_BUTTON6 |
Button 6
|
GIRARA_MOUSE_BUTTON7 |
Button 7
|
GIRARA_MOUSE_BUTTON8 |
Button 8
|
GIRARA_MOUSE_BUTTON9 |
Button 9
|
Definition at line 171 of file types.h.
This structure defines the possible types that a setting value can have
- Enumerator:
BOOLEAN |
Boolean type
|
FLOAT |
Floating number
|
INT |
Integer
|
STRING |
String
|
UNKNOWN |
Unknown type
|
Definition at line 138 of file types.h.