head	1.3;
access;
symbols
	last-version-in-peti-style:1.2
	callback-semantic-rewrite:1.1.0.2;
locks; strict;
comment	@ * @;


1.3
date	2001.08.08.19.15.27;	author rse;	state dead;
branches;
next	1.2;

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

1.1
date	2001.07.18.17.38.37;	author simons;	state Exp;
branches
	1.1.2.1;
next	;

1.1.2.1
date	2001.08.01.11.27.20;	author simons;	state Exp;
branches;
next	1.1.2.2;

1.1.2.2
date	2001.08.01.12.05.07;	author simons;	state Exp;
branches;
next	;


desc
@@


1.3
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);
	}
    if (va_arg(*args, int) != 42)
	{
	printf("The varadic argument is not what the engine expected!\n");
	exit(1);
	}
    if (buffer_size < 64)
	return XDS_ERR_OVERFLOW;
    else
	*used_buffer_size = 64;
    return XDS_OK;
    }

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

    /* Create an XDS context and set a buffer that's too small for the
       first encode() call. Then call encode() with two parameters:
       the one the engine is expecting and a different one after that.
       The engine will complain if it sees the second value -- what
       would mean that the args parameter was not resetted to the
       original value before the engine is restarted after buffer
       enlargement. */

    xds = xds_init(XDS_ENCODE);
    if (xds == NULL)
	{
	printf("Failed to initialize XDS context.\n");
	return 1;
	}
    if (xds_register(xds, "int", &dummy_engine, (void*)42) != XDS_OK)
	{
	printf("Failed to register my encoding engines.\n");
	return 1;
	}
    buffer = malloc(32);
    if (buffer == NULL)
        {
        printf("malloc() failed!\n");
        return 1;
        }
    buffer_size = 32;
    if (xds_setbuffer(xds, XDS_GIFT, buffer, buffer_size) != XDS_OK)
        {
        printf("xds_setbuffer() failed!\n");
        return 1;
        }
    if (xds_encode(xds, "int", 42, 13) != XDS_OK)
	{
	printf("xds_encode() failed!");
	return 1;
	}
    xds_destroy(xds);
    return 0;
    }
@


1.2
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.1
log
@When an engine is restarted after buffer enlargement, the original
value of the ap_list must be restored. Fixed that bug and added a test
suite that verifies this behavior.
@
text
@d32 3
a34 1
static int dummy_engine(xds_t* xds, void* engine_context, void* buffer, size_t buffer_size, va_list* args)
d56 5
d71 5
a75 1
    return 64;
@


1.1.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)
a51 5
	exit(1);
	}
    if (used_buffer_size == NULL)
	{
	printf("used_buffer_size pointer passed to engine is NULL!\n");
@


1.1.2.2
log
@Rewrote callback for the new semantics.
@
text
@d71 1
a71 5
    if (buffer_size < 64)
	return XDS_ERR_OVERFLOW;
    else
	*used_buffer_size = 64;
    return XDS_OK;
@