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.18.17.37.49;	author simons;	state Exp;
branches
	1.5.2.1;
next	1.4;

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

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

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

1.1
date	2001.07.08.16.02.56;	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.03.12;	author simons;	state Exp;
branches;
next	1.5.2.3;

1.5.2.3
date	2001.08.01.14.35.43;	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"

static int dummy_engine(xds_t* xds, void* engine_context,
			void* buffer, size_t buffer_size, size_t* used_buffer_size,
			va_list* args)
    {
    if (xds == NULL)
	{
	printf("XDS context isn't passed through to registered engine.\n");
	exit(1);
	}
    if (engine_context != (void*)42)
	{
	printf("Engine context isn't passed through to registered engine.\n");
	exit(1);
	}
    if (buffer == NULL)
	{
	printf("Buffer passed to engine is NULL.\n");
	exit(1);
	}
    if (buffer_size == 0)
	{
	printf("buffer_size passed to engine is zero!\n");
	exit(1);
	}
    if (used_buffer_size == NULL)
	{
	printf("used_buffer_size pointer passed to engine is NULL!\n");
	exit(1);
	}
    if (args == NULL)
	{
	printf("args pointer passed to engine is NULL!\n");
	exit(1);
	}
    *used_buffer_size = 6;
    if (buffer_size < 6)
	return XDS_ERR_OVERFLOW;
    memmove(buffer, "Hallo ", 6);
    return XDS_OK;
    }

int main()
    {
    xds_t* xds;

    /* Create XDS context. */

    xds = xds_init(XDS_ENCODE);
    if (xds == NULL)
	{
	printf("Failed to initialize XDS context.\n");
	return 1;
	}

    /* Register the dummy callback under multiple names. */

    if (xds_register(xds, "int", &dummy_engine, (void*)42) != XDS_OK ||
	xds_register(xds, "float", &dummy_engine, (void*)42) != XDS_OK ||
	xds_register(xds, "double", &dummy_engine, (void*)42) != XDS_OK ||
	xds_register(xds, "text", &dummy_engine, (void*)42) != XDS_OK)
	{
	printf("Failed to register my encoding engines.\n");
	return 1;
	}

    /* Let's go and encode something. */

    if (xds_encode(xds, "int:text    double double float") != XDS_OK)
	{
	printf("xds_encode() failed!\n");
	return 1;
	}
    if (memcmp(xds->buffer, "Hallo Hallo Hallo Hallo Hallo ", 30) != 0)
	{
	printf("xds_encode() did not yield the expected result.\n");
	return 1;
	}

    /* Clean up. */

    xds_destroy(xds);

    /* 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
@Since args is a pointer now, let the engine check that it does not get
passed NULL here.
@
text
@d32 3
a34 1
static int dummy_engine(xds_t* xds, void* engine_context, void* buffer, size_t buffer_size, va_list* args)
d53 6
a58 1
	printf("Buffer size passed to engine is zero!\n");
d66 5
a70 2
    strncpy(buffer, "Hallo ", buffer_size);
    return 6;
d101 1
a101 1
	printf("xds_encode() failed!");
d104 1
a104 1
    if (strcmp(xds->buffer, "Hallo Hallo Hallo Hallo Hallo ") != 0)
@


1.5.2.1
log
@Modified test suits to compile with the new headers.
@
text
@d32 1
a32 3
static int dummy_engine(xds_t* xds, void* engine_context,
			void* buffer, size_t buffer_size, size_t* used_buffer_size,
			va_list* args)
d51 1
a51 6
	printf("buffer_size passed to engine is zero!\n");
	exit(1);
	}
    if (used_buffer_size == NULL)
	{
	printf("used_buffer_size pointer passed to engine is NULL!\n");
d59 2
a60 7
    if (buffer_size < 6)
	return XDS_ERR_OVERFLOW;
    else
	*used_buffer_size = 6;

    memmove(buffer, "Hallo ", 6);
    return XDS_OK;
d91 1
a91 1
	printf("xds_encode() failed!\n");
@


1.5.2.2
log
@Use memcmp() instead of strcmp() because we can't rely on trailing zero bytes.
@
text
@d106 1
a106 1
    if (memcmp(xds->buffer, "Hallo Hallo Hallo Hallo Hallo ", 30) != 0)
@


1.5.2.3
log
@Have the callback set used_buffer_size in any case so that we can use
a qualified guess at the new buffer size in case of reallocation.
@
text
@a65 1
    *used_buffer_size = 6;
d68 3
@


1.4
log
@Passing va_list parameters by value is fine, unless the called routine
modifies the parameter list and you expect the change to propagate
back to the mother routine. What is what we want. Hence, I changed the
prototype of the engine callback to expect a pointer to va_list.
@
text
@d54 5
@


1.3
log
@Removed unnecessary include statements.
@
text
@d32 1
a32 1
static int dummy_engine(xds_t* xds, void* engine_context, void* buffer, size_t buffer_size, va_list args)
@


1.2
log
@Implemented test suite for xds_encode().
@
text
@a29 2
#include <unistd.h>
#include <assert.h>
@


1.1
log
@Added preliminary version of the xds-encode test case.
@
text
@d53 1
a53 1
	printf("Buffer size passed to engine is NULL.\n");
d56 2
a57 1
    return 0;
a62 1
    size_t i;
d64 1
a64 1
    /* Create contexts for encoding and decoding. */
d68 4
a71 4
	    {
	    printf("Failed to initialize XDS context.\n");
	    return 1;
	    }
d75 4
a78 6
    if (xds_register(xds, "foo", &dummy_engine, (void*)42) != XDS_OK)
	{
	printf("Failed to register engine for 'foo'.\n");
	return 1;
	}
    if (xds_register(xds, "bar", &dummy_engine, (void*)42) != XDS_OK)
d80 1
a80 21
	printf("Failed to register engine for 'bar'.\n");
	return 1;
	}
    if (xds_register(xds, "zarah", &dummy_engine, (void*)42) != XDS_OK)
	{
	printf("Failed to register engine for 'zarah'.\n");
	return 1;
	}
    if (xds_register(xds, "caesar", &dummy_engine, (void*)42) != XDS_OK)
	{
	printf("Failed to register engine for 'caesar'.\n");
	return 1;
	}
    if (xds_register(xds, "claus", &dummy_engine, (void*)42) != XDS_OK)
	{
	printf("Failed to register engine for 'claus'.\n");
	return 1;
	}
    if (xds_register(xds, "heinz", &dummy_engine, (void*)42) != XDS_OK)
	{
	printf("Failed to register engine for 'heinz'.\n");
d84 1
a84 1
    /* Register the callback again, overwriting an existing entry. */
d86 1
a86 1
    if (xds_register(xds, "claus", &dummy_engine, (void*)42) != XDS_OK)
d88 1
a88 1
	printf("Failed to re-register engine for 'claus'.\n");
d91 1
a91 4

    /* Ensure that everything is in alphabetical order. */

    for (i = 1; i < xds->engines_len; ++i)
d93 2
a94 7
	assert(xds->engines[i-1].name != NULL);
	assert(xds->engines[i].name != NULL);
	if (strcmp(xds->engines[i-1].name, xds->engines[i].name) >= 0)
	    {
	    printf("xds->engines is not in alphabetical order!\n");
	    exit(1);
	    }
@