generatedoc.c File Reference

HTML doc generator. More...

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "global.h"
#include "hotkeys.h"
#include "helpfile.h"
#include "keyboard.h"
#include "windows.h"
#include "init_buttons.h"

Include dependency graph for generatedoc.c:

Macros
#define	Init_button(btn, tooltip, x_offset, y_offset, width, height, shape, left_action, right_action, left_instant, right_instant, unselect_action, family)

Functions
static int	Export_help (const char *path)
	Export the help to HTML files. More...
static int	fputs_utf8 (const char *str, size_t len, FILE *f)
	Convert from latin1 to utf-8. More...
int	main (int argc, char *argv[])
static word *	Find_default_shortcut (word shortcut_number)
	similar to Shortcut() from help.c, but relying only on default shortcuts More...
static const char *	Keyboard_default_shortcut (word shortcut_number)
	Similar to Keyboard_shortcut_value() from help.c, but relying only on default shortcuts. More...
static void	Print_button (FILE *f, int btn)
static const char *	Export_help_table (FILE *f, unsigned int page)

Variables
static T_Toolbar_button	Buttons [NB_BUTTONS]
const char *const	skins []
	available skins More...

Detailed Description

HTML doc generator.

Macro Definition Documentation

Init_button

#define Init_button	(		btn,
			tooltip,
			x_offset,
			y_offset,
			width,
			height,
			shape,
			left_action,
			right_action,
			left_instant,
			right_instant,
			unselect_action,
			family
	)

Value:

        Buttons[btn].Tooltip = tooltip; \
        Buttons[btn].X_offset = x_offset; \
        Buttons[btn].Y_offset = y_offset; \
        Buttons[btn].Width = width; \
        Buttons[btn].Height = height; \
        Buttons[btn].Shape = shape; \
        Buttons[btn].Family = family;

Function Documentation

Export_help()

static int Export_help ( const char *  path )

static

Export the help to HTML files.

References Buttons, Export_help_table(), Help_section, NULL, Print_button(), and skins.

Referenced by main().

fputs_utf8()

static int fputs_utf8 ( const char *  str, size_t  len, FILE *  f  )

static

Convert from latin1 to utf-8.

Referenced by Export_help_table().

main()

int main	(	int	argc,
		char *	argv[]
	)

References Export_help().

Find_default_shortcut()

static word * Find_default_shortcut ( word  shortcut_number )

static

similar to Shortcut() from help.c, but relying only on default shortcuts

References ConfigKey, T_Key_config::Key, NB_SHORTCUTS, NULL, and Ordering.

Referenced by Keyboard_default_shortcut().

Keyboard_default_shortcut()

static const char * Keyboard_default_shortcut ( word  shortcut_number )

static

Similar to Keyboard_shortcut_value() from help.c, but relying only on default shortcuts.

References Find_default_shortcut(), Key_name(), and NULL.

Referenced by Export_help_table().

Print_button()

static void Print_button ( FILE *  f, int  btn  )

static

References BUTTON_ANIM_PLAY, BUTTON_HIDE, BUTTON_LAYER_SELECT, Buttons, NB_BUTTONS, T_Toolbar_button::X_offset, and T_Toolbar_button::Y_offset.

Referenced by Export_help(), and Export_help_table().

Export_help_table()

static const char * Export_help_table ( FILE *  f, unsigned int  page  )

static

References Buttons, fputs_utf8(), Help_section, T_Help_section::Help_table, Keyboard_default_shortcut(), T_Help_section::Length, NB_BUTTONS, NULL, Print_button(), and T_Help_table::Text.

Referenced by Export_help().

Variable Documentation

Buttons

T_Toolbar_button Buttons[NB_BUTTONS]

static

Referenced by Export_help(), Export_help_table(), and Print_button().

skins

const char* const skins[]

Initial value:

= {
  "classic",
  "modern",
  "DPaint",
  "scenish",
  "Aurora",
  "chrisfx",
  "black",
  "klin",
  NULL
}

available skins

Referenced by Export_help().