blob: b835b0f53d3fa00ce728d78a3e56a33dc89ab793 [file] [log] [blame]
vlmfa67ddc2004-06-03 03:38:44 +00001/*-
2 * Copyright (c) 2003, 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
3 * Redistribution and modifications are permitted subject to BSD license.
4 */
5#ifndef _BER_DECODER_H_
6#define _BER_DECODER_H_
7
vlmd1579582004-09-24 21:00:50 +00008#include <asn_application.h>
vlmfa67ddc2004-06-03 03:38:44 +00009
vlm574b0812004-09-29 13:24:10 +000010struct asn_TYPE_descriptor_s; /* Forward declaration */
11struct asn_codec_ctx_s; /* Forward declaration */
vlmfa67ddc2004-06-03 03:38:44 +000012
13/*
vlmfa67ddc2004-06-03 03:38:44 +000014 * The BER decoder of any type.
15 * This function may be invoked directly from the application.
16 */
vlm9de248e2004-10-20 15:50:55 +000017asn_dec_rval_t ber_decode(struct asn_codec_ctx_s *opt_codec_ctx,
vlm574b0812004-09-29 13:24:10 +000018 struct asn_TYPE_descriptor_s *type_descriptor,
vlmfa67ddc2004-06-03 03:38:44 +000019 void **struct_ptr, /* Pointer to a target structure's pointer */
20 void *buffer, /* Data to be decoded */
21 size_t size /* Size of that buffer */
22 );
23
24/*
25 * Type of generic function which decodes the byte stream into the structure.
26 */
vlm9de248e2004-10-20 15:50:55 +000027typedef asn_dec_rval_t (ber_type_decoder_f)(
vlm574b0812004-09-29 13:24:10 +000028 struct asn_codec_ctx_s *opt_codec_ctx,
29 struct asn_TYPE_descriptor_s *type_descriptor,
vlm9de248e2004-10-20 15:50:55 +000030 void **struct_ptr, void *buf_ptr, size_t size,
vlmfa67ddc2004-06-03 03:38:44 +000031 int tag_mode);
32
33/*******************************
34 * INTERNALLY USEFUL FUNCTIONS *
35 *******************************/
36
37/*
38 * Check that all tags correspond to the type definition (as given in head).
39 * On return, last_length would contain either a non-negative length of the
40 * value part of the last TLV, or the negative number of expected
41 * "end of content" sequences. The number may only be negative if the
42 * head->last_tag_form is non-zero.
43 */
vlm9de248e2004-10-20 15:50:55 +000044asn_dec_rval_t ber_check_tags(
vlm574b0812004-09-29 13:24:10 +000045 struct asn_codec_ctx_s *opt_codec_ctx, /* optional context */
46 struct asn_TYPE_descriptor_s *type_dsc,
47 asn_struct_ctx_t *opt_ctx, /* saved decoding context */
vlmfa67ddc2004-06-03 03:38:44 +000048 void *ptr, size_t size,
49 int tag_mode, /* {-1,0,1}: IMPLICIT, no, EXPLICIT */
vlm6678cb12004-09-26 13:10:40 +000050 int last_tag_form, /* {-1,0:1}: any, primitive, constr */
vlmfa67ddc2004-06-03 03:38:44 +000051 ber_tlv_len_t *last_length,
vlm574b0812004-09-29 13:24:10 +000052 int *opt_tlv_form /* optional tag form */
53 );
vlmfa67ddc2004-06-03 03:38:44 +000054
55#endif /* _BER_DECODER_H_ */