/* ***** 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 editor.
 *
 * 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"
#include "nsIDOMXMLDocument.idl"

interface xeIDocumentWrapper;
interface xeIDocumentPack;

[scriptable, uuid(019207de-fed0-41e8-892a-2bb1e17abd19)]
interface xeIDocumentFile : nsISupports
{
  attribute ACString contents;

  readonly attribute ACString savedContents;

  readonly attribute ACString location;

  void init(in ACString pathToFile, in ACString contentType);

  void read();
  
  void write(in ACString contents);

  // The reference file.  What the user directly edits.
  const unsigned short FILE_REFERENCE    = 0;

  // A copy of the reference file living somewhere else.
  const unsigned short FILE_COPY         = 1;

  /* A preprocessed version of the reference file.  This means a file merge.
     Example:  A chrome XUL file with #ifdef foo lines.
   */
  const unsigned short FILE_PREPROCESSED = 2;

  /* A file which either produces the reference file or is produced from it.
     Example:  A PHP file which generates the reference HTML file from a
     database.
   */
  const unsigned short FILE_GENERATED    = 3;
};

[scriptable, uuid(91b62fe1-8dd2-4a39-950b-e6a2fdaabdea)]
interface xeIXMLDocumentFile: xeIDocumentFile
{
  attribute nsIDOMXMLDocument contentDocument;
  
  void parse(in xeIDocumentWrapper aWrapper, in xeIDocumentPack aPack);
};
