#ifndef COMMON_WIREDELTA_H
#define COMMON_WIREDELTA_H

/*
 * Copyright (c) 2002, The EROS Group, LLC and Johns Hopkins
 * University. All rights reserved.
 * 
 * This software was developed to support the EROS secure operating
 * system project (http://www.eros-os.org). The latest version of
 * the OpenCM software can be found at http://www.opencm.org.
 * 
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 * 
 * 3. Neither the name of the The EROS Group, LLC nor the name of
 *    Johns Hopkins University, nor the names of its contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
 */

typedef struct WireDelta {
  Serializable ser;
  
  const char *baseTrueName;	/* truename of baseline */

  /* The /delta/ field can have one of two formats.
   *
   * If baseLine == 0, then /delta/ is a buffer containing a
   * deserializable byte stream stored in BINARY format.
   *
   * If baseLine is non-zero, then /delta/ is a buffer containing the
   * serialized form of a single xdelta_t. This xdelta_t is relative
   * to the BINARY serialization of the object named by
   * /baseTrueName/. When applied, it returns a buffer that is the
   * BINARY serialization of the result object.
   */

  Buffer *delta;
} WireDelta;

WireDelta *wireDelta_create(const char *baseTN, Buffer *b);

/** wireDelta_apply(): apply the delta to the base buffer.  
 *
 * The /base/ buffer must be the result of a binary serialization.
 *
 * If the WireDelta is known to have a NULL baseTrueName (as when the
 * network request did not supply a baseTrueName) the supplied /base/
 * pointer can be NULL.
 */
Buffer    *wireDelta_apply(WireDelta *wd, Buffer *base);

#endif /* COMMON_WIREDELTA_H */
