sexp.h 5.83 KB
Newer Older
1
/* sexp.h
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

   Parsing s-expressions.
   Copyright (C) 2002 Niels Möller

   This file is part of GNU Nettle.

   GNU Nettle is free software: you can redistribute it and/or
   modify it under the terms of either:

     * the GNU Lesser General Public License as published by the Free
       Software Foundation; either version 3 of the License, or (at your
       option) any later version.

   or

     * the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

   or both in parallel, as here.

   GNU Nettle 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
   General Public License for more details.

   You should have received copies of the GNU General Public License and
   the GNU Lesser General Public License along with this program.  If
   not, see http://www.gnu.org/licenses/.
*/
32 33 34 35
 
#ifndef NETTLE_SEXP_H_INCLUDED
#define NETTLE_SEXP_H_INCLUDED

36
#include <stdarg.h>
37
#include "nettle-types.h"
38

Niels Möller's avatar
Niels Möller committed
39 40 41 42
#ifdef __cplusplus
extern "C" {
#endif

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
/* Name mangling */
#define sexp_iterator_first nettle_sexp_iterator_first
#define sexp_transport_iterator_first nettle_sexp_transport_iterator_first
#define sexp_iterator_next nettle_sexp_iterator_next
#define sexp_iterator_enter_list nettle_sexp_iterator_enter_list
#define sexp_iterator_exit_list nettle_sexp_iterator_exit_list
#define sexp_iterator_subexpr nettle_sexp_iterator_subexpr
#define sexp_iterator_get_uint32 nettle_sexp_iterator_get_uint32
#define sexp_iterator_check_type nettle_sexp_iterator_check_type
#define sexp_iterator_check_types nettle_sexp_iterator_check_types
#define sexp_iterator_assoc nettle_sexp_iterator_assoc
#define sexp_format nettle_sexp_format
#define sexp_vformat nettle_sexp_vformat
#define sexp_transport_format nettle_sexp_transport_format
#define sexp_transport_vformat nettle_sexp_transport_vformat
#define sexp_token_chars nettle_sexp_token_chars

60
enum sexp_type
61
  { SEXP_ATOM, SEXP_LIST, SEXP_END };
62 63 64

struct sexp_iterator
{
65
  size_t length;
66
  const uint8_t *buffer;
67 68

  /* Points at the start of the current sub expression. */
69
  size_t start;
Niels Möller's avatar
Niels Möller committed
70 71
  /* If type is SEXP_LIST, pos points at the start of the current
   * element. Otherwise, it points at the end. */
72
  size_t pos;
73 74 75 76
  unsigned level;

  enum sexp_type type;
  
77
  size_t display_length;
78 79
  const uint8_t *display;

80
  size_t atom_length;
81 82 83 84 85
  const uint8_t *atom;
};


/* All these functions return 1 on success, 0 on failure */
86 87 88 89

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

92 93 94
/* NOTE: Decodes the input string in place */
int
sexp_transport_iterator_first(struct sexp_iterator *iterator,
95
			      size_t length, uint8_t *input);
96

97 98 99 100 101 102 103 104 105 106 107
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);

108 109 110 111 112 113 114 115
#if 0
/* Skips out of as many lists as necessary to get back to the given
 * level. */
int
sexp_iterator_exit_lists(struct sexp_iterator *iterator,
			 unsigned level);
#endif

116 117 118 119
/* Gets start and length of the current subexpression. Implies
 * sexp_iterator_next. */
const uint8_t *
sexp_iterator_subexpr(struct sexp_iterator *iterator,
120
		      size_t *length);
121

122 123 124 125
int
sexp_iterator_get_uint32(struct sexp_iterator *iterator,
			 uint32_t *x);

126 127 128 129 130 131 132

/* Checks the type of the current expression, which should be a list
 *
 *  (<type> ...)
 */
int
sexp_iterator_check_type(struct sexp_iterator *iterator,
133
			 const char *type);
134

135
const char *
136 137
sexp_iterator_check_types(struct sexp_iterator *iterator,
			  unsigned ntypes,
138
			  const char * const *types);
139

140 141 142 143
/* Current element must be a list. Looks up element of type
 *
 *   (key rest...)
 *
144
 * For a matching key, the corresponding iterator is initialized
145
 * pointing at the start of REST.
146 147
 *
 * On success, exits the current list.
148 149 150 151
 */
int
sexp_iterator_assoc(struct sexp_iterator *iterator,
		    unsigned nkeys,
152
		    const char * const *keys,
153 154
		    struct sexp_iterator *values);

155 156 157 158 159 160 161

/* 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;

162 163 164
/* Returns the number of output characters, or 0 on out of memory. If
 * buffer == NULL, just compute length.
 *
Niels Möller's avatar
Niels Möller committed
165
 * Format strings can contained matched parentheses, tokens ("foo" in
166 167
 * the format string is formatted as "3:foo"), whitespace (which
 * separates tokens but is otherwise ignored) and the following
168 169
 * formatting specifiers:
 *
170
 *   %s   String represented as size_t length, const uint8_t *data.
171
 *
172
 *   %t   Optional display type, represented as
173
 *        size_t display_length, const uint8_t *display,
174 175
 *        display == NULL means no display type.
 *
176 177 178 179 180
 *   %i   Non-negative small integer, uint32_t.
 *
 *   %b   Non-negative bignum, mpz_t.
 *
 *   %l   Literal string (no length added), typically a balanced
181
 *        subexpression. Represented as size_t length, const uint8_t
182
 *        *data.
183
 *
184 185
 *   %(, %)  Allows insertion of unbalanced parenthesis.
 *
186 187 188 189 190
 * Modifiers:
 *
 *   %0   For %s, %t and %l, says that there's no length argument,
 *        instead the string is NUL-terminated, and there's only one
 *        const uint8_t * argument.
191 192
 */
 
193
size_t
194 195 196
sexp_format(struct nettle_buffer *buffer,
	    const char *format, ...);

197
size_t
198 199 200
sexp_vformat(struct nettle_buffer *buffer,
	     const char *format, va_list args);

201
size_t
202 203 204
sexp_transport_format(struct nettle_buffer *buffer,
		      const char *format, ...);

205
size_t
206 207
sexp_transport_vformat(struct nettle_buffer *buffer,
		       const char *format, va_list args);
208

Niels Möller's avatar
Niels Möller committed
209 210 211 212
#ifdef __cplusplus
}
#endif

213
#endif /* NETTLE_SEXP_H_INCLUDED */