]> git.stg.codes - stg.git/blob - libs/smux/include/stg/xer_encoder.h
055e73c0c8b0dfd330c8d3f80c6d2b02270b3100
[stg.git] / libs / smux / include / stg / xer_encoder.h
1 /*-
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
8 #include <asn_application.h>
9
10 #ifdef __cplusplus
11 extern "C" {
12 #endif
13
14 struct asn_TYPE_descriptor_s;   /* Forward declaration */
15
16 /* Flags used by the xer_encode() and (*xer_type_encoder_f), defined below */
17 enum xer_encoder_flags_e {
18         /* Mode of encoding */
19         XER_F_BASIC     = 0x01, /* BASIC-XER (pretty-printing) */
20         XER_F_CANONICAL = 0x02  /* Canonical XER (strict rules) */
21 };
22
23 /*
24  * The XER encoder of any type. May be invoked by the application.
25  */
26 asn_enc_rval_t xer_encode(struct asn_TYPE_descriptor_s *type_descriptor,
27                 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  */
41 int xer_fprint(FILE *stream, struct asn_TYPE_descriptor_s *td, void *sptr);
42
43 /*
44  * Type of the generic XER encoder.
45  */
46 typedef asn_enc_rval_t (xer_type_encoder_f)(
47                 struct asn_TYPE_descriptor_s *type_descriptor,
48                 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
55 #ifdef __cplusplus
56 }
57 #endif
58
59 #endif  /* _XER_ENCODER_H_ */