silcbuffmt.c
- Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
+ Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 1997 - 2000 Pekka Riikonen
+ Copyright (C) 1997 - 2002 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of 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.
-
+
This program 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
/* Macro to check whether there is enough free space to add the
required amount of data. For unformatting this means that there must
be the data that is to be extracted. */
-#define HAS_SPACE(x, req) \
-do { \
- if (req > (x)->len) \
- goto fail; \
-} while(0)
+#define MY_HAS_SPACE(__x__, __req__) \
+ do { \
+ if (__req__ > (__x__)->len) \
+ goto fail; \
+ } while(0)
/* Formats the arguments sent and puts them into the buffer sent as
argument. The buffer must be initialized beforehand and it must have
enough free space to include the formatted data. If this function
- fails caller should not trust the buffer anymore and should free it.
+ fails caller should not trust the buffer anymore and should free it.
This function is used, for example, to create packets to send over
network. */
int len;
/* Parse the arguments by formatting type. */
- while(1) {
+ while (1) {
fmt = va_arg(ap, SilcBufferParamType);
switch(fmt) {
case SILC_BUFFER_PARAM_SI8_CHAR:
{
char x = (char)va_arg(ap, int);
- HAS_SPACE(dst, 1);
+ MY_HAS_SPACE(dst, 1);
silc_buffer_put(dst, &x, 1);
silc_buffer_pull(dst, 1);
break;
case SILC_BUFFER_PARAM_UI8_CHAR:
{
unsigned char x = (unsigned char)va_arg(ap, int);
- HAS_SPACE(dst, 1);
+ MY_HAS_SPACE(dst, 1);
silc_buffer_put(dst, &x, 1);
silc_buffer_pull(dst, 1);
break;
{
unsigned char xf[2];
SilcInt16 x = (SilcInt16)va_arg(ap, int);
- HAS_SPACE(dst, 2);
+ MY_HAS_SPACE(dst, 2);
SILC_PUT16_MSB(x, xf);
silc_buffer_put(dst, xf, 2);
silc_buffer_pull(dst, 2);
{
unsigned char xf[2];
SilcUInt16 x = (SilcUInt16)va_arg(ap, int);
- HAS_SPACE(dst, 2);
+ MY_HAS_SPACE(dst, 2);
SILC_PUT16_MSB(x, xf);
silc_buffer_put(dst, xf, 2);
silc_buffer_pull(dst, 2);
{
unsigned char xf[4];
SilcInt32 x = va_arg(ap, SilcInt32);
- HAS_SPACE(dst, 4);
+ MY_HAS_SPACE(dst, 4);
SILC_PUT32_MSB(x, xf);
silc_buffer_put(dst, xf, 4);
silc_buffer_pull(dst, 4);
{
unsigned char xf[4];
SilcUInt32 x = va_arg(ap, SilcUInt32);
- HAS_SPACE(dst, 4);
+ MY_HAS_SPACE(dst, 4);
SILC_PUT32_MSB(x, xf);
silc_buffer_put(dst, xf, 4);
silc_buffer_pull(dst, 4);
{
unsigned char xf[8];
SilcInt64 x = va_arg(ap, SilcInt64);
- HAS_SPACE(dst, sizeof(SilcInt64));
+ MY_HAS_SPACE(dst, sizeof(SilcInt64));
SILC_PUT64_MSB(x, xf);
silc_buffer_put(dst, xf, sizeof(SilcInt64));
silc_buffer_pull(dst, sizeof(SilcInt64));
{
unsigned char xf[8];
SilcUInt64 x = va_arg(ap, SilcUInt64);
- HAS_SPACE(dst, sizeof(SilcUInt64));
+ MY_HAS_SPACE(dst, sizeof(SilcUInt64));
SILC_PUT64_MSB(x, xf);
silc_buffer_put(dst, xf, sizeof(SilcUInt64));
silc_buffer_pull(dst, sizeof(SilcUInt64));
{
unsigned char *x = va_arg(ap, unsigned char *);
SilcUInt32 tmp_len = strlen(x);
- HAS_SPACE(dst, tmp_len);
+ MY_HAS_SPACE(dst, tmp_len);
silc_buffer_put(dst, x, tmp_len);
silc_buffer_pull(dst, tmp_len);
break;
{
unsigned char *x = va_arg(ap, unsigned char *);
SilcUInt32 len = va_arg(ap, SilcUInt32);
- HAS_SPACE(dst, len);
+ MY_HAS_SPACE(dst, len);
silc_buffer_put(dst, x, len);
silc_buffer_pull(dst, len);
break;
va_start(ap, src);
ret = silc_buffer_unformat_vp(src, ap);
va_end(ap);
-
+
return ret;
}
case SILC_BUFFER_PARAM_SI8_CHAR:
{
char *x = va_arg(ap, char *);
- HAS_SPACE(src, 1);
+ MY_HAS_SPACE(src, 1);
if (x)
*x = src->data[0];
silc_buffer_pull(src, 1);
case SILC_BUFFER_PARAM_UI8_CHAR:
{
unsigned char *x = va_arg(ap, unsigned char *);
- HAS_SPACE(src, 1);
+ MY_HAS_SPACE(src, 1);
if (x)
*x = src->data[0];
silc_buffer_pull(src, 1);
case SILC_BUFFER_PARAM_SI16_SHORT:
{
SilcInt16 *x = va_arg(ap, SilcInt16 *);
- HAS_SPACE(src, 2);
+ MY_HAS_SPACE(src, 2);
if (x)
SILC_GET16_MSB(*x, src->data);
silc_buffer_pull(src, 2);
case SILC_BUFFER_PARAM_UI16_SHORT:
{
SilcUInt16 *x = va_arg(ap, SilcUInt16 *);
- HAS_SPACE(src, 2);
+ MY_HAS_SPACE(src, 2);
if (x)
SILC_GET16_MSB(*x, src->data);
silc_buffer_pull(src, 2);
case SILC_BUFFER_PARAM_SI32_INT:
{
SilcInt32 *x = va_arg(ap, SilcInt32 *);
- HAS_SPACE(src, 4);
+ MY_HAS_SPACE(src, 4);
if (x)
SILC_GET32_MSB(*x, src->data);
silc_buffer_pull(src, 4);
case SILC_BUFFER_PARAM_UI32_INT:
{
SilcUInt32 *x = va_arg(ap, SilcUInt32 *);
- HAS_SPACE(src, 4);
+ MY_HAS_SPACE(src, 4);
if (x)
SILC_GET32_MSB(*x, src->data);
silc_buffer_pull(src, 4);
case SILC_BUFFER_PARAM_SI64_INT:
{
SilcInt64 *x = va_arg(ap, SilcInt64 *);
- HAS_SPACE(src, sizeof(SilcInt64));
+ MY_HAS_SPACE(src, sizeof(SilcInt64));
if (x)
SILC_GET64_MSB(*x, src->data);
silc_buffer_pull(src, sizeof(SilcInt64));
case SILC_BUFFER_PARAM_UI64_INT:
{
SilcUInt64 *x = va_arg(ap, SilcUInt64 *);
- HAS_SPACE(src, sizeof(SilcUInt64));
+ MY_HAS_SPACE(src, sizeof(SilcUInt64));
if (x)
SILC_GET64_MSB(*x, src->data);
silc_buffer_pull(src, sizeof(SilcUInt64));
{
SilcUInt8 len2;
unsigned char **x = va_arg(ap, unsigned char **);
- HAS_SPACE(src, 1);
+ MY_HAS_SPACE(src, 1);
len2 = (SilcUInt8)src->data[0];
silc_buffer_pull(src, 1);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (x)
*x = src->data;
silc_buffer_pull(src, len2);
{
SilcUInt16 len2;
unsigned char **x = va_arg(ap, unsigned char **);
- HAS_SPACE(src, 2);
+ MY_HAS_SPACE(src, 2);
SILC_GET16_MSB(len2, src->data);
silc_buffer_pull(src, 2);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (x)
*x = src->data;
silc_buffer_pull(src, len2);
{
SilcUInt8 len2;
unsigned char **x = va_arg(ap, unsigned char **);
- HAS_SPACE(src, 1);
+ MY_HAS_SPACE(src, 1);
len2 = (SilcUInt8)src->data[0];
silc_buffer_pull(src, 1);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (x && len2) {
*x = silc_calloc(len2 + 1, sizeof(unsigned char));
memcpy(*x, src->data, len2);
{
SilcUInt16 len2;
unsigned char **x = va_arg(ap, unsigned char **);
- HAS_SPACE(src, 2);
+ MY_HAS_SPACE(src, 2);
SILC_GET16_MSB(len2, src->data);
silc_buffer_pull(src, 2);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (x && len2) {
*x = silc_calloc(len2 + 1, sizeof(unsigned char));
memcpy(*x, src->data, len2);
{
SilcUInt32 len2;
unsigned char **x = va_arg(ap, unsigned char **);
- HAS_SPACE(src, 4);
+ MY_HAS_SPACE(src, 4);
SILC_GET32_MSB(len2, src->data);
silc_buffer_pull(src, 4);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (x)
*x = src->data;
silc_buffer_pull(src, len2);
{
SilcUInt32 len2;
unsigned char **x = va_arg(ap, unsigned char **);
- HAS_SPACE(src, 4);
+ MY_HAS_SPACE(src, 4);
SILC_GET32_MSB(len2, src->data);
silc_buffer_pull(src, 4);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (x && len2) {
*x = silc_calloc(len2 + 1, sizeof(unsigned char));
memcpy(*x, src->data, len2);
SilcUInt8 len2;
unsigned char **x = va_arg(ap, unsigned char **);
SilcUInt8 *len = va_arg(ap, SilcUInt8 *);
- HAS_SPACE(src, 1);
+ MY_HAS_SPACE(src, 1);
len2 = (SilcUInt8)src->data[0];
silc_buffer_pull(src, 1);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (len)
*len = len2;
if (x)
SilcUInt16 len2;
unsigned char **x = va_arg(ap, unsigned char **);
SilcUInt16 *len = va_arg(ap, SilcUInt16 *);
- HAS_SPACE(src, 2);
+ MY_HAS_SPACE(src, 2);
SILC_GET16_MSB(len2, src->data);
silc_buffer_pull(src, 2);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (len)
*len = len2;
if (x)
SilcUInt8 len2;
unsigned char **x = va_arg(ap, unsigned char **);
SilcUInt8 *len = va_arg(ap, SilcUInt8 *);
- HAS_SPACE(src, 1);
+ MY_HAS_SPACE(src, 1);
len2 = (SilcUInt8)src->data[0];
silc_buffer_pull(src, 1);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (len)
*len = len2;
if (x && len2) {
SilcUInt16 len2;
unsigned char **x = va_arg(ap, unsigned char **);
SilcUInt16 *len = va_arg(ap, SilcUInt16 *);
- HAS_SPACE(src, 2);
+ MY_HAS_SPACE(src, 2);
SILC_GET16_MSB(len2, src->data);
silc_buffer_pull(src, 2);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (len)
*len = len2;
if (x && len2) {
SilcUInt32 len2;
unsigned char **x = va_arg(ap, unsigned char **);
SilcUInt32 *len = va_arg(ap, SilcUInt32 *);
- HAS_SPACE(src, 4);
+ MY_HAS_SPACE(src, 4);
SILC_GET32_MSB(len2, src->data);
silc_buffer_pull(src, 4);
- HAS_SPACE(src, len2);
+ MY_HAS_SPACE(src, len2);
if (len)
*len = len2;
if (x)
{
unsigned char **x = va_arg(ap, unsigned char **);
SilcUInt32 len = va_arg(ap, SilcUInt32);
- HAS_SPACE(src, len);
+ MY_HAS_SPACE(src, len);
if (len && x)
*x = src->data;
silc_buffer_pull(src, len);
{
unsigned char **x = va_arg(ap, unsigned char **);
SilcUInt32 len = va_arg(ap, SilcUInt32);
- HAS_SPACE(src, len);
+ MY_HAS_SPACE(src, len);
if (len && x) {
*x = silc_calloc(len + 1, sizeof(unsigned char));
memcpy(*x, src->data, len);
it under the terms of 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.
-
+
This program 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
memcpy the data to the pointer sent as argument (in unformatting).
Any XXX_STRING will not allocate or copy any data. Instead it
- will set the pointer to the data. Note that the data pointer
+ will set the pointer to the data. Note that the data pointer
returned (in unformatting) must not be freed.
*/
SILC_BUFFER_PARAM_END
} SilcBufferParamType;
-/* Macros for expanding parameters into variable function argument list.
- These are passed to silc_buffer_format and silc_buffer_unformat
+/* Macros for expanding parameters into variable function argument list.
+ These are passed to silc_buffer_format and silc_buffer_unformat
functions. */
/* One signed/unsigned character.
#define SILC_STR_SI_CHAR(x) SILC_BUFFER_PARAM_SI8_CHAR, (x)
#define SILC_STR_UI_CHAR(x) SILC_BUFFER_PARAM_UI8_CHAR, (x)
-/* Signed/SilcUInt16.
+/* Signed/SilcUInt16.
Formatting: SILC_STR_SI_SHORT(short)
SILC_STR_UI_SHORT(SilcUInt16)
#define SILC_STR_SI_SHORT(x) SILC_BUFFER_PARAM_SI16_SHORT, (x)
#define SILC_STR_UI_SHORT(x) SILC_BUFFER_PARAM_UI16_SHORT, (x)
-/* Signed/SilcUInt32.
+/* Signed/SilcUInt32.
Formatting: SILC_STR_SI_INT(int)
SILC_STR_UI_INT(SilcUInt32)
#define SILC_STR_SI_INT(x) SILC_BUFFER_PARAM_SI32_INT, (x)
#define SILC_STR_UI_INT(x) SILC_BUFFER_PARAM_UI32_INT, (x)
-/* Signed/SilcUInt64.
+/* Signed/SilcUInt64.
Formatting: SILC_STR_SI_INT64(int)
SILC_STR_UI_INT64(SilcUInt32)
/* Unsigned NULL terminated string. Note that the string must be
NULL terminated because strlen() will be used to get the length of
- the string.
+ the string.
Formatting: SILC_STR_UI32_STRING(unsigned char *)
Unformatting: SILC_STR_UI32_STRING(unsigned char **)
Unformatting procedure will check for length of the string from the
buffer before trying to get the string out. Thus, one *must* format the
- length as UI_INT or UI_SHORT into the buffer *before* formatting the
- actual string to the buffer, and, in unformatting one must ignore the
- length of the string because unformatting procedure will take it
+ length as UI_INT or UI_SHORT into the buffer *before* formatting the
+ actual string to the buffer, and, in unformatting one must ignore the
+ length of the string because unformatting procedure will take it
automatically.
Example:
- Formatting: ..., SILC_STR_UI_INT(strlen(string)),
+ Formatting: ..., SILC_STR_UI_INT(strlen(string)),
SILC_STR_UI32_STRING(string), ...
Unformatting: ..., SILC_STR_UI32_STRING(&string), ...
I.e., you ignore the formatted length field in unformatting. If you don't
the unformatting procedure might fail and it definitely does not unformat
- the data reliably.
+ the data reliably.
- _ALLOC routines automatically allocates memory for the variable sent
+ _ALLOC routines automatically allocates memory for the variable sent
as argument in unformatting.
*/
Unformatting procedure will check for length of the string from the
buffer before trying to get the string out. Thus, one *must* format the
- length as UI_INT or UI_SHORT into the buffer *before* formatting the
- actual string to the buffer, and, in unformatting one must ignore the
- length of the string because unformatting procedure will take it
+ length as UI_INT or UI_SHORT into the buffer *before* formatting the
+ actual string to the buffer, and, in unformatting one must ignore the
+ length of the string because unformatting procedure will take it
automatically.
Example:
- Formatting: ..., SILC_STR_UI_INT(strlen(string)),
+ Formatting: ..., SILC_STR_UI_INT(strlen(string)),
SILC_STR_UI32_NSTRING(string, strlen(string)), ...
Unformatting: ..., SILC_STR_UI32_NSTRING(&string, &len), ...
UI/SI16 and UI/SI32 means that the length is considered to be either
short (16 bits) or int (32 bits) in unformatting.
- _ALLOC routines automatically allocates memory for the variable sent
+ _ALLOC routines automatically allocates memory for the variable sent
as argument in unformatting.
*/
#define SILC_STR_UI32_NSTRING_ALLOC(x, l) \
SILC_BUFFER_PARAM_UI32_NSTRING_ALLOC, (x), (l)
-/* Extended Unsigned string formatting. Second argument is the length of
+/* Extended Unsigned string formatting. Second argument is the length of
the string.
Formatting: This is equal to using *_NSTRING
from the buffer without having the length of the string formatted
in the buffer.
- _ALLOC routines automatically allocates memory for the variable sent
+ _ALLOC routines automatically allocates memory for the variable sent
as argument in unformatting.
*/
***/
int silc_buffer_unformat_vp(SilcBuffer src, va_list ap);
-#endif
+#endif /* !SILCBUFFMT_H */
projects / silc.git / commitdiff