blob: 055e73c0c8b0dfd330c8d3f80c6d2b02270b3100 [file] [log] [blame]
Lev Walkina9cc46e2004-09-22 16:06:28 +00001/*-
2 * Copyright (c) 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
3 * Redistribution and modifications are permitted subject to BSD license.
4 */
5#ifndef _XER_ENCODER_H_
6#define _XER_ENCODER_H_
7
Lev Walkin11c3e172004-09-24 21:00:50 +00008#include <asn_application.h>
Lev Walkina9cc46e2004-09-22 16:06:28 +00009
Lev Walkin21b41ac2005-07-24 09:03:44 +000010#ifdef __cplusplus
11extern "C" {
12#endif
13
Lev Walkin5e033762004-09-29 13:26:15 +000014struct asn_TYPE_descriptor_s; /* Forward declaration */
Lev Walkina9cc46e2004-09-22 16:06:28 +000015
16/* Flags used by the xer_encode() and (*xer_type_encoder_f), defined below */
17enum xer_encoder_flags_e {
18 /* Mode of encoding */
19 XER_F_BASIC = 0x01, /* BASIC-XER (pretty-printing) */
Lev Walkin34ae9e32006-03-17 02:40:30 +000020 XER_F_CANONICAL = 0x02 /* Canonical XER (strict rules) */
Lev Walkina9cc46e2004-09-22 16:06:28 +000021};
22
23/*
24 * The XER encoder of any type. May be invoked by the application.
25 */
Lev Walkin5e033762004-09-29 13:26:15 +000026asn_enc_rval_t xer_encode(struct asn_TYPE_descriptor_s *type_descriptor,
Lev Walkina9cc46e2004-09-22 16:06:28 +000027 void *struct_ptr, /* Structure to be encoded */
28 enum xer_encoder_flags_e xer_flags,
29 asn_app_consume_bytes_f *consume_bytes_cb,
30 void *app_key /* Arbitrary callback argument */
31 );
32
33/*
34 * The variant of the above function which dumps the BASIC-XER (XER_F_BASIC)
35 * output into the chosen file pointer.
36 * RETURN VALUES:
37 * 0: The structure is printed.
38 * -1: Problem printing the structure.
39 * WARNING: No sensible errno value is returned.
40 */
Lev Walkin5e033762004-09-29 13:26:15 +000041int xer_fprint(FILE *stream, struct asn_TYPE_descriptor_s *td, void *sptr);
Lev Walkina9cc46e2004-09-22 16:06:28 +000042
43/*
44 * Type of the generic XER encoder.
45 */
46typedef asn_enc_rval_t (xer_type_encoder_f)(
Lev Walkin5e033762004-09-29 13:26:15 +000047 struct asn_TYPE_descriptor_s *type_descriptor,
Lev Walkina9cc46e2004-09-22 16:06:28 +000048 void *struct_ptr, /* Structure to be encoded */
49 int ilevel, /* Level of indentation */
50 enum xer_encoder_flags_e xer_flags,
51 asn_app_consume_bytes_f *consume_bytes_cb, /* Callback */
52 void *app_key /* Arbitrary callback argument */
53 );
54
Lev Walkin21b41ac2005-07-24 09:03:44 +000055#ifdef __cplusplus
56}
57#endif
58
Lev Walkina9cc46e2004-09-22 16:06:28 +000059#endif /* _XER_ENCODER_H_ */