NMEAutolink.h File Reference

NME optional automatic link recognition (CamelCase and URL) More...

#include "NME.h"

Go to the source code of this file.

Defines
#define	NMEAutoconvertCamelCaseEntry   {NMEAutoconvertCamelCase, NULL}
	NMEAutoconvertCamelCase entry for table of NMEAutoconvert.
#define	NMEAutoconvertURLEntry   {NMEAutoconvertURL, NULL}
	NMEAutoconvertURL entry for table of NMEAutoconvert.
Functions
NMEBoolean	NMEAutoconvertCamelCase (NMEConstText src, NMEInt srcLen, NMEInt *i, NMEContext *context, void *userData)
	Autoconvert implementation for camelCase words.
NMEBoolean	NMEAutoconvertURL (NMEConstText src, NMEInt srcLen, NMEInt *i, NMEContext *context, void *userData)
	Autoconvert implementation for URLs.

---

Detailed Description

NME optional automatic link recognition (CamelCase and URL)

Author:

Yves Piguet.

Copyright:

2007-2013, Yves Piguet.

To convert camelCase words to links (i.e. transform any word with at least one uppercase letter following a lowercase letter, such as camelCase, to a link as if it were enclosed between double-brackets, as [[camelCase]]), add NMEAutoconvertCamelCaseEntry to the table autoconverts[] in NMEOutputFormat. To convert URLs to links (i.e. transform any sequence beginning with http://, https://, ftp:// or mailto: to a link as if it were enclosed between double-brackets), add NMEAutoconvertURLEntry to the table autoconverts[] in NMEOutputFormat. To have both:

    NMEAutoconvert const autoconverts[] =
    {
        NMEAutoconvertCamelCaseEntry,
        NMEAutoconvertURLEntry,
        NMEAutoconvertTableEnd
    };
    NMEOutputFormat f = NMEOutputFormatHTML;
    f.autoconverts = autoconverts;
    ... NMEProcess(..., &f, ...);

Definition in file NMEAutolink.h.

---

Function Documentation

NMEBoolean NMEAutoconvertCamelCase	(	NMEConstText	src,
		NMEInt	srcLen,
		NMEInt *	i,
		NMEContext *	context,
		void *	userData
	)

Autoconvert implementation for camelCase words.

Parameters:

[in]	src	source text with markup
[in]	srcLen	source text length
[in,out]	i	index in src (token to parse on input, next token on output)
[in,out]	context	current context
[in]	userData	pointer passed from the parser, as specified in NMEAutoconvert

Returns:

TRUE for conversion, else FALSE

Definition at line 18 of file NMEAutolink.c.

NMEBoolean NMEAutoconvertURL	(	NMEConstText	src,
		NMEInt	srcLen,
		NMEInt *	i,
		NMEContext *	context,
		void *	userData
	)

Autoconvert implementation for URLs.

Parameters:

[in]	src	source text with markup
[in]	srcLen	source text length
[in,out]	i	index in src (token to parse on input, next token on output)
[in,out]	context	current context
[in]	userData	pointer passed from the parser, as specified in NMEAutoconvert

Returns:

TRUE for conversion, else FALSE

Definition at line 53 of file NMEAutolink.c.