gp_markup_parser.h File Reference

A markup parsers. More...

#include <utils/gp_markup.h>

Go to the source code of this file.

Enumerations
enum	gp_markup_fmt { GP_MARKUP_PLAINTEXT , GP_MARKUP_GFXPRIM , GP_MARKUP_HTML }
	Markup format to parse. More...
enum	gp_markup_html_flags { GP_MARKUP_HTML_KEEP_WS = 0x01 }

Functions
gp_markup *	gp_markup_parse (enum gp_markup_fmt fmt, const char *markup, enum gp_markup_flags flags)
	Parsers a markup string.
gp_markup *	gp_markup_plaintext_parse (const char *markup, enum gp_markup_flags flags)
	Parses a plaintext markup.
gp_markup *	gp_markup_gfxprim_parse (const char *markup, enum gp_markup_flags flags)
	Parses a gfxprim markup.
gp_markup *	gp_markup_html_parse (const char *markup, enum gp_markup_flags flags)
	Parses a HTML markup.
void	gp_markup_free (gp_markup *self)
	Frees a markup.

Detailed Description

A markup parsers.

Definition in file gp_markup_parser.h.

Enumeration Type Documentation

gp_markup_fmt

enum gp_markup_fmt

Markup format to parse.

Enumerator
GP_MARKUP_PLAINTEXT	An UTF-8 text without any formatting
GP_MARKUP_GFXPRIM	A GFXprim markup
GP_MARKUP_HTML	A small subset of HTML

Definition at line 19 of file gp_markup_parser.h.

gp_markup_html_flags

enum gp_markup_html_flags

HTML parser markup flags.

Enumerator
GP_MARKUP_HTML_KEEP_WS	Keep whitespaces Some HTML like markup languages only use tags for text size/color and expect whitespaces to be kept, such as Pango markup or XDXF.

Definition at line 65 of file gp_markup_parser.h.

Function Documentation

gp_markup_free()

void gp_markup_free

(

gp_markup *

self

)

Frees a markup.

Parameters

markup

A parsed markup.

gp_markup_gfxprim_parse()

gp_markup * gp_markup_gfxprim_parse	(	const char *	markup,
		enum gp_markup_flags	flags
	)

Parses a gfxprim markup.

Parameters

markup	A string with a markup.
flags	Flags passed to markup parser.

Returns

A parsed markup or NULL in a case of a failure.

gp_markup_html_parse()

gp_markup * gp_markup_html_parse	(	const char *	markup,
		enum gp_markup_flags	flags
	)

Parses a HTML markup.

Parameters

markup	A string with a markup.
flags	A flags passed to markup parser.

Returns

A parsed markup or NULL in a case of a failure.

gp_markup_parse()

gp_markup * gp_markup_parse	(	enum gp_markup_fmt	fmt,
		const char *	markup,
		enum gp_markup_flags	flags
	)

Parsers a markup string.

Parameters

fmt	A markup format.
markup	A string with a markup.
flags	A flags passed to markup parser.

Returns

A parsed markup or NULL in a case of a failure.

gp_markup_plaintext_parse()

gp_markup * gp_markup_plaintext_parse	(	const char *	markup,
		enum gp_markup_flags	flags
	)

Parses a plaintext markup.

Parameters

markup	A string with a markup.
flags	Flags passed to markup parser.

Returns

A parsed markup or NULL in a case of a failure.