/* ***** 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 Original Code is Verbosio XML Entities Manager.
 *
 * The Initial Developer of the Original Code is
 * Alexander J. Vincent <ajvincent@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either 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 xeIDocumentPack;
interface xeIDocumentWrapper;
interface xeIDTDWrapper;

[scriptable, uuid(34a0783e-78ad-471f-9ebb-bd3a130e62ab)]
interface xeIEntity : nsISupports
{
  /**
   * The DTD wrapper owning the entity.
   */
  readonly attribute xeIDTDWrapper ownerDTD;

  /**
   * The name of the entity.
   */
  readonly attribute ACString name;

  /**
   * The source code of the entity.
   */
  readonly attribute ACString source;

  /**
   * Accept new value for the entity.  This does NOT affect the DTD wrapper.
   *
   * @param aSource The new entity value.
   *
   * @throws NS_ERROR_INVALID_ARG if the new value cannot fit in an attribute,
   *         and the original value could.
   */
  void acceptNewValue(in ACString aSource);

  /**
   * Update the DTD wrapper with the entity's new value.
   */
  void persistValue();

  /**
   * True if the entity has no XML markup.
   */
  readonly attribute boolean safeForAttributes;

  /**
   * Clone this object.
   */
  xeIEntity clone();
};

[scriptable, uuid(516b8bc8-514d-49c1-8ab1-54f1e3d7f110)]
interface xeIEntityManager : nsISupports
{
  /**
   * Initialize the document pack.
   */
  void initialize(in xeIDocumentPack aPack);

  /**
   * Map the DTD entities in a document.
   *
   * @param aWrapper The document wrapper holding the DTD.
   */
  void mapEntities(in xeIDocumentWrapper aWrapper);

  /**
   * Get the contents of the last mapped document with entity references.
   *
   * @return String of the document's contents.
   */
  ACString getSanitizedContent(in xeIDocumentWrapper aWrapper);
};
