head	1.7;
access;
symbols
	last-version-in-peti-style:1.6
	callback-semantic-rewrite:1.5.0.2;
locks; strict;
comment	@ * @;


1.7
date	2001.08.08.19.15.27;	author rse;	state dead;
branches;
next	1.6;

1.6
date	2001.08.01.15.25.50;	author simons;	state Exp;
branches;
next	1.5;

1.5
date	2001.07.24.15.44.18;	author simons;	state Exp;
branches
	1.5.2.1;
next	1.4;

1.4
date	2001.07.23.15.33.43;	author simons;	state Exp;
branches;
next	1.3;

1.3
date	2001.07.20.10.56.02;	author simons;	state Exp;
branches;
next	1.2;

1.2
date	2001.07.19.09.38.42;	author simons;	state Exp;
branches;
next	1.1;

1.1
date	2001.07.18.19.03.17;	author simons;	state Exp;
branches;
next	;

1.5.2.1
date	2001.08.01.11.27.20;	author simons;	state Exp;
branches;
next	1.5.2.2;

1.5.2.2
date	2001.08.01.12.04.42;	author simons;	state Exp;
branches;
next	1.5.2.3;

1.5.2.3
date	2001.08.01.13.26.32;	author simons;	state Exp;
branches;
next	;


desc
@@


1.7
log
@First cut of the ruthless style adjustments to OSSP XDS:

o adjust source tree to follow OSSP source tree style
  by heavily combining sources into smaller sets
  (needs more work when still missing parts are added later)

o automatic re-indentation of sources with GNU indent
  (still needs manual review and adjustments; will follow)

These two heavy steps were mostly done automatically with the help of
two helper scripts written in Perl. So expect more manual adjustments to
follow...
@
text
@/*
   XDS - OSSP Extensible Data Serialization Library
   Copyright (c) 2001 The OSSP Project (http://www.ossp.org/)
   Copyright (c) 2001 Cable & Wireless Deutschland (http://www.cw.com/de/)

   This file is part of OSSP XDS, an extensible data serialization
   library which can be found at http://www.ossp.com/pkg/xds/.

   Permission to use, copy, modify, and distribute this software for
   any purpose with or without fee is hereby granted, provided that
   the above copyright notice and this permission notice appear in all
   copies.

   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGE.
*/

#include <stdio.h>
#include <string.h>
#include "../internal.h"

struct mystruct
    {
    xds_int32_t   small;
    xds_int64_t   big;
    xds_uint32_t  positive;
    };

static int encode_mystruct_engine(xds_t* xds, void* engine_context,
				  void* buffer, size_t buffer_size, size_t* used_buffer_size,
				  va_list* args)
    {
    struct mystruct* ms;

    assert(xds != NULL);
    assert(buffer != NULL);
    assert(buffer_size != 0);
    assert(used_buffer_size != NULL);
    assert(args != NULL);

    ms = va_arg(*args, struct mystruct*);
    return xds_encode(xds, "int32 int64 uint32", ms->small, ms->big, ms->positive);
    }

static int decode_mystruct_engine(xds_t* xds, void* engine_context,
				  void* buffer, size_t buffer_size, size_t* used_buffer_size,
				  va_list* args)
    {
    struct mystruct* ms;

    assert(xds != NULL);
    assert(buffer != NULL);
    assert(buffer_size != 0);
    assert(used_buffer_size != NULL);
    assert(args != NULL);

    ms = va_arg(*args, struct mystruct*);
    return xds_decode(xds, "int32 int64 uint32", &(ms->small), &(ms->big), &(ms->positive));
    }

int main()
    {
    xds_t* xds;
    char*  buffer;
    size_t buffer_size;

    struct mystruct ms, new_ms;
    ms.small    = -0x1234567;
    ms.big      = -0x1234567890abcdeLL;
    ms.positive = 42;

    /* Encode our copy of mystruct using our encoding callback. Then
       get a the buffer and destroy the context again. */

    xds = xds_init(XDS_ENCODE);
    if (xds == NULL)
	{
	printf("Failed to initialize XDS context.\n");
	return 1;
	}
    if (xds_register(xds, "mystruct", &encode_mystruct_engine, NULL) != XDS_OK ||
	xds_register(xds, "int32", &xdr_encode_int32, NULL) != XDS_OK ||
	xds_register(xds, "int64", &xdr_encode_int64, NULL) != XDS_OK ||
	xds_register(xds, "uint32", &xdr_encode_uint32, NULL) != XDS_OK)
	{
	printf("Failed to register my encoding engines.\n");
	return 1;
	}
    buffer_size = 4;
    buffer = malloc(buffer_size);
    if (buffer == NULL)
	{
	printf("Failed to allocate memory for buffer.\n");
	return 1;
	}
    if (xds_setbuffer(xds, XDS_GIFT, buffer, buffer_size) != XDS_OK)
	{
	printf("xds_setbuffer() failed!\n");
	return 1;
	}
    if (xds_encode(xds, "mystruct", &ms) != XDS_OK)
	{
	printf("xds_encode() failed!\n");
	return 1;
	}
    if (xds->buffer_capacity <= buffer_size)
	{
	printf("Buffer should have been enlarged after xds_encode()!\n");
	return 1;
	}
    if (xds_getbuffer(xds, XDS_GIFT, (void**)&buffer, &buffer_size) != XDS_OK)
	{
	printf("xds_getbuffer() failed!\n");
	return 1;
	}
    xds_destroy(xds);
    printf("The encoded representation is %u bytes long.\n", buffer_size);

    /* Now create a decoding context and decode the whole thing again. */

    xds = xds_init(XDS_DECODE);
    if (xds == NULL)
	{
	printf("Failed to initialize XDS context.\n");
	return 1;
	}
    if (xds_register(xds, "mystruct", &decode_mystruct_engine, NULL) != XDS_OK ||
	xds_register(xds, "int32", &xdr_decode_int32, NULL) != XDS_OK ||
	xds_register(xds, "int64", &xdr_decode_int64, NULL) != XDS_OK ||
	xds_register(xds, "uint32", &xdr_decode_uint32, NULL) != XDS_OK)
	{
	printf("Failed to register my decoding engines.\n");
	return 1;
	}
    if (xds_setbuffer(xds, XDS_GIFT, buffer, buffer_size) != XDS_OK)
	{
	printf("xds_setbuffer() failed!\n");
	return 1;
	}
    if (xds_decode(xds, "mystruct", &new_ms) != XDS_OK)
	{
	printf("xds_decode() failed!\n");
	return 1;
	}
    xds_destroy(xds);

    /* Both structures must be identical. */

    if (ms.small != new_ms.small || ms.big != new_ms.big || ms.positive != new_ms.positive)
	{
	printf("Decoded data does not match the original!\n");
	return 1;
	}

    /* Everything went fine. */

    return 0;
    }
@


1.6
log
@Merged the whole contents of branch "callback-semantic-rewrite" into
the main branch. The changes there include:

 - A change of the callback semantics; callbacks do now return
   XDS_ERR_(UNDER|OVER)FLOW in case the buffer size doesn't fit.
   Rather than passing the differing byte size through the return
   code, it is stored in the location used_buffer_size points to -- a
   new parameter provided to all callbacks.

   In order to implement this, the framework, all callbacks and most
   of the test suits had to be adapted.

 - internal.h now provides the macro xds_check_parameter(), which can
   be used to verify the contents of function parameters with assert()
   and if in one line. If assert()s are deactivated, the routine will
   still return XDS_ERR_INVALID_ARG.

   Because of this change, internal.h now includes the system header
   assert.h. This means that this include coulde be removed from
   almost all modules.

 - internal.h now provides the macros xds_init_(en|de)coding_engine().
   These can be used to comfortably verify a callback's parameters and
   to verify the buffer size. All engines have been rewritten to use
   these.
@
text
@@


1.5
log
@Comparing the new structure instance with the old one by memcmp() was
bound to fail because on some architectures padding is inserted -- and
those padding bytes didn't match even though the structure's values
were identical. Thus we do now compare element by element.

Furthermore, the encoding and decoding engines way of predicting the
correct buffer size ("sizeof(struct mystruct)") failed also because it
didn't take padding into account. Fixed that also.
@
text
@a29 1
#include <assert.h>
d39 3
a41 1
static int encode_mystruct_engine(xds_t* xds, void* engine_context, void* buffer, size_t buffer_size, va_list* args)
a42 1
    int rc;
d48 1
d52 1
a52 5
    rc = xds_encode(xds, "int32 int64 uint32", ms->small, ms->big, ms->positive);
    if (rc == XDS_OK)
	return 0;
    else
	return rc;
d55 3
a57 1
static int decode_mystruct_engine(xds_t* xds, void* engine_context, void* buffer, size_t buffer_size, va_list* args)
a58 1
    int rc;
d64 1
d68 1
a68 5
    rc = xds_decode(xds, "int32 int64 uint32", &(ms->small), &(ms->big), &(ms->positive));
    if (rc == XDS_OK)
	return 0;
    else
	return rc;
@


1.5.2.1
log
@Modified test suits to compile with the new headers.
@
text
@d40 1
a40 3
static int encode_mystruct_engine(xds_t* xds, void* engine_context,
				  void* buffer, size_t buffer_size, size_t* used_buffer_size,
				  va_list* args)
a47 1
    assert(used_buffer_size != NULL);
d58 1
a58 3
static int decode_mystruct_engine(xds_t* xds, void* engine_context,
				  void* buffer, size_t buffer_size, size_t* used_buffer_size,
				  va_list* args)
a65 1
    assert(used_buffer_size != NULL);
@


1.5.2.2
log
@Rewrote formatting engines for the new semantics.
@
text
@d44 1
d54 5
a58 1
    return xds_encode(xds, "int32 int64 uint32", ms->small, ms->big, ms->positive);
d65 1
d75 5
a79 1
    return xds_decode(xds, "int32 int64 uint32", &(ms->small), &(ms->big), &(ms->positive));
@


1.5.2.3
log
@Now that internal.h includes assert.h we don't need to do that
anymore.
@
text
@d30 1
@


1.4
log
@Removed redundant include of sys/types.h.
@
text
@d50 4
a53 7
    if (buffer_size >= sizeof(struct mystruct))
	{
	ms = va_arg(*args, struct mystruct*);
	rc = xds_encode(xds, "int32 int64 uint32", ms->small, ms->big, ms->positive);
	if (rc != XDS_OK)
	    return rc;
	}
d55 1
a55 3
	return sizeof(struct mystruct);

    return 0;
d68 4
a71 7
    if (buffer_size >= sizeof(struct mystruct))
	{
	ms = va_arg(*args, struct mystruct*);
	rc = xds_decode(xds, "int32 int64 uint32", &(ms->small), &(ms->big), &(ms->positive));
	if (rc != XDS_OK)
	    return rc;
	}
d73 1
a73 3
	return XDS_ERR_UNDERFLOW;

    return 0;
d104 12
d121 5
d128 1
a128 1
	printf("xds_setbuffer() failed!\n");
d132 1
d164 1
a164 1
    if (memcmp(&ms, &new_ms, sizeof(struct mystruct)) != 0)
@


1.3
log
@Use xds_(u)int(8|16|32|64) instead of the system defines.
@
text
@a30 1
#include <sys/types.h>
@


1.2
log
@Include sys/types.h for int32_t and others.
@
text
@d36 3
a38 3
    int32_t   small;
    int64_t   big;
    u_int32_t positive;
@


1.1
log
@Added test suite that will verify that it is okay to call xds_encode()
in an encoding engine and xds_decode() in a decoding engine.
@
text
@d31 1
@