sexp.h 3.09 KB
Newer Older
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
/* sexp.h
 *
 * Parsing s-expressions.
 */

/* nettle, low-level cryptographics library
 *
 * Copyright (C) 2002 Niels Möller
 *  
 * The nettle library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * The nettle library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with the nettle library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */
 
#ifndef NETTLE_SEXP_H_INCLUDED
#define NETTLE_SEXP_H_INCLUDED

#include <inttypes.h>

enum sexp_type
32
  { SEXP_ATOM, SEXP_LIST, SEXP_END };
33
34
35
36
37

struct sexp_iterator
{
  unsigned length;
  const uint8_t *buffer;
Niels Möller's avatar
Niels Möller committed
38
39
40
  
  /* If type is SEXP_LIST, pos points at the start of the current
   * element. Otherwise, it points at the end. */
41
42
43
44
45
46
47
48
49
50
51
52
53
54
  unsigned pos;
  unsigned level;

  enum sexp_type type;
  
  unsigned display_length;
  const uint8_t *display;

  unsigned atom_length;
  const uint8_t *atom;
};


/* All these functions return 1 on success, 0 on failure */
55
56
57
58
59
60

/* Initializes the iterator. */
int
sexp_iterator_first(struct sexp_iterator *iterator,
		    unsigned length, const uint8_t *input);

61
62
63
64
65
/* NOTE: Decodes the input string in place */
int
sexp_transport_iterator_first(struct sexp_iterator *iterator,
			      unsigned length, uint8_t *input);

66
67
68
69
70
71
72
73
74
75
76
int
sexp_iterator_next(struct sexp_iterator *iterator);

/* Current element must be a list. */
int
sexp_iterator_enter_list(struct sexp_iterator *iterator);

/* Skips the rest of the current list */
int
sexp_iterator_exit_list(struct sexp_iterator *iterator);

77
78
79
80
81
82
83
84
85
86
87
88
89
90

/* Checks the type of the current expression, which should be a list
 *
 *  (<type> ...)
 */
int
sexp_iterator_check_type(struct sexp_iterator *iterator,
			 const uint8_t *type);

const uint8_t *
sexp_iterator_check_types(struct sexp_iterator *iterator,
			  unsigned ntypes,
			  const uint8_t **types);

91
92
93
94
/* Current element must be a list. Looks up element of type
 *
 *   (key rest...)
 *
95
 * For a matching key, the corresponding iterator is initialized
96
97
98
99
100
 * pointing at the start of REST.
 */
int
sexp_iterator_assoc(struct sexp_iterator *iterator,
		    unsigned nkeys,
101
		    const uint8_t **keys,
102
103
		    struct sexp_iterator *values);

104
105
106
107
108
109
110
111
112
113

/* Output functions. What is a reasonable API for this? It seems
 * ugly to have to reimplement string streams. */

/* Declared for real in buffer.h */
struct nettle_buffer;

int
sexp_format(struct nettle_buffer *buffer, const char *format, ...);

114
115
116
117
118
119
120
int
sexp_transport_format(struct nettle_buffer *buffer,
		      /* If non-zero, break lines to at most
		       * line_length characters. */
		      unsigned line_length,
		      const char *format, ...);

121

122
#endif /* NETTLE_SEXP_H_INCLUDED */