/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: set ts=8 sw=2 et tw=80:
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Initial Developer of the Original Code is the Mozilla Foundation.

 * Portions created by the Initial Developer are Copyright (C) 2011
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Justin Lebar <justin.lebar@gmail.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface nsIVariant;
interface nsIDocument;

%{C++
struct JSContext;
%}

/**
 * This interface acts as a container for an object serialized using the
 * structured clone algorithm.
 *
 * You can copy an object into an nsIStructuredCloneContainer using
 * initFromVariant or initFromBase64.  It's an error to initialize an
 * nsIStructuredCloneContainer more than once.
 *
 * Once you've initialized the container, you can get a copy of the object it
 * stores by calling deserializeToVariant.  You can also get a base-64-encoded
 * string containing a copy of the container's serialized data, using
 * getDataAsBase64.
 */
[scriptable, uuid(400a282d-7157-4ed0-85b4-8bdc2fa634cd)]
interface nsIStructuredCloneContainer : nsISupports
{
  /**
   * Initialize this structured clone container so it contains a clone of the
   * given variant. aData must be backed by a jsval.
   */
  [implicit_jscontext]
  void initFromVariant(in nsIVariant aData);

  /**
   * Initialize this structured clone container from a base-64-encoded byte
   * stream, stored in aData.  aFormatVersion should be the version of the
   * structured clone algorithm which was used to generate aData.
   */
  [implicit_jscontext]
  void initFromBase64(in AString aData,in unsigned long aFormatVersion);

  /**
   * Deserialize the object this conatiner holds, returning it wrapped as
   * an nsIVariant.
   */
  [implicit_jscontext]
  nsIVariant deserializeToVariant();

  /**
   * Get this structured clone container's data as a base-64-encoded string.
   */
  AString getDataAsBase64();

  /**
   * Get the size in bytes of this container's serialized data.
   */
  readonly attribute unsigned long long serializedNBytes;

  /**
   * Get the version of the structured clone algorithm which was used to
   * generate this container's serialized buffer.
   */
  readonly attribute unsigned long formatVersion;
};
