parser.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#include <stdint.h>
#include <stdbool.h>
 
#ifndef _PARSER_H_
#define _PARSER_H_
 
/*
 * Maximum length of a valid SMS message is 175 bytes so we'll reserve buffer
 * of 180 bytes to be safe and we are able to handle properly few extra bytes.
 * 175 is result of the following calculation of maximum field lengths:
 *   12: SMSC address
 *    4: Misc bytes in SMS-DELIVER msg:
 *       First byte with several bit fields, TP-PID, TP-DCS, TP-UDL.
 *   12: Originating address (phone number)
 *    7: Timestamp
 *  140: User data
 */
#define PARSER_BUF_SIZE 180
 
/* Forward declaration of the parser struct */
struct parser;
 
typedef int (*parser_module)(struct parser *parser, uint8_t *buf);
 
struct parser_api {
        uint32_t (*data_size)(void);
        void*    (*get_parsers)(void);
        void*    (*get_decoder)(void);
        int      (*get_parser_count)(void);
        int      (*get_header)(struct parser *parser, void *header);
};
 
struct parser {
        uint8_t buf_pos;
        uint8_t buf[PARSER_BUF_SIZE];
        uint16_t buf_size;
 
        uint8_t *payload;
        uint8_t payload_buf_size;
        uint8_t payload_pos;
 
        void *data;
 
        struct parser_api *api;
};
 
int parser_create(struct parser *parser, struct parser_api *api);
 
int parser_delete(struct parser *parser);
 
int parser_process_str(struct parser *parser, const char *data);
 
int parser_get_payload(struct parser *parser, char *buf, uint8_t buf_size);
 
int parser_get_header(struct parser *parser, void *header);
 
#endif /* _PARSER_H_ */