girara
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Data Structures | Macros | Functions
internal.h File Reference
#include "types.h"
#include "macros.h"
#include <glib.h>

Go to the source code of this file.

Data Structures

struct  girara_command_t
struct  girara_mode_string_t
struct  girara_shortcut_mapping_t
struct  girara_argument_mapping_t
struct  girara_shortcut_t
struct  girara_inputbar_shortcut_t
struct  girara_special_command_t
struct  girara_mouse_event_t
struct  girara_config_handle_t

Macros

#define FORMAT_COMMAND   "<b>%s</b>"
#define FORMAT_DESCRIPTION   "<i>%s</i>"
#define UNUSED(x)   GIRARA_UNUSED(x)
#define HIDDEN   GIRARA_HIDDEN
#define LENGTH(x)   (sizeof(x)/sizeof((x)[0]))

Functions

HIDDEN void girara_setting_free (girara_setting_t *setting)
HIDDEN void girara_config_handle_free (girara_config_handle_t *handle)
HIDDEN void girara_shortcut_mapping_free (girara_shortcut_mapping_t *mapping)
HIDDEN void girara_shortcut_free (girara_shortcut_t *shortcut)
HIDDEN void girara_inputbar_shortcut_free (girara_inputbar_shortcut_t *shortcut)
HIDDEN void girara_mode_string_free (girara_mode_string_t *mode)
HIDDEN void girara_statusbar_item_free (girara_statusbar_item_t *statusbaritem)
HIDDEN void girara_argument_mapping_free (girara_argument_mapping_t *argument_mapping)
HIDDEN void girara_special_command_free (girara_special_command_t *special_command)
HIDDEN void girara_command_free (girara_command_t *command)
HIDDEN void girara_mouse_event_free (girara_mouse_event_t *mouse_event)
HIDDEN girara_completion_t * girara_cc_set (girara_session_t *session, const char *input)
HIDDEN bool girara_cmd_map (girara_session_t *session, girara_list_t *argument_list)
HIDDEN bool girara_cmd_unmap (girara_session_t *session, girara_list_t *argument_list)
HIDDEN bool girara_cmd_quit (girara_session_t *session, girara_list_t *argument_list)
HIDDEN bool girara_cmd_set (girara_session_t *session, girara_list_t *argument_list)
HIDDEN bool girara_cmd_exec (girara_session_t *session, girara_list_t *argument_list)

Macro Definition Documentation

#define FORMAT_COMMAND   "<b>%s</b>"

Definition at line 10 of file internal.h.

#define FORMAT_DESCRIPTION   "<i>%s</i>"

Definition at line 11 of file internal.h.

#define HIDDEN   GIRARA_HIDDEN

Definition at line 14 of file internal.h.

#define LENGTH (   x)    (sizeof(x)/sizeof((x)[0]))

Definition at line 16 of file internal.h.

#define UNUSED (   x)    GIRARA_UNUSED(x)

Definition at line 13 of file internal.h.

Function Documentation

HIDDEN void girara_argument_mapping_free ( girara_argument_mapping_t *  argument_mapping)

Definition at line 483 of file shortcuts.c.

HIDDEN girara_completion_t* girara_cc_set ( girara_session_t *  session,
const char *  input 
)

Default complection function for the settings

Parameters
sessionThe used girara session
inputThe current input

Definition at line 197 of file settings.c.

HIDDEN bool girara_cmd_exec ( girara_session_t *  session,
girara_list_t *  argument_list 
)

Execute an external command

  • Parameters
    sessionThe used girara session
    argument_listList of passed arguments
    Returns
    TRUE No error occured
    FALSE An error occured

Definition at line 626 of file commands.c.

HIDDEN bool girara_cmd_map ( girara_session_t *  session,
girara_list_t *  argument_list 
)

Default command to map sortcuts

Parameters
sessionThe used girara session
argument_listList of passed arguments
Returns
TRUE No error occured
FALSE An error occured

Definition at line 398 of file commands.c.

HIDDEN bool girara_cmd_quit ( girara_session_t *  session,
girara_list_t *  argument_list 
)

Default command to quit the application

Parameters
sessionThe used girara session
argument_listList of passed arguments
Returns
TRUE No error occured
FALSE An error occured
HIDDEN bool girara_cmd_set ( girara_session_t *  session,
girara_list_t *  argument_list 
)

Default command to set the value of settings

Parameters
sessionThe used girara session
argument_listList of passed arguments
Returns
TRUE No error occured
FALSE An error occured

Definition at line 422 of file commands.c.

HIDDEN bool girara_cmd_unmap ( girara_session_t *  session,
girara_list_t *  argument_list 
)

Default command to unmap sortcuts

Parameters
sessionThe used girara session
argument_listList of passed arguments
Returns
TRUE No error occured
FALSE An error occured

Definition at line 404 of file commands.c.

HIDDEN void girara_command_free ( girara_command_t *  command)

Definition at line 613 of file commands.c.

HIDDEN void girara_config_handle_free ( girara_config_handle_t *  handle)

Definition at line 39 of file config.c.

HIDDEN void girara_inputbar_shortcut_free ( girara_inputbar_shortcut_t *  shortcut)

Definition at line 143 of file shortcuts.c.

HIDDEN void girara_mode_string_free ( girara_mode_string_t *  mode)

Definition at line 664 of file session.c.

HIDDEN void girara_mouse_event_free ( girara_mouse_event_t *  mouse_event)

Definition at line 549 of file shortcuts.c.

HIDDEN void girara_setting_free ( girara_setting_t *  setting)

Free girara_setting_t struct

Parameters
settingThe setting to free.

Definition at line 153 of file settings.c.

HIDDEN void girara_shortcut_free ( girara_shortcut_t *  shortcut)

Definition at line 87 of file shortcuts.c.

HIDDEN void girara_shortcut_mapping_free ( girara_shortcut_mapping_t *  mapping)

Definition at line 446 of file shortcuts.c.

HIDDEN void girara_special_command_free ( girara_special_command_t *  special_command)

Definition at line 604 of file commands.c.

HIDDEN void girara_statusbar_item_free ( girara_statusbar_item_t *  statusbaritem)

Definition at line 54 of file statusbar.c.