summaryrefslogtreecommitdiffstats
path: root/asn1/asn1c/xer_encoder.h
blob: 868c2ca16a5f786e23492126e0957c0b0870daf0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

/*-
 * Copyright (c) 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
 * Redistribution and modifications are permitted subject to BSD license.
 */
#ifndef	_XER_ENCODER_H_
#define	_XER_ENCODER_H_

#include <asn_application.h>

#ifdef __cplusplus
extern "C" {
#endif

    struct asn_TYPE_descriptor_s;       /* Forward declaration */

/* Flags used by the xer_encode() and (*xer_type_encoder_f), defined below */
    enum xer_encoder_flags_e {
        /* Mode of encoding */
        XER_F_BASIC = 0x01,     /* BASIC-XER (pretty-printing) */
        XER_F_CANONICAL = 0x02  /* Canonical XER (strict rules) */
    };

/*
 * The XER encoder of any type. May be invoked by the application.
 */
    asn_enc_rval_t xer_encode(struct asn_TYPE_descriptor_s *type_descriptor, void *struct_ptr,  /* Structure to be encoded */
                              enum xer_encoder_flags_e xer_flags, asn_app_consume_bytes_f * consume_bytes_cb, void *app_key     /* Arbitrary callback argument */
        );

/*
 * The variant of the above function which dumps the BASIC-XER (XER_F_BASIC)
 * output into the chosen file pointer.
 * RETURN VALUES:
 * 	 0: The structure is printed.
 * 	-1: Problem printing the structure.
 * WARNING: No sensible errno value is returned.
 */
    int xer_fprint(FILE * stream, struct asn_TYPE_descriptor_s *td,
                   void *sptr);

/*
 * Type of the generic XER encoder.
 */
    typedef asn_enc_rval_t(xer_type_encoder_f) (struct asn_TYPE_descriptor_s * type_descriptor, void *struct_ptr,       /* Structure to be encoded */
                                                int ilevel,     /* Level of indentation */
                                                enum xer_encoder_flags_e xer_flags, asn_app_consume_bytes_f * consume_bytes_cb, /* Callback */
                                                void *app_key   /* Arbitrary callback argument */
        );

#ifdef __cplusplus
}
#endif
#endif                          /* _XER_ENCODER_H_ */