1 /*- 2 * Copyright (c) 2004-2017 Lev Walkin <vlm@lionet.info>. All rights reserved. 3 * Redistribution and modifications are permitted subject to BSD license. 4 */ 5 #ifndef _XER_DECODER_H_ 6 #define _XER_DECODER_H_ 7 8 #include "asn1/asn1c/asn_application.h" 9 10 #ifdef __cplusplus 11 extern "C" { 12 #endif 13 14 struct asn_TYPE_descriptor_s; /* Forward declaration */ 15 16 /* 17 * The XER decoder of any ASN.1 type. May be invoked by the application. 18 * Decodes CANONICAL-XER and BASIC-XER. 19 */ 20 asn_dec_rval_t xer_decode( 21 const struct asn_codec_ctx_s *opt_codec_ctx, 22 const struct asn_TYPE_descriptor_s *type_descriptor, 23 void **struct_ptr, /* Pointer to a target structure's pointer */ 24 const void *buffer, /* Data to be decoded */ 25 size_t size /* Size of data buffer */ 26 ); 27 28 /* 29 * Type of the type-specific XER decoder function. 30 */ 31 typedef asn_dec_rval_t(xer_type_decoder_f)( 32 const asn_codec_ctx_t *opt_codec_ctx, 33 const struct asn_TYPE_descriptor_s *type_descriptor, void **struct_ptr, 34 const char *opt_mname, /* Member name */ 35 const void *buf_ptr, size_t size); 36 37 /******************************* 38 * INTERNALLY USEFUL FUNCTIONS * 39 *******************************/ 40 41 /* 42 * Generalized function for decoding the primitive values. 43 * Used by more specialized functions, such as OCTET_STRING_decode_xer_utf8 44 * and others. This function should not be used by applications, as its API 45 * is subject to changes. 46 */ 47 asn_dec_rval_t xer_decode_general( 48 const asn_codec_ctx_t *opt_codec_ctx, 49 asn_struct_ctx_t *ctx, /* Type decoder context */ 50 void *struct_key, /* Treated as opaque pointer */ 51 const char *xml_tag, /* Expected XML tag name */ 52 const void *buf_ptr, size_t size, 53 int (*opt_unexpected_tag_decoder)(void *struct_key, const void *chunk_buf, 54 size_t chunk_size), 55 ssize_t (*body_receiver)(void *struct_key, const void *chunk_buf, 56 size_t chunk_size, int have_more)); 57 58 59 /* 60 * Fetch the next XER (XML) token from the stream. 61 * The function returns the number of bytes occupied by the chunk type, 62 * returned in the _ch_type. The _ch_type is only set (and valid) when 63 * the return value is >= 0. 64 */ 65 typedef enum pxer_chunk_type { 66 PXER_WMORE, /* Chunk type is not clear, more data expected. */ 67 PXER_TAG, /* Complete XER tag */ 68 PXER_TEXT, /* Plain text between XER tags */ 69 PXER_COMMENT /* A comment, may be part of */ 70 } pxer_chunk_type_e; 71 ssize_t xer_next_token(int *stateContext, 72 const void *buffer, size_t size, pxer_chunk_type_e *_ch_type); 73 74 /* 75 * This function checks the buffer against the tag name is expected to occur. 76 */ 77 typedef enum xer_check_tag { 78 XCT_BROKEN = 0, /* The tag is broken */ 79 XCT_OPENING = 1, /* This is the <opening> tag */ 80 XCT_CLOSING = 2, /* This is the </closing> tag */ 81 XCT_BOTH = 3, /* This is the <modified/> tag */ 82 XCT__UNK__MASK = 4, /* Mask of everything unexpected */ 83 XCT_UNKNOWN_OP = 5, /* Unexpected <opening> tag */ 84 XCT_UNKNOWN_CL = 6, /* Unexpected </closing> tag */ 85 XCT_UNKNOWN_BO = 7 /* Unexpected <modified/> tag */ 86 } xer_check_tag_e; 87 xer_check_tag_e xer_check_tag(const void *buf_ptr, int size, 88 const char *need_tag); 89 90 /* 91 * Get the number of bytes consisting entirely of XER whitespace characters. 92 * RETURN VALUES: 93 * >=0: Number of whitespace characters in the string. 94 */ 95 size_t xer_whitespace_span(const void *chunk_buf, size_t chunk_size); 96 97 /* 98 * Skip the series of anticipated extensions. 99 */ 100 int xer_skip_unknown(xer_check_tag_e tcv, ber_tlv_len_t *depth); 101 102 #ifdef __cplusplus 103 } 104 #endif 105 106 #endif /* _XER_DECODER_H_ */ 107