5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2005 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 /****h* silcutil/SILC Buffer Format Interface
24 * SILC Buffer Format API provides a few functions for formatting
25 * various different data types into a buffer, and retrieving
26 * various data from buffer into specific data types. It is usefull
27 * to format for example packets and later unformat them.
36 /****f* silcutil/SilcBufferFormatAPI/silc_buffer_format
40 * int silc_buffer_format(SilcBuffer dst, ...);
44 * Formats a buffer from a variable argument list. Returns -1 on error
45 * and the length of the formatted buffer otherwise.
49 * ret = silc_buffer_format(buffer,
50 * SILC_STR_INT(intval),
51 * SILC_STR_CHAR(charval),
52 * SILC_STR_INT(intval),
53 * SILC_STR_SHORT(str_len),
54 * SILC_STR_UI_XNSTRING(str, str_len),
60 int silc_buffer_format(SilcBuffer dst, ...);
62 /****f* silcutil/SilcBufferFormatAPI/silc_buffer_unformat
66 * int silc_buffer_unformat(SilcBuffer src, ...);
70 * Unformats a buffer from a variable argument list. Returns -1 on error
71 * and the length of the unformatted buffer otherwise.
75 * ret = silc_buffer_unformat(buffer,
76 * SILC_STR_INT(&intval),
77 * SILC_STR_CHAR(&charval),
79 * SILC_STR_UI16_NSTRING_ALLOC(&str, &str_len),
85 int silc_buffer_unformat(SilcBuffer src, ...);
87 /****f* silcutil/SilcBufferFormatAPI/silc_buffer_format_vp
91 * int silc_buffer_format_vp(SilcBuffer dst, va_list vp);
95 * Formats a buffer from a variable argument list indicated by the `ap'.
96 * Returns -1 on error and the length of the formatted buffer otherwise.
99 int silc_buffer_format_vp(SilcBuffer dst, va_list ap);
101 /****f* silcutil/SilcBufferFormatAPI/silc_buffer_unformat_vp
105 * int silc_buffer_unformat_vp(SilcBuffer src, va_list vp);
109 * Unformats a buffer from a variable argument list indicated by the `ap'.
110 * Returns -1 on error and the length of the unformatted buffer otherwise.
113 int silc_buffer_unformat_vp(SilcBuffer src, va_list ap);
115 /****f* silcutil/SilcBufferFormatAPI/silc_buffer_strformat
119 * int silc_buffer_strformat(SilcBuffer dst, ...);
123 * Formats a buffer from variable argument list of strings. Each
124 * string must be NULL-terminated and the variable argument list must
125 * be end with SILC_STR_END argument. This allows that a string in
126 * the list can be NULL, in which case it is skipped. This automatically
127 * allocates the space for the buffer data but `dst' must be already
128 * allocated by the caller.
132 * ret = silc_buffer_strformat(buffer, "foo", "bar", SILC_STR_END);
137 int silc_buffer_strformat(SilcBuffer dst, ...);
139 /* SilcStack aware versions */
141 /****f* silcutil/SilcBufferFormatAPI/silc_buffer_sstrformat
145 * int silc_buffer_strformat(SilcStack stack, SilcBuffer dst, ...);
149 * Formats a buffer from variable argument list of strings. Each
150 * string must be NULL-terminated and the variable argument list must
151 * be end with SILC_STR_END argument. This allows that a string in
152 * the list can be NULL, in which case it is skipped. This automatically
153 * allocates the space for the buffer data but `dst' must be already
154 * allocated by the caller. This function is equivalent to
155 * silc_buffer_strformat but allocates memory from `stack'.
158 int silc_buffer_sstrformat(SilcStack stack, SilcBuffer dst, ...);
160 /* Macros for expanding parameters into variable function argument list.
161 These are passed to silc_buffer_format and silc_buffer_unformat
164 /* Buffer parameter types.
169 Any XXX_STRING_ALLOC types will allocate space for the data and
170 memcpy the data to the pointer sent as argument (in unformatting).
172 Any XXX_STRING will not allocate or copy any data. Instead it
173 will set the pointer to the data. Note that the data pointer
174 returned (in unformatting) must not be freed.
178 SILC_BUFFER_PARAM_SI8_CHAR,
179 SILC_BUFFER_PARAM_UI8_CHAR,
181 SILC_BUFFER_PARAM_SI16_SHORT,
182 SILC_BUFFER_PARAM_UI16_SHORT,
184 SILC_BUFFER_PARAM_SI32_INT,
185 SILC_BUFFER_PARAM_UI32_INT,
187 SILC_BUFFER_PARAM_SI64_INT,
188 SILC_BUFFER_PARAM_UI64_INT,
190 SILC_BUFFER_PARAM_UI8_STRING, /* No copy */
191 SILC_BUFFER_PARAM_UI8_STRING_ALLOC, /* Alloc + memcpy */
192 SILC_BUFFER_PARAM_UI16_STRING, /* No copy */
193 SILC_BUFFER_PARAM_UI16_STRING_ALLOC, /* Alloc + memcpy */
194 SILC_BUFFER_PARAM_UI32_STRING, /* No copy */
195 SILC_BUFFER_PARAM_UI32_STRING_ALLOC, /* Alloc + memcpy */
196 SILC_BUFFER_PARAM_UI8_NSTRING, /* No copy */
197 SILC_BUFFER_PARAM_UI8_NSTRING_ALLOC, /* Alloc + memcpy */
198 SILC_BUFFER_PARAM_UI16_NSTRING, /* No copy */
199 SILC_BUFFER_PARAM_UI16_NSTRING_ALLOC, /* Alloc + memcpy */
200 SILC_BUFFER_PARAM_UI32_NSTRING, /* No copy */
201 SILC_BUFFER_PARAM_UI32_NSTRING_ALLOC, /* Alloc + memcpy */
202 SILC_BUFFER_PARAM_UI_XNSTRING, /* No copy */
203 SILC_BUFFER_PARAM_UI_XNSTRING_ALLOC, /* Alloc + memcpy */
205 SILC_BUFFER_PARAM_OFFSET,
207 SILC_BUFFER_PARAM_END
208 } SilcBufferParamType;
210 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_*_CHAR
214 * #define SILC_STR_UI_CHAR() ...
215 * #define SILC_STR_SI_CHAR() ...
219 * One signed/unsigned character.
221 * Formatting: SILC_STR_SI_CHAR(char)
222 * SILC_STR_UI_CHAR(unsigned char)
223 * Unformatting: SILC_STR_SI_CHAR(char *)
224 * SILC_STR_UI_CHAR(unsigned char *)
227 #define SILC_STR_SI_CHAR(x) SILC_BUFFER_PARAM_SI8_CHAR, (x)
228 #define SILC_STR_UI_CHAR(x) SILC_BUFFER_PARAM_UI8_CHAR, (x)
230 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_*_SHORT
234 * #define SILC_STR_UI_SHORT() ...
235 * #define SILC_STR_SI_SHORT() ...
241 * Formatting: SILC_STR_SI_SHORT(short)
242 * SILC_STR_UI_SHORT(SilcUInt16)
243 * Unformatting: SILC_STR_SI_SHORT(short *)
244 * SILC_STR_UI_SHORT(SilcUInt16 *)
247 #define SILC_STR_SI_SHORT(x) SILC_BUFFER_PARAM_SI16_SHORT, (x)
248 #define SILC_STR_UI_SHORT(x) SILC_BUFFER_PARAM_UI16_SHORT, (x)
250 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_*_INT
254 * #define SILC_STR_UI_INT() ...
255 * #define SILC_STR_SI_INT() ...
261 * Formatting: SILC_STR_SI_INT(int)
262 * SILC_STR_UI_INT(SilcUInt32)
263 * Unformatting: SILC_STR_SI_INT(int *)
264 * SILC_STR_UI_INT(SilcUInt32 *)
267 #define SILC_STR_SI_INT(x) SILC_BUFFER_PARAM_SI32_INT, (x)
268 #define SILC_STR_UI_INT(x) SILC_BUFFER_PARAM_UI32_INT, (x)
270 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_*_INT64
274 * #define SILC_STR_UI_INT64() ...
275 * #define SILC_STR_SI_INT64() ...
281 * Formatting: SILC_STR_SI_INT64(int)
282 * SILC_STR_UI_INT64(SilcUInt32)
283 * Unformatting: SILC_STR_SI_INT64(int *)
284 * SILC_STR_UI_INT64(SilcUInt32 *)
287 #define SILC_STR_SI_INT64(x) SILC_BUFFER_PARAM_SI64_INT, (x)
288 #define SILC_STR_UI_INT64(x) SILC_BUFFER_PARAM_UI64_INT, (x)
290 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_*_STRING
294 * #define SILC_STR_UI8_STRING() ...
295 * #define SILC_STR_UI8_STRING_ALLOC() ...
296 * #define SILC_STR_UI16_STRING() ...
297 * #define SILC_STR_UI16_STRING_ALLOC() ...
298 * #define SILC_STR_UI32_STRING() ...
299 * #define SILC_STR_UI32_STRING_ALLOC() ...
303 * Unsigned NULL terminated string. Note that the string must be
304 * NULL terminated because strlen() will be used to get the length of
307 * Formatting: SILC_STR_UI32_STRING(unsigned char *)
308 * Unformatting: SILC_STR_UI32_STRING(unsigned char **)
310 * Unformatting procedure will check for length of the string from the
311 * buffer before trying to get the string out. Thus, one *must* format the
312 * length as UI_INT or UI_SHORT into the buffer *before* formatting the
313 * actual string to the buffer, and, in unformatting one must ignore the
314 * length of the string because unformatting procedure will take it
319 * Formatting: ..., SILC_STR_UI_INT(strlen(string)),
320 * SILC_STR_UI32_STRING(string), ...
321 * Unformatting: ..., SILC_STR_UI32_STRING(&string), ...
323 * I.e., you can ignore the formatted length field in unformatting.
325 * UI8, UI16 and UI32 means that the length is considered to be
326 * either char (8 bits), short (16 bits) or int (32 bits) in
329 * _ALLOC routines automatically allocates memory for the variable sent
330 * as argument in unformatting.
333 #define SILC_STR_UI8_STRING(x) SILC_BUFFER_PARAM_UI8_STRING, (x)
334 #define SILC_STR_UI8_STRING_ALLOC(x) SILC_BUFFER_PARAM_UI8_STRING_ALLOC, (x)
335 #define SILC_STR_UI16_STRING(x) SILC_BUFFER_PARAM_UI16_STRING, (x)
336 #define SILC_STR_UI16_STRING_ALLOC(x) SILC_BUFFER_PARAM_UI16_STRING_ALLOC, (x)
337 #define SILC_STR_UI32_STRING(x) SILC_BUFFER_PARAM_UI32_STRING, (x)
338 #define SILC_STR_UI32_STRING_ALLOC(x) SILC_BUFFER_PARAM_UI32_STRING_ALLOC, (x)
340 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_*_NSTRING
344 * #define SILC_STR_UI8_NSTRING() ...
345 * #define SILC_STR_UI8_NSTRING_ALLOC() ...
346 * #define SILC_STR_UI16_NSTRING() ...
347 * #define SILC_STR_UI16_NSTRING_ALLOC() ...
348 * #define SILC_STR_UI32_NSTRING() ...
349 * #define SILC_STR_UI32_NSTRING_ALLOC() ...
353 * Unsigned string. Second argument is the length of the string.
355 * Formatting: SILC_STR_UI32_NSTRING(unsigned char *, SilcUInt32)
356 * Unformatting: SILC_STR_UI32_NSTRING(unsigned char **, SilcUInt32 *)
358 * Unformatting procedure will check for length of the string from the
359 * buffer before trying to get the string out. Thus, one *must* format the
360 * length as UI_INT or UI_SHORT into the buffer *before* formatting the
361 * actual string to the buffer, and, in unformatting one must ignore the
362 * length of the string because unformatting procedure will take it
367 * Formatting: ..., SILC_STR_UI_INT(strlen(string)),
368 * SILC_STR_UI32_NSTRING(string, strlen(string)), ...
369 * Unformatting: ..., SILC_STR_UI32_NSTRING(&string, &len), ...
371 * I.e., you can ignore the formatted length field in unformatting. The
372 * length taken from the buffer is returned to the pointer sent as
373 * argument (&len in above example).
375 * UI8, UI16 and UI32 means that the length is considered to be
376 * either char (8 bits), short (16 bits) or int (32 bits) in
379 * _ALLOC routines automatically allocates memory for the variable sent
380 * as argument in unformatting.
383 #define SILC_STR_UI8_NSTRING(x, l) SILC_BUFFER_PARAM_UI8_NSTRING, (x), (l)
384 #define SILC_STR_UI8_NSTRING_ALLOC(x, l) \
385 SILC_BUFFER_PARAM_UI8_NSTRING_ALLOC, (x), (l)
386 #define SILC_STR_UI16_NSTRING(x, l) SILC_BUFFER_PARAM_UI16_NSTRING, (x), (l)
387 #define SILC_STR_UI16_NSTRING_ALLOC(x, l) \
388 SILC_BUFFER_PARAM_UI16_NSTRING_ALLOC, (x), (l)
389 #define SILC_STR_UI32_NSTRING(x, l) SILC_BUFFER_PARAM_UI32_NSTRING, (x), (l)
390 #define SILC_STR_UI32_NSTRING_ALLOC(x, l) \
391 SILC_BUFFER_PARAM_UI32_NSTRING_ALLOC, (x), (l)
393 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_UI_XNSTRING
397 * #define SILC_STR_UI_XNSTRING() ...
398 * #define SILC_STR_UI_XNSTRING_ALLOC() ...
402 * Extended Unsigned string formatting. Second argument is the length of
405 * Formatting: SILC_STR_UI_XNSTRING(unsigned char *, SilcUInt32)
406 * Unformatting: SILC_STR_UI_XNSTRING(unsigned char **, SilcUInt32)
408 * This type can be used to take arbitrary length string from the buffer
409 * by sending the requested amount of bytes as argument. This differs
410 * from *_STRING and *_NSTRING so that this doesn't try to find the
411 * length of the data from the buffer but the length of the data is
412 * sent as argument. This a handy way to unformat fixed length strings
413 * from the buffer without having the length of the string formatted
416 * _ALLOC routines automatically allocates memory for the variable sent
417 * as argument in unformatting.
420 #define SILC_STR_UI_XNSTRING(x, l) SILC_BUFFER_PARAM_UI_XNSTRING, (x), (l)
421 #define SILC_STR_UI_XNSTRING_ALLOC(x, l) \
422 SILC_BUFFER_PARAM_UI_XNSTRING_ALLOC, (x), (l)
424 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_OFFSET
428 * #define SILC_STR_OFFSET() ...
432 * Offset in buffer. This can be used in formatting and unformatting to
433 * move the data pointer of the buffer either forwards (positive offset)
434 * or backwards (negative offset). It can be used to for example skip
435 * some types during unformatting.
439 * ..., SILC_STR_OFFSET(5), ...
440 * ..., SILC_STR_OFFSET(-3), ...
442 * Moves the data pointer at the point of the offset either forward
443 * or backward and then moves to the next type. Multiple SILC_STR_OFFSETs
444 * can be used in formatting and unformatting at the same time.
447 #define SILC_STR_OFFSET(x) SILC_BUFFER_PARAM_OFFSET, (x)
449 #define SILC_STR_APPEND
450 #define SILC_STR_APPEND_TAIL
452 /****d* silcutil/SilcBufferFormatAPI/SILC_STR_END
456 * #define SILC_STR_END ...
460 * Marks end of the argument list. This must be at the end of the
461 * argument list or error will occur.
464 #define SILC_STR_END SILC_BUFFER_PARAM_END
466 /****d* silcutil/SilcBufferFormatAPI/SILC_STRFMT_END
470 * #define SILC_STRFMT_END ...
474 * Marks end of the argument list in silc_buffer_strformat function.
475 * This must be at the end of the argument list or error will occur.
478 #define SILC_STRFMT_END (void *)SILC_STR_END
480 #endif /* !SILCBUFFMT_H */