libpsyc/include/psyc/parser.h

/**
 * @file psyc/parser.h
 * @brief Interface for various psyc parser functions.
 *
 * All parsing functions and the definitions they use are
 * defined in this file.
*/

/**
 * @defgroup parsing Parsing Functions
 *
 * This module contains all parsing functions.
 * @{
 */

#ifndef PSYC_PARSER_H
# define PSYC_PARSER_H

#include <stdint.h>
#include <string.h>

/**
 * Different types that a variable can have.
 *
 * This enum lists PSYC variable types that
 * this library is capable of checking for
 * validity. Other variable types are treated
 * as opaque data.
 */
typedef enum {
	PSYC_TYPE_AMOUNT,
	PSYC_TYPE_COLOR,
	PSYC_TYPE_DATE,
	PSYC_TYPE_DEGREE,
	PSYC_TYPE_ENTITY,
	PSYC_TYPE_FLAG,
	PSYC_TYPE_LANGUAGE,
	PSYC_TYPE_LIST,
	PSYC_TYPE_NICK,
	PSYC_TYPE_PAGE,
	PSYC_TYPE_UNIFORM,
	PSYC_TYPE_TIME,
} PSYC_Type;

typedef enum
{
	PSYC_HEADER_ONLY = 1,
} PSYC_Flag;

/**
 * The return value definitions for the packet parsing function.
 * @see PSYC_parse()
 */
typedef enum
{
	PSYC_ERROR_END = -7,
	PSYC_ERROR_METHOD = -6,
	PSYC_ERROR_VAR_LEN = -5,
	PSYC_ERROR_VAR_TAB = -4,
	PSYC_ERROR_VAR_NAME = -3,
	PSYC_ERROR_LENGTH = -2,
	PSYC_ERROR = -1,
	PSYC_SUCCESS = 0,
	PSYC_INSUFFICIENT = 1,
/// Routing variable parsing done. Modifier, name & value contains the respective parts.
	PSYC_ROUTING = 2,
/// Entity variable parsing done. Modifier, name & value contains the respective parts.
	PSYC_ENTITY = 3,
/// Entity variable parsing is incomplete. Modifier & name are complete, value is incomplete.
	PSYC_ENTITY_INCOMPLETE = 4,
/// Body parsing done, name contains method, value contains body.
	PSYC_BODY = 5,
/// Body parsing is incomplete, name contains method, value contains part of the body.
	PSYC_BODY_INCOMPLETE = 6,
/// Reached end of packet, parsing done.
	PSYC_COMPLETE = 7,
// Binary value parsing incomplete, used internally.
	PSYC_INCOMPLETE = 8,
} PSYC_ReturnCode;

/**
 * The return value definitions for the list parsing function.
 * @see PSYC_parseList()
 */
typedef enum
{
	PSYC_ERROR_LIST_DELIM = -5,
	PSYC_ERROR_LIST_LEN = -4,
	PSYC_ERROR_LIST_TYPE = -3,
	PSYC_ERROR_LIST_NAME = -2,
	PSYC_ERROR_LIST= -1,
	PSYC_LIST_ELEM = 1,
	PSYC_LIST_END = 2,
	PSYC_LIST_INCOMPLETE = 3,
} PSYC_ListReturnCode;

/**
 * PSYC packet parts.
 */
typedef enum
{
	PSYC_PART_RESET = -1,
	PSYC_PART_HEADER = 0,
	PSYC_PART_LENGTH,
	PSYC_PART_CONTENT,
	PSYC_PART_METHOD,
	PSYC_PART_DATA,
	PSYC_PART_END,
} PSYC_Part;

/**
 * List types.
 * Possible types are text and binary.
 */
typedef enum
{
	PSYC_LIST_TEXT = 1,
	PSYC_LIST_BINARY = 2,
} PSYC_ListType;

typedef struct
{
	size_t length;
	const uint8_t * ptr; // just an unsigned char for opaque data
} PSYC_Array;

/**
 * Struct for keeping parser state.
 */
typedef struct
{
	size_t cursor; ///< current position in buffer
	size_t startc; ///< line start position
	PSYC_Array buffer;
	uint8_t flags;
	PSYC_Part part; ///< part of the packet being parsed currently

	size_t contentParsed; ///< number of bytes parsed from the content so far
	size_t contentLength; ///< expected length of the content
	char contentLengthFound; ///< is there a length given for this packet?
	size_t valueParsed; ///< number of bytes parsed from the value so far
	size_t valueLength; ///< expected length of the value
} PSYC_State;

/**
 * Struct for keeping list parser state.
 */
typedef struct
{
	size_t cursor; ///< current position in buffer
	size_t startc; ///< line start position
	PSYC_Array buffer;
	PSYC_ListType type; ///< list type

	size_t elemParsed; ///< number of bytes parsed from the elem so far
	size_t elemLength; ///< expected length of the elem
} PSYC_ListState;

#ifndef PSYC_COMPILE_LIBRARY
/**
 * Shortcut for creating an array.
 *
 * @param memory Pointer to the buffer.
 * @param length Length of that buffer.
 *
 * @return An instance of the PSYC_Array struct.
 */
inline PSYC_Array PSYC_createArray (uint8_t* const memory, size_t length)
{
	PSYC_Array arr = {length, memory};
	return arr;
}

/**
 * Initiates the state struct with flags.
 *
 * @param state Pointer to the state struct that should be initiated.
 * @param flags The flags that one ones to set, see PSYC_Flag.
 */
inline void PSYC_initState2 (PSYC_State* state, uint8_t flags )
{
	memset(state, 0, sizeof(PSYC_State));
	state->flags = flags;
}

/**
 * Initiates the state struct.
 *
 * @param state Pointer to the state struct that should be initiated.
 */
inline void PSYC_initState (PSYC_State* state)
{
	memset(state, 0, sizeof(PSYC_State));
}

/**
 * Initiates the list state struct.
 *
 * @param state Pointer to the list state struct that should be initiated.
 */
inline void PSYC_initListState (PSYC_ListState* state)
{
	memset(state, 0, sizeof(PSYC_ListState));
}

inline void PSYC_nextBuffer (PSYC_State* state, PSYC_Array newBuf)
{
	state->buffer = newBuf;
	state->cursor = 0;
}

inline void PSYC_nextListBuffer (PSYC_ListState* state, PSYC_Array newBuf)
{
	state->buffer = newBuf;
	state->cursor = 0;
}

inline size_t PSYC_getContentLength (PSYC_State* s)
{
	return s->contentLength;
}

#endif

/**
 * Parse PSYC packets.
 *
 * Generalized line-based packet parser.
 *
 * @param state An initialized PSYC_State
 * @param modifier A pointer to a character. In case of a variable, it will
 *                 be set to the modifier of that variable
 * @param name A pointer to a PSYC_Array. It will point to the name of
 *             the variable or method and its length will be set accordingly
 * @param value A pointer to a PSYC_Array. It will point to the
 *              value/body the variable/method and its length will be set accordingly
 */
PSYC_ReturnCode PSYC_parse(PSYC_State* state, uint8_t* modifier, PSYC_Array* name, PSYC_Array* value);

/**
 * List value parser.
 */
PSYC_ListReturnCode PSYC_parseList(PSYC_ListState* state, PSYC_Array *name, PSYC_Array* value, PSYC_Array* elem);

#endif // PSYC_PARSER_H

/** @} */ // end of parsing group