Atrinik Client  4.0
Functions | Variables
help.c File Reference
#include <global.h>
#include <toolkit/string.h>

Go to the source code of this file.

Functions

static void hfile_free (hfile_struct *hfile)
 
void hfiles_deinit (void)
 
void hfiles_init (void)
 
hfile_structhelp_find (const char *name)
 
void help_show (const char *name)
 
static int command_match_cmp (const void *a, const void *b)
 
void help_handle_tabulator (text_input_struct *text_input)
 

Variables

static hfile_structhfiles = NULL
 
static UT_array * command_matches = NULL
 
static size_t command_index = 0
 
static char command_buf [HUGE_BUF]
 

Detailed Description

Handles help files.

Author
Alex Tokar

Definition in file help.c.

Function Documentation

static int command_match_cmp ( const void *  a,
const void *  b 
)
static

Comparison function used in help_handle_tabulator().

Definition at line 241 of file help.c.

hfile_struct* help_find ( const char *  name)

Find a help file by its name.

Parameters
nameName of the help file to find.
Returns
Help file if found, NULL otherwise.

Definition at line 205 of file help.c.

void help_handle_tabulator ( text_input_struct text_input)

Handle tabulator key in console text input.

Definition at line 249 of file help.c.

void help_show ( const char *  name)

Show a help GUI.

Parameters
nameName of the help file entry to show.

Definition at line 219 of file help.c.

static void hfile_free ( hfile_struct hfile)
static

Free a help file structure.

Definition at line 56 of file help.c.

void hfiles_deinit ( void  )

Frees the hfiles hashtable.

Definition at line 70 of file help.c.

void hfiles_init ( void  )

Read help files from file.

Definition at line 89 of file help.c.

Variable Documentation

char command_buf[HUGE_BUF]
static

Last console string cache.

Definition at line 51 of file help.c.

size_t command_index = 0
static

Index in command_matches to add to text input on the next tabulator key press.

Definition at line 47 of file help.c.

UT_array* command_matches = NULL
static

Array of command matches in console text input.

Definition at line 42 of file help.c.

hfile_struct* hfiles = NULL
static

Hashtable that contains the help files.

Definition at line 38 of file help.c.