roxml_buff.c File Reference

buffer XML document backend More...

#include "roxml_core.h"
#include "roxml_parser.h"
#include "roxml_internal.h"

Go to the source code of this file.

Functions
ROXML_INT int	roxml_read_buff (int pos, int size, char *buffer, node_t *node)
	read xml doc function
ROXML_INT void	roxml_close_buff (node_t *n)
	unload function
ROXML_INT int	roxml_parse_buff (roxml_load_ctx_t *context, roxml_parser_item_t *parser, char *buffer)
	generic load function
ROXML_API node_t *	roxml_load_buf (char *buffer)
	load function for buffers

Detailed Description

buffer XML document backend

(C) Copyright 2014 Tristan Lelong trist.nosp@m.an.l.nosp@m.elong.nosp@m.@lib.nosp@m.roxml.nosp@m..net

SPDX-Licence-Identifier: LGPL-2.1+ The author added a static linking exception, see License.txt.

Definition in file roxml_buff.c.

Function Documentation

roxml_close_buff()

void roxml_close_buff

(

node_t *

n

)

unload function

This function clear a document that was opened as part of a buffer

Parameters

n	is any node of the tree to be cleaned

Returns

void

Definition at line 29 of file roxml_buff.c.

roxml_load_buf()

node_t * roxml_load_buf

(

char *

buffer

)

load function for buffers

This function load a document by parsing all the corresponding nodes. The document must be contained inside the char * buffer given in parameter and remain valid until the roxml_close() function is called

Parameters

buffer

the XML buffer to load

Returns

the root node or ROXML_INVALID_DOC (NULL). errno is set to EINVAL in case of parsing error

See also

roxml_close

roxml_load_fd

roxml_load_doc

Definition at line 47 of file roxml_buff.c.

roxml_parse_buff()

node_t * roxml_parse_buff	(	roxml_load_ctx_t *	context,
		roxml_parser_item_t *	parser,
		char *	buffer
	)

generic load function

This function parse a buffer document and all the corresponding nodes

Parameters

context	internal data used for parsing
parser	the parser object to run
buffer	address of buffer that contains xml

Returns

an error code and filled context see roxml_close_buff

Definition at line 34 of file roxml_buff.c.

roxml_read_buff()

roxml_read_buff	(	int	pos,
		int	size,
		char *	buffer,
		node_t *	node
	)

read xml doc function

this function read inside a xml buffer and fill the given buffer

Parameters

pos	the pos in the xml document
size	the size of the data to read
buffer	the destination buffer
node	the node that belong to the tree we want to read to

Returns

the number of bytes read

Definition at line 16 of file roxml_buff.c.