psyc-mirrors/libpsyc
1
0
Fork 0
mirror of git://git.psyc.eu/libpsyc synced 2024-08-15 03:19:02 +00:00
Code Issues Releases Wiki Activity

Explain a little more that the functions don't allocate memory

Browse source
This commit is contained in:
Marenz 2011-05-09 00:39:41 +02:00
parent ba3053c908
commit ebd4e77962
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
include/psyc/parser.h
View file

@ -179,6 +179,9 @@ void psyc_initParseState2 (psycParseState *state, uint8_t flags)
/** /**
* Sets a new buffer in the parser state struct with data to be parsed. * Sets a new buffer in the parser state struct with data to be parsed.
* *
* This function does NOT copy the buffer. It will parse whatever is
* at the memory pointed to by buffer.
*
* @param state Pointer to the initialized state of the parser * @param state Pointer to the initialized state of the parser
* @param buffer the buffer that should be parsed now * @param buffer the buffer that should be parsed now
* @see psycString * @see psycString
@ -199,6 +202,9 @@ void psyc_setParseBuffer (psycParseState *state, psycString buffer)
/** /**
* Sets a new buffer in the parser state struct with data to be parsed. * Sets a new buffer in the parser state struct with data to be parsed.
* *
* This function does NOT copy the buffer. It will parse whatever is
* at the memory pointed to by buffer.
*
* @param state Pointer to the initialized state of the parser * @param state Pointer to the initialized state of the parser
* @param buffer pointer to the data that should be parsed * @param buffer pointer to the data that should be parsed
* @param length length of the data in bytes * @param length length of the data in bytes
@ -292,6 +298,8 @@ const char * psyc_getParseRemainingBuffer (psycParseState *state)
* *
* Generalized line-based packet parser. * Generalized line-based packet parser.
* *
* This function will never allocate heap memory.
*
* @param state An initialized psycParseState * @param state An initialized psycParseState
* @param oper A pointer to a character. In case of a variable, it will * @param oper A pointer to a character. In case of a variable, it will
* be set to the operator of that variable * be set to the operator of that variable